This event handler component forwards any message that it receives to the active plGameStateBase. More...

#include <ForwardEventsToGameStateComponent.h>

Inheritance diagram for plForwardEventsToGameStateComponent:

[legend]

Protected Member Functions
virtual bool	HandlesMessage (const plMessage &msg) const override
	Returns whether the given Message is handled by this component.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) override
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) const override
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual void	Initialize () override
	Can be overridden for basic initialization that depends on a valid hierarchy and position.

Protected Member Functions inherited from plEventMessageHandlerComponent
virtual void	Deinitialize () override
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

Protected Member Functions inherited from plComponent
	plComponent ()
	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 plWorldModuleTypeId	GetTypeId () const =0

virtual plComponentMode::Enum	GetMode () const =0

virtual void	OnActivated ()
	This method is called when the component gets activated.

virtual void	OnDeactivated ()
	This method is called when the component gets deactivated.

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

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Additional Inherited Members
Public Member Functions inherited from plEventMessageHandlerComponent
virtual void	SerializeComponent (plWorldWriter &inout_stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (plWorldReader &inout_stream) override
	Override this to load the current state of the component from the given stream.

	plEventMessageHandlerComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.

void	SetDebugOutput (bool bEnable)
	Sets the debug output object flag. The effect is type specific, most components will not do anything different.

bool	GetDebugOutput () const
	Gets the debug output object flag.

void	SetGlobalEventHandlerMode (bool bEnable)
	Registers or de-registers this component as a global event handler.

bool	GetGlobalEventHandlerMode () const
	Returns whether this component is registered as a global event handler.

void	SetPassThroughUnhandledEvents (bool bPassThrough)
	Sets whether unhandled event messages should be passed to parent objects or not.

bool	GetPassThroughUnhandledEvents () const

Public Member Functions inherited from plComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state.

bool	GetActiveFlag () const
	Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.

bool	IsActive () const
	Checks whether this component is in an active state.

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized.

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well.

plComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const plComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

plGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const plGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

plWorld *	GetWorld ()
	Returns the corresponding world for this component.

const plWorld *	GetWorld () const
	Returns the corresponding world for this component.

plComponentHandle	GetHandle () const
	Returns a handle to this component.

plUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (plUInt32 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 ()
	Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg)
	Sends a message to this component.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg) const

void	PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.

void	SetUserFlag (plUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (plUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds plObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the plObjectFlags::CreatedByPrefab flag is set on this component.

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
PL_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 inherited from plEventMessageHandlerComponent
static plArrayPtr< plComponentHandle >	GetAllGlobalEventHandler (const plWorld *pWorld)
	Returns all global event handler for the given world.

static void	ClearGlobalEventHandlersForWorld (const plWorld *pWorld)

Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Protected Attributes inherited from plComponent
const plRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Detailed Description

This event handler component forwards any message that it receives to the active plGameStateBase.

Game states can have message handlers just like any other reflected type. However, since they are not part of the plWorld, messages are not delivered to them. By attaching this component to a game object, all event messages that arrive at that node are forwarded to the active game state. This way, a game state can receive information, such as when a trigger gets activated.

Multiple of these components can exist in a scene, gathering and forwarding messages from many different game objects, so that the game state can react to many different things.

Member Function Documentation

◆ HandlesMessage()

bool plForwardEventsToGameStateComponent::HandlesMessage ( const plMessage & msg ) const

overrideprotectedvirtual

Returns whether the given Message is handled by this component.

Reimplemented from plComponent.

◆ Initialize()

void plForwardEventsToGameStateComponent::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 plGameObject is set. Contrary to OnActivated() and OnSimulationStarted(), this function is always called for all components.

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

Reimplemented from plComponent.

◆ OnUnhandledMessage() [1/2]

bool plForwardEventsToGameStateComponent::OnUnhandledMessage	(	plMessage &	msg,
		bool	bWasPostedMsg ) const

overrideprotectedvirtual

When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

Returns: Should return true if the given message was handled, false otherwise.

Reimplemented from plComponent.

◆ OnUnhandledMessage() [2/2]

bool plForwardEventsToGameStateComponent::OnUnhandledMessage	(	plMessage &	msg,
		bool	bWasPostedMsg )

overrideprotectedvirtual

When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

Returns: Should return true if the given message was handled, false otherwise.

Reimplemented from plComponent.

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

Code/Engine/Core/GameState/ForwardEventsToGameStateComponent.h
Code/Engine/Core/GameState/Implementation/ForwardEventsToGameStateComponent.cpp

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ HandlesMessage()

◆ Initialize()

◆ OnUnhandledMessage() [1/2]

◆ OnUnhandledMessage() [2/2]