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

A state machine state implementation that can be scripted using e.g. visual scripting. More...

#include <StateMachineState_Script.h>

Inheritance diagram for xiiStateMachineState_Script:
[legend]

Public Member Functions

 xiiStateMachineState_Script (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 void Update (xiiStateMachineInstance &ref_instance, void *pInstanceData, xiiTime deltaTime) const override
 
virtual xiiResult Serialize (xiiStreamWriter &inout_stream) const override
 
virtual xiiResult Deserialize (xiiStreamReader &inout_stream) override
 
virtual bool GetInstanceDataDesc (xiiInstanceDataDesc &out_desc) override
 Returns whether this state needs additional instance data and if so fills the out_desc.
 
void SetScriptClassFile (const char *szFile)
 
const char * GetScriptClassFile () const
 
const xiiRangeView< xiiStringView, xiiUInt32 > GetParameters () const
 
void SetParameter (xiiStringView sKey, const xiiVariant &value)
 
void RemoveParameter (xiiStringView sKey)
 
bool GetParameter (xiiStringView sKey, xiiVariant &out_value) const
 
- Public Member Functions inherited from xiiStateMachineState
 xiiStateMachineState (xiiStringView sName=xiiStringView())
 
void SetName (xiiStringView sName)
 
xiiStringView GetName () const
 
const xiiHashedString & GetNameHashed () const
 
- 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
 

Detailed Description

A state machine state implementation that can be scripted using e.g. visual scripting.

Member Function Documentation

◆ Deserialize()

xiiResult xiiStateMachineState_Script::Deserialize ( xiiStreamReader & inout_stream)
overridevirtual

Reimplemented from xiiStateMachineState.

◆ GetInstanceDataDesc()

bool xiiStateMachineState_Script::GetInstanceDataDesc ( xiiInstanceDataDesc & out_desc)
overridevirtual

Returns whether this state needs additional instance data and if so fills the out_desc.

See also
xiiStateMachineInstanceDataDesc

Reimplemented from xiiStateMachineState.

◆ OnEnter()

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

Implements xiiStateMachineState.

◆ OnExit()

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

Reimplemented from xiiStateMachineState.

◆ Serialize()

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

Reimplemented from xiiStateMachineState.

◆ Update()

void xiiStateMachineState_Script::Update ( xiiStateMachineInstance & ref_instance,
void * pInstanceData,
xiiTime deltaTime ) const
overridevirtual

Reimplemented from xiiStateMachineState.

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