Interface State

The base type of an FSM state.

interface State {
    fsm: FSM;
    name: string;
    acceptVisitor(visitor): void;
    checkStartingState(): void;
    uninstall(): void;
}

Hierarchy

Implemented by

Properties

fsm name

Methods

acceptVisitor checkStartingState uninstall

Properties

Readonly fsm

fsm: FSM

The FSM that contains the state.

Readonly name

name: string

The name of the state.

Methods

acceptVisitor

checkStartingState

  • checkStartingState(): void

  • Checks whether the starting state of the fsm is this state. In this case, the fsm is notified about the starting of the FSM.

    Returns void

    Throws

    CancelFSMException

uninstall

  • uninstall(): void

  • Uninstall (ie flushes) the state. Useful to clear data. The state must not be used after that.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc