UNPKG

17.8 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: WII</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: WII</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 <span class="ancestors"><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a>.</span>
91
92 WII
93 </h2>
94
95
96</header>
97
98
99<article>
100 <div class="container-overview">
101
102
103 <div class="description"><p>Static class to manage the Nintendo Wii remotes (Wiimotes). It will return itself if it is tried to be instantiated. It uses <a href="https://github.com/ryanmcgrath/wii-js">wii-js</a>. NOTE: This class is still under development.</p></div>
104
105
106
107<dl class="details">
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
138 <dd class="tag-source">
139 <ul class="dummy">
140 <li>
141 <a href="CrossBase_input_controllers_CB_Controllers_Proprietary_WII.js.html">CrossBase/input/controllers/CB_Controllers_Proprietary_WII.js</a>,
142 <a href="CrossBase_input_controllers_CB_Controllers_Proprietary_WII.js.html#sunlight-1-line-12">line 12</a>
143 </li>
144 </ul>
145 </dd>
146
147
148
149
150
151
152
153 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
154 <dd class="tag-todo">
155 <ul>
156 <li>Find a way to know how to check when a button is released.</li>
157
158 <li>Update values of CB_Controllers_Proprietary.WII._wiimotes[x].UP, etc.</li>
159
160 <li>Do not forget x and y properties (?).</li>
161 </ul>
162 </dd>
163
164</dl>
165
166
167
168
169 </div>
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184 <h3 class="subsection-title">Methods</h3>
185
186 <dl>
187
188<hr>
189<dt>
190 <h4 class="name" id=".getGamePads"><span class="type-signature">&lt;static> </span>getGamePads<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
191
192
193</dt>
194<dd>
195
196
197 <div class="description">
198 <p>Returns an object with all gamepads simulating the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a>.</p>
199 </div>
200
201
202
203
204
205
206
207
208
209
210<dl class="details">
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
241 <dd class="tag-source">
242 <ul class="dummy">
243 <li>
244 <a href="CrossBase_input_controllers_CB_Controllers_Proprietary_WII.js.html">CrossBase/input/controllers/CB_Controllers_Proprietary_WII.js</a>,
245 <a href="CrossBase_input_controllers_CB_Controllers_Proprietary_WII.js.html#sunlight-1-line-143">line 143</a>
246 </li>
247 </ul>
248 </dd>
249
250
251
252
253
254
255
256</dl>
257
258
259
260
261
262
263
264
265
266
267
268
269
270 <h5>Returns:</h5>
271
272
273<div class="param-desc">
274 <p>Returns an object with the &quot;remotes&quot; property which contains another object whose properties are the index of each device and the value an object with the status of that device. The number of remotes is 4 (index from &quot;0&quot; to &quot;3&quot;). Simulating the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API">GamePad API</a>. Those status objects which are not using the real API will have a property called &quot;usingPrototype&quot; set to true.</p>
275</div>
276
277
278
279<dl>
280 <dt>
281 Type
282 </dt>
283 <dd>
284
285<span class="param-type">Object</span>
286
287
288
289 </dd>
290</dl>
291
292
293
294
295
296</dd>
297
298 </dl>
299
300
301
302
303
304</article>
305
306</section>
307
308
309
310
311 </div>
312 </div>
313
314 <div class="clearfix"></div>
315
316
317 <div class="col-md-3">
318 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
319 </div>
320
321
322</div>
323</div>
324
325
326 <div class="modal fade" id="searchResults">
327 <div class="modal-dialog">
328 <div class="modal-content">
329 <div class="modal-header">
330 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
331 <h4 class="modal-title">Search results</h4>
332 </div>
333 <div class="modal-body"></div>
334 <div class="modal-footer">
335 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
336 </div>
337 </div><!-- /.modal-content -->
338 </div><!-- /.modal-dialog -->
339 </div>
340
341
342<footer>
343
344
345 <span class="copyright">
346 <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>
347 </span>
348
349<span class="jsdoc-message">
350 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
351
352 on Mon Feb 3rd 2020
353
354 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
355</span>
356</footer>
357
358<script src="scripts/docstrap.lib.js"></script>
359<script src="scripts/toc.js"></script>
360
361 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
362
363
364<script>
365$( function () {
366 $( "[id*='$']" ).each( function () {
367 var $this = $( this );
368
369 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
370 } );
371
372 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
373 var $this = $( this );
374
375 var example = $this.find( "code" );
376 exampleText = example.html();
377 var lang = /{@lang (.*?)}/.exec( exampleText );
378 if ( lang && lang[1] ) {
379 exampleText = exampleText.replace( lang[0], "" );
380 example.html( exampleText );
381 lang = lang[1];
382 } else {
383 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
384 lang = langClassMatch ? langClassMatch[1] : "javascript";
385 }
386
387 if ( lang ) {
388
389 $this
390 .addClass( "sunlight-highlight-" + lang )
391 .addClass( "linenums" )
392 .html( example.html() );
393
394 }
395 } );
396
397 Sunlight.highlightAll( {
398 lineNumbers : true,
399 showMenu : true,
400 enableDoclinks : true
401 } );
402
403 $.catchAnchorLinks( {
404 navbarOffset: 10
405 } );
406 $( "#toc" ).toc( {
407 anchorName : function ( i, heading, prefix ) {
408 return $( heading ).attr( "id" ) || ( prefix + i );
409 },
410 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
411 showAndHide : false,
412 smoothScrolling: true
413 } );
414
415 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
416 $( '.dropdown-toggle' ).dropdown();
417
418 $( "table" ).each( function () {
419 var $this = $( this );
420 $this.addClass('table');
421 } );
422
423} );
424</script>
425
426
427
428<!--Navigation and Symbol Display-->
429
430<script>
431 $( function () {
432 $( '#main' ).localScroll( {
433 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
434 } );
435 $( "dt.name" ).each( function () {
436 var $this = $( this ).find("h4");
437 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
438 var dt = $(this);
439 var children = dt.next( "dd" );
440
441 dt.prepend( icon ).css( {cursor : "pointer"} );
442 dt.addClass( "member-collapsed" ).addClass( "member" );
443
444
445 children.hide();
446
447 dt.children().on( "click", function () {
448 children = dt.next( "dd" );
449 children.slideToggle( "fast", function () {
450
451 if ( children.is( ":visible" ) ) {
452 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
453 dt.addClass( "member-open" ).animate( "member-collapsed" );
454 } else {
455 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
456 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
457 }
458 } );
459 } );
460
461 } );
462 } );
463</script>
464
465
466<!--Google Analytics-->
467
468
469
470 <script type="text/javascript">
471 $(document).ready(function() {
472 SearcherDisplay.init();
473 });
474 </script>
475
476
477</body>
478</html>
\No newline at end of file