Options
All
  • Public
  • Public/Protected
  • All
Menu

Definition of a state that is placed into an ActiveState once it becomes active. No variables within a StateDefinition should be changed after instantiation.

Hierarchy

  • StateDefinition

Index

Properties

description

description: string

A human-readable description of what this state represents.

Optional enterCommands

enterCommands: CommandOrEventInstance[]

Commands that will trigger the state as being active.

Optional enterEvents

enterEvents: CommandOrEventInstance[]

Events that will trigger the state as being active.

Optional exitCommands

exitCommands: CommandOrEventInstance[]

Commands that will make the state become inactive.

Optional exitEvents

Events that will make the state become inactive.

isModal

isModal: boolean

If a state is modal than it means that no other modal states can be running at the same time.

name

name: string

The name of the state. Used to reference it.

Optional parentState

parentState: string

The state that this state depends on. If the parent state is not active then this state is not active either. However, if the parent state is reactivated and this state was sitting dormant (active but w/ no parent) then this state will be considered active.