This is a subscriber slot class that triggers a provided script. More...

Inheritance diagram for Mezzanine::ScriptSubscriberSlot:

Collaboration diagram for Mezzanine::ScriptSubscriberSlot:

Public Member Functions
	ScriptSubscriberSlot (Event Ev, Scripting::iScript SubScript)
	Class constructor. More...

virtual	~ScriptSubscriberSlot ()
	Class destructor.

virtual void	_NotifyEvent (EventArgumentsPtr Args)
	Notifies this subscriber of an event being fired. More...

Scripting::iScript *	GetScript () const
	Gets a pointer to the function used by this subscriber slot. More...

virtual SlotType	GetType () const
	Gets the type of subscriber slot this is. More...

Public Member Functions inherited from Mezzanine::EventSubscriberSlot
	EventSubscriberSlot (Event *Ev)
	Class constructor. More...

virtual	~EventSubscriberSlot ()
	Class destructor.

Event *	GetEvent () const
	Gets the set of events the subscriber is subscribed to. More...

Protected Attributes
Scripting::iScript *	SubscriberScript
	A pointer to the script to be executed when the event is fired. More...

Protected Attributes inherited from Mezzanine::EventSubscriberSlot
Event *	SubbedEvent
	A pointer to the connected event. More...

Additional Inherited Members
Public Types inherited from Mezzanine::EventSubscriberSlot
enum	SlotType { ST_Custom = 1, ST_Functor = 2, ST_CFunction = 3, ST_Script = 4, ST_MemberFunction = 5 }
	This enum is used to describe the type of SubscriberSlot an instance is, to be used for casting.

Detailed Description

This is a subscriber slot class that triggers a provided script.

Definition at line 231 of file eventsubscriberslot.h.

Constructor & Destructor Documentation

Mezzanine::ScriptSubscriberSlot::ScriptSubscriberSlot	(	Event *	Ev,
		Scripting::iScript *	SubScript
	)

Class constructor.

Parameters

Ev	The event this subscriber slot belongs to.
SubScript	The subscriber script to be called when the event is fired.

Definition at line 149 of file eventsubscriberslot.cpp.

void Mezzanine::ScriptSubscriberSlot::_NotifyEvent ( EventArgumentsPtr Args )

virtual

Notifies this subscriber of an event being fired.

Parameters

Args	The arguments containing specific information regarding this event.

Definition at line 169 of file eventsubscriberslot.cpp.

Scripting::iScript * Mezzanine::ScriptSubscriberSlot::GetScript ( ) const

Gets a pointer to the function used by this subscriber slot.

Returns: Returns a pointer to the function subscriber being used in this subscriber slot.

Definition at line 160 of file eventsubscriberslot.cpp.

EventSubscriberSlot::SlotType Mezzanine::ScriptSubscriberSlot::GetType ( ) const

virtual

Gets the type of subscriber slot this is.

Returns: Returns a SlotType enum value representing the type of subscriber slot this is.

Definition at line 163 of file eventsubscriberslot.cpp.

Scripting::iScript* Mezzanine::ScriptSubscriberSlot::SubscriberScript

protected

A pointer to the script to be executed when the event is fired.

Definition at line 236 of file eventsubscriberslot.h.

The documentation for this class was generated from the following files: