Interface Transition

A transition between two states of an FSM.

interface Transition {
    destroy(): void;
    getFrom(): string;
    getFSM(): FSM | undefined;
    getName(): string | undefined;
    getTo(): string;
    id(): number;
    run(...eventArgs: unknown[]): void;
    setEvent(event: CJSEvent): void;
}

Index

Methods

destroy getFrom getFSM getName getTo id run setEvent

Methods

destroy

destroy(): void
Stops the transition from running and cleans up.

Returns void
- Defined in fsm.ts:88

getFrom

getFrom(): string
The name of the state this transition goes from

Returns string
- Defined in fsm.ts:53

getFSM

getFSM(): FSM | undefined
The FSM this transition belongs to (undefined once it's destroyed)

Returns FSM | undefined
- Defined in fsm.ts:67

getName

getName(): string | undefined
Returns string | undefined
- Defined in fsm.ts:62

getTo

getTo(): string
The name of the state this transition goes to

Returns string
- Defined in fsm.ts:58

id

id(): number
A unique id

Returns number
- Defined in fsm.ts:72

run

run(...eventArgs: unknown[]): void
Runs the transition, if its FSM is in the transition's from state. Arguments are passed to listeners.
Parameters
- ...eventArgs: unknown[]
Returns void
- Defined in fsm.ts:82

setEvent

setEvent(event: CJSEvent): void
The event (from cjs.on) that triggers this transition
Parameters
- event: CJSEvent
Returns void
- Defined in fsm.ts:77