UNPKG

103 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Namespace: CB_Controllers</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Controllers</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Controllers
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage different controllers (gamepads, joysticks, remotes, etc.). It will return itself if it is tried to be instantiated. It uses <a href="https://github.com/MozillaReality/gamepad-plus">gamepad-plus</a>.</p></div>
102
103
104
105<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
140 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-8">line 8</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
152 <dd class="tag-todo">
153 <ul>
154 <li>Find a way to do button mapping (so we could use names as LEFT, RIGHT, etc.) and normalization for most web clients and gamepads (without forgetting proprietary ones as WII U, etc.).</li>
155
156 <li>Consider using always a numeric index instead of the ID of the gamepad (array instead of object), which could be a string, for CB_Controllers._gamepads (for optimization purposes).</li>
157
158 <li>Consider modifying <a href="CB_Controllers.html#.isButtonDown"><code>CB_Controllers.isButtonDown</code></a> function or add a new one to check whether any button (or axes) is down or not.</li>
159 </ul>
160 </dd>
161
162</dl>
163
164
165
166
167 </div>
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182 <h3 class="subsection-title">Methods</h3>
183
184 <dl>
185
186<hr>
187<dt>
188 <h4 class="name" id=".getAxes"><span class="type-signature">&lt;static> </span>getAxes<span class="signature">( [gamepadId] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {array}</span></h4>
189
190
191</dt>
192<dd>
193
194
195 <div class="description">
196 <p>Gets an array with information about the status of the axes of a given gamepad (or from all if none is given).</p>
197 </div>
198
199
200
201
202
203
204
205
206 <h5>Parameters:</h5>
207
208
209<table class="params table table-striped">
210 <thead>
211 <tr>
212
213 <th style="width:12%; min-width:110px;">Name</th>
214
215
216 <th style="width:12%; min-width:110px;">Type</th>
217
218
219 <th style="width:12%; min-width:110px;">Argument</th>
220
221
222
223 <th style="width:12%; min-width:110px;">Default</th>
224
225
226 <th class="last" style="min-width:310px;">Description</th>
227 </tr>
228 </thead>
229
230 <tbody>
231
232
233 <tr>
234
235 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
236
237
238 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
239
240
241<span class="param-type">integer</span>
242|
243
244<span class="param-type">string</span>
245
246
247
248
249 </td>
250
251
252 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
253
254 &lt;optional><br>
255
256
257
258
259
260 </td>
261
262
263
264 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
265
266 ""
267
268 </td>
269
270
271 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any). When more than one gamepad is checked, the first axes values found which are not zero (0) will have priority.</p></td>
272 </tr>
273
274
275
276 <tr>
277
278 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
279
280
281 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
282
283
284<span class="param-type">boolean</span>
285
286
287
288
289 </td>
290
291
292 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
293
294 &lt;optional><br>
295
296
297
298
299
300 </td>
301
302
303
304 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
305
306 false|true
307
308 </td>
309
310
311 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
312 </tr>
313
314
315
316 <tr>
317
318 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
319
320
321 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
322
323
324<span class="param-type">boolean</span>
325
326
327
328
329 </td>
330
331
332 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
333
334 &lt;optional><br>
335
336
337
338
339
340 </td>
341
342
343
344 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
345
346 false
347
348 </td>
349
350
351 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
352 </tr>
353
354
355
356 <tr>
357
358 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
359
360
361 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
362
363
364<span class="param-type">boolean</span>
365
366
367
368
369 </td>
370
371
372 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
373
374 &lt;optional><br>
375
376
377
378
379
380 </td>
381
382
383
384 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
385
386 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
387
388 </td>
389
390
391 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
392 </tr>
393
394
395 </tbody>
396</table>
397
398
399
400
401<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
432 <dd class="tag-source">
433 <ul class="dummy">
434 <li>
435 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
436 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-321">line 321</a>
437 </li>
438 </ul>
439 </dd>
440
441
442
443
444
445
446
447</dl>
448
449
450
451
452
453
454
455
456
457
458
459
460
461 <h5>Returns:</h5>
462
463
464<div class="param-desc">
465 <p>Returns an array with information about the status of the axes of a given gamepad (or from all if none is given).</p>
466</div>
467
468
469
470<dl>
471 <dt>
472 Type
473 </dt>
474 <dd>
475
476<span class="param-type">array</span>
477
478
479
480 </dd>
481</dl>
482
483
484
485
486
487</dd>
488
489
490
491<hr>
492<dt>
493 <h4 class="name" id=".getAxesDown"><span class="type-signature">&lt;static> </span>getAxesDown<span class="signature">( [gamepadId] [, minimumValue] [, maximumValue] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {Object}</span></h4>
494
495
496</dt>
497<dd>
498
499
500 <div class="description">
501 <p>Gets an array with the axes pressed of a given gamepad (or from all if none is given). If more than one gamepad is pressing the same axis, it will return the value of the first one found.</p>
502 </div>
503
504
505
506
507
508
509
510
511 <h5>Parameters:</h5>
512
513
514<table class="params table table-striped">
515 <thead>
516 <tr>
517
518 <th style="width:12%; min-width:110px;">Name</th>
519
520
521 <th style="width:12%; min-width:110px;">Type</th>
522
523
524 <th style="width:12%; min-width:110px;">Argument</th>
525
526
527
528 <th style="width:12%; min-width:110px;">Default</th>
529
530
531 <th class="last" style="min-width:310px;">Description</th>
532 </tr>
533 </thead>
534
535 <tbody>
536
537
538 <tr>
539
540 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
541
542
543 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
544
545
546<span class="param-type">integer</span>
547|
548
549<span class="param-type">string</span>
550
551
552
553
554 </td>
555
556
557 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
558
559 &lt;optional><br>
560
561
562
563
564
565 </td>
566
567
568
569 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
570
571 ""
572
573 </td>
574
575
576 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any).</p></td>
577 </tr>
578
579
580
581 <tr>
582
583 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>minimumValue</code></td>
584
585
586 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
587
588
589<span class="param-type">float</span>
590
591
592
593
594 </td>
595
596
597 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
598
599 &lt;optional><br>
600
601
602
603
604
605 </td>
606
607
608
609 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
610
611 0.5
612
613 </td>
614
615
616 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The minimum value (included) that the checked axis or axes must have to consider them to be pressed.</p></td>
617 </tr>
618
619
620
621 <tr>
622
623 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>maximumValue</code></td>
624
625
626 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
627
628
629<span class="param-type">float</span>
630
631
632
633
634 </td>
635
636
637 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
638
639 &lt;optional><br>
640
641
642
643
644
645 </td>
646
647
648
649 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
650
651 1|-0.5
652
653 </td>
654
655
656 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The maximum value (included) that the checked axis or axes must have to consider them to be pressed. The default value will be -0.5 if the given &quot;minimumValue&quot; is negative or zero (0) or it will be 1 otherwise.</p></td>
657 </tr>
658
659
660
661 <tr>
662
663 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
664
665
666 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
667
668
669<span class="param-type">boolean</span>
670
671
672
673
674 </td>
675
676
677 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
678
679 &lt;optional><br>
680
681
682
683
684
685 </td>
686
687
688
689 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
690
691 false|true
692
693 </td>
694
695
696 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
697 </tr>
698
699
700
701 <tr>
702
703 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
704
705
706 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
707
708
709<span class="param-type">boolean</span>
710
711
712
713
714 </td>
715
716
717 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
718
719 &lt;optional><br>
720
721
722
723
724
725 </td>
726
727
728
729 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
730
731 false
732
733 </td>
734
735
736 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
737 </tr>
738
739
740
741 <tr>
742
743 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
744
745
746 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
747
748
749<span class="param-type">boolean</span>
750
751
752
753
754 </td>
755
756
757 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
758
759 &lt;optional><br>
760
761
762
763
764
765 </td>
766
767
768
769 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
770
771 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
772
773 </td>
774
775
776 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
777 </tr>
778
779
780 </tbody>
781</table>
782
783
784
785
786<dl class="details">
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
817 <dd class="tag-source">
818 <ul class="dummy">
819 <li>
820 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
821 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-379">line 379</a>
822 </li>
823 </ul>
824 </dd>
825
826
827
828
829
830
831
832</dl>
833
834
835
836
837
838
839
840
841
842
843
844
845
846 <h5>Returns:</h5>
847
848
849<div class="param-desc">
850 <p>Returns an array with the axes pressed of a given gamepad (or from all if none is given). If more than one gamepad is pressing the same axis, it will return the value of the first one found.</p>
851</div>
852
853
854
855<dl>
856 <dt>
857 Type
858 </dt>
859 <dd>
860
861<span class="param-type">Object</span>
862
863
864
865 </dd>
866</dl>
867
868
869
870
871
872</dd>
873
874
875
876<hr>
877<dt>
878 <h4 class="name" id=".getButtons"><span class="type-signature">&lt;static> </span>getButtons<span class="signature">( [gamepadId] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {Object}</span></h4>
879
880
881</dt>
882<dd>
883
884
885 <div class="description">
886 <p>Gets an object with all the buttons of a given gamepad (or from all if none is given).</p>
887 </div>
888
889
890
891
892
893
894
895
896 <h5>Parameters:</h5>
897
898
899<table class="params table table-striped">
900 <thead>
901 <tr>
902
903 <th style="width:12%; min-width:110px;">Name</th>
904
905
906 <th style="width:12%; min-width:110px;">Type</th>
907
908
909 <th style="width:12%; min-width:110px;">Argument</th>
910
911
912
913 <th style="width:12%; min-width:110px;">Default</th>
914
915
916 <th class="last" style="min-width:310px;">Description</th>
917 </tr>
918 </thead>
919
920 <tbody>
921
922
923 <tr>
924
925 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
926
927
928 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
929
930
931<span class="param-type">integer</span>
932|
933
934<span class="param-type">string</span>
935
936
937
938
939 </td>
940
941
942 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
943
944 &lt;optional><br>
945
946
947
948
949
950 </td>
951
952
953
954 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
955
956 ""
957
958 </td>
959
960
961 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any).</p></td>
962 </tr>
963
964
965
966 <tr>
967
968 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
969
970
971 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
972
973
974<span class="param-type">boolean</span>
975
976
977
978
979 </td>
980
981
982 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
983
984 &lt;optional><br>
985
986
987
988
989
990 </td>
991
992
993
994 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
995
996 false|true
997
998 </td>
999
1000
1001 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
1002 </tr>
1003
1004
1005
1006 <tr>
1007
1008 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
1009
1010
1011 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1012
1013
1014<span class="param-type">boolean</span>
1015
1016
1017
1018
1019 </td>
1020
1021
1022 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1023
1024 &lt;optional><br>
1025
1026
1027
1028
1029
1030 </td>
1031
1032
1033
1034 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1035
1036 false
1037
1038 </td>
1039
1040
1041 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
1042 </tr>
1043
1044
1045
1046 <tr>
1047
1048 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
1049
1050
1051 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1052
1053
1054<span class="param-type">boolean</span>
1055
1056
1057
1058
1059 </td>
1060
1061
1062 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1063
1064 &lt;optional><br>
1065
1066
1067
1068
1069
1070 </td>
1071
1072
1073
1074 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1075
1076 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
1077
1078 </td>
1079
1080
1081 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
1082 </tr>
1083
1084
1085 </tbody>
1086</table>
1087
1088
1089
1090
1091<dl class="details">
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1122 <dd class="tag-source">
1123 <ul class="dummy">
1124 <li>
1125 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
1126 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-476">line 476</a>
1127 </li>
1128 </ul>
1129 </dd>
1130
1131
1132
1133
1134
1135
1136
1137</dl>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151 <h5>Returns:</h5>
1152
1153
1154<div class="param-desc">
1155 <p>Returns an object with all the buttons of a given gamepad (or from all if none is given). The indexes will be the button code and the values will be an object with information about the button (with properties such as &quot;pressed&quot;, &quot;value&quot;, etc.).</p>
1156</div>
1157
1158
1159
1160<dl>
1161 <dt>
1162 Type
1163 </dt>
1164 <dd>
1165
1166<span class="param-type">Object</span>
1167
1168
1169
1170 </dd>
1171</dl>
1172
1173
1174
1175
1176
1177</dd>
1178
1179
1180
1181<hr>
1182<dt>
1183 <h4 class="name" id=".getButtonsDown"><span class="type-signature">&lt;static> </span>getButtonsDown<span class="signature">( [gamepadId] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {Object}</span></h4>
1184
1185
1186</dt>
1187<dd>
1188
1189
1190 <div class="description">
1191 <p>Gets an object with the buttons pressed of a given gamepad (or from all if none is given).</p>
1192 </div>
1193
1194
1195
1196
1197
1198
1199
1200
1201 <h5>Parameters:</h5>
1202
1203
1204<table class="params table table-striped">
1205 <thead>
1206 <tr>
1207
1208 <th style="width:12%; min-width:110px;">Name</th>
1209
1210
1211 <th style="width:12%; min-width:110px;">Type</th>
1212
1213
1214 <th style="width:12%; min-width:110px;">Argument</th>
1215
1216
1217
1218 <th style="width:12%; min-width:110px;">Default</th>
1219
1220
1221 <th class="last" style="min-width:310px;">Description</th>
1222 </tr>
1223 </thead>
1224
1225 <tbody>
1226
1227
1228 <tr>
1229
1230 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
1231
1232
1233 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1234
1235
1236<span class="param-type">integer</span>
1237|
1238
1239<span class="param-type">string</span>
1240
1241
1242
1243
1244 </td>
1245
1246
1247 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1248
1249 &lt;optional><br>
1250
1251
1252
1253
1254
1255 </td>
1256
1257
1258
1259 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1260
1261 ""
1262
1263 </td>
1264
1265
1266 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any).</p></td>
1267 </tr>
1268
1269
1270
1271 <tr>
1272
1273 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
1274
1275
1276 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1277
1278
1279<span class="param-type">boolean</span>
1280
1281
1282
1283
1284 </td>
1285
1286
1287 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1288
1289 &lt;optional><br>
1290
1291
1292
1293
1294
1295 </td>
1296
1297
1298
1299 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1300
1301 false|true
1302
1303 </td>
1304
1305
1306 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
1307 </tr>
1308
1309
1310
1311 <tr>
1312
1313 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
1314
1315
1316 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1317
1318
1319<span class="param-type">boolean</span>
1320
1321
1322
1323
1324 </td>
1325
1326
1327 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1328
1329 &lt;optional><br>
1330
1331
1332
1333
1334
1335 </td>
1336
1337
1338
1339 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1340
1341 false
1342
1343 </td>
1344
1345
1346 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
1347 </tr>
1348
1349
1350
1351 <tr>
1352
1353 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
1354
1355
1356 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1357
1358
1359<span class="param-type">boolean</span>
1360
1361
1362
1363
1364 </td>
1365
1366
1367 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1368
1369 &lt;optional><br>
1370
1371
1372
1373
1374
1375 </td>
1376
1377
1378
1379 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1380
1381 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
1382
1383 </td>
1384
1385
1386 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
1387 </tr>
1388
1389
1390 </tbody>
1391</table>
1392
1393
1394
1395
1396<dl class="details">
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1427 <dd class="tag-source">
1428 <ul class="dummy">
1429 <li>
1430 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
1431 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-522">line 522</a>
1432 </li>
1433 </ul>
1434 </dd>
1435
1436
1437
1438
1439
1440
1441
1442</dl>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 <h5>Returns:</h5>
1457
1458
1459<div class="param-desc">
1460 <p>Returns an object with the buttons pressed of a given gamepad (or from all if none is given).</p>
1461</div>
1462
1463
1464
1465<dl>
1466 <dt>
1467 Type
1468 </dt>
1469 <dd>
1470
1471<span class="param-type">Object</span>
1472
1473
1474
1475 </dd>
1476</dl>
1477
1478
1479
1480
1481
1482</dd>
1483
1484
1485
1486<hr>
1487<dt>
1488 <h4 class="name" id=".getGamePads"><span class="type-signature">&lt;static> </span>getGamePads<span class="signature">( [avoidProprietary])</span><span class="type-signature"> &rarr; {Object}</span></h4>
1489
1490
1491</dt>
1492<dd>
1493
1494
1495 <div class="description">
1496 <p>Returns an object with the current gamepad objects, if any (using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a> for non-proprietary gamepads).</p>
1497 </div>
1498
1499
1500
1501
1502
1503
1504
1505
1506 <h5>Parameters:</h5>
1507
1508
1509<table class="params table table-striped">
1510 <thead>
1511 <tr>
1512
1513 <th style="width:12%; min-width:110px;">Name</th>
1514
1515
1516 <th style="width:12%; min-width:110px;">Type</th>
1517
1518
1519 <th style="width:12%; min-width:110px;">Argument</th>
1520
1521
1522
1523 <th style="width:12%; min-width:110px;">Default</th>
1524
1525
1526 <th class="last" style="min-width:310px;">Description</th>
1527 </tr>
1528 </thead>
1529
1530 <tbody>
1531
1532
1533 <tr>
1534
1535 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
1536
1537
1538 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1539
1540
1541<span class="param-type">boolean</span>
1542
1543
1544
1545
1546 </td>
1547
1548
1549 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1550
1551 &lt;optional><br>
1552
1553
1554
1555
1556
1557 </td>
1558
1559
1560
1561 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1562
1563 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
1564
1565 </td>
1566
1567
1568 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads which do not use the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a> (as WII, WI U gamepads, etc.) will not be included in the returning object and it will only include the ones detected by the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a>. Otherwise, if set to true, the returning object will contain one property called &quot;standard&quot; which will contain an object with the &quot;gamepads&quot; property with the gamepad objects that use the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a> and possibly different properties (one per each proprietary system) and inside of them an object with the &quot;gamepads&quot; property and maybe also other properties for other kind of devices which will include the status objects of those devices for each proprietary system. For gamepads that support the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a>, the indexes will be the identifier for each gamepad and the value its gamepad object. For proprietary gamepads, it will contain the returning value of the &quot;getGamePads&quot; function of each proprietary API.</p></td>
1569 </tr>
1570
1571
1572 </tbody>
1573</table>
1574
1575
1576
1577
1578<dl class="details">
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1609 <dd class="tag-source">
1610 <ul class="dummy">
1611 <li>
1612 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
1613 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-582">line 582</a>
1614 </li>
1615 </ul>
1616 </dd>
1617
1618
1619
1620
1621
1622
1623
1624 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1625 <dd class="tag-todo">
1626 <ul>
1627 <li>The proprietary ones should return better-normalized values to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a>.</li>
1628 </ul>
1629 </dd>
1630
1631</dl>
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645 <h5>Returns:</h5>
1646
1647
1648<div class="param-desc">
1649 <p>Returns an object with the current gamepad objects, if any (using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a> for non-proprietary gamepads).</p>
1650</div>
1651
1652
1653
1654<dl>
1655 <dt>
1656 Type
1657 </dt>
1658 <dd>
1659
1660<span class="param-type">Object</span>
1661
1662
1663
1664 </dd>
1665</dl>
1666
1667
1668
1669
1670
1671</dd>
1672
1673
1674
1675<hr>
1676<dt>
1677 <h4 class="name" id=".isAxisDown"><span class="type-signature">&lt;static> </span>isAxisDown<span class="signature">(axesNumbers [, gamepadId] [, minimumValue] [, maximumValue] [, allPressed] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1678
1679
1680</dt>
1681<dd>
1682
1683
1684 <div class="description">
1685 <p>Returns whether a given axis or axes are being pressed or not (accepts one index or more than one with an array).</p>
1686 </div>
1687
1688
1689
1690
1691
1692
1693
1694
1695 <h5>Parameters:</h5>
1696
1697
1698<table class="params table table-striped">
1699 <thead>
1700 <tr>
1701
1702 <th style="width:12%; min-width:110px;">Name</th>
1703
1704
1705 <th style="width:12%; min-width:110px;">Type</th>
1706
1707
1708 <th style="width:12%; min-width:110px;">Argument</th>
1709
1710
1711
1712 <th style="width:12%; min-width:110px;">Default</th>
1713
1714
1715 <th class="last" style="min-width:310px;">Description</th>
1716 </tr>
1717 </thead>
1718
1719 <tbody>
1720
1721
1722 <tr>
1723
1724 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>axesNumbers</code></td>
1725
1726
1727 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1728
1729
1730<span class="param-type">integer</span>
1731|
1732
1733<span class="param-type">array</span>
1734
1735
1736
1737
1738 </td>
1739
1740
1741 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1742
1743
1744
1745
1746
1747 </td>
1748
1749
1750
1751 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1752
1753 </td>
1754
1755
1756 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Number with the index of the axis or array of numbers with the indexes of the axes that we want to check.</p></td>
1757 </tr>
1758
1759
1760
1761 <tr>
1762
1763 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
1764
1765
1766 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1767
1768
1769<span class="param-type">integer</span>
1770|
1771
1772<span class="param-type">string</span>
1773
1774
1775
1776
1777 </td>
1778
1779
1780 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1781
1782 &lt;optional><br>
1783
1784
1785
1786
1787
1788 </td>
1789
1790
1791
1792 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1793
1794 ""
1795
1796 </td>
1797
1798
1799 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any).</p></td>
1800 </tr>
1801
1802
1803
1804 <tr>
1805
1806 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>minimumValue</code></td>
1807
1808
1809 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1810
1811
1812<span class="param-type">float</span>
1813
1814
1815
1816
1817 </td>
1818
1819
1820 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1821
1822 &lt;optional><br>
1823
1824
1825
1826
1827
1828 </td>
1829
1830
1831
1832 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1833
1834 0.5
1835
1836 </td>
1837
1838
1839 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The minimum value (included) that the checked axis or axes must have to consider them to be pressed.</p></td>
1840 </tr>
1841
1842
1843
1844 <tr>
1845
1846 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>maximumValue</code></td>
1847
1848
1849 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1850
1851
1852<span class="param-type">float</span>
1853
1854
1855
1856
1857 </td>
1858
1859
1860 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1861
1862 &lt;optional><br>
1863
1864
1865
1866
1867
1868 </td>
1869
1870
1871
1872 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1873
1874 1|-0.5
1875
1876 </td>
1877
1878
1879 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The maximum value (included) that the checked axis or axes must have to consider them to be pressed. The default value will be -0.5 if the given &quot;minimumValue&quot; is negative or zero (0) or it will be 1 otherwise.</p></td>
1880 </tr>
1881
1882
1883
1884 <tr>
1885
1886 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>allPressed</code></td>
1887
1888
1889 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1890
1891
1892<span class="param-type">boolean</span>
1893
1894
1895
1896
1897 </td>
1898
1899
1900 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1901
1902 &lt;optional><br>
1903
1904
1905
1906
1907
1908 </td>
1909
1910
1911
1912 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1913
1914 false
1915
1916 </td>
1917
1918
1919 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, the function will return true only in the case that all given axes are being pressed. In the case that this parameter is set to true and the &quot;gamepadId&quot; parameter is set to an empty string, it will not have in mind whether the axes are pressed by a unique gamepad or by different ones as long as all axes are pressed.</p></td>
1920 </tr>
1921
1922
1923
1924 <tr>
1925
1926 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
1927
1928
1929 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1930
1931
1932<span class="param-type">boolean</span>
1933
1934
1935
1936
1937 </td>
1938
1939
1940 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1941
1942 &lt;optional><br>
1943
1944
1945
1946
1947
1948 </td>
1949
1950
1951
1952 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1953
1954 false|true
1955
1956 </td>
1957
1958
1959 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
1960 </tr>
1961
1962
1963
1964 <tr>
1965
1966 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
1967
1968
1969 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1970
1971
1972<span class="param-type">boolean</span>
1973
1974
1975
1976
1977 </td>
1978
1979
1980 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1981
1982 &lt;optional><br>
1983
1984
1985
1986
1987
1988 </td>
1989
1990
1991
1992 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1993
1994 false
1995
1996 </td>
1997
1998
1999 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
2000 </tr>
2001
2002
2003
2004 <tr>
2005
2006 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
2007
2008
2009 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2010
2011
2012<span class="param-type">boolean</span>
2013
2014
2015
2016
2017 </td>
2018
2019
2020 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2021
2022 &lt;optional><br>
2023
2024
2025
2026
2027
2028 </td>
2029
2030
2031
2032 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2033
2034 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
2035
2036 </td>
2037
2038
2039 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
2040 </tr>
2041
2042
2043 </tbody>
2044</table>
2045
2046
2047
2048
2049<dl class="details">
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2080 <dd class="tag-source">
2081 <ul class="dummy">
2082 <li>
2083 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
2084 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-399">line 399</a>
2085 </li>
2086 </ul>
2087 </dd>
2088
2089
2090
2091
2092
2093
2094
2095 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2096 <dd class="tag-todo">
2097 <ul>
2098 <li>Make it compatible with proprietary gamepads (if possible).</li>
2099 </ul>
2100 </dd>
2101
2102</dl>
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116 <h5>Returns:</h5>
2117
2118
2119<div class="param-desc">
2120 <p>If the &quot;allPressed&quot; parameter is false, returns true if the given code or any of the given codes is pressed. If the &quot;allPressed&quot; parameter is set to true, it will return true only in the case that all given axes are being pressed. In the case that the &quot;allPressed&quot; parameter is set to true and the gamepadId parameter is set to an empty string, it will not have in mind whether the axes are pressed by a unique gamepad or by different ones as long as all axes are pressed.</p>
2121</div>
2122
2123
2124
2125<dl>
2126 <dt>
2127 Type
2128 </dt>
2129 <dd>
2130
2131<span class="param-type">boolean</span>
2132
2133
2134
2135 </dd>
2136</dl>
2137
2138
2139
2140
2141
2142</dd>
2143
2144
2145
2146<hr>
2147<dt>
2148 <h4 class="name" id=".isButtonDown"><span class="type-signature">&lt;static> </span>isButtonDown<span class="signature">(buttonCodes [, gamepadId] [, allPressed] [, gamepadIdNumeric] [, caseSensitive] [, avoidProprietary])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2149
2150
2151</dt>
2152<dd>
2153
2154
2155 <div class="description">
2156 <p>Returns whether a given button or buttons are being pressed or not (accepts one key code or more than one with an array).</p>
2157 </div>
2158
2159
2160
2161
2162
2163
2164
2165
2166 <h5>Parameters:</h5>
2167
2168
2169<table class="params table table-striped">
2170 <thead>
2171 <tr>
2172
2173 <th style="width:12%; min-width:110px;">Name</th>
2174
2175
2176 <th style="width:12%; min-width:110px;">Type</th>
2177
2178
2179 <th style="width:12%; min-width:110px;">Argument</th>
2180
2181
2182
2183 <th style="width:12%; min-width:110px;">Default</th>
2184
2185
2186 <th class="last" style="min-width:310px;">Description</th>
2187 </tr>
2188 </thead>
2189
2190 <tbody>
2191
2192
2193 <tr>
2194
2195 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>buttonCodes</code></td>
2196
2197
2198 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2199
2200
2201<span class="param-type">integer</span>
2202|
2203
2204<span class="param-type">array</span>
2205
2206
2207
2208
2209 </td>
2210
2211
2212 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2213
2214
2215
2216
2217
2218 </td>
2219
2220
2221
2222 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2223
2224 </td>
2225
2226
2227 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Number with the button code or array of numbers with the button codes that we want to check.</p></td>
2228 </tr>
2229
2230
2231
2232 <tr>
2233
2234 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadId</code></td>
2235
2236
2237 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2238
2239
2240<span class="param-type">integer</span>
2241|
2242
2243<span class="param-type">string</span>
2244
2245
2246
2247
2248 </td>
2249
2250
2251 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2252
2253 &lt;optional><br>
2254
2255
2256
2257
2258
2259 </td>
2260
2261
2262
2263 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2264
2265 ""
2266
2267 </td>
2268
2269
2270 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If an empty string is given, all gamepads available will be checked. Otherwise, it will only check the gamepad with the given ID or index (if any).</p></td>
2271 </tr>
2272
2273
2274
2275 <tr>
2276
2277 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>allPressed</code></td>
2278
2279
2280 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2281
2282
2283<span class="param-type">boolean</span>
2284
2285
2286
2287
2288 </td>
2289
2290
2291 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2292
2293 &lt;optional><br>
2294
2295
2296
2297
2298
2299 </td>
2300
2301
2302
2303 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2304
2305 false
2306
2307 </td>
2308
2309
2310 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, the function will return true only in the case that all given buttons are being pressed. In the case that this parameter is set to true and the &quot;gamepadId&quot; parameter is set to an empty string, it will not have in mind whether the buttons are pressed by a unique gamepad or by different ones as long as all buttons are pressed.</p></td>
2311 </tr>
2312
2313
2314
2315 <tr>
2316
2317 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>gamepadIdNumeric</code></td>
2318
2319
2320 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2321
2322
2323<span class="param-type">boolean</span>
2324
2325
2326
2327
2328 </td>
2329
2330
2331 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2332
2333 &lt;optional><br>
2334
2335
2336
2337
2338
2339 </td>
2340
2341
2342
2343 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2344
2345 false|true
2346
2347 </td>
2348
2349
2350 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If the &quot;gamepadId&quot; parameter is an empty string, this parameter will be ignored. Otherwise, if the &quot;gamepadId&quot; parameter is not empty and this parameter is set to true, the gamepadId parameter will be converted to integer using &quot;parseInt&quot; internally. By default, this parameter is false unless the given &quot;gamepadId&quot; is numeric.</p></td>
2351 </tr>
2352
2353
2354
2355 <tr>
2356
2357 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>caseSensitive</code></td>
2358
2359
2360 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2361
2362
2363<span class="param-type">boolean</span>
2364
2365
2366
2367
2368 </td>
2369
2370
2371 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2372
2373 &lt;optional><br>
2374
2375
2376
2377
2378
2379 </td>
2380
2381
2382
2383 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2384
2385 false
2386
2387 </td>
2388
2389
2390 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the &quot;gamepadId&quot; given should match the ID of the gamepad being case sensitive or not. This parameter will only be considered when the &quot;gamepadIdNumeric&quot; parameter is set to false.</p></td>
2391 </tr>
2392
2393
2394
2395 <tr>
2396
2397 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>avoidProprietary</code></td>
2398
2399
2400 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2401
2402
2403<span class="param-type">boolean</span>
2404
2405
2406
2407
2408 </td>
2409
2410
2411 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2412
2413 &lt;optional><br>
2414
2415
2416
2417
2418
2419 </td>
2420
2421
2422
2423 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2424
2425 <a href="CB_Configuration.CrossBase.html#.CB_Controllers_avoidProprietary_DEFAULT"><code>CB_Configuration.CrossBase.CB_Controllers_avoidProprietary_DEFAULT</code></a>
2426
2427 </td>
2428
2429
2430 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, proprietary gamepads will not be checked (performance will be faster).</p></td>
2431 </tr>
2432
2433
2434 </tbody>
2435</table>
2436
2437
2438
2439
2440<dl class="details">
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2471 <dd class="tag-source">
2472 <ul class="dummy">
2473 <li>
2474 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
2475 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-540">line 540</a>
2476 </li>
2477 </ul>
2478 </dd>
2479
2480
2481
2482
2483
2484
2485
2486 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2487 <dd class="tag-todo">
2488 <ul>
2489 <li>Make it compatible with proprietary gamepads (if possible).</li>
2490 </ul>
2491 </dd>
2492
2493</dl>
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507 <h5>Returns:</h5>
2508
2509
2510<div class="param-desc">
2511 <p>If the &quot;allPressed&quot; parameter is false, returns true if the given code or any of the given codes is pressed. If the &quot;allPressed&quot; parameter is set to true, it will return true only in the case that all given buttons are being pressed. In the case that the &quot;allPressed&quot; parameter is set to true and the gamepadId parameter is set to an empty string, it will not have in mind whether the buttons are pressed by a unique gamepad or by different ones as long as all buttons are pressed.</p>
2512</div>
2513
2514
2515
2516<dl>
2517 <dt>
2518 Type
2519 </dt>
2520 <dd>
2521
2522<span class="param-type">boolean</span>
2523
2524
2525
2526 </dd>
2527</dl>
2528
2529
2530
2531
2532
2533</dd>
2534
2535
2536
2537<hr>
2538<dt>
2539 <h4 class="name" id=".onConnect"><span class="type-signature">&lt;static> </span>onConnect<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
2540
2541
2542</dt>
2543<dd>
2544
2545
2546 <div class="description">
2547 <p>Sets a function to execute when a gamepad is connected (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/ongamepadconnected">&quot;onGamepadConnected&quot;</a> event is fired) or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">Gamepad API</a>.</p>
2548 </div>
2549
2550
2551
2552
2553
2554
2555
2556
2557 <h5>Parameters:</h5>
2558
2559
2560<table class="params table table-striped">
2561 <thead>
2562 <tr>
2563
2564 <th style="width:12%; min-width:110px;">Name</th>
2565
2566
2567 <th style="width:12%; min-width:110px;">Type</th>
2568
2569
2570 <th style="width:12%; min-width:110px;">Argument</th>
2571
2572
2573
2574 <th style="width:12%; min-width:110px;">Default</th>
2575
2576
2577 <th class="last" style="min-width:310px;">Description</th>
2578 </tr>
2579 </thead>
2580
2581 <tbody>
2582
2583
2584 <tr>
2585
2586 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
2587
2588
2589 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2590
2591
2592<span class="param-type">function</span>
2593|
2594
2595<span class="param-type">null</span>
2596
2597
2598
2599
2600 </td>
2601
2602
2603 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2604
2605
2606
2607
2608
2609 </td>
2610
2611
2612
2613 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2614
2615 </td>
2616
2617
2618 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first parameter received for this function will be the gamepad object affected and the second parameter will be an object containing all current gamepads objects (properties will be the index of each gamepad). If a null value is used, the event will be removed.</p></td>
2619 </tr>
2620
2621
2622
2623 <tr>
2624
2625 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
2626
2627
2628 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2629
2630
2631<span class="param-type">boolean</span>
2632
2633
2634
2635
2636 </td>
2637
2638
2639 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2640
2641 &lt;optional><br>
2642
2643
2644
2645
2646
2647 </td>
2648
2649
2650
2651 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2652
2653 true
2654
2655 </td>
2656
2657
2658 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2659 </tr>
2660
2661
2662 </tbody>
2663</table>
2664
2665
2666
2667
2668<dl class="details">
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2699 <dd class="tag-source">
2700 <ul class="dummy">
2701 <li>
2702 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
2703 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-176">line 176</a>
2704 </li>
2705 </ul>
2706 </dd>
2707
2708
2709
2710
2711
2712
2713
2714 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2715 <dd class="tag-todo">
2716 <ul>
2717 <li>Make it compatible with proprietary ones (if possible).</li>
2718 </ul>
2719 </dd>
2720
2721</dl>
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737</dd>
2738
2739
2740
2741<hr>
2742<dt>
2743 <h4 class="name" id=".onDisconnect"><span class="type-signature">&lt;static> </span>onDisconnect<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
2744
2745
2746</dt>
2747<dd>
2748
2749
2750 <div class="description">
2751 <p>Sets a function to execute when a gamepad is disconnected (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/ongamepaddisconnected">&quot;onGamepadDisconnected&quot;</a> event is fired) or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">Gamepad API</a>.</p>
2752 </div>
2753
2754
2755
2756
2757
2758
2759
2760
2761 <h5>Parameters:</h5>
2762
2763
2764<table class="params table table-striped">
2765 <thead>
2766 <tr>
2767
2768 <th style="width:12%; min-width:110px;">Name</th>
2769
2770
2771 <th style="width:12%; min-width:110px;">Type</th>
2772
2773
2774 <th style="width:12%; min-width:110px;">Argument</th>
2775
2776
2777
2778 <th style="width:12%; min-width:110px;">Default</th>
2779
2780
2781 <th class="last" style="min-width:310px;">Description</th>
2782 </tr>
2783 </thead>
2784
2785 <tbody>
2786
2787
2788 <tr>
2789
2790 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
2791
2792
2793 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2794
2795
2796<span class="param-type">function</span>
2797|
2798
2799<span class="param-type">null</span>
2800
2801
2802
2803
2804 </td>
2805
2806
2807 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2808
2809
2810
2811
2812
2813 </td>
2814
2815
2816
2817 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2818
2819 </td>
2820
2821
2822 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first parameter received for this function will be the gamepad object affected and the second parameter will be an object containing all current gamepads objects (properties will be the index of each gamepad). If a null value is used, the event will be removed.</p></td>
2823 </tr>
2824
2825
2826
2827 <tr>
2828
2829 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
2830
2831
2832 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2833
2834
2835<span class="param-type">boolean</span>
2836
2837
2838
2839
2840 </td>
2841
2842
2843 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2844
2845 &lt;optional><br>
2846
2847
2848
2849
2850
2851 </td>
2852
2853
2854
2855 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2856
2857 true
2858
2859 </td>
2860
2861
2862 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2863 </tr>
2864
2865
2866 </tbody>
2867</table>
2868
2869
2870
2871
2872<dl class="details">
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2903 <dd class="tag-source">
2904 <ul class="dummy">
2905 <li>
2906 <a href="CrossBase_input_controllers_CB_Controllers.js.html">CrossBase/input/controllers/CB_Controllers.js</a>,
2907 <a href="CrossBase_input_controllers_CB_Controllers.js.html#sunlight-1-line-189">line 189</a>
2908 </li>
2909 </ul>
2910 </dd>
2911
2912
2913
2914
2915
2916
2917
2918 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2919 <dd class="tag-todo">
2920 <ul>
2921 <li>Make it compatible with proprietary ones (if possible).</li>
2922 </ul>
2923 </dd>
2924
2925</dl>
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941</dd>
2942
2943 </dl>
2944
2945
2946
2947
2948
2949</article>
2950
2951</section>
2952
2953
2954
2955
2956 </div>
2957 </div>
2958
2959 <div class="clearfix"></div>
2960
2961
2962 <div class="col-md-3">
2963 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
2964 </div>
2965
2966
2967</div>
2968</div>
2969
2970
2971 <div class="modal fade" id="searchResults">
2972 <div class="modal-dialog">
2973 <div class="modal-content">
2974 <div class="modal-header">
2975 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
2976 <h4 class="modal-title">Search results</h4>
2977 </div>
2978 <div class="modal-body"></div>
2979 <div class="modal-footer">
2980 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
2981 </div>
2982 </div><!-- /.modal-content -->
2983 </div><!-- /.modal-dialog -->
2984 </div>
2985
2986
2987<footer>
2988
2989
2990 <span class="copyright">
2991 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
2992 </span>
2993
2994<span class="jsdoc-message">
2995 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
2996
2997 on Mon Feb 3rd 2020
2998
2999 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3000</span>
3001</footer>
3002
3003<script src="scripts/docstrap.lib.js"></script>
3004<script src="scripts/toc.js"></script>
3005
3006 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
3007
3008
3009<script>
3010$( function () {
3011 $( "[id*='$']" ).each( function () {
3012 var $this = $( this );
3013
3014 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
3015 } );
3016
3017 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
3018 var $this = $( this );
3019
3020 var example = $this.find( "code" );
3021 exampleText = example.html();
3022 var lang = /{@lang (.*?)}/.exec( exampleText );
3023 if ( lang && lang[1] ) {
3024 exampleText = exampleText.replace( lang[0], "" );
3025 example.html( exampleText );
3026 lang = lang[1];
3027 } else {
3028 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
3029 lang = langClassMatch ? langClassMatch[1] : "javascript";
3030 }
3031
3032 if ( lang ) {
3033
3034 $this
3035 .addClass( "sunlight-highlight-" + lang )
3036 .addClass( "linenums" )
3037 .html( example.html() );
3038
3039 }
3040 } );
3041
3042 Sunlight.highlightAll( {
3043 lineNumbers : true,
3044 showMenu : true,
3045 enableDoclinks : true
3046 } );
3047
3048 $.catchAnchorLinks( {
3049 navbarOffset: 10
3050 } );
3051 $( "#toc" ).toc( {
3052 anchorName : function ( i, heading, prefix ) {
3053 return $( heading ).attr( "id" ) || ( prefix + i );
3054 },
3055 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
3056 showAndHide : false,
3057 smoothScrolling: true
3058 } );
3059
3060 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
3061 $( '.dropdown-toggle' ).dropdown();
3062
3063 $( "table" ).each( function () {
3064 var $this = $( this );
3065 $this.addClass('table');
3066 } );
3067
3068} );
3069</script>
3070
3071
3072
3073<!--Navigation and Symbol Display-->
3074
3075<script>
3076 $( function () {
3077 $( '#main' ).localScroll( {
3078 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
3079 } );
3080 $( "dt.name" ).each( function () {
3081 var $this = $( this ).find("h4");
3082 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
3083 var dt = $(this);
3084 var children = dt.next( "dd" );
3085
3086 dt.prepend( icon ).css( {cursor : "pointer"} );
3087 dt.addClass( "member-collapsed" ).addClass( "member" );
3088
3089
3090 children.hide();
3091
3092 dt.children().on( "click", function () {
3093 children = dt.next( "dd" );
3094 children.slideToggle( "fast", function () {
3095
3096 if ( children.is( ":visible" ) ) {
3097 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
3098 dt.addClass( "member-open" ).animate( "member-collapsed" );
3099 } else {
3100 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
3101 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
3102 }
3103 } );
3104 } );
3105
3106 } );
3107 } );
3108</script>
3109
3110
3111<!--Google Analytics-->
3112
3113
3114
3115 <script type="text/javascript">
3116 $(document).ready(function() {
3117 SearcherDisplay.init();
3118 });
3119 </script>
3120
3121
3122</body>
3123</html>
\No newline at end of file