ezEngine  Release 25.03
Classes | Public Member Functions | Friends | List of all members
ezStateMachineDescription Class Reference

The state machine description defines the structure of a state machine like e.g. what states it has and how to transition between them. Once an instance is created from a description it is not allowed to change the description afterwards. More...

#include <StateMachine.h>

Inheritance diagram for ezStateMachineDescription:
Inheritance graph
[legend]

Public Member Functions

ezUInt32 AddState (ezUniquePtr< ezStateMachineState > &&pState)
 Adds the given state to the description and returns the state index.
 
void AddTransition (ezUInt32 uiFromStateIndex, ezUInt32 uiToStateIndex, ezUniquePtr< ezStateMachineTransition > &&pTransistion)
 Adds the given transition between the two given states. A uiFromStateIndex of ezInvalidIndex generates a transition that can be done from any other possible state.
 
ezResult Serialize (ezStreamWriter &inout_stream) const
 
ezResult Deserialize (ezStreamReader &inout_stream)
 
- Public Member Functions inherited from ezRefCounted
virtual ~ezRefCounted ()=default
 Adds a virtual destructor.
 
- Public Member Functions inherited from ezRefCountingImpl
 ezRefCountingImpl ()=default
 Constructor.
 
 ezRefCountingImpl (const ezRefCountingImpl &rhs)
 
void operator= (const ezRefCountingImpl &rhs)
 
ezInt32 AddRef () const
 Increments the reference counter. Returns the new reference count.
 
ezInt32 ReleaseRef () const
 Decrements the reference counter. Returns the new reference count.
 
bool IsReferenced () const
 Returns true if the reference count is greater than 0, false otherwise.
 
ezInt32 GetRefCount () const
 Returns the current reference count.
 

Friends

class ezStateMachineInstance
 

Detailed Description

The state machine description defines the structure of a state machine like e.g. what states it has and how to transition between them. Once an instance is created from a description it is not allowed to change the description afterwards.

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