Class default

Index

Constructors

Properties

_currentState lateUpdateEvent log name stateCount states updateEvent verboseLogs

Accessors

Methods

addState destroy enterState executeTransition exitState lateUpdate sendSignal update

Constructors

constructor

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

Properties

`Private`_currentState

_currentState: default = null

`Private`lateUpdateEvent

lateUpdateEvent: DispatchedUpdateEvent

`Private`log

`Private`name

name: string

`Private`stateCount

stateCount: number = 0

`Private`states

states: any = {}

`Private`updateEvent

updateEvent: DispatchedUpdateEvent

`Private`verboseLogs

verboseLogs: boolean = false

Accessors

currentState

get currentState(): default
Returns default

Methods

addState

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

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

`Private`executeTransition

executeTransition(transition: Transition): void
Parameters
- transition: Transition
Returns void

`Private`exitState

exitState(): void
Returns void

`Private`lateUpdate

lateUpdate(): void
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

`Private`update

update(): void
Returns void