Class KmtIdleState

Hierarchy (View Summary)

TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- KmtIdleState

Index

Constructors

constructor

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

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        KmtInputEventMapping,
        KmtInputStates,
        KmtInputContext,
        Guard<KmtInputContext>,
    >,
> = {}

`Protected`_guards

_guards: Guard<KmtInputContext, "isIdle"> = { isIdle: () => true, }

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:135

eventReactions

get eventReactions(): Partial<
EventAction<KmtInputEventMapping, KmtInputContext, KmtInputStates>,
>
Returns Partial<EventAction<KmtInputEventMapping, KmtInputContext, KmtInputStates>>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/kmt-input-state-machine.ts:76

guards

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

Methods

handles

handles<K extends keyof KmtInputEventMapping>(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    event: K,
    payload: KmtInputEventMapping[K],
    context: KmtInputContext,
): KmtInputStates
Type Parameters
- K extends keyof KmtInputEventMapping
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- event: K
- payload: KmtInputEventMapping[K]
- context: KmtInputContext
Returns KmtInputStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:147

leftPointerMoveHandler

leftPointerMoveHandler(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
    payload: PointerEventPayload,
): KmtInputStates
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
- payload: PointerEventPayload
Returns KmtInputStates
- Defined in input-state-machine/kmt-input-state-machine.ts:87

middlePointerDownHandler

middlePointerDownHandler(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
    payload: PointerEventPayload,
): KmtInputStates
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
- payload: PointerEventPayload
Returns KmtInputStates
- Defined in input-state-machine/kmt-input-state-machine.ts:135

scrollHandler

scrollHandler(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
    payload: ScrollEventPayload,
): KmtInputStates
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
- payload: ScrollEventPayload
Returns KmtInputStates
- Defined in input-state-machine/kmt-input-state-machine.ts:112

scrollWithCtrlHandler

scrollWithCtrlHandler(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
    payload: ScrollWithCtrlEventPayload,
): KmtInputStates
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
- payload: ScrollWithCtrlEventPayload
Returns KmtInputStates
- Defined in input-state-machine/kmt-input-state-machine.ts:117

spacebarDownHandler

spacebarDownHandler(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
    payload: SpaceBarEventPayload,
): KmtInputStates
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
- payload: SpaceBarEventPayload
Returns KmtInputStates
- Defined in input-state-machine/kmt-input-state-machine.ts:130

uponEnter

uponEnter(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
): void
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:139

uponLeave

uponLeave(
    stateMachine: StateMachine<
        KmtInputEventMapping,
        KmtInputContext,
        KmtInputStates,
    >,
    context: KmtInputContext,
): void
Parameters
- stateMachine: StateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- context: KmtInputContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:143

Class KmtIdleState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns KmtIdleState

Properties

Protected_eventGuards

Protected_guards

Accessors

eventGuards

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

eventReactions

Returns Partial<EventAction<KmtInputEventMapping, KmtInputContext, KmtInputStates>>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns KmtInputStates

leftPointerMoveHandler

Parameters

Returns KmtInputStates

middlePointerDownHandler

Parameters

Returns KmtInputStates

scrollHandler

Parameters

Returns KmtInputStates

scrollWithCtrlHandler

Parameters

Returns KmtInputStates

spacebarDownHandler

Parameters

Returns KmtInputStates

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>,
>,
>