Urho3D
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
Urho3D::ScriptFile Class Reference

Script file resource. More...

#include <ScriptFile.h>

Inheritance diagram for Urho3D::ScriptFile:
Urho3D::Resource Urho3D::ScriptEventListener Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 ScriptFile (Context *context)
 Construct.
virtual ~ScriptFile ()
 Destruct.
virtual bool Load (Deserializer &source)
 Load resource. Return true if successful.
virtual void AddEventHandler (StringHash eventType, const String &handlerName)
 Add an event handler. Called by script exposed version of SubscribeToEvent().
virtual void AddEventHandler (Object *sender, StringHash eventType, const String &handlerName)
 Add an event handler for a specific sender. Called by script exposed version of SubscribeToEvent().
bool Execute (const String &declaration, const VariantVector &parameters=VariantVector(), bool unprepare=true)
 Query for a function by declaration and execute if found.
bool Execute (asIScriptFunction *function, const VariantVector &parameters=VariantVector(), bool unprepare=true)
 Execute a function.
bool Execute (asIScriptObject *object, const String &declaration, const VariantVector &parameters=VariantVector(), bool unprepare=true)
 Query for an object method by declaration and execute if found.
bool Execute (asIScriptObject *object, asIScriptFunction *method, const VariantVector &parameters=VariantVector(), bool unprepare=true)
 Execute an object method.
asIScriptObject * CreateObject (const String &className)
 Create a script object.
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.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
virtual bool Save (Serializer &dest)
 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.
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.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const 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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.

Static Public Member Functions

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

Private Member Functions

 OBJECT (ScriptFile)
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 HandleScriptEvent (StringHash eventType, VariantMap &eventData)
 Handle an event in script.

Private Attributes

SharedPtr< Scriptscript_
 Script subsystem.
asIScriptModule * scriptModule_
 Script module.
bool compiled_
 Compiled 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 * > 
functions_
 Search cache for functions.
HashMap< asIObjectType
*, HashMap< String,
asIScriptFunction * > > 
methods_
 Search cache for methods.

Detailed Description

Script file resource.


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