Urho3D::LuaScript Class Reference

Lua script subsystem. More...

#include <Urho3D/LuaScript/LuaScript.h>

Inheritance diagram for Urho3D::LuaScript:

Collaboration diagram for Urho3D::LuaScript:

Public Member Functions
	LuaScript (Context *context)
	Construct.
	~LuaScript () override
	Destruct.
void	AddEventHandler (const String &eventName, int index) override
	Add a scripted event handler by function at the given stack index.
void	AddEventHandler (const String &eventName, const String &functionName) override
	Add a scripted event handler by function name.
void	AddEventHandler (Object *sender, const String &eventName, int index) override
	Add a scripted event handler by function at the given stack index for a specific sender.
void	AddEventHandler (Object *sender, const String &eventName, const String &functionName) override
	Add a scripted event handler by function name for a specific sender.
void	RemoveEventHandler (const String &eventName) override
	Remove a scripted event handler.
void	RemoveEventHandler (Object *sender, const String &eventName) override
	Remove a scripted event handler for a specific sender.
void	RemoveEventHandlers (Object *sender) override
	Remove all scripted event handlers for a specific sender.
void	RemoveAllEventHandlers () override
	Remove all scripted event handlers.
void	RemoveEventHandlersExcept (const Vector< String > &exceptionNames) override
	Remove all scripted event handlers, except those listed.
bool	HasEventHandler (const String &eventName) const override
	Return whether has subscribed to an event.
bool	HasEventHandler (Object *sender, const String &eventName) const override
	Return whether has subscribed to a specific sender's event.
bool	ExecuteFile (const String &fileName)
	Execute script file. Return true if successful.
bool	ExecuteString (const String &string)
	Execute script string. Return true if successful.
bool	LoadRawFile (const String &fileName)
	Load script file on file system (i.e. not from resource cache). Return true if successful.
bool	ExecuteRawFile (const String &fileName)
	Load and execute script file on file system (i.e. not from resource cache). Return true if successful.
bool	ExecuteFunction (const String &functionName)
	Execute script function.
void	SetExecuteConsoleCommands (bool enable)
	Set whether to execute engine console commands as script code.
lua_State *	GetState () const
	Return Lua state.
LuaFunction *	GetFunction (int index)
	Return Lua function at the given stack index.
LuaFunction *	GetFunction (const String &functionName, bool silentIfNotFound=false)
	Return Lua function by function name.
bool	GetExecuteConsoleCommands () const
	Return whether is executing engine console commands as script code.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
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	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	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.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
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
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
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.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
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
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.
Public Member Functions inherited from Urho3D::LuaScriptEventListener
virtual	~LuaScriptEventListener ()=default
	Destruct.

Static Public Member Functions
static bool	PushLuaFunction (lua_State *L, const String &functionName)
	Push Lua function to stack. Return true if is successful. Return false on any error and an error string is pushed instead.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (LuaScript, Object)
void	RegisterLoader ()
	Register loader.
void	ReplacePrint ()
	Replace print.
void	HandlePostUpdate (StringHash eventType, VariantMap &eventData)
	Handle post update.
void	HandleConsoleCommand (StringHash eventType, VariantMap &eventData)
	Handle a console command event.

Static Private Member Functions
static int	AtPanic (lua_State *L)
	At panic.
static int	Loader (lua_State *L)
	Loader.
static int	Print (lua_State *L)
	Print function.

Private Attributes
lua_State *	luaState_
	Lua state.
SharedPtr< LuaScriptEventInvoker >	eventInvoker_
	Procedural event invoker.
LuaFunction *	coroutineUpdate_
	Coroutine update function.
bool	executeConsoleCommands_
	Flag for executing engine console commands as script code. Default to true.
HashMap< const void *, SharedPtr< LuaFunction > >	functionPointerToFunctionMap_
	Function pointer to function map.
HashMap< String, SharedPtr< LuaFunction > >	functionNameToFunctionMap_
	Function name to function map.

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

Detailed Description

Lua script subsystem.

---

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

• Source/Urho3D/LuaScript/LuaScript.h
• Source/Urho3D/LuaScript/LuaScript.cpp