Class State

State machine state

System.Object
State
Namespace: FlaxEngine.Utilities
Assembly: FlaxEngine.CSharp.dll
Syntax
public abstract class State : Object

Constructors

State()

Declaration
protected State()

Properties

IsActive

Gets a value indicating whether this state is active.

Declaration
public bool IsActive { get; }
Property Value
System.Boolean

StateMachine

Gets the state machine.

Declaration
public StateMachine StateMachine { get; }
Property Value
StateMachine

Methods

CanEnter()

Checks if can enter to that state

Declaration
public virtual bool CanEnter()
Returns
System.Boolean

True if can enter to that state, otherwise false

CanExit(State)

Checks if can exit from that state

Declaration
public virtual bool CanExit(State nextState)
Parameters
State nextState

Next state to enter after exit from the current state
Returns
System.Boolean

True if can exit from that state, otherwise false

OnEnter()

Called when state is starting to be active.

Declaration
public virtual void OnEnter()

OnExit(State)

Called when state is ending to be active.

Declaration
public virtual void OnExit(State nextState)
Parameters
State nextState

The next state.

ToString()

Declaration
public override string ToString()
Returns
System.String

Extension Methods