Class Keyboards

Hierarchy

  • BaseKeyBoard
    • Keyboards

Constructors

constructor

Properties

topics

Accessors

movePlayer

Methods

destroy disable dispose enable init off on once

Constructors

constructor

  • new Keyboards(world): Keyboards

  • Parameters

    Returns Keyboards

Properties

topics

topics: Record<keyof IKeyboardEvent, ITopic<any>[]> = ...

Accessors

movePlayer

  • get movePlayer(): boolean

  • Returns boolean

  • set movePlayer(value): void

  • Parameters

    • value: boolean

    Returns void

Methods

destroy

  • destroy(): void

  • Returns void

disable

  • disable(): void

  • Returns void

dispose

  • dispose(): void

  • 移除所有的监听事件

    Returns void

enable

  • enable(): void

  • Returns void

init

  • init(options?): void

  • Parameters

    • Optional options: IKeyBoardOptions

    Returns void

off

  • off<K>(topic, listener?): void

  • 移除监听事件

    Type Parameters

    • K extends keyof IKeyboardEvent

    Parameters

    • topic: K
    • Optional listener: IListener<IKeyboardEvent[K]>

    Returns void

on

  • on<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器

    Type Parameters

    • K extends keyof IKeyboardEvent

    Parameters

    • topic: K
    • listener: IListener<IKeyboardEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

once

  • once<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器，单个 listener 只执行1次

    Type Parameters

    • K extends keyof IKeyboardEvent

    Parameters

    • topic: K
    • listener: IListener<IKeyboardEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc