Urho3D::ScriptEventInvoker Class Reference

Helper class for forwarding events to script objects that are not part of a scene. More...

#include <ScriptFile.h>

Inheritance diagram for Urho3D::ScriptEventInvoker:

Collaboration diagram for Urho3D::ScriptEventInvoker:

Public Member Functions
	ScriptEventInvoker (ScriptFile *file, asIScriptObject *object=0)
	Constructor, will create the asILockableSharedBool if a ScriptObject is passed in.
	~ScriptEventInvoker ()
	Destructor, release the ref it we still hold it.
asIScriptObject *	GetObject () const
	Get the asIScriptObject to call the method on, can be null.
bool	IsObjectAlive () const
	Returns whether the ScriptObject is still alive. Will return true if there is no reference and object.
void	HandleScriptEvent (StringHash eventType, VariantMap &eventData)
	Handle an event in script.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	OBJECT (ScriptEventInvoker)

Private Attributes
ScriptFile *	file_
	Parent script file.
asILockableSharedBool *	sharedBool_
	Shared boolean for checking the continued existence of the script object.
asIScriptObject *	object_
	Script object that the handler method belongs to. Null for procedural event handling.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Helper class for forwarding events to script objects that are not part of a scene.

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Script/ScriptFile.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Script/ScriptFile.cpp