Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
plStateMachineState_SendMsg Class Reference

A state machine state that sends a plMsgStateMachineStateChanged on state enter or exit to the owner of the state machine instance. Currently only works for plStateMachineComponent. More...

#include <StateMachineComponent.h>

Inheritance diagram for plStateMachineState_SendMsg:
Inheritance graph
[legend]

Public Member Functions

 plStateMachineState_SendMsg (plStringView sName=plStringView())
 
virtual void OnEnter (plStateMachineInstance &ref_instance, void *pInstanceData, const plStateMachineState *pFromState) const override
 
virtual void OnExit (plStateMachineInstance &ref_instance, void *pInstanceData, const plStateMachineState *pToState) const override
 
virtual plResult Serialize (plStreamWriter &inout_stream) const override
 
virtual plResult Deserialize (plStreamReader &inout_stream) override
 
- Public Member Functions inherited from plStateMachineState
 plStateMachineState (plStringView sName=plStringView())
 
void SetName (plStringView sName)
 
plStringView GetName () const
 
const plHashedString & GetNameHashed () const
 
virtual void Update (plStateMachineInstance &ref_instance, void *pInstanceData, plTime deltaTime) const
 
virtual bool GetInstanceDataDesc (plInstanceDataDesc &out_desc)
 Returns whether this state needs additional instance data and if so fills the out_desc.
 
- 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.
 

Public Attributes

plTime m_MessageDelay
 
bool m_bSendMessageOnEnter = true
 
bool m_bSendMessageOnExit = false
 
bool m_bLogOnEnter = false
 
bool m_bLogOnExit = false
 

Additional Inherited Members

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

Detailed Description

A state machine state that sends a plMsgStateMachineStateChanged on state enter or exit to the owner of the state machine instance. Currently only works for plStateMachineComponent.

Optionally it can also log a message on state enter or exit.

Member Function Documentation

◆ Deserialize()

plResult plStateMachineState_SendMsg::Deserialize ( plStreamReader & inout_stream)
overridevirtual

Reimplemented from plStateMachineState.

◆ OnEnter()

void plStateMachineState_SendMsg::OnEnter ( plStateMachineInstance & ref_instance,
void * pInstanceData,
const plStateMachineState * pFromState ) const
overridevirtual

Implements plStateMachineState.

◆ OnExit()

void plStateMachineState_SendMsg::OnExit ( plStateMachineInstance & ref_instance,
void * pInstanceData,
const plStateMachineState * pToState ) const
overridevirtual

Reimplemented from plStateMachineState.

◆ Serialize()

plResult plStateMachineState_SendMsg::Serialize ( plStreamWriter & inout_stream) const
overridevirtual

Reimplemented from plStateMachineState.

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