U3D
Open-source, cross-platform 2D and 3D game engine built in C++
Loading...
Searching...
No Matches
Urho3D::LuaScriptEventListener Class Referenceabstract

Lua script event listener. More...

#include </var/dev/u3d/stable/Source/Urho3D/LuaScript/LuaScriptEventListener.h>

Inheritance diagram for Urho3D::LuaScriptEventListener:
[legend]

Public Member Functions

virtual ~LuaScriptEventListener ()=default
 Destruct.
 
virtual void AddEventHandler (const String &eventName, int index)=0
 Add a scripted event handler by function at the given stack index. More...
 
virtual void AddEventHandler (const String &eventName, const String &functionName)=0
 Add a scripted event handler by function name. More...
 
virtual void AddEventHandler (Object *sender, const String &eventName, int index)=0
 Add a scripted event handler by function at the given stack index for a specific sender. More...
 
virtual void AddEventHandler (Object *sender, const String &eventName, const String &functionName)=0
 Add a scripted event handler by function name for a specific sender. More...
 
virtual void RemoveEventHandler (const String &eventName)=0
 Remove a scripted event handler. More...
 
virtual void RemoveEventHandler (Object *sender, const String &eventName)=0
 Remove a scripted event handler for a specific sender. More...
 
virtual void RemoveEventHandlers (Object *sender)=0
 Remove all scripted event handlers for a specific sender. More...
 
virtual void RemoveAllEventHandlers ()=0
 Remove all scripted event handlers. More...
 
virtual void RemoveEventHandlersExcept (const Vector< String > &exceptionNames)=0
 Remove all scripted event handlers, except those listed. More...
 
virtual bool HasEventHandler (const String &eventName) const =0
 Return whether has subscribed to an event. More...
 
virtual bool HasEventHandler (Object *sender, const String &eventName) const =0
 Return whether has subscribed to a specific sender's event. More...
 

Detailed Description

Lua script event listener.

Member Function Documentation

◆ AddEventHandler() [1/4]

virtual void Urho3D::LuaScriptEventListener::AddEventHandler ( const String eventName,
const String functionName 
)
pure virtual

Add a scripted event handler by function name.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ AddEventHandler() [2/4]

virtual void Urho3D::LuaScriptEventListener::AddEventHandler ( const String eventName,
int  index 
)
pure virtual

Add a scripted event handler by function at the given stack index.

Implemented in Urho3D::LuaScriptInstance, and Urho3D::LuaScript.

◆ AddEventHandler() [3/4]

virtual void Urho3D::LuaScriptEventListener::AddEventHandler ( Object sender,
const String eventName,
const String functionName 
)
pure virtual

Add a scripted event handler by function name for a specific sender.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ AddEventHandler() [4/4]

virtual void Urho3D::LuaScriptEventListener::AddEventHandler ( Object sender,
const String eventName,
int  index 
)
pure virtual

Add a scripted event handler by function at the given stack index for a specific sender.

Implemented in Urho3D::LuaScriptInstance, and Urho3D::LuaScript.

◆ HasEventHandler() [1/2]

virtual bool Urho3D::LuaScriptEventListener::HasEventHandler ( const String eventName) const
pure virtual

Return whether has subscribed to an event.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ HasEventHandler() [2/2]

virtual bool Urho3D::LuaScriptEventListener::HasEventHandler ( Object sender,
const String eventName 
) const
pure virtual

Return whether has subscribed to a specific sender's event.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ RemoveAllEventHandlers()

virtual void Urho3D::LuaScriptEventListener::RemoveAllEventHandlers ( )
pure virtual

Remove all scripted event handlers.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ RemoveEventHandler() [1/2]

virtual void Urho3D::LuaScriptEventListener::RemoveEventHandler ( const String eventName)
pure virtual

Remove a scripted event handler.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ RemoveEventHandler() [2/2]

virtual void Urho3D::LuaScriptEventListener::RemoveEventHandler ( Object sender,
const String eventName 
)
pure virtual

Remove a scripted event handler for a specific sender.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ RemoveEventHandlers()

virtual void Urho3D::LuaScriptEventListener::RemoveEventHandlers ( Object sender)
pure virtual

Remove all scripted event handlers for a specific sender.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.

◆ RemoveEventHandlersExcept()

virtual void Urho3D::LuaScriptEventListener::RemoveEventHandlersExcept ( const Vector< String > &  exceptionNames)
pure virtual

Remove all scripted event handlers, except those listed.

Implemented in Urho3D::LuaScript, and Urho3D::LuaScriptInstance.


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