Public Member Functions |
| ScriptInstance (Context *context) |
| Construct.
|
virtual | ~ScriptInstance () |
| Destruct.
|
virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
|
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 | CreateObject (ScriptFile *scriptFile, const String &className) |
| Create object of certain class from the script file. Return true if successful.
|
void | SetScriptFile (ScriptFile *scriptFile) |
| Set script file only. Recreate object if necessary.
|
void | SetClassName (const String &className) |
| Set class name only. Recreate object if necessary.
|
void | SetActive (bool active) |
| Enable or disable scripted updates and event handlers.
|
void | SetFixedUpdateFps (int fps) |
| Set fixed updates per second. 0 (default) uses the physics frame rate.
|
bool | Execute (const String &declaration, const VariantVector ¶meters=VariantVector()) |
| Query for a method by declaration and execute if found.
|
bool | Execute (asIScriptFunction *method, const VariantVector ¶meters=VariantVector()) |
| Execute a method.
|
void | DelayedExecute (float delay, bool repeat, const String &declaration, const VariantVector ¶meters=VariantVector()) |
| Add a delay-executed method call, optionally repeating.
|
void | ClearDelayedExecute (const String &declaration=String()) |
| Clear pending delay-executed method calls. If empty declaration given, clears all.
|
ScriptFile * | GetScriptFile () const |
| Return script file.
|
asIScriptObject * | GetScriptObject () const |
| Return script object.
|
const String & | GetClassName () const |
| Return class name.
|
bool | IsActive () const |
| Return whether scripted updates and event handlers are enabled.
|
int | GetFixedUpdateFps () const |
| Return fixed updates per second.
|
void | SetScriptFileAttr (ResourceRef value) |
| Set script file attribute.
|
void | SetDelayedMethodCallsAttr (PODVector< unsigned char > value) |
| Set delayed method calls attribute.
|
void | SetFixedUpdateAccAttr (float value) |
| Set fixed update time accumulator attribute.
|
void | SetScriptDataAttr (PODVector< unsigned char > data) |
| Set script data attribute by calling a script function.
|
ResourceRef | GetScriptFileAttr () const |
| Return script file attribute.
|
PODVector< unsigned char > | GetDelayedMethodCallsAttr () const |
| Return delayed method calls attribute.
|
float | GetFixedUpdateAccAttr () const |
| Return fixed update time accumulator attribute.
|
PODVector< unsigned char > | GetScriptDataAttr () const |
| Get script data attribute by calling a script function.
|
| Component (Context *context) |
| Construct.
|
virtual | ~Component () |
| Destruct.
|
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| Handle attribute write access.
|
virtual bool | Save (Serializer &dest) |
| Save as binary data. Return true if successful.
|
virtual bool | SaveXML (XMLElement &dest) |
| Save as XML data. Return true if successful.
|
virtual void | GetDependencyNodes (PODVector< Node * > &dest) |
| Return the depended on nodes to order network updates.
|
virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
| Visualize the component as debug geometry.
|
void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
unsigned | GetID () const |
| Return ID.
|
Node * | GetNode () const |
| Return scene node.
|
Scene * | GetScene () const |
| Return the scene the node belongs to.
|
void | GetComponents (PODVector< Component * > &dest, ShortStringHash type) const |
| Return components in the same scene node by type.
|
Component * | GetComponent (ShortStringHash type) const |
| Return component in the same scene node by type. If there are several, returns the first.
|
template<class T > |
T * | GetComponent () const |
| Template version of returning a component in the same scene node by type.
|
template<class T > |
void | GetComponents (PODVector< T * > &dest) const |
| Template version of returning components in the same scene node by type.
|
void | AddReplicationState (ComponentReplicationState *state) |
| Add a replication state that is tracking this component.
|
void | PrepareNetworkUpdate () |
| Prepare network update by comparing attributes and marking replication states dirty as necessary.
|
void | CleanupConnection (Connection *connection) |
| Clean up all references to a network connection that is about to be removed.
|
void | MarkNetworkUpdate () |
| Mark for attribute check on the next network update.
|
| Serializable (Context *context) |
| Construct.
|
virtual | ~Serializable () |
| Destruct.
|
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) |
| Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
|
virtual bool | Load (Deserializer &source) |
| Load from binary data. Return true if successful.
|
virtual bool | LoadXML (const XMLElement &source) |
| Load from XML data. Return true if successful.
|
bool | SetAttribute (unsigned index, const Variant &value) |
| Set attribute by index. Return true if successfully set.
|
bool | SetAttribute (const String &name, const Variant &value) |
| Set attribute by name. Return true if successfully set.
|
void | AllocateNetworkState () |
| Allocate network attribute state.
|
void | WriteInitialDeltaUpdate (Serializer &dest) |
| Write initial delta network update.
|
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits) |
| Write a delta network update according to dirty attribute bits.
|
void | WriteLatestDataUpdate (Serializer &dest) |
| Write a latest data network update.
|
void | ReadDeltaUpdate (Deserializer &source) |
| Read and apply a network delta update.
|
void | ReadLatestDataUpdate (Deserializer &source) |
| Read and apply a network latest data update.
|
Variant | GetAttribute (unsigned index) |
| Return attribute value by index. Return empty if illegal index.
|
Variant | GetAttribute (const String &name) |
| Return attribute value by name. Return empty if not found.
|
unsigned | GetNumAttributes () const |
| Return number of attributes.
|
unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes.
|
const Vector< AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined.
|
const Vector< AttributeInfo > * | GetNetworkAttributes () const |
| Return network replication attribute descriptions, or null if none defined.
|
| 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 String & | GetTypeName () 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.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash 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.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| 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.
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|