- 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
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
import {preventDefault as preventDefaultAction} from "./input.js";
import * as event from "./../system/event.js";
import { isMobile } from "./../system/platform.js";
// corresponding actions
let _keyStatus = {};
// lock enable flag for keys
let _keyLock = {};
// actual lock status of each key
let _keyLocked = {};
// List of binded keys being held
let _keyRefs = {};
// whether default event should be prevented for a given keypress
let _preventDefaultForKeys = {};
// list of binded keys
let _keyBindings = {};
/**
* key down event
* @ignore
*/
let keyDownEvent = function (e, keyCode, mouseButton) {
keyCode = keyCode || e.keyCode || e.button;
let action = _keyBindings[keyCode];
// publish a message for keydown event
event.emit(event.KEYDOWN,
action,
keyCode,
action ? !_keyLocked[action] : true
);
if (action) {
if (!_keyLocked[action]) {
let trigger = (typeof mouseButton !== "undefined") ? mouseButton : keyCode;
if (!_keyRefs[action][trigger]) {
_keyStatus[action]++;
_keyRefs[action][trigger] = true;
}
}
// prevent event propagation
if (_preventDefaultForKeys[keyCode] && (typeof e.preventDefault === "function")) {
// "fake" events generated through triggerKeyEvent do not have a preventDefault fn
return e.preventDefault();
}
else {
return true;
}
}
return true;
};
/**
* key up event
* @ignore
*/
let keyUpEvent = function (e, keyCode, mouseButton) {
keyCode = keyCode || e.keyCode || e.button;
let action = _keyBindings[keyCode];
// publish a message for keydown event
event.emit(event.KEYUP, action, keyCode);
if (action) {
let trigger = (typeof mouseButton !== "undefined") ? mouseButton : keyCode;
_keyRefs[action][trigger] = undefined;
if (_keyStatus[action] > 0) {
_keyStatus[action]--;
}
_keyLocked[action] = false;
// prevent event propagation
if (_preventDefaultForKeys[keyCode] && (typeof e.preventDefault === "function")) {
// "fake" events generated through triggerKeyEvent do not have a preventDefault fn
return e.preventDefault();
}
else {
return true;
}
}
return true;
};
/*
* PUBLIC STUFF
*/
/**
* the default target element for keyboard events (usually the window element in which the game is running)
* @public
* @type {EventTarget}
* @name keyBoardEventTarget
* @memberof input
*/
export let keyBoardEventTarget = null;
/**
* standard keyboard constants
* @public
* @enum {number}
* @namespace KEY
* @memberof input
*/
export const KEY = {
"BACKSPACE" : 8,
/** @memberof input.KEY */
"TAB" : 9,
/** @memberof input.KEY */
"ENTER" : 13,
/** @memberof input.KEY */
"SHIFT" : 16,
/** @memberof input.KEY */
"CTRL" : 17,
/** @memberof input.KEY */
"ALT" : 18,
/** @memberof input.KEY */
"PAUSE" : 19,
/** @memberof input.KEY */
"CAPS_LOCK" : 20,
/** @memberof input.KEY */
"ESC" : 27,
/** @memberof input.KEY */
"SPACE" : 32,
/** @memberof input.KEY */
"PAGE_UP" : 33,
/** @memberof input.KEY */
"PAGE_DOWN" : 34,
/** @memberof input.KEY */
"END" : 35,
/** @memberof input.KEY */
"HOME" : 36,
/** @memberof input.KEY */
"LEFT" : 37,
/** @memberof input.KEY */
"UP" : 38,
/** @memberof input.KEY */
"RIGHT" : 39,
/** @memberof input.KEY */
"DOWN" : 40,
/** @memberof input.KEY */
"PRINT_SCREEN" : 42,
/** @memberof input.KEY */
"INSERT" : 45,
/** @memberof input.KEY */
"DELETE" : 46,
/** @memberof input.KEY */
"NUM0" : 48,
/** @memberof input.KEY */
"NUM1" : 49,
/** @memberof input.KEY */
"NUM2" : 50,
/** @memberof input.KEY */
"NUM3" : 51,
/** @memberof input.KEY */
"NUM4" : 52,
/** @memberof input.KEY */
"NUM5" : 53,
/** @memberof input.KEY */
"NUM6" : 54,
/** @memberof input.KEY */
"NUM7" : 55,
/** @memberof input.KEY */
"NUM8" : 56,
/** @memberof input.KEY */
"NUM9" : 57,
/** @memberof input.KEY */
"A" : 65,
/** @memberof input.KEY */
"B" : 66,
/** @memberof input.KEY */
"C" : 67,
/** @memberof input.KEY */
"D" : 68,
/** @memberof input.KEY */
"E" : 69,
/** @memberof input.KEY */
"F" : 70,
/** @memberof input.KEY */
"G" : 71,
/** @memberof input.KEY */
"H" : 72,
/** @memberof input.KEY */
"I" : 73,
/** @memberof input.KEY */
"J" : 74,
/** @memberof input.KEY */
"K" : 75,
/** @memberof input.KEY */
"L" : 76,
/** @memberof input.KEY */
"M" : 77,
/** @memberof input.KEY */
"N" : 78,
/** @memberof input.KEY */
"O" : 79,
/** @memberof input.KEY */
"P" : 80,
/** @memberof input.KEY */
"Q" : 81,
/** @memberof input.KEY */
"R" : 82,
/** @memberof input.KEY */
"S" : 83,
/** @memberof input.KEY */
"T" : 84,
/** @memberof input.KEY */
"U" : 85,
/** @memberof input.KEY */
"V" : 86,
/** @memberof input.KEY */
"W" : 87,
/** @memberof input.KEY */
"X" : 88,
/** @memberof input.KEY */
"Y" : 89,
/** @memberof input.KEY */
"Z" : 90,
/** @memberof input.KEY */
"WINDOW_KEY" : 91,
/** @memberof input.KEY */
"NUMPAD0" : 96,
/** @memberof input.KEY */
"NUMPAD1" : 97,
/** @memberof input.KEY */
"NUMPAD2" : 98,
/** @memberof input.KEY */
"NUMPAD3" : 99,
/** @memberof input.KEY */
"NUMPAD4" : 100,
/** @memberof input.KEY */
"NUMPAD5" : 101,
/** @memberof input.KEY */
"NUMPAD6" : 102,
/** @memberof input.KEY */
"NUMPAD7" : 103,
/** @memberof input.KEY */
"NUMPAD8" : 104,
/** @memberof input.KEY */
"NUMPAD9" : 105,
/** @memberof input.KEY */
"MULTIPLY" : 106,
/** @memberof input.KEY */
"ADD" : 107,
/** @memberof input.KEY */
"SUBSTRACT" : 109,
/** @memberof input.KEY */
"DECIMAL" : 110,
/** @memberof input.KEY */
"DIVIDE" : 111,
/** @memberof input.KEY */
"F1" : 112,
/** @memberof input.KEY */
"F2" : 113,
/** @memberof input.KEY */
"F3" : 114,
/** @memberof input.KEY */
"F4" : 115,
/** @memberof input.KEY */
"F5" : 116,
/** @memberof input.KEY */
"F6" : 117,
/** @memberof input.KEY */
"F7" : 118,
/** @memberof input.KEY */
"F8" : 119,
/** @memberof input.KEY */
"F9" : 120,
/** @memberof input.KEY */
"F10" : 121,
/** @memberof input.KEY */
"F11" : 122,
/** @memberof input.KEY */
"F12" : 123,
/** @memberof input.KEY */
"TILDE" : 126,
/** @memberof input.KEY */
"NUM_LOCK" : 144,
/** @memberof input.KEY */
"SCROLL_LOCK" : 145,
/** @memberof input.KEY */
"SEMICOLON" : 186,
/** @memberof input.KEY */
"PLUS" : 187,
/** @memberof input.KEY */
"COMMA" : 188,
/** @memberof input.KEY */
"MINUS" : 189,
/** @memberof input.KEY */
"PERIOD" : 190,
/** @memberof input.KEY */
"FORWAND_SLASH" : 191,
/** @memberof input.KEY */
"GRAVE_ACCENT" : 192,
/** @memberof input.KEY */
"OPEN_BRACKET" : 219,
/** @memberof input.KEY */
"BACK_SLASH" : 220,
/** @memberof input.KEY */
"CLOSE_BRACKET" : 221,
/** @memberof input.KEY */
"SINGLE_QUOTE" : 222
};
/**
* enable keyboard event
* @ignore
*/
export function initKeyboardEvent() {
// make sure the keyboard is enable
if (keyBoardEventTarget === null && isMobile === false) {
keyBoardEventTarget = globalThis;
if (typeof keyBoardEventTarget.addEventListener === "function") {
keyBoardEventTarget.addEventListener("keydown", keyDownEvent, false);
keyBoardEventTarget.addEventListener("keyup", keyUpEvent, false);
}
}
}
/**
* return the key press status of the specified action
* @name isKeyPressed
* @memberof input
* @public
* @param {string} action - user defined corresponding action
* @returns {boolean} true if pressed
* @example
* if (me.input.isKeyPressed('left')) {
* //do something
* }
* else if (me.input.isKeyPressed('right')) {
* //do something else...
* }
*/
export function isKeyPressed(action) {
if (_keyStatus[action] && !_keyLocked[action]) {
if (_keyLock[action]) {
_keyLocked[action] = true;
}
return true;
}
return false;
}
/**
* return the key status of the specified action
* @name keyStatus
* @memberof input
* @public
* @param {string} action - user defined corresponding action
* @returns {boolean} down (true) or up(false)
*/
export function keyStatus(action) {
return (_keyStatus[action] > 0);
}
/**
* trigger the specified key (simulated) event <br>
* @name triggerKeyEvent
* @memberof input
* @public
* @param {number} keycode - (See {@link input.KEY})
* @param {boolean} [status=false] - true to trigger a key down event, or false for key up event
* @param {number} [mouseButton] - the mouse button to trigger
* @example
* // trigger a key press
* me.input.triggerKeyEvent(me.input.KEY.LEFT, true);
*/
export function triggerKeyEvent(keycode, status, mouseButton) {
if (status === true) {
keyDownEvent({}, keycode, mouseButton);
}
else {
keyUpEvent({}, keycode, mouseButton);
}
}
/**
* associate a user defined action to a keycode
* @name bindKey
* @memberof input
* @public
* @param {number} keycode - (See {@link input.KEY})
* @param {string} action - user defined corresponding action
* @param {boolean} [lock=false] - cancel the keypress event once read
* @param {boolean} [preventDefault=input.preventDefault] - prevent default browser action
* @example
* // enable the keyboard
* me.input.bindKey(me.input.KEY.LEFT, "left");
* me.input.bindKey(me.input.KEY.RIGHT, "right");
* me.input.bindKey(me.input.KEY.X, "jump", true);
* me.input.bindKey(me.input.KEY.F1, "options", true, true);
*/
export function bindKey(keycode, action, lock, preventDefault = preventDefaultAction) {
_keyBindings[keycode] = action;
_preventDefaultForKeys[keycode] = preventDefault;
_keyStatus[action] = 0;
_keyLock[action] = lock ? lock : false;
_keyLocked[action] = false;
_keyRefs[action] = {};
}
/**
* return the action associated with the given keycode
* @name getBindingKey
* @memberof input
* @public
* @param {number} keycode - (See {@link input.KEY})
* @returns {string} user defined associated action
*/
export function getBindingKey(keycode) {
return _keyBindings[keycode];
}
/**
* unlock a key manually
* @name unlockKey
* @memberof input
* @public
* @param {string} action - user defined corresponding action
* @example
* // Unlock jump when touching the ground
* if (!this.falling && !this.jumping) {
* me.input.unlockKey("jump");
* }
*/
export function unlockKey(action) {
_keyLocked[action] = false;
}
/**
* unbind the defined keycode
* @name unbindKey
* @memberof input
* @public
* @param {number} keycode - (See {@link input.KEY})
* @example
* me.input.unbindKey(me.input.KEY.LEFT);
*/
export function unbindKey(keycode) {
// clear the event status
let keybinding = _keyBindings[keycode];
_keyStatus[keybinding] = 0;
_keyLock[keybinding] = false;
_keyRefs[keybinding] = {};
// remove the key binding
_keyBindings[keycode] = null;
_preventDefaultForKeys[keycode] = null;
}