-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconsole_ConsoleInput.js.html
More file actions
560 lines (488 loc) · 20 KB
/
console_ConsoleInput.js.html
File metadata and controls
560 lines (488 loc) · 20 KB
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: console/ConsoleInput.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: console/ConsoleInput.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>//------------------------------------------------------------------------------
// Constructor scope
//------------------------------------------------------------------------------
/**
* Creates a new instance of the ConsoleInput class.
*
* @constructor
* @package
*
* @param {rune.console.Console} console Reference to the console to which the object is connected.
*
* @class
* @classdesc
*
* The ConsoleInput class represents an input field for a text console.
*/
rune.console.ConsoleInput = function(console) {
//--------------------------------------------------------------------------
// Public properties
//--------------------------------------------------------------------------
/**
* Whether or not the input field receives input from keyboard events.
*
* @type {boolean}
*/
this.enabled = true;
//--------------------------------------------------------------------------
// Private properties
//--------------------------------------------------------------------------
/**
* The Console object to which the input field belongs.
*
* @type {rune.console.Console}
* @private
*/
this.m_console = console;
/**
* Represents the text cursor.
*
* @type {rune.console.ConsoleCursor}
* @private
*/
this.m_cursor = null;
/**
* Input prefix.
*
* @type {string}
* @private
*/
this.m_cursorPrefix = "> ";
/**
* Represents input history.
*
* @type {rune.console.ConsoleHistory}
* @private
*/
this.m_history = null;
/**
* Current input string.
*
* @type {string}
* @private
*/
this.m_input = "";
/**
* Callback handle for "keydown" events.
*
* @type {Function}
* @private
*/
this.m_onKeyDownHandler = null;
//--------------------------------------------------------------------------
// Constructor call
//--------------------------------------------------------------------------
/**
* Invokes secondary class constructor.
*/
this.m_construct();
};
//------------------------------------------------------------------------------
// Private static constants
//------------------------------------------------------------------------------
/**
* The key code of "enter".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_RETURN = 13;
/**
* The key code of "backspace".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_BACKSPACE = 8;
/**
* The key code of "up arrow".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_UP = 38;
/**
* The key code of "down arrow".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_DOWN = 40;
/**
* The key code of "grave accent".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_TILDE = 192;
/**
* The key code of "shift".
*
* @const {number}
* @private
*/
rune.console.ConsoleInput.KEYBOARD_SHIFT = 16;
//------------------------------------------------------------------------------
// Public prototype methods (API)
//------------------------------------------------------------------------------
/**
* Adds a character to the input field.
*
* @param {string} chr The character to add.
*
* @returns {undefined}
* @suppress {accessControls}
*/
rune.console.ConsoleInput.prototype.add = function(chr) {
this.m_input += chr || "";
this.m_console.breakCache();
};
/**
* Clears the contents of the input field.
*
* @returns {undefined}
* @suppress {accessControls}
*/
rune.console.ConsoleInput.prototype.clear = function() {
this.m_input = "";
this.m_console.breakCache();
};
//------------------------------------------------------------------------------
// Public prototype methods (ENGINE)
//------------------------------------------------------------------------------
/**
* Updates the input field.
*
* @param {number} step Current time step.
*
* @returns {undefined}
* @ignore
*/
rune.console.ConsoleInput.prototype.update = function(step) {
this.m_updateCursor(step);
};
/**
* Renders the input field.
*
* @returns {undefined}
* @ignore
*/
rune.console.ConsoleInput.prototype.render = function() {
this.m_renderString(this.m_cursorPrefix + this.m_input + this.m_cursor.text);
};
/**
* Removes and frees memory allocated by the input field.
*
* @returns {undefined}
* @ignore
*/
rune.console.ConsoleInput.prototype.dispose = function() {
this.m_disposeHistory();
this.m_disposeCursor();
this.m_disposeEvent();
};
//------------------------------------------------------------------------------
// Protected prototype methods
//------------------------------------------------------------------------------
/**
* The class constructor.
*
* @returns {undefined}
* @protected
* @ignore
*/
rune.console.ConsoleInput.prototype.m_construct = function() {
this.m_constructEvent();
this.m_constructCursor();
this.m_constructHistory();
};
//------------------------------------------------------------------------------
// Private prototype methods
//------------------------------------------------------------------------------
/**
* Creates event handler for "keydown" events.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_constructEvent = function() {
this.m_disposeEvent();
var m_this = this;
if (this.m_onKeyDownHandler == null) {
window.addEventListener(
"keydown",
this.m_onKeyDownHandler = function(event) {
m_this.m_onKeyDown(event);
}
);
} else throw new Error();
};
/**
* Creates the text cursor.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_constructCursor = function() {
this.m_disposeCursor();
if (this.m_cursor == null) {
this.m_cursor = new rune.console.ConsoleCursor();
} else throw new Error();
};
/**
* Creates the input history subsystem.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_constructHistory = function() {
this.m_disposeHistory();
if (this.m_history == null) {
this.m_history = new rune.console.ConsoleHistory();
} else throw new Error();
};
/**
* Updates the text cursor.
*
* @param {number} step Current time step.
*
* @returns {undefined}
* @private
* @suppress {accessControls}
*/
rune.console.ConsoleInput.prototype.m_updateCursor = function(step) {
if (this.m_cursor != null) {
if (this.m_cursor.update(step)) {
this.m_console.breakCache();
}
}
};
/**
* Renders a string to the input field.
*
* @param {string} str String to render.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_renderString = function(str) {
var x = this.m_console['indentation'];
var y = this.m_console['unscaledHeight'] - this.m_console['format']['charHeight'];
for (var i = 0; i < str.length; i++) {
this.m_renderCharacter(
str.charCodeAt(i),
x,
y
);
x += this.m_console['format']['charWidth'];
}
};
/**
* Renders a character to the input field.
*
* @param {number} chr The character code for the character to render.
* @param {number} x The x position of the character.
* @param {number} y The y position of the character.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_renderCharacter = function(chr, x, y) {
var rect = this.m_console['format'].getCharRect(chr);
if (rect != null) {
this.m_console['canvas'].drawImage(
this.m_console['format']['texture'],
x,
y,
rect.width,
rect.height,
rect.x,
rect.y,
rect.width,
rect.height
);
}
};
/**
* Removes the input history subsystem.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_disposeHistory = function() {
if (this.m_history instanceof rune.console.ConsoleHistory) {
this.m_history.dispose();
this.m_history = null;
}
};
/**
* Removes the text cursor.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_disposeCursor = function() {
if (this.m_cursor instanceof rune.console.ConsoleCursor) {
this.m_cursor.dispose();
this.m_cursor = null;
}
};
/**
* Removes event listeners who listen for "keydown" events.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_disposeEvent = function() {
if (typeof this.m_onKeyDownHandler === "function") {
window.removeEventListener(
"keydown",
this.m_onKeyDownHandler
);
}
};
/**
* Automatically called when a key is pressed.
*
* @param {Event} event Keyboard event.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_onKeyDown = function(event) {
if (this.enabled == true && this.m_console['enabled'] == true) {
this.m_commandSwitch(event);
}
};
/**
* Handles how to handle a character entry.
*
* @param {Event} event Keyboard event.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_commandSwitch = function(event) {
switch (event.keyCode) {
case rune.console.ConsoleInput.KEYBOARD_RETURN:
this.m_executeCommand();
break;
case rune.console.ConsoleInput.KEYBOARD_BACKSPACE:
this.m_removeFromInput();
break;
case rune.console.ConsoleInput.KEYBOARD_UP:
this.m_previousInput();
break;
case rune.console.ConsoleInput.KEYBOARD_DOWN:
this.m_nextInput();
break;
case rune.console.ConsoleInput.KEYBOARD_TILDE:
break;
case rune.console.ConsoleInput.KEYBOARD_SHIFT:
break;
default:
this.m_addToInput(event);
break;
}
};
/**
* Executes entered command.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_executeCommand = function() {
this.m_onInput(this.m_input);
this.m_history.add(this.m_input);
this.clear();
};
/**
* Executes the command of a text string.
*
* @param {string} input Input string.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_onInput = function(input) {
if (this.m_console != null) {
this.m_console.execute(input);
}
};
/**
* Adds a character to the input string.
*
* @param {Event} event Keyboard event.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_addToInput = function(event) {
this.m_cursor.reset();
var chr = (event.key != null && event.key.length === 1) ? event.key : String.fromCharCode(event.which || event.keyCode);
this.add(chr);
};
/**
* Retrieves the next input string from the history.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_nextInput = function() {
this.clear();
this.m_input = this.m_history.next() || "";
};
/**
* Retrieves the previous input string from the history.
*
* @returns {undefined}
* @private
*/
rune.console.ConsoleInput.prototype.m_previousInput = function() {
this.clear();
this.m_input = this.m_history.previous() || "";
};
/**
* Deletes the last character in the input string.
*
* @returns {undefined}
* @private
* @suppress {accessControls}
*/
rune.console.ConsoleInput.prototype.m_removeFromInput = function() {
this.m_cursor.reset();
this.m_input = this.m_input.substring(0, this.m_input.length - 1);
this.m_console.breakCache();
};</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="rune.html">rune</a></li><li><a href="rune.animation.html">animation</a></li><li><a href="rune.camera.html">camera</a></li><li><a href="rune.color.html">color</a></li><li><a href="rune.console.html">console</a></li><li><a href="rune.data.html">data</a></li><li><a href="rune.debug.html">debug</a></li><li><a href="rune.display.html">display</a></li><li><a href="rune.geom.html">geom</a></li><li><a href="rune.input.html">input</a></li><li><a href="rune.media.html">media</a></li><li><a href="rune.net.html">net</a></li><li><a href="rune.particle.html">particle</a></li><li><a href="rune.physics.html">physics</a></li><li><a href="rune.resource.html">resource</a></li><li><a href="rune.scene.html">scene</a></li><li><a href="rune.state.html">state</a></li><li><a href="rune.system.html">system</a></li><li><a href="rune.text.html">text</a></li><li><a href="rune.tilemap.html">tilemap</a></li><li><a href="rune.timer.html">timer</a></li><li><a href="rune.tween.html">tween</a></li><li><a href="rune.ui.html">ui</a></li><li><a href="rune.util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="rune.animation.Animation.html">Animation</a></li><li><a href="rune.animation.Animations.html">Animations</a></li><li><a href="rune.animation.AnimationScripts.html">AnimationScripts</a></li><li><a href="rune.camera.Camera.html">Camera</a></li><li><a href="rune.camera.CameraFade.html">CameraFade</a></li><li><a href="rune.camera.CameraFlash.html">CameraFlash</a></li><li><a href="rune.camera.Cameras.html">Cameras</a></li><li><a href="rune.camera.CameraShake.html">CameraShake</a></li><li><a href="rune.camera.CameraTargets.html">CameraTargets</a></li><li><a href="rune.camera.CameraTint.html">CameraTint</a></li><li><a href="rune.camera.CameraTintTween.html">CameraTintTween</a></li><li><a href="rune.camera.CameraViewport.html">CameraViewport</a></li><li><a href="rune.color.Color24.html">Color24</a></li><li><a href="rune.color.Color32.html">Color32</a></li><li><a href="rune.color.ColorComponent.html">ColorComponent</a></li><li><a href="rune.console.Console.html">Console</a></li><li><a href="rune.console.ConsoleCommand.html">ConsoleCommand</a></li><li><a href="rune.console.ConsoleCommands.html">ConsoleCommands</a></li><li><a href="rune.console.ConsoleCursor.html">ConsoleCursor</a></li><li><a href="rune.console.ConsoleHistory.html">ConsoleHistory</a></li><li><a href="rune.console.ConsoleInput.html">ConsoleInput</a></li><li><a href="rune.console.ConsoleManager.html">ConsoleManager</a></li><li><a href="rune.console.ConsoleOutput.html">ConsoleOutput</a></li><li><a href="rune.data.Highscores.html">Highscores</a></li><li><a href="rune.data.Loader.html">Loader</a></li><li><a href="rune.data.LoaderDebug.html">LoaderDebug</a></li><li><a href="rune.data.Logo.html">Logo</a></li><li><a href="rune.data.Requests.html">Requests</a></li><li><a href="rune.debug.Debugger.html">Debugger</a></li><li><a href="rune.debug.Framerate.html">Framerate</a></li><li><a href="rune.debug.Histogram.html">Histogram</a></li><li><a href="rune.debug.Master.html">Master</a></li><li><a href="rune.debug.Memory.html">Memory</a></li><li><a href="rune.debug.Music.html">Music</a></li><li><a href="rune.debug.Render.html">Render</a></li><li><a href="rune.debug.Sound.html">Sound</a></li><li><a href="rune.debug.Update.html">Update</a></li><li><a href="rune.display.Artboard.html">Artboard</a></li><li><a href="rune.display.Canvas.html">Canvas</a></li><li><a href="rune.display.DisplayGroup.html">DisplayGroup</a></li><li><a href="rune.display.DisplayGroups.html">DisplayGroups</a></li><li><a href="rune.display.DisplayObject.html">DisplayObject</a></li><li><a href="rune.display.DisplayObjectContainer.html">DisplayObjectContainer</a></li><li><a href="rune.display.Flicker.html">Flicker</a></li><li><a href="rune.display.Frame.html">Frame</a></li><li><a href="rune.display.Graphic.html">Graphic</a></li><li><a href="rune.display.Graphics.html">Graphics</a></li><li><a href="rune.display.Hitbox.html">Hitbox</a></li><li><a href="rune.display.InteractiveObject.html">InteractiveObject</a></li><li><a href="rune.display.Quadtree.html">Quadtree</a></li><li><a href="rune.display.RepeatedGraphic.html">RepeatedGraphic</a></li><li><a href="rune.display.Screen.html">Screen</a></li><li><a href="rune.display.Sprite.html">Sprite</a></li><li><a href="rune.display.Stage.html">Stage</a></li><li><a href="rune.display.Texture.html">Texture</a></li><li><a href="rune.geom.Point.html">Point</a></li><li><a href="rune.geom.Rectangle.html">Rectangle</a></li><li><a href="rune.geom.Vector2D.html">Vector2D</a></li><li><a href="rune.input.Gamepad.html">Gamepad</a></li><li><a href="rune.input.Gamepads.html">Gamepads</a></li><li><a href="rune.input.GamepadsOptions.html">GamepadsOptions</a></li><li><a href="rune.input.Inputs.html">Inputs</a></li><li><a href="rune.input.Keyboard.html">Keyboard</a></li><li><a href="rune.input.KeyboardKey.html">KeyboardKey</a></li><li><a href="rune.input.KeyboardOptions.html">KeyboardOptions</a></li><li><a href="rune.media.Sound.html">Sound</a></li><li><a href="rune.media.SoundChannel.html">SoundChannel</a></li><li><a href="rune.media.Sounds.html">Sounds</a></li><li><a href="rune.net.URLLoader.html">URLLoader</a></li><li><a href="rune.net.URLRequest.html">URLRequest</a></li><li><a href="rune.net.URLResponse.html">URLResponse</a></li><li><a href="rune.particle.Emitter.html">Emitter</a></li><li><a href="rune.particle.EmitterOptions.html">EmitterOptions</a></li><li><a href="rune.particle.Particle.html">Particle</a></li><li><a href="rune.physics.Space.html">Space</a></li><li><a href="rune.physics.Velocity.html">Velocity</a></li><li><a href="rune.resource.Request.html">Request</a></li><li><a href="rune.resource.Requester.html">Requester</a></li><li><a href="rune.resource.RequesterOptions.html">RequesterOptions</a></li><li><a href="rune.resource.Requests.html">Requests</a></li><li><a href="rune.resource.Resource.html">Resource</a></li><li><a href="rune.resource.Resources.html">Resources</a></li><li><a href="rune.scene.Scene.html">Scene</a></li><li><a href="rune.scene.Scenes.html">Scenes</a></li><li><a href="rune.state.State.html">State</a></li><li><a href="rune.state.States.html">States</a></li><li><a href="rune.system.Application.html">Application</a></li><li><a href="rune.system.Config.html">Config</a></li><li><a href="rune.system.Time.html">Time</a></li><li><a href="rune.text.BitmapField.html">BitmapField</a></li><li><a href="rune.text.BitmapFormat.html">BitmapFormat</a></li><li><a href="rune.tilemap.Block.html">Block</a></li><li><a href="rune.tilemap.Tile.html">Tile</a></li><li><a href="rune.tilemap.Tilemap.html">Tilemap</a></li><li><a href="rune.tilemap.TilemapLayer.html">TilemapLayer</a></li><li><a href="rune.timer.Timer.html">Timer</a></li><li><a href="rune.timer.TimerOptions.html">TimerOptions</a></li><li><a href="rune.timer.Timers.html">Timers</a></li><li><a href="rune.tween.Circular.html">Circular</a></li><li><a href="rune.tween.Cubic.html">Cubic</a></li><li><a href="rune.tween.Expo.html">Expo</a></li><li><a href="rune.tween.Linear.html">Linear</a></li><li><a href="rune.tween.Quad.html">Quad</a></li><li><a href="rune.tween.Quart.html">Quart</a></li><li><a href="rune.tween.Quint.html">Quint</a></li><li><a href="rune.tween.Sine.html">Sine</a></li><li><a href="rune.tween.Tween.html">Tween</a></li><li><a href="rune.tween.Tweens.html">Tweens</a></li><li><a href="rune.tween.TweenValue.html">TweenValue</a></li><li><a href="rune.ui.Counter.html">Counter</a></li><li><a href="rune.ui.CounterDigit.html">CounterDigit</a></li><li><a href="rune.ui.Progressbar.html">Progressbar</a></li><li><a href="rune.ui.VTList.html">VTList</a></li><li><a href="rune.ui.VTListElement.html">VTListElement</a></li><li><a href="rune.ui.VTMenu.html">VTMenu</a></li><li><a href="rune.ui.VTMenuPointer.html">VTMenuPointer</a></li><li><a href="rune.util.Executable.html">Executable</a></li><li><a href="rune.util.Filter.html">Filter</a></li><li><a href="rune.util.Math.html">Math</a></li><li><a href="rune.util.Palette.html">Palette</a></li><li><a href="rune.util.Path.html">Path</a></li><li><a href="rune.util.Paths.html">Paths</a></li><li><a href="rune.util.Stack.html">Stack</a></li><li><a href="rune.util.URL.html">URL</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Apr 01 2025 09:55:09 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>