 |
XII Release 0.1.0
|
|
XII Release 0.1.0
|
#include <BlackboardComponent.h>
Public Member Functions | |
| virtual void | SerializeComponent (xiiWorldWriter &inout_stream) const override |
| Override this to save the current state of the component to the given stream. | |
| virtual void | DeserializeComponent (xiiWorldReader &inout_stream) override |
| const xiiSharedPtr< xiiBlackboard > & | GetBoard () |
| Returns the blackboard owned by this component. | |
| xiiSharedPtr< const xiiBlackboard > | GetBoard () const |
| void | SetShowDebugInfo (bool bShow) |
| bool | GetShowDebugInfo () const |
| void | SetEntryValue (const char *szName, const xiiVariant &value) |
| xiiVariant | GetEntryValue (const char *szName) const |
| Public Member Functions inherited from xiiComponent | |
| void | SetActiveFlag (bool bEnabled) |
| bool | GetActiveFlag () const |
| bool | IsActive () const |
| bool | IsActiveAndInitialized () const |
| bool | IsActiveAndSimulating () const |
| xiiComponentManagerBase * | GetOwningManager () |
| Returns the corresponding manager for this component. | |
| const xiiComponentManagerBase * | GetOwningManager () const |
| Returns the corresponding manager for this component. | |
| xiiGameObject * | GetOwner () |
| Returns the owner game object if the component is attached to one or nullptr. | |
| const xiiGameObject * | GetOwner () const |
| Returns the owner game object if the component is attached to one or nullptr. | |
| xiiWorld * | GetWorld () |
| Returns the corresponding world for this component. | |
| const xiiWorld * | GetWorld () const |
| Returns the corresponding world for this component. | |
| xiiComponentHandle | GetHandle () const |
| Returns a handle to this component. | |
| xiiUInt32 | GetUniqueID () const |
| Returns the unique id for this component. | |
| void | SetUniqueID (xiiUInt32 uiUniqueID) |
| Sets the unique id for this component. | |
| void | EnsureInitialized () |
| Ensures that the component is initialized. Must only be called from another component's Initialize callback. | |
| void | EnsureSimulationStarted () |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) |
| Sends a message to this component. | |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) const |
| void | PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::NextFrame) const |
| Queues the message for the given phase. The message is processed after the given delay in the corresponding phase. | |
| virtual bool | HandlesMessage (const xiiMessage &msg) const |
| Returns whether the given Message is handled by this component. | |
| void | SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet) |
| Be careful to check which flags may already be in use by base classes. | |
| bool | GetUserFlag (xiiUInt8 uiFlagIndex) const |
| Retrieves a custom flag. Index must be between 0 and 7. | |
| void | SetCreatedByPrefab () |
| Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details. | |
| bool | WasCreatedByPrefab () const |
| Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component. | |
| void | DeleteComponent () |
| Deletes this component. Note that the component will be invalidated first and the actual deletion is postponed. | |
| Public Member Functions inherited from xiiReflectedClass | |
| virtual const xiiRTTI * | GetDynamicRTTI () const |
| bool | IsInstanceOf (const xiiRTTI *pType) const |
| Returns whether the type of this instance is of the given type or derived from it. | |
| template<typename T> | |
| XII_ALWAYS_INLINE bool | IsInstanceOf () const |
| Returns whether the type of this instance is of the given type or derived from it. | |
Static Public Member Functions | |
| static xiiSharedPtr< xiiBlackboard > | FindBlackboard (xiiGameObject *pSearchObject, xiiStringView sBlackboardName=xiiStringView()) |
| Static Public Member Functions inherited from xiiNoBase | |
| static const xiiRTTI * | GetStaticRTTI () |
Protected Member Functions | |
| virtual void | OnActivated () override |
| virtual void | OnDeactivated () override |
| void | OnUpdateLocalBounds (xiiMsgUpdateLocalBounds &msg) const |
| void | OnExtractRenderData (xiiMsgExtractRenderData &msg) const |
| Protected Member Functions inherited from xiiComponent | |
| xiiComponent () | |
| Keep the constructor private or protected in derived classes, so it cannot be called manually. | |
| bool | IsDynamic () const |
| Returns whether this component is dynamic and thus can only be attached to dynamic game objects. | |
| virtual xiiWorldModuleTypeId | GetTypeId () const =0 |
| virtual xiiComponentMode::Enum | GetMode () const =0 |
| virtual void | Initialize () |
| virtual void | Deinitialize () |
| virtual void | OnSimulationStarted () |
| void | EnableUnhandledMessageHandler (bool enable) |
| By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message. | |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) const |
| bool | IsInitialized () const |
| bool | IsInitializing () const |
| bool | IsSimulationStarted () const |
Static Protected Member Functions | |
| static xiiBlackboard * | Reflection_FindBlackboard (xiiGameObject *pSearchObject, xiiStringView sBlackboardName) |
Protected Attributes | |
| xiiSharedPtr< xiiBlackboard > | m_pBoard |
| xiiBlackboardTemplateResourceHandle | m_hTemplate |
| Protected Attributes inherited from xiiComponent | |
| const xiiRTTI * | m_pMessageDispatchType = nullptr |
| Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary. | |
This base component represents a xiiBlackboard, which can be used to share state between multiple components and objects.
The derived implementations may either create their own blackboards or reference other blackboards.
|
overridevirtual |
Override this to load the current state of the component from the given stream.
The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.
Reimplemented from xiiComponent.
Reimplemented in xiiGlobalBlackboardComponent, and xiiLocalBlackboardComponent.
|
static |
Try to find a xiiBlackboardComponent on pSearchObject or its parents with the given name and returns its blackboard.
The blackboard name is only checked if the given name is not empty. If no matching blackboard component is found, the function will call xiiBlackboard::GetOrCreateGlobal() with the given name. Thus if you provide a name, you will always get a result, either from a component or from the global storage.
|
overrideprotectedvirtual |
This method is called when the component gets activated.
By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.
Reimplemented from xiiComponent.
Reimplemented in xiiGlobalBlackboardComponent, and xiiLocalBlackboardComponent.
|
overrideprotectedvirtual |
This method is called when the component gets deactivated.
Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.
Reimplemented from xiiComponent.
Reimplemented in xiiGlobalBlackboardComponent, and xiiLocalBlackboardComponent.
|
overridevirtual |
Override this to save the current state of the component to the given stream.
Reimplemented from xiiComponent.
Reimplemented in xiiGlobalBlackboardComponent, and xiiLocalBlackboardComponent.
1.15.0