XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
xiiStateMachineState_SendMsg Class Reference

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

#include <StateMachineComponent.h>

Inheritance diagram for xiiStateMachineState_SendMsg:
[legend]

Public Member Functions

 xiiStateMachineState_SendMsg (xiiStringView sName=xiiStringView())
 
virtual void OnEnter (xiiStateMachineInstance &ref_instance, void *pInstanceData, const xiiStateMachineState *pFromState) const override
 
virtual void OnExit (xiiStateMachineInstance &ref_instance, void *pInstanceData, const xiiStateMachineState *pToState) const override
 
virtual xiiResult Serialize (xiiStreamWriter &inout_stream) const override
 
virtual xiiResult Deserialize (xiiStreamReader &inout_stream) override
 
- Public Member Functions inherited from xiiStateMachineState
 xiiStateMachineState (xiiStringView sName=xiiStringView())
 
void SetName (xiiStringView sName)
 
xiiStringView GetName () const
 
const xiiHashedString & GetNameHashed () const
 
virtual void Update (xiiStateMachineInstance &ref_instance, void *pInstanceData, xiiTime deltaTime) const
 
virtual bool GetInstanceDataDesc (xiiInstanceDataDesc &out_desc)
 Returns whether this state needs additional instance data and if so fills the out_desc.
 
- 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

xiiTime 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 xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
 

Detailed Description

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

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

Member Function Documentation

◆ Deserialize()

xiiResult xiiStateMachineState_SendMsg::Deserialize ( xiiStreamReader & inout_stream)
overridevirtual

Reimplemented from xiiStateMachineState.

◆ OnEnter()

void xiiStateMachineState_SendMsg::OnEnter ( xiiStateMachineInstance & ref_instance,
void * pInstanceData,
const xiiStateMachineState * pFromState ) const
overridevirtual

Implements xiiStateMachineState.

◆ OnExit()

void xiiStateMachineState_SendMsg::OnExit ( xiiStateMachineInstance & ref_instance,
void * pInstanceData,
const xiiStateMachineState * pToState ) const
overridevirtual

Reimplemented from xiiStateMachineState.

◆ Serialize()

xiiResult xiiStateMachineState_SendMsg::Serialize ( xiiStreamWriter & inout_stream) const
overridevirtual

Reimplemented from xiiStateMachineState.

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