Interface InputState

Defines a type of state that can receive input events.

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

Hierarchy

Implemented by

Properties

fsm name

Methods

acceptVisitor checkStartingState enter 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

enter

  • enter(): void

  • Actions done while entering this state.

    Returns void

    Throws

    CancelFSMException If entering the state leads to a cancelling of the FSM execution.

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