Class MenuNavController

Listen to active menu navigation bindings on a VirLine instance and perform them within the given element.

Hierarchy

NavController
- MenuNavController

Index

Constructors

constructor

new MenuNavController(
    host: HTMLElement,
    virLine: VirLineWithState<
        PartialWithUndefined<
            { playersActiveBindings: PlayersActiveBindingsMap<MenuNavBinding> },
        >,
    >,
    options?: MenuNavOptions,
): MenuNavController
Parameters
- host: HTMLElement
- virLine: VirLineWithState<
      PartialWithUndefined<
          { playersActiveBindings: PlayersActiveBindingsMap<MenuNavBinding> },
      >,
  >
- options: MenuNavOptions = {}
Returns MenuNavController
Overrides NavController.constructor
- Defined in packages/handle-input/src/elements/menu-nav.ts:92

Properties

options

options: Required<MenuNavOptions> = ...

The current options assigned to this MenuNavController instance. Override the defaults in the constructor, or mutate it at any time to affect all subsequent menu navigation.

Methods

destroy

destroy(): void
Destroy all listeners to free up memory.

Returns void
Overrides NavController.destroy
- Defined in packages/handle-input/src/elements/menu-nav.ts:130

pause

pause(): void
Stop reacting to user inputs.

Returns void
- Defined in packages/handle-input/src/elements/menu-nav.ts:120

resume

resume(): void
Resume reacting to user inputs.

Returns void
- Defined in packages/handle-input/src/elements/menu-nav.ts:125

Class MenuNavController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MenuNavController

Properties

options

Methods

destroy

Returns void

pause

Returns void

resume

Returns void

Settings

On This Page