Urho3D::ScriptFile Class Reference

Script file resource. More...

#include <Urho3D/AngelScript/ScriptFile.h>

Inheritance diagram for Urho3D::ScriptFile:

Collaboration diagram for Urho3D::ScriptFile:

Public Member Functions
	ScriptFile (Context *context)
	Construct.
	~ScriptFile () override
	Destruct.
bool	BeginLoad (Deserializer &source) override
	Load resource from stream. May be called from a worker thread. Return true if successful.
bool	EndLoad () override
	Finish resource loading. Always called from the main thread. Return true if successful.
void	AddEventHandler (StringHash eventType, const String &handlerName) override
	Add a scripted event handler.
void	AddEventHandler (Object *sender, StringHash eventType, const String &handlerName) override
	Add a scripted event handler for a specific sender.
void	RemoveEventHandler (StringHash eventType) override
	Remove a scripted event handler.
void	RemoveEventHandler (Object *sender, StringHash eventType) 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	RemoveEventHandlers () override
	Remove all scripted event handlers.
void	RemoveEventHandlersExcept (const PODVector< StringHash > &exceptions) override
	Remove all scripted event handlers, except those listed.
bool	HasEventHandler (StringHash eventType) const override
	Return whether has subscribed to an event.
bool	HasEventHandler (Object *sender, StringHash eventType) const override
	Return whether has subscribed to a specific sender's event.
bool	Execute (const String &declaration, const VariantVector &parameters=Variant::emptyVariantVector, Variant *functionReturn=nullptr, bool unprepare=true)
	Query for a function by declaration and execute if found.
bool	Execute (asIScriptFunction *function, const VariantVector &parameters=Variant::emptyVariantVector, Variant *functionReturn=nullptr, bool unprepare=true)
	Execute a function.
bool	Execute (asIScriptObject *object, const String &declaration, const VariantVector &parameters=Variant::emptyVariantVector, Variant *functionReturn=nullptr, bool unprepare=true)
	Query for an object method by declaration and execute if found.
bool	Execute (asIScriptObject *object, asIScriptFunction *method, const VariantVector &parameters=Variant::emptyVariantVector, Variant *functionReturn=nullptr, bool unprepare=true)
	Execute an object method.
void	DelayedExecute (float delay, bool repeat, const String &declaration, const VariantVector &parameters=Variant::emptyVariantVector)
	Add a delay-executed function call, optionally repeating.
void	ClearDelayedExecute (const String &declaration=String::EMPTY)
	Clear pending delay-executed function calls. If empty declaration given, clears all.
asIScriptObject *	CreateObject (const String &className, bool useInterface=false)
	Create a script object. Optionally search for the first class in the module that implements the specified interface.
bool	SaveByteCode (Serializer &dest)
	Save the script bytecode. Return true if successful.
asIScriptModule *	GetScriptModule () const
	Return script module.
asIScriptFunction *	GetFunction (const String &declaration)
	Return a function by declaration. Will be stored to a search cache so that further searches should be faster.
asIScriptFunction *	GetMethod (asIScriptObject *object, const String &declaration)
	Return an object method by declaration.
bool	IsCompiled () const
	Return whether script compiled successfully.
void	CleanupEventInvoker (asIScriptObject *object)
	Clean up an event invoker object when its associated script object no longer exists.
Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.
bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool	Save (Serializer &dest) const
	Save resource. Return true if successful.
bool	LoadFile (const String &fileName)
virtual bool	SaveFile (const String &fileName) const
void	SetName (const String &name)
void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.
void	ResetUseTimer ()
	Reset last used timer.
void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
const String &	GetName () const
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
unsigned	GetUseTimer ()
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
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::ScriptEventListener
virtual	~ScriptEventListener ()=default
	Destruct.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (ScriptFile, Resource)
void	AddEventHandlerInternal (Object *sender, StringHash eventType, const String &handlerName)
	Add an event handler and create the necessary proxy object.
bool	AddScriptSection (asIScriptEngine *engine, Deserializer &source)
	Add a script section, checking for includes recursively. Return true if successful.
void	SetParameters (asIScriptContext *context, asIScriptFunction *function, const VariantVector &parameters)
	Set parameters for a function or method.
void	ReleaseModule ()
	Release the script module.
void	HandleUpdate (StringHash eventType, VariantMap &eventData)
	Handle application update event.

Private Attributes
SharedPtr< Script >	script_
	Script subsystem.
asIScriptModule *	scriptModule_ {}
	Script module.
bool	compiled_ {}
	Compiled flag.
bool	subscribed_ {}
	Subscribed to application update event flag.
HashSet< String >	includeFiles_
	Encountered include files during script file loading.
HashMap< asITypeInfo *, bool >	validClasses_
	Search cache for checking whether script classes implement "ScriptObject" interface.
HashMap< String, asIScriptFunction * >	functions_
	Search cache for functions.
HashMap< asITypeInfo *, HashMap< String, asIScriptFunction * > >	methods_
	Search cache for methods.
Vector< DelayedCall >	delayedCalls_
	Delayed function calls.
HashMap< asIScriptObject *, SharedPtr< ScriptEventInvoker > >	eventInvokers_
	Event helper objects for handling procedural or non-ScriptInstance script events.
SharedArrayPtr< unsigned char >	loadByteCode_
	Byte code for asynchronous loading.
unsigned	loadByteCodeSize_ {}
	Byte code size for asynchronous loading.

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

Detailed Description

Script file resource.

---

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

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