ezEngine Release 25.08
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ezStateMachineState_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 ezStateMachineState_Script:
Inheritance graph
[legend]

Public Member Functions

 ezStateMachineState_Script (ezStringView sName=ezStringView())
 
virtual void OnEnter (ezStateMachineInstance &ref_instance, void *pInstanceData, const ezStateMachineState *pFromState) const override
 
virtual void OnExit (ezStateMachineInstance &ref_instance, void *pInstanceData, const ezStateMachineState *pToState) const override
 
virtual void Update (ezStateMachineInstance &ref_instance, void *pInstanceData, ezTime deltaTime) const override
 
virtual ezResult Serialize (ezStreamWriter &inout_stream) const override
 
virtual ezResult Deserialize (ezStreamReader &inout_stream) override
 
virtual bool GetInstanceDataDesc (ezInstanceDataDesc &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 ezRangeView< const char *, ezUInt32 > GetParameters () const
 
void SetParameter (const char *szKey, const ezVariant &value)
 
void RemoveParameter (const char *szKey)
 
bool GetParameter (const char *szKey, ezVariant &out_value) const
 
- Public Member Functions inherited from ezStateMachineState
 ezStateMachineState (ezStringView sName=ezStringView())
 
void SetName (ezStringView sName)
 
ezStringView GetName () const
 
const ezHashedString & GetNameHashed () const
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI * GetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_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 ezNoBase
static const ezRTTI * GetStaticRTTI ()
 

Detailed Description

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

Member Function Documentation

◆ Deserialize()

ezResult ezStateMachineState_Script::Deserialize ( ezStreamReader &  inout_stream)
overridevirtual

Reimplemented from ezStateMachineState.

◆ GetInstanceDataDesc()

bool ezStateMachineState_Script::GetInstanceDataDesc ( ezInstanceDataDesc &  out_desc)
overridevirtual

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

See also
ezStateMachineInstanceDataDesc

Reimplemented from ezStateMachineState.

◆ OnEnter()

void ezStateMachineState_Script::OnEnter ( ezStateMachineInstance &  ref_instance,
void *  pInstanceData,
const ezStateMachineState *  pFromState 
) const
overridevirtual

Implements ezStateMachineState.

◆ OnExit()

void ezStateMachineState_Script::OnExit ( ezStateMachineInstance &  ref_instance,
void *  pInstanceData,
const ezStateMachineState *  pToState 
) const
overridevirtual

Reimplemented from ezStateMachineState.

◆ Serialize()

ezResult ezStateMachineState_Script::Serialize ( ezStreamWriter &  inout_stream) const
overridevirtual

Reimplemented from ezStateMachineState.

◆ Update()

void ezStateMachineState_Script::Update ( ezStateMachineInstance &  ref_instance,
void *  pInstanceData,
ezTime  deltaTime 
) const
overridevirtual

Reimplemented from ezStateMachineState.

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