phaser/src/input/keyboard/keys/Key.js at e75731df8753cc6ffd9725b755bd452dab11e0d0 · ITCSsDeveloper/phaser · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
var Class = require('../../../utils/Class');

//  Phaser.Input.Keyboard.Key

//  A generic Key object which can be passed to the Process functions (and so on)
//  keycode must be an integer

var Key = new Class({

    initialize:

    function Key (keyCode)
    {
        //  @property {integer} keyCode - The keycode of this key.
        this.keyCode = keyCode;

        //  @property {KeyboardEvent} originalEvent - The original DOM event.
        this.originalEvent = undefined;

        //  @property {boolean} preventDefault - Should this Key prevent event propagation?
        //  @default
        this.preventDefault = true;

        //  @property {boolean} enabled - Can this Key be processed?
        //  @default
        this.enabled = true;

        //  @property {boolean} isDown - The "down" state of the key. This will remain `true` for as long as the keyboard thinks this key is held down.
        //  @default
        this.isDown = false;

        //  @property {boolean} isUp - The "up" state of the key. This will remain `true` for as long as the keyboard thinks this key is up.
        //  @default
        this.isUp = true;

        //  @property {boolean} altKey - The down state of the ALT key, if pressed at the same time as this key.
        //  @default
        this.altKey = false;

        //  @property {boolean} ctrlKey - The down state of the CTRL key, if pressed at the same time as this key.
        //  @default
        this.ctrlKey = false;

        //  @property {boolean} shiftKey - The down state of the SHIFT key, if pressed at the same time as this key.
        //  @default
        this.shiftKey = false;

        //  @property {integer} location - The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.
        //  @default
        this.location = 0;

        //  @property {number} timeDown - The timestamp when the key was last pressed down. This is based on Game.time.now.
        this.timeDown = 0;

        //  If the key is down this value holds the duration of that key press and is constantly updated.
        //  If the key is up it holds the duration of the previous down session.
        //  @property {number} duration - The number of milliseconds this key has been held down for.
        //  @default
        this.duration = 0;

        //  @property {number} timeUp - The timestamp when the key was last released. This is based on Game.time.now.
        //  @default
        this.timeUp = 0;

        //  @property {number} repeats - If a key is held down this holds down the number of times the key has 'repeated'.
        //  @default
        this.repeats = 0;

         // @property {boolean} _justDown - True if the key has just been pressed (NOTE: requires to be reset, see justDown getter)
         // @private
         this._justDown = false;

         // @property {boolean} _justUp - True if the key has just been pressed (NOTE: requires to be reset, see justDown getter)
         // @private
         this._justUp = false;
    }

});

module.exports = Key;