PokéRogue
    Preparing search index...

    Class KeyCombo

    A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them it will emit a keycombomatch event from the Keyboard Manager.

    The keys to be listened for can be defined as:

    A string (i.e. 'ATARI') An array of either integers (key codes) or strings, or a mixture of both An array of objects (such as Key objects) with a public 'keyCode' property

    For example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter) you could pass the following array of key codes:

    this.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });

    this.input.keyboard.on('keycombomatch', function (event) {
        console.log('Konami Code entered!');
    });

    Or, to listen for the user entering the word PHASER:

    this.input.keyboard.createCombo('PHASER');
    Index
    constructor
    current deleteOnMatch enabled index keyCodes manager matched maxKeyDelay progress resetOnMatch resetOnWrongKey size timeLastMatched timeMatched
    destroy

    • Parameters

      • keyboardPlugin: KeyboardPlugin

        A reference to the Keyboard Plugin.

      • keys: string | number[] | object[]

        The keys that comprise this combo.

      • Optionalconfig: KeyComboConfig

        A Key Combo configuration object.

      Returns KeyCombo

    current: number

    The current keyCode the combo is waiting for.

    deleteOnMatch: boolean

    If the combo matches successfully, this KeyCombo instance will automatically destroy itself.

    enabled: boolean

    A flag that controls if this Key Combo is actively processing keys or not.

    index: number

    The current index of the key being waited for in the keyCodes array.

    keyCodes: any[]

    An array of the keycodes that comprise this combo.

    manager: KeyboardPlugin

    A reference to the Keyboard Plugin

    matched: boolean

    Has this Key Combo been matched yet?

    maxKeyDelay: number

    The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.

    progress: number

    How far complete is this combo? A value between 0 and 1.

    resetOnMatch: boolean

    If the combo has previously been matched and the user presses the first key of the combo again, the combo will reset.

    resetOnWrongKey: boolean

    If the user presses an incorrect key, the combo sequence will be reset to the beginning.

    size: number

    The length of this combo (in keycodes)

    timeLastMatched: number

    The time the previous key in the combo was matched.

    timeMatched: number

    The time the entire combo was matched.

    • Destroys this Key Combo and all of its references.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods