Rebel Fork Framework
|
Helper base class for user-defined game logic components that hooks up to update events and forwards them to virtual functions similar to ScriptInstance class. More...
#include <Urho3D/Scene/LogicComponent.h>
Public Member Functions | |
LogicComponent (Context *context) | |
Construct. | |
~LogicComponent () override | |
Destruct. | |
void | OnSetEnabled () override |
Handle enabled/disabled state change. Changes update event subscription. | |
virtual void | Start () |
Called when the component is added to a scene node. Other components may not yet exist. | |
virtual void | DelayedStart () |
Called before the first update. At this point all other components of the node should exist. Will also be called if update events are not wanted; in that case the event is immediately unsubscribed afterward. | |
virtual void | Stop () |
Called when the component is detached from a scene node, usually on destruction. Note that you will no longer have access to the node and scene at that point. | |
virtual void | Update (float timeStep) |
Called on scene update, variable timestep. | |
virtual void | PostUpdate (float timeStep) |
Called on scene post-update, variable timestep. | |
virtual void | FixedUpdate (float timeStep) |
Called on physics update, fixed timestep. | |
virtual void | FixedPostUpdate (float timeStep) |
Called on physics post-update, fixed timestep. | |
virtual StringHash | GetUpdateEvent () const |
virtual StringHash | GetPostUpdateEvent () const |
Return post update event type. Should stay the same for any given instance of the component. | |
void | SetUpdateEventMask (UpdateEventFlags mask) |
Set what update events should be subscribed to. Use this for optimization: by default all are in use. Note that this is not an attribute and is not saved or network-serialized, therefore it should always be called eg. in the subclass constructor. | |
UpdateEventFlags | GetUpdateEventMask () const |
Return what update events are subscribed to. | |
bool | IsDelayedStartCalled () const |
Return whether the DelayedStart() function has been called. | |
![]() | |
Component (Context *context) | |
Construct. | |
~Component () override | |
Destruct. | |
AttributeScopeHint | GetEffectiveScopeHint () const |
bool | Save (Serializer &dest) const override |
Save as binary data. Return true if successful. | |
bool | SaveXML (XMLElement &dest) const override |
Save as XML data. Return true if successful. | |
bool | SaveJSON (JSONValue &dest) const override |
Save as JSON data. Return true if successful. | |
virtual void | GetDependencyNodes (ea::vector< Node * > &dest) |
Return the depended on nodes to order network updates. | |
virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
Visualize the component as debug geometry. | |
virtual bool | HasAuxiliaryData () const |
virtual void | SerializeAuxiliaryData (Archive &archive) |
Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException. | |
void | SetEnabled (bool enable) |
void | Remove () |
Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. | |
unsigned | GetID () const |
Node * | GetNode () const |
Scene * | GetScene () const |
Return the scene the node belongs to. | |
bool | IsEnabled () const |
bool | IsEnabledEffective () const |
ea::string | GetFullNameDebug () const |
Return full component name for debugging. Unique for each component in the scene. Slow! | |
Component * | GetComponent (StringHash 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. | |
unsigned | GetIndexInParent () const |
Return index of this component in the node. | |
![]() | |
Serializable (Context *context) | |
Construct. | |
~Serializable () override | |
Destruct. | |
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor. | |
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) const |
Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor. | |
virtual ObjectReflection * | GetReflection () const |
Return reflection used for serialization. | |
virtual const ea::vector< AttributeInfo > * | GetAttributes () const |
Return attribute descriptions, or null if none defined. | |
void | SerializeInBlock (Archive &archive) override |
Serialize content from/to archive. May throw ArchiveException. | |
void | SerializeInBlock (Archive &archive, bool serializeTemporary) |
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. | |
virtual bool | LoadJSON (const JSONValue &source) |
Load from JSON data. Return true if successful. | |
virtual bool | Load (const ea::string &resourceName) |
Load from binary resource. | |
virtual bool | LoadXML (const ea::string &resourceName) |
Load from XML resource. | |
virtual bool | LoadJSON (const ea::string &resourceName) |
Load from JSON resource. | |
virtual bool | LoadFile (const ea::string &resourceName) |
Load from resource of automatically detected type. | |
virtual void | ApplyAttributes () |
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. | |
virtual bool | SaveDefaultAttributes (const AttributeInfo &attr) const |
Return whether should save default-valued attributes into XML. Default false. | |
bool | SetAttribute (unsigned index, const Variant &value) |
bool | SetAttribute (const ea::string &name, const Variant &value) |
Set attribute by name. Return true if successfully set. | |
void | SetInstanceDefault (bool enable) |
(Internal use) Set instance-level default flag. | |
void | SetInstanceDefault (const ea::string &name, const Variant &defaultValue) |
(Internal use) Set instance-level default value. Allocate the internal data structure as necessary. | |
virtual Variant | GetInstanceDefault (const ea::string &name) const |
(Internal use) Get instance-level default value. | |
void | ResetToDefault () |
Reset all editable attributes to their default values. | |
void | RemoveInstanceDefault () |
Remove instance's default values if they are set previously. | |
void | SetTemporary (bool enable) |
Variant | GetAttribute (unsigned index) const |
Variant | GetAttribute (const ea::string &name) const |
Return attribute value by name. Return empty if not found. | |
Variant | GetAttributeDefault (unsigned index) const |
Variant | GetAttributeDefault (const ea::string &name) const |
Return attribute default value by name. Return empty if not found. | |
unsigned | GetNumAttributes () const |
void | CopyAttributes (const Serializable *source, bool resetToDefault=true) |
Copy all attributes from another serializable. | |
SharedPtr< Serializable > | Clone (bool resetToDefault=true) const |
Clone this serializable. | |
bool | IsTemporary () const |
![]() | |
Object (Context *context) | |
Construct. | |
~Object () override | |
Destruct. Clean up self from event sender & receiver structures. | |
virtual StringHash | GetType () const =0 |
virtual const ea::string & | GetTypeName () const =0 |
virtual const TypeInfo * | GetTypeInfo () const =0 |
Return type info. | |
virtual bool | IsInstanceOf (StringHash type) const =0 |
Check whether current instance implements specified type. | |
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
Handle event. | |
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 | SubscribeToEventManual (StringHash eventType, EventHandler *handler) |
Subscribe to an event that can be sent by any sender. | |
void | SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler) |
Subscribe to a specific sender's event. | |
template<class T > | |
void | SubscribeToEvent (StringHash eventType, T handler) |
Subscribe to an event that can be sent by any sender. | |
template<class T > | |
void | SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions) |
Unsubscribe from all events except those listed. | |
void | UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions) |
Unsubscribe from all events except those with listed senders. | |
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, const Args &... args) |
Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs. | |
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 ea::string & | GetCategory () const |
void | SendEvent (StringHash eventType, const VariantMap &eventData) |
Send event with parameters to all subscribers. | |
void | SetBlockEvents (bool block) |
Block object from sending and receiving events. | |
bool | GetBlockEvents () const |
Return sending and receiving events blocking status. | |
![]() | |
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. | |
int | AddRef () |
int | ReleaseRef () |
int | Refs () const |
int | WeakRefs () const |
RefCount * | RefCountPtr () const |
Return pointer to the reference count structure. | |
bool | HasScriptObject () const |
Return true if script runtime object wrapping this native object exists. | |
bool | IsScriptStrongRef () const |
Return true if script reference is strong. | |
Protected Member Functions | |
void | OnNodeSet (Node *previousNode, Node *currentNode) override |
Handle scene node being assigned at creation. | |
void | OnSceneSet (Scene *previousScene, Scene *scene) override |
Handle scene being assigned. | |
![]() | |
virtual void | OnMarkedDirty (Node *node) |
Handle scene node transform dirtied. | |
virtual void | OnNodeSetEnabled (Node *node) |
Handle scene node enabled status changing. | |
void | SetID (unsigned id) |
void | SetNode (Node *node) |
Set scene node. Called by Node when creating the component. | |
Component * | GetFixedUpdateSource () |
Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists. | |
void | DoAutoRemove (AutoRemoveMode mode) |
Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case. | |
Private Member Functions | |
URHO3D_OBJECT (LogicComponent, Component) | |
void | UpdateEventSubscription () |
Subscribe/unsubscribe to update events based on current enabled state and update event mask. | |
void | HandleSceneUpdate (StringHash eventType, VariantMap &eventData) |
Handle scene update event. | |
void | HandleScenePostUpdate (StringHash eventType, VariantMap &eventData) |
Handle scene post-update event. | |
Additional Inherited Members | |
![]() | |
static const TypeInfo * | GetTypeInfoStatic () |
Return type info static. | |
![]() | |
static constexpr ea::array< StringHash, 0 > | TypeHierarchy {} |
![]() | |
Node * | node_ |
Scene node. | |
unsigned | id_ |
Unique ID within the scene. | |
bool | networkUpdate_ |
Network update queued flag. | |
bool | enabled_ |
Enabled flag. | |
![]() | |
ea::unique_ptr< VariantMap > | instanceDefaultValues_ |
Attribute default value at each instance level. | |
bool | setInstanceDefault_ |
When true, store the attribute value as instance's default value (internal use only). | |
bool | temporary_ |
Temporary flag. | |
![]() | |
WeakPtr< Context > | context_ |
Execution context. | |
Helper base class for user-defined game logic components that hooks up to update events and forwards them to virtual functions similar to ScriptInstance class.
|
inlinevirtual |
Called before the first update. At this point all other components of the node should exist. Will also be called if update events are not wanted; in that case the event is immediately unsubscribed afterward.
Reimplemented in Urho3D::TextRenderer3D.
|
virtual |
Called on physics post-update, fixed timestep.
Reimplemented in Urho3D::RaycastVehicle.
|
virtual |
Called on physics update, fixed timestep.
Reimplemented in Urho3D::RaycastVehicle.
|
virtual |
Return post update event type. Should stay the same for any given instance of the component.
Reimplemented in Urho3D::IKSolver.
|
virtual |
Return update event type. Should stay the same for any given instance of the component. DelayedStart is invoked before the first update event of this type.
|
overrideprotectedvirtual |
Handle scene node being assigned at creation.
Reimplemented from Urho3D::Component.
Reimplemented in Urho3D::RaycastVehicle, Urho3D::RmlCanvasComponent, Urho3D::RmlUIComponent, and Urho3D::VRRig.
|
overrideprotectedvirtual |
Handle scene being assigned.
Reimplemented from Urho3D::Component.
|
overridevirtual |
Handle enabled/disabled state change. Changes update event subscription.
Reimplemented from Urho3D::Component.
Reimplemented in Urho3D::RaycastVehicle, Urho3D::RmlCanvasComponent, and Urho3D::RmlUIComponent.
|
virtual |
Called on scene post-update, variable timestep.
Reimplemented in Urho3D::IKSolver, Urho3D::RaycastVehicle, and Urho3D::TextRenderer3D.
|
virtual |
Called on scene update, variable timestep.
Reimplemented in Urho3D::RmlSerializableInspector, Urho3D::RmlUIComponent, and Urho3D::ShakeComponent.