Class StateMachine

Index

Constructors

Accessors

Methods

addState destroy enterState sendSignal

Constructors

constructor

new StateMachine(name: string): StateMachine
Parameters
- name: string
Returns StateMachine

Accessors

currentState

get currentState(): State
Returns State

Methods

addState

addState(config: StateConfig): State
Add a new state to the state machine.
Parameters
- config: StateConfig
  StateConfig. State names are Unique
Returns State

destroy

destroy(): void
Returns void

enterState

enterState(stateName: string, skipOnEnter?: boolean): void
Change states
Parameters
- stateName: string
  to enter
- skipOnEnter: boolean = false
  set to true in order to call enterState without calling that state's onEnter() function
Returns void

sendSignal

sendSignal(signal: string, data?: any): void
Send a signal to the statemachine to possibly change states
Parameters
- signal: string
  name of the signal
- data: any = null
  optional data
Returns void