Open 3D Engine ScriptCanvas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
ScriptCanvasEditor::State< Traits > Class Template Reference

Base class for all states in the system, users must provide a state ID through StateTraits. More...

#include <GraphUpgrade.h>

Inherits ScriptCanvasEditor::IState.

Public Member Functions

 State (StateMachine *stateMachine)
 
template<typename T >
T * GetStateMachine ()
 
StateMachine * GetStateMachine () override
 
int GetStateId () const override
 
void Enter () override
 
ExitStatus Exit () override
 
void Log (const char *format,...)
 

Static Public Member Functions

static int StateID ()
 

Additional Inherited Members

- Public Types inherited from ScriptCanvasEditor::IState
enum class  ExitStatus { Default , Skipped , Upgraded }
 
- Static Public Attributes inherited from ScriptCanvasEditor::IState
static constexpr int EXIT_STATE_ID = (-1)
 
- Protected Member Functions inherited from ScriptCanvasEditor::IState
virtual int GetStateId () const =0
 
virtual void Enter ()
 
virtual ExitStatus Exit ()
 
virtual void OnEnter ()
 
virtual void Run ()
 
virtual ExitStatus OnExit ()
 
virtual StateMachine * GetStateMachine ()
 
virtual int EvaluateTransition ()
 
virtual const char * GetName () const
 

Detailed Description

template<typename Traits>
class ScriptCanvasEditor::State< Traits >

Base class for all states in the system, users must provide a state ID through StateTraits.

Member Function Documentation

◆ Enter()

template<typename Traits >
void ScriptCanvasEditor::State< Traits >::Enter ( )
inlineoverridevirtual

Reimplemented from ScriptCanvasEditor::IState.

◆ Exit()

template<typename Traits >
ExitStatus ScriptCanvasEditor::State< Traits >::Exit ( )
inlineoverridevirtual

Reimplemented from ScriptCanvasEditor::IState.

◆ GetStateId()

template<typename Traits >
int ScriptCanvasEditor::State< Traits >::GetStateId ( ) const
inlineoverridevirtual

Implements ScriptCanvasEditor::IState.

◆ GetStateMachine() [1/2]

template<typename Traits >
template<typename T >
T * ScriptCanvasEditor::State< Traits >::GetStateMachine ( )
inlinevirtual

Reimplemented from ScriptCanvasEditor::IState.

◆ GetStateMachine() [2/2]

template<typename Traits >
StateMachine * ScriptCanvasEditor::State< Traits >::GetStateMachine ( )
inlineoverridevirtual

Reimplemented from ScriptCanvasEditor::IState.

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