Urho3D::Script Class Reference

Scripting subsystem. Allows execution of AngelScript. More...

#include <Urho3D/AngelScript/Script.h>

Inheritance diagram for Urho3D::Script:

Collaboration diagram for Urho3D::Script:

Public Member Functions
	Script (Context *context)
	Construct.
	~Script () override
	Destruct. Release the AngelScript engine.
bool	Execute (const String &line)
	Compile and execute a line of script in immediate mode.
void	SetDefaultScriptFile (ScriptFile *file)
	Set immediate mode script file.
void	SetDefaultScene (Scene *scene)
	Set immediate mode scene.
void	SetExecuteConsoleCommands (bool enable)
	Set whether to execute engine console commands as script code.
void	DumpAPI (DumpMode mode=DOXYGEN, const String &sourceTree=String::EMPTY)
	Print the whole script API (all registered classes, methods and properties) to the log. No-ops when URHO3D_LOGGING not defined.
void	MessageCallback (const asSMessageInfo *msg)
	Log a message from the script engine.
void	ExceptionCallback (asIScriptContext *context)
	Handle a script exception.
asIScriptEngine *	GetScriptEngine () const
	Return the AngelScript engine.
asIScriptContext *	GetImmediateContext () const
	Return immediate execution script context.
ScriptFile *	GetDefaultScriptFile () const
	Return immediate mode script file.
Scene *	GetDefaultScene () const
	Return immediate mode scene.
bool	GetExecuteConsoleCommands () const
	Return whether is executing engine console commands as script code.
void	ClearObjectTypeCache ()
	Clear the inbuild object type cache.
asITypeInfo *	GetObjectType (const char *declaration)
	Query for an inbuilt object type by constant declaration. Can not be used for script types.
Mutex &	GetModuleMutex ()
	Return the script module create/delete mutex.
const char **	GetEnumValues (int asTypeID)
	Returns an array of strings of enum value names for Enum Attributes.
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.

Static Public Member Functions
static String	GetCallStack (asIScriptContext *context)
	Get call stack.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Script, Object)
void	IncScriptNestingLevel ()
	Increase script nesting level.
void	DecScriptNestingLevel ()
	Decrease script nesting level.
unsigned	GetScriptNestingLevel ()
	Return current script nesting level.
asIScriptContext *	GetScriptFileContext ()
	Return a script function/method execution context for the current execution nesting level.
void	OutputAPIRow (DumpMode mode, const String &row, bool removeReference=false, const String &separator=";")
	Output a sanitated row of script API. No-ops when URHO3D_LOGGING not defined.
void	HandleConsoleCommand (StringHash eventType, VariantMap &eventData)
	Handle a console command event.

Private Attributes
asIScriptEngine *	scriptEngine_
	AngelScript engine.
asIScriptContext *	immediateContext_
	Immediate execution script context.
WeakPtr< ScriptFile >	defaultScriptFile_
	Immediate execution script file.
WeakPtr< Scene >	defaultScene_
	Immediate execution scene.
Vector< asIScriptContext * >	scriptFileContexts_
	Script function/method execution contexts.
HashMap< const char *, asITypeInfo * >	objectTypes_
	Search cache for inbuilt object types.
HashMap< int, PODVector< const char * > >	enumValues_
	Cache of typeIds to array of enum value strings for attributes.
SharedPtr< ResourceRouter >	router_
	AngelScript resource router.
Mutex	moduleMutex_
	Script module create/delete mutex.
unsigned	scriptNestingLevel_
	Current script execution nesting level.
bool	executeConsoleCommands_
	Flag for executing engine console commands as script code. Default to true.

Friends
class	ScriptFile

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

Detailed Description

Scripting subsystem. Allows execution of AngelScript.

---

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

• Source/Urho3D/AngelScript/Script.h
• Source/Urho3D/AngelScript/Script.cpp