Script file resource. More...

#include <ScriptFile.h>

Inheritance diagram for Urho3D::ScriptFile:
Collaboration diagram for Urho3D::ScriptFile:

Public Member Functions

 ScriptFile (Context *context)
virtual ~ScriptFile ()
virtual bool BeginLoad (Deserializer &source)
 Load resource from stream. May be called from a worker thread. Return true if successful.
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
virtual void AddEventHandler (StringHash eventType, const String &handlerName)
 Add a scripted event handler.
virtual void AddEventHandler (Object *sender, StringHash eventType, const String &handlerName)
 Add a scripted event handler for a specific sender.
virtual void RemoveEventHandler (StringHash eventType)
 Remove a scripted event handler.
virtual void RemoveEventHandler (Object *sender, StringHash eventType)
 Remove a scripted event handler for a specific sender.
virtual void RemoveEventHandlers (Object *sender)
 Remove all scripted event handlers for a specific sender.
virtual void RemoveEventHandlers ()
 Remove all scripted event handlers.
virtual void RemoveEventHandlersExcept (const PODVector< StringHash > &exceptions)
 Remove all scripted event handlers, except those listed.
bool Execute (const String &declaration, const VariantVector &parameters=Variant::emptyVariantVector, bool unprepare=true)
 Query for a function by declaration and execute if found.
bool Execute (asIScriptFunction *function, const VariantVector &parameters=Variant::emptyVariantVector, bool unprepare=true)
 Execute a function.
bool Execute (asIScriptObject *object, const String &declaration, const VariantVector &parameters=Variant::emptyVariantVector, 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, 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)
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.
void SetName (const String &name)
 Set 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 StringGetName () const
 Return name.
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
 Return memory use in bytes, possibly approximate.
unsigned GetUseTimer ()
 Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
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::StringGetTypeName () 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...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () 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 StringGetCategory () 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.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
- Public Member Functions inherited from Urho3D::ScriptEventListener
virtual ~ScriptEventListener ()

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.

Private Member Functions

 OBJECT (ScriptFile)
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< Scriptscript_
 Script subsystem.
asIScriptModule * scriptModule_
 Script module.
bool compiled_
 Compiled flag.
bool subscribed_
 Subscribed to application update event flag.
HashSet< StringincludeFiles_
 Encountered include files during script file loading.
HashMap< asIObjectType *, bool > validClasses_
 Search cache for checking whether script classes implement "ScriptObject" interface.
HashMap< String,
asIScriptFunction * > 
 Search cache for functions.
HashMap< asIObjectType
*, HashMap< String,
asIScriptFunction * > > 
 Search cache for methods.
Vector< DelayedCalldelayedCalls_
 Delayed function calls.
HashMap< asIScriptObject
*, SharedPtr
< ScriptEventInvoker > > 
 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
 Execution context.

Detailed Description

Script file resource.

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