Class BoardIdleState

Hierarchy (View Summary)

TemplateState<BoardEventMapping, BoardContext, BoardStates>
- BoardIdleState

Index

Constructors

constructor

new BoardIdleState(world?: World): BoardIdleState
Parameters
- world: World = ...
Returns BoardIdleState
Overrides TemplateState.constructor
- Defined in input-state-machine/input-state-machine.ts:74

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        BoardEventMapping,
        BoardStates,
        BoardContext,
        Guard<BoardContext>,
    >,
> = {}

`Protected`_guards

_guards: Guard<BoardContext, "isIdle"> = ...

Accessors

eventGuards

get eventGuards(): Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Returns Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Inherited from TemplateState.eventGuards
- Defined in being/interfaces.ts:115

eventReactions

get eventReactions(): Partial<
EventAction<BoardEventMapping, BoardContext, BoardStates>,
>
Returns Partial<EventAction<BoardEventMapping, BoardContext, BoardStates>>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/input-state-machine.ts:87

guards

get guards(): Guard<Context>
Returns Guard<Context>
Inherited from TemplateState.guards
- Defined in being/interfaces.ts:111

Methods

handles

handles<K extends keyof BoardEventMapping>(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    event: K,
    payload: BoardEventMapping[K],
    context: BoardContext,
): BoardStates
Type Parameters
- K extends keyof BoardEventMapping
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- event: K
- payload: BoardEventMapping[K]
- context: BoardContext
Returns BoardStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:127

leftPointerDownHandler

leftPointerDownHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: PointerEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: PointerEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:91

leftPointerMoveHandler

leftPointerMoveHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: PointerEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: PointerEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:98

middlePointerDownHandler

middlePointerDownHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: PointerEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: PointerEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:146

scrollHandler

scrollHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: ScrollEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: ScrollEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:123

scrollWithCtrlHandler

scrollWithCtrlHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: ScrollWithCtrlEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: ScrollWithCtrlEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:128

spacebarDownHandler

spacebarDownHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: SpaceBarEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: SpaceBarEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:141

uponEnter

uponEnter(
stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
context: BoardContext,
): void
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:119

uponLeave

uponLeave(
stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
context: BoardContext,
): void
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:123

Class BoardIdleState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BoardIdleState

Properties

Protected_eventGuards

Protected_guards

Accessors

eventGuards

Returns Partial< EventGuards< EventPayloadMapping, States, Context, Guard<Context, string>, >,>

eventReactions

Returns Partial<EventAction<BoardEventMapping, BoardContext, BoardStates>>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns BoardStates

leftPointerDownHandler

Parameters

Returns BoardStates

leftPointerMoveHandler

Parameters

Returns BoardStates

middlePointerDownHandler

Parameters

Returns BoardStates

scrollHandler

Parameters

Returns BoardStates

scrollWithCtrlHandler

Parameters

Returns BoardStates

spacebarDownHandler

Parameters

Returns BoardStates

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

Settings

On This Page

`Protected`_eventGuards

`Protected`_guards

Returns Partial<
EventGuards<
EventPayloadMapping,
States,
Context,
Guard<Context, string>,
>,
>