#include <BlackboardComponent.h>

Inheritance diagram for xiiGlobalBlackboardComponent:

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
	xiiGlobalBlackboardComponent (xiiGlobalBlackboardComponent &&other)
xiiGlobalBlackboardComponent &	operator= (xiiGlobalBlackboardComponent &&other)
void	SetBlackboardName (const char *szName)
const char *	GetBlackboardName () const
Public Member Functions inherited from xiiBlackboardComponent
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.

Public Attributes
xiiEnum< xiiGlobalBlackboardInitMode >	m_InitMode

Protected Member Functions
virtual void	Initialize () override
virtual void	OnActivated () override
virtual void	OnDeactivated () override
virtual void	OnSimulationStarted () override
Protected Member Functions inherited from xiiBlackboardComponent
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	Deinitialize ()
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

Additional Inherited Members
Static Public Member Functions inherited from xiiBlackboardComponent
static xiiSharedPtr< xiiBlackboard >	FindBlackboard (xiiGameObject *pSearchObject, xiiStringView sBlackboardName=xiiStringView())
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Static Protected Member Functions inherited from xiiBlackboardComponent
static xiiBlackboard *	Reflection_FindBlackboard (xiiGameObject *pSearchObject, xiiStringView sBlackboardName)
Protected Attributes inherited from xiiBlackboardComponent
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.

Detailed Description

This component references a global blackboard by name. If necessary, the blackboard will be created.

This allows to initialize a global blackboard with known values.

Member Function Documentation

◆ DeserializeComponent()

void xiiGlobalBlackboardComponent::DeserializeComponent ( xiiWorldReader & ref_stream )

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 xiiBlackboardComponent.

◆ Initialize()

void xiiGlobalBlackboardComponent::Initialize ( )

overrideprotectedvirtual

Can be overridden for basic initialization that depends on a valid hierarchy and position.

All trivial initialization should be done in the constructor. For typical game code, you should prefer to use OnSimulationStarted(). This method is called once for every component, after creation but only at the start of the next world update. Therefore the global position has already been computed and the owner xiiGameObject is set. Contrary to OnActivated() and OnSimulationStarted(), this function is always called for all components.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from xiiComponent.

◆ OnActivated()

void xiiGlobalBlackboardComponent::OnActivated ( )

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.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from xiiBlackboardComponent.

◆ OnDeactivated()

void xiiGlobalBlackboardComponent::OnDeactivated ( )

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.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from xiiBlackboardComponent.

◆ OnSimulationStarted()

void xiiGlobalBlackboardComponent::OnSimulationStarted ( )

overrideprotectedvirtual

This method is called once for active components, at the start of the next world update, but only when the world is simulated.

This is the one preferred method to setup typical game logic. In a pure game environment there is no practical difference between OnActivated() and OnSimulationStarted(), as OnSimulationStarted() will be called right after OnActivated().

However, when a scene is open inside the editor, there is an important difference: OnActivated() is called once the component was created. OnSimulationStarted() is only called once the game simulation is started inside the editor. As an example, if a component starts a sound in OnActivated(), that sound will play right after the scene has been loaded into the editor. If instead the sound gets started in OnSimulationStarted(), it will only play once the user starts the game mode inside the editor.

Additionally, OnSimulationStarted() is only executed once, even if the xiiWorld pauses and resumes world simulation multiple times. However, note that it will be called again after the component has been deactivated and is activated again.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from xiiComponent.

◆ SerializeComponent()

void xiiGlobalBlackboardComponent::SerializeComponent ( xiiWorldWriter & ref_stream ) const

overridevirtual

Override this to save the current state of the component to the given stream.

Reimplemented from xiiBlackboardComponent.

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

/home/runner/work/XII/XII/Source/Engine/GameEngine/Components/GamePlay/BlackboardComponent.h
/home/runner/work/XII/XII/Source/Engine/GameEngine/Components/GamePlay/Implementation/BlackboardComponent.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeserializeComponent()

◆ Initialize()

◆ OnActivated()

◆ OnDeactivated()

◆ OnSimulationStarted()

◆ SerializeComponent()