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 [printable] Namespace: CB_Mouse</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.yeti.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 [printable]</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_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><li><a href="CB_baseSymbols.html">CB_baseSymbols</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_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_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_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_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</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_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</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_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_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>
|
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_Mouse</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 | CB_Mouse
|
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 the mouse and related. It will return itself if it is tried to be instantiated.</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_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
140 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-12">line 12</a>
|
141 | </li>
|
142 | </ul>
|
143 | </dd>
|
144 |
|
145 |
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 | </dl>
|
152 |
|
153 |
|
154 |
|
155 |
|
156 | </div>
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 |
|
167 | <h3 class="subsection-title">Namespaces</h3>
|
168 |
|
169 | <dl>
|
170 | <dt><a href="namespaces.html#CB_Mouse.CursorImage"><a href="CB_Mouse.CursorImage.html">CursorImage</a></a></dt>
|
171 | <dd></dd>
|
172 | </dl>
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 | <h3 class="subsection-title">Methods</h3>
|
179 |
|
180 | <dl>
|
181 |
|
182 | <hr>
|
183 | <dt>
|
184 | <h4 class="name" id=".getButtons"><span class="type-signature"><static> </span>getButtons<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
185 |
|
186 |
|
187 | </dt>
|
188 | <dd>
|
189 |
|
190 |
|
191 | <div class="description">
|
192 | <p>Tells what mouse buttons are down (LEFT, MIDDLE and/or RIGHT buttons).</p>
|
193 | </div>
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 | <dl class="details">
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
235 | <dd class="tag-source">
|
236 | <ul class="dummy">
|
237 | <li>
|
238 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
239 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-301">line 301</a>
|
240 | </li>
|
241 | </ul>
|
242 | </dd>
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 | </dl>
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 |
|
264 | <h5>Returns:</h5>
|
265 |
|
266 |
|
267 | <div class="param-desc">
|
268 | <p>Returns an object using the following format (where "true" means that the button is being pressed): { LEFT : boolean, MIDDLE : boolean, RIGHT : boolean }</p>
|
269 | </div>
|
270 |
|
271 |
|
272 |
|
273 | <dl>
|
274 | <dt>
|
275 | Type
|
276 | </dt>
|
277 | <dd>
|
278 |
|
279 | <span class="param-type">Object</span>
|
280 |
|
281 |
|
282 |
|
283 | </dd>
|
284 | </dl>
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 | </dd>
|
291 |
|
292 |
|
293 |
|
294 | <hr>
|
295 | <dt>
|
296 | <h4 class="name" id=".getLockElement"><span class="type-signature"><static> </span>getLockElement<span class="signature">( [avoidCache])</span><span class="type-signature"> → {Element|null}</span></h4>
|
297 |
|
298 |
|
299 | </dt>
|
300 | <dd>
|
301 |
|
302 |
|
303 | <div class="description">
|
304 | <p>Gets the lock element for the mouse pointer (if any) or null otherwise. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
305 | </div>
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
|
311 |
|
312 |
|
313 |
|
314 | <h5>Parameters:</h5>
|
315 |
|
316 |
|
317 | <table class="params table table-striped">
|
318 | <thead>
|
319 | <tr>
|
320 |
|
321 | <th style="width:12%; min-width:110px;">Name</th>
|
322 |
|
323 |
|
324 | <th style="width:12%; min-width:110px;">Type</th>
|
325 |
|
326 |
|
327 | <th style="width:12%; min-width:110px;">Argument</th>
|
328 |
|
329 |
|
330 |
|
331 | <th style="width:12%; min-width:110px;">Default</th>
|
332 |
|
333 |
|
334 | <th class="last" style="min-width:310px;">Description</th>
|
335 | </tr>
|
336 | </thead>
|
337 |
|
338 | <tbody>
|
339 |
|
340 |
|
341 | <tr>
|
342 |
|
343 | <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>avoidCache</code></td>
|
344 |
|
345 |
|
346 | <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;">
|
347 |
|
348 |
|
349 | <span class="param-type">boolean</span>
|
350 |
|
351 |
|
352 |
|
353 |
|
354 | </td>
|
355 |
|
356 |
|
357 | <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;">
|
358 |
|
359 | <optional><br>
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 | </td>
|
366 |
|
367 |
|
368 |
|
369 | <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;">
|
370 |
|
371 | false
|
372 |
|
373 | </td>
|
374 |
|
375 |
|
376 | <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 false, the returning value will use the previously-cached value (updated when this function is called with this parameter set to true or the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerlockchange_event">onPointerLockChange</a> or analog event is fired or when the <a href="CB_Mouse.html#.lock"><code>CB_Mouse.lock</code></a> or <a href="CB_Mouse.html#.unlock"><code>CB_Mouse.unlock</code></a> functions are called successfully).</p></td>
|
377 | </tr>
|
378 |
|
379 |
|
380 | </tbody>
|
381 | </table>
|
382 |
|
383 |
|
384 |
|
385 |
|
386 | <dl class="details">
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 |
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
417 | <dd class="tag-source">
|
418 | <ul class="dummy">
|
419 | <li>
|
420 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
421 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-691">line 691</a>
|
422 | </li>
|
423 | </ul>
|
424 | </dd>
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 |
|
431 |
|
432 | </dl>
|
433 |
|
434 |
|
435 |
|
436 |
|
437 |
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 | <h5>Returns:</h5>
|
447 |
|
448 |
|
449 | <div class="param-desc">
|
450 | <p>Returns the lock element for the mouse pointer (if any) or null otherwise.</p>
|
451 | </div>
|
452 |
|
453 |
|
454 |
|
455 | <dl>
|
456 | <dt>
|
457 | Type
|
458 | </dt>
|
459 | <dd>
|
460 |
|
461 | <span class="param-type">Element</span>
|
462 | |
|
463 |
|
464 | <span class="param-type">null</span>
|
465 |
|
466 |
|
467 |
|
468 | </dd>
|
469 | </dl>
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 | </dd>
|
476 |
|
477 |
|
478 |
|
479 | <hr>
|
480 | <dt>
|
481 | <h4 class="name" id=".getX"><span class="type-signature"><static> </span>getX<span class="signature">( [e] [, ignoreScroll] [, ignoreLock])</span><span class="type-signature"> → {number}</span></h4>
|
482 |
|
483 |
|
484 | </dt>
|
485 | <dd>
|
486 |
|
487 |
|
488 | <div class="description">
|
489 | <p>Gets and returns the X coordinate (horizontal position) of the mouse (relative to the window in desktop) in pixels.</p>
|
490 | </div>
|
491 |
|
492 |
|
493 |
|
494 |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 | <h5>Parameters:</h5>
|
500 |
|
501 |
|
502 | <table class="params table table-striped">
|
503 | <thead>
|
504 | <tr>
|
505 |
|
506 | <th style="width:12%; min-width:110px;">Name</th>
|
507 |
|
508 |
|
509 | <th style="width:12%; min-width:110px;">Type</th>
|
510 |
|
511 |
|
512 | <th style="width:12%; min-width:110px;">Argument</th>
|
513 |
|
514 |
|
515 |
|
516 | <th style="width:12%; min-width:110px;">Default</th>
|
517 |
|
518 |
|
519 | <th class="last" style="min-width:310px;">Description</th>
|
520 | </tr>
|
521 | </thead>
|
522 |
|
523 | <tbody>
|
524 |
|
525 |
|
526 | <tr>
|
527 |
|
528 | <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>e</code></td>
|
529 |
|
530 |
|
531 | <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;">
|
532 |
|
533 |
|
534 | <span class="param-type">Event</span>
|
535 |
|
536 |
|
537 |
|
538 |
|
539 | </td>
|
540 |
|
541 |
|
542 | <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;">
|
543 |
|
544 | <optional><br>
|
545 |
|
546 |
|
547 |
|
548 |
|
549 |
|
550 | </td>
|
551 |
|
552 |
|
553 |
|
554 | <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;">
|
555 |
|
556 | </td>
|
557 |
|
558 |
|
559 | <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><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">Mouse event object</a>. If not provided, the returning value will use the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p></td>
|
560 | </tr>
|
561 |
|
562 |
|
563 |
|
564 | <tr>
|
565 |
|
566 | <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>ignoreScroll</code></td>
|
567 |
|
568 |
|
569 | <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;">
|
570 |
|
571 |
|
572 | <span class="param-type">boolean</span>
|
573 |
|
574 |
|
575 |
|
576 |
|
577 | </td>
|
578 |
|
579 |
|
580 | <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;">
|
581 |
|
582 | <optional><br>
|
583 |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 | </td>
|
589 |
|
590 |
|
591 |
|
592 | <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;">
|
593 |
|
594 | false
|
595 |
|
596 | </td>
|
597 |
|
598 |
|
599 | <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 horizontal scroll position will not be added to the returning value.</p></td>
|
600 | </tr>
|
601 |
|
602 |
|
603 |
|
604 | <tr>
|
605 |
|
606 | <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>ignoreLock</code></td>
|
607 |
|
608 |
|
609 | <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;">
|
610 |
|
611 |
|
612 | <span class="param-type">boolean</span>
|
613 |
|
614 |
|
615 |
|
616 |
|
617 | </td>
|
618 |
|
619 |
|
620 | <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;">
|
621 |
|
622 | <optional><br>
|
623 |
|
624 |
|
625 |
|
626 |
|
627 |
|
628 | </td>
|
629 |
|
630 |
|
631 |
|
632 | <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;">
|
633 |
|
634 | false
|
635 |
|
636 | </td>
|
637 |
|
638 |
|
639 | <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, it will ignore whether the cursor is being locked or not. Otherwise, if set to false and the cursor is locked, the returning value will only have in mind the position in the locking element.</p></td>
|
640 | </tr>
|
641 |
|
642 |
|
643 | </tbody>
|
644 | </table>
|
645 |
|
646 |
|
647 |
|
648 |
|
649 | <dl class="details">
|
650 |
|
651 |
|
652 |
|
653 |
|
654 |
|
655 |
|
656 |
|
657 |
|
658 |
|
659 |
|
660 |
|
661 |
|
662 |
|
663 |
|
664 |
|
665 |
|
666 |
|
667 |
|
668 |
|
669 |
|
670 |
|
671 |
|
672 |
|
673 |
|
674 |
|
675 |
|
676 |
|
677 |
|
678 |
|
679 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
680 | <dd class="tag-source">
|
681 | <ul class="dummy">
|
682 | <li>
|
683 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
684 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-315">line 315</a>
|
685 | </li>
|
686 | </ul>
|
687 | </dd>
|
688 |
|
689 |
|
690 |
|
691 |
|
692 |
|
693 |
|
694 |
|
695 | </dl>
|
696 |
|
697 |
|
698 |
|
699 |
|
700 |
|
701 |
|
702 |
|
703 |
|
704 |
|
705 |
|
706 |
|
707 |
|
708 |
|
709 | <h5>Returns:</h5>
|
710 |
|
711 |
|
712 | <div class="param-desc">
|
713 | <p>Returns the X coordinate (horizontal position) of the mouse (relative to the window in desktop) in pixels.</p>
|
714 | </div>
|
715 |
|
716 |
|
717 |
|
718 | <dl>
|
719 | <dt>
|
720 | Type
|
721 | </dt>
|
722 | <dd>
|
723 |
|
724 | <span class="param-type">number</span>
|
725 |
|
726 |
|
727 |
|
728 | </dd>
|
729 | </dl>
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 | </dd>
|
736 |
|
737 |
|
738 |
|
739 | <hr>
|
740 | <dt>
|
741 | <h4 class="name" id=".getXMovement"><span class="type-signature"><static> </span>getXMovement<span class="signature">( [e])</span><span class="type-signature"> → {number}</span></h4>
|
742 |
|
743 |
|
744 | </dt>
|
745 | <dd>
|
746 |
|
747 |
|
748 | <div class="description">
|
749 | <p>Returns the current X (horizontal) movement (useful when the mouse pointer is locked) in pixels. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX">MouseEvent.movementX</a>.</p>
|
750 | </div>
|
751 |
|
752 |
|
753 |
|
754 |
|
755 |
|
756 |
|
757 |
|
758 |
|
759 | <h5>Parameters:</h5>
|
760 |
|
761 |
|
762 | <table class="params table table-striped">
|
763 | <thead>
|
764 | <tr>
|
765 |
|
766 | <th style="width:12%; min-width:110px;">Name</th>
|
767 |
|
768 |
|
769 | <th style="width:12%; min-width:110px;">Type</th>
|
770 |
|
771 |
|
772 | <th style="width:12%; min-width:110px;">Argument</th>
|
773 |
|
774 |
|
775 |
|
776 |
|
777 | <th class="last" style="min-width:310px;">Description</th>
|
778 | </tr>
|
779 | </thead>
|
780 |
|
781 | <tbody>
|
782 |
|
783 |
|
784 | <tr>
|
785 |
|
786 | <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>e</code></td>
|
787 |
|
788 |
|
789 | <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;">
|
790 |
|
791 |
|
792 | <span class="param-type">Event</span>
|
793 |
|
794 |
|
795 |
|
796 |
|
797 | </td>
|
798 |
|
799 |
|
800 | <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;">
|
801 |
|
802 | <optional><br>
|
803 |
|
804 |
|
805 |
|
806 |
|
807 |
|
808 | </td>
|
809 |
|
810 |
|
811 |
|
812 |
|
813 | <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><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">Mouse event object</a>. If not provided, the returning value will use the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p></td>
|
814 | </tr>
|
815 |
|
816 |
|
817 | </tbody>
|
818 | </table>
|
819 |
|
820 |
|
821 |
|
822 |
|
823 | <dl class="details">
|
824 |
|
825 |
|
826 |
|
827 |
|
828 |
|
829 |
|
830 |
|
831 |
|
832 |
|
833 |
|
834 |
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 |
|
841 |
|
842 |
|
843 |
|
844 |
|
845 |
|
846 |
|
847 |
|
848 |
|
849 |
|
850 |
|
851 |
|
852 |
|
853 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
854 | <dd class="tag-source">
|
855 | <ul class="dummy">
|
856 | <li>
|
857 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
858 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-475">line 475</a>
|
859 | </li>
|
860 | </ul>
|
861 | </dd>
|
862 |
|
863 |
|
864 |
|
865 |
|
866 |
|
867 |
|
868 |
|
869 | </dl>
|
870 |
|
871 |
|
872 |
|
873 |
|
874 |
|
875 |
|
876 |
|
877 |
|
878 |
|
879 |
|
880 |
|
881 |
|
882 |
|
883 | <h5>Returns:</h5>
|
884 |
|
885 |
|
886 | <div class="param-desc">
|
887 | <p>Returns the current X (horizontal) movement (useful when the mouse pointer is locked) in pixels.</p>
|
888 | </div>
|
889 |
|
890 |
|
891 |
|
892 | <dl>
|
893 | <dt>
|
894 | Type
|
895 | </dt>
|
896 | <dd>
|
897 |
|
898 | <span class="param-type">number</span>
|
899 |
|
900 |
|
901 |
|
902 | </dd>
|
903 | </dl>
|
904 |
|
905 |
|
906 |
|
907 |
|
908 |
|
909 | </dd>
|
910 |
|
911 |
|
912 |
|
913 | <hr>
|
914 | <dt>
|
915 | <h4 class="name" id=".getXRelative"><span class="type-signature"><static> </span>getXRelative<span class="signature">(x [, ignoreScroll])</span><span class="type-signature"> → {number}</span></h4>
|
916 |
|
917 |
|
918 | </dt>
|
919 | <dd>
|
920 |
|
921 |
|
922 | <div class="description">
|
923 | <p>Gets and returns the current X coordinate (horizontal position) in pixels of the mouse relative to a given X position. The returning value uses the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p>
|
924 | </div>
|
925 |
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 |
|
932 |
|
933 | <h5>Parameters:</h5>
|
934 |
|
935 |
|
936 | <table class="params table table-striped">
|
937 | <thead>
|
938 | <tr>
|
939 |
|
940 | <th style="width:12%; min-width:110px;">Name</th>
|
941 |
|
942 |
|
943 | <th style="width:12%; min-width:110px;">Type</th>
|
944 |
|
945 |
|
946 | <th style="width:12%; min-width:110px;">Argument</th>
|
947 |
|
948 |
|
949 |
|
950 | <th style="width:12%; min-width:110px;">Default</th>
|
951 |
|
952 |
|
953 | <th class="last" style="min-width:310px;">Description</th>
|
954 | </tr>
|
955 | </thead>
|
956 |
|
957 | <tbody>
|
958 |
|
959 |
|
960 | <tr>
|
961 |
|
962 | <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>x</code></td>
|
963 |
|
964 |
|
965 | <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;">
|
966 |
|
967 |
|
968 | <span class="param-type">number</span>
|
969 |
|
970 |
|
971 |
|
972 |
|
973 | </td>
|
974 |
|
975 |
|
976 | <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;">
|
977 |
|
978 |
|
979 |
|
980 |
|
981 |
|
982 | </td>
|
983 |
|
984 |
|
985 |
|
986 | <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;">
|
987 |
|
988 | </td>
|
989 |
|
990 |
|
991 | <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 X coordinate (horizontal position) in pixels. The returning value will be calculated relatively to it.</p></td>
|
992 | </tr>
|
993 |
|
994 |
|
995 |
|
996 | <tr>
|
997 |
|
998 | <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>ignoreScroll</code></td>
|
999 |
|
1000 |
|
1001 | <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;">
|
1002 |
|
1003 |
|
1004 | <span class="param-type">boolean</span>
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 | </td>
|
1010 |
|
1011 |
|
1012 | <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;">
|
1013 |
|
1014 | <optional><br>
|
1015 |
|
1016 |
|
1017 |
|
1018 |
|
1019 |
|
1020 | </td>
|
1021 |
|
1022 |
|
1023 |
|
1024 | <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;">
|
1025 |
|
1026 | false
|
1027 |
|
1028 | </td>
|
1029 |
|
1030 |
|
1031 | <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 horizontal scroll position will not be added to the returning value.</p></td>
|
1032 | </tr>
|
1033 |
|
1034 |
|
1035 | </tbody>
|
1036 | </table>
|
1037 |
|
1038 |
|
1039 |
|
1040 |
|
1041 | <dl class="details">
|
1042 |
|
1043 |
|
1044 |
|
1045 |
|
1046 |
|
1047 |
|
1048 |
|
1049 |
|
1050 |
|
1051 |
|
1052 |
|
1053 |
|
1054 |
|
1055 |
|
1056 |
|
1057 |
|
1058 |
|
1059 |
|
1060 |
|
1061 |
|
1062 |
|
1063 |
|
1064 |
|
1065 |
|
1066 |
|
1067 |
|
1068 |
|
1069 |
|
1070 |
|
1071 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1072 | <dd class="tag-source">
|
1073 | <ul class="dummy">
|
1074 | <li>
|
1075 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1076 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-435">line 435</a>
|
1077 | </li>
|
1078 | </ul>
|
1079 | </dd>
|
1080 |
|
1081 |
|
1082 |
|
1083 |
|
1084 |
|
1085 |
|
1086 |
|
1087 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1088 | <dd class="tag-todo">
|
1089 | <ul>
|
1090 | <li>Think about allowing to define an "e" parameter with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a>.</li>
|
1091 | </ul>
|
1092 | </dd>
|
1093 |
|
1094 | </dl>
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 |
|
1100 |
|
1101 |
|
1102 |
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 | <h5>Returns:</h5>
|
1109 |
|
1110 |
|
1111 | <div class="param-desc">
|
1112 | <p>Returns the current X coordinate (horizontal position) in pixels of the mouse relative to a given X position.</p>
|
1113 | </div>
|
1114 |
|
1115 |
|
1116 |
|
1117 | <dl>
|
1118 | <dt>
|
1119 | Type
|
1120 | </dt>
|
1121 | <dd>
|
1122 |
|
1123 | <span class="param-type">number</span>
|
1124 |
|
1125 |
|
1126 |
|
1127 | </dd>
|
1128 | </dl>
|
1129 |
|
1130 |
|
1131 |
|
1132 |
|
1133 |
|
1134 | </dd>
|
1135 |
|
1136 |
|
1137 |
|
1138 | <hr>
|
1139 | <dt>
|
1140 | <h4 class="name" id=".getY"><span class="type-signature"><static> </span>getY<span class="signature">( [e] [, ignoreScroll] [, ignoreLock])</span><span class="type-signature"> → {number}</span></h4>
|
1141 |
|
1142 |
|
1143 | </dt>
|
1144 | <dd>
|
1145 |
|
1146 |
|
1147 | <div class="description">
|
1148 | <p>Gets and returns the Y coordinate (vertical position) of the mouse (relative to the window in desktop) in pixels.</p>
|
1149 | </div>
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 | <h5>Parameters:</h5>
|
1159 |
|
1160 |
|
1161 | <table class="params table table-striped">
|
1162 | <thead>
|
1163 | <tr>
|
1164 |
|
1165 | <th style="width:12%; min-width:110px;">Name</th>
|
1166 |
|
1167 |
|
1168 | <th style="width:12%; min-width:110px;">Type</th>
|
1169 |
|
1170 |
|
1171 | <th style="width:12%; min-width:110px;">Argument</th>
|
1172 |
|
1173 |
|
1174 |
|
1175 | <th style="width:12%; min-width:110px;">Default</th>
|
1176 |
|
1177 |
|
1178 | <th class="last" style="min-width:310px;">Description</th>
|
1179 | </tr>
|
1180 | </thead>
|
1181 |
|
1182 | <tbody>
|
1183 |
|
1184 |
|
1185 | <tr>
|
1186 |
|
1187 | <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>e</code></td>
|
1188 |
|
1189 |
|
1190 | <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;">
|
1191 |
|
1192 |
|
1193 | <span class="param-type">Event</span>
|
1194 |
|
1195 |
|
1196 |
|
1197 |
|
1198 | </td>
|
1199 |
|
1200 |
|
1201 | <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;">
|
1202 |
|
1203 | <optional><br>
|
1204 |
|
1205 |
|
1206 |
|
1207 |
|
1208 |
|
1209 | </td>
|
1210 |
|
1211 |
|
1212 |
|
1213 | <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;">
|
1214 |
|
1215 | </td>
|
1216 |
|
1217 |
|
1218 | <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><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">Mouse event object</a>. If not provided, the returning value will use the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p></td>
|
1219 | </tr>
|
1220 |
|
1221 |
|
1222 |
|
1223 | <tr>
|
1224 |
|
1225 | <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>ignoreScroll</code></td>
|
1226 |
|
1227 |
|
1228 | <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;">
|
1229 |
|
1230 |
|
1231 | <span class="param-type">boolean</span>
|
1232 |
|
1233 |
|
1234 |
|
1235 |
|
1236 | </td>
|
1237 |
|
1238 |
|
1239 | <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;">
|
1240 |
|
1241 | <optional><br>
|
1242 |
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 | </td>
|
1248 |
|
1249 |
|
1250 |
|
1251 | <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;">
|
1252 |
|
1253 | false
|
1254 |
|
1255 | </td>
|
1256 |
|
1257 |
|
1258 | <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 vertical scroll position will not be added to the returning value.</p></td>
|
1259 | </tr>
|
1260 |
|
1261 |
|
1262 |
|
1263 | <tr>
|
1264 |
|
1265 | <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>ignoreLock</code></td>
|
1266 |
|
1267 |
|
1268 | <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;">
|
1269 |
|
1270 |
|
1271 | <span class="param-type">boolean</span>
|
1272 |
|
1273 |
|
1274 |
|
1275 |
|
1276 | </td>
|
1277 |
|
1278 |
|
1279 | <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;">
|
1280 |
|
1281 | <optional><br>
|
1282 |
|
1283 |
|
1284 |
|
1285 |
|
1286 |
|
1287 | </td>
|
1288 |
|
1289 |
|
1290 |
|
1291 | <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;">
|
1292 |
|
1293 | false
|
1294 |
|
1295 | </td>
|
1296 |
|
1297 |
|
1298 | <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, it will ignore whether the cursor is being locked or not. Otherwise, if set to false and the cursor is locked, the returning value will only have in mind the position in the locking element.</p></td>
|
1299 | </tr>
|
1300 |
|
1301 |
|
1302 | </tbody>
|
1303 | </table>
|
1304 |
|
1305 |
|
1306 |
|
1307 |
|
1308 | <dl class="details">
|
1309 |
|
1310 |
|
1311 |
|
1312 |
|
1313 |
|
1314 |
|
1315 |
|
1316 |
|
1317 |
|
1318 |
|
1319 |
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 |
|
1325 |
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 |
|
1332 |
|
1333 |
|
1334 |
|
1335 |
|
1336 |
|
1337 |
|
1338 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1339 | <dd class="tag-source">
|
1340 | <ul class="dummy">
|
1341 | <li>
|
1342 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1343 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-375">line 375</a>
|
1344 | </li>
|
1345 | </ul>
|
1346 | </dd>
|
1347 |
|
1348 |
|
1349 |
|
1350 |
|
1351 |
|
1352 |
|
1353 |
|
1354 | </dl>
|
1355 |
|
1356 |
|
1357 |
|
1358 |
|
1359 |
|
1360 |
|
1361 |
|
1362 |
|
1363 |
|
1364 |
|
1365 |
|
1366 |
|
1367 |
|
1368 | <h5>Returns:</h5>
|
1369 |
|
1370 |
|
1371 | <div class="param-desc">
|
1372 | <p>Returns the Y coordinate (vertical position) of the mouse (relative to the window in desktop) in pixels.</p>
|
1373 | </div>
|
1374 |
|
1375 |
|
1376 |
|
1377 | <dl>
|
1378 | <dt>
|
1379 | Type
|
1380 | </dt>
|
1381 | <dd>
|
1382 |
|
1383 | <span class="param-type">number</span>
|
1384 |
|
1385 |
|
1386 |
|
1387 | </dd>
|
1388 | </dl>
|
1389 |
|
1390 |
|
1391 |
|
1392 |
|
1393 |
|
1394 | </dd>
|
1395 |
|
1396 |
|
1397 |
|
1398 | <hr>
|
1399 | <dt>
|
1400 | <h4 class="name" id=".getYMovement"><span class="type-signature"><static> </span>getYMovement<span class="signature">( [e])</span><span class="type-signature"> → {number}</span></h4>
|
1401 |
|
1402 |
|
1403 | </dt>
|
1404 | <dd>
|
1405 |
|
1406 |
|
1407 | <div class="description">
|
1408 | <p>Returns the current Y (vertical) movement (useful when the mouse pointer is locked) in pixels. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementY">MouseEvent.movementY</a>.</p>
|
1409 | </div>
|
1410 |
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 |
|
1416 |
|
1417 |
|
1418 | <h5>Parameters:</h5>
|
1419 |
|
1420 |
|
1421 | <table class="params table table-striped">
|
1422 | <thead>
|
1423 | <tr>
|
1424 |
|
1425 | <th style="width:12%; min-width:110px;">Name</th>
|
1426 |
|
1427 |
|
1428 | <th style="width:12%; min-width:110px;">Type</th>
|
1429 |
|
1430 |
|
1431 | <th style="width:12%; min-width:110px;">Argument</th>
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 | <th class="last" style="min-width:310px;">Description</th>
|
1437 | </tr>
|
1438 | </thead>
|
1439 |
|
1440 | <tbody>
|
1441 |
|
1442 |
|
1443 | <tr>
|
1444 |
|
1445 | <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>e</code></td>
|
1446 |
|
1447 |
|
1448 | <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;">
|
1449 |
|
1450 |
|
1451 | <span class="param-type">Event</span>
|
1452 |
|
1453 |
|
1454 |
|
1455 |
|
1456 | </td>
|
1457 |
|
1458 |
|
1459 | <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;">
|
1460 |
|
1461 | <optional><br>
|
1462 |
|
1463 |
|
1464 |
|
1465 |
|
1466 |
|
1467 | </td>
|
1468 |
|
1469 |
|
1470 |
|
1471 |
|
1472 | <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><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">Mouse event object</a>. If not provided, the returning value will use the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p></td>
|
1473 | </tr>
|
1474 |
|
1475 |
|
1476 | </tbody>
|
1477 | </table>
|
1478 |
|
1479 |
|
1480 |
|
1481 |
|
1482 | <dl class="details">
|
1483 |
|
1484 |
|
1485 |
|
1486 |
|
1487 |
|
1488 |
|
1489 |
|
1490 |
|
1491 |
|
1492 |
|
1493 |
|
1494 |
|
1495 |
|
1496 |
|
1497 |
|
1498 |
|
1499 |
|
1500 |
|
1501 |
|
1502 |
|
1503 |
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 |
|
1510 |
|
1511 |
|
1512 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1513 | <dd class="tag-source">
|
1514 | <ul class="dummy">
|
1515 | <li>
|
1516 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1517 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-489">line 489</a>
|
1518 | </li>
|
1519 | </ul>
|
1520 | </dd>
|
1521 |
|
1522 |
|
1523 |
|
1524 |
|
1525 |
|
1526 |
|
1527 |
|
1528 | </dl>
|
1529 |
|
1530 |
|
1531 |
|
1532 |
|
1533 |
|
1534 |
|
1535 |
|
1536 |
|
1537 |
|
1538 |
|
1539 |
|
1540 |
|
1541 |
|
1542 | <h5>Returns:</h5>
|
1543 |
|
1544 |
|
1545 | <div class="param-desc">
|
1546 | <p>Returns the current Y (vertical) movement (useful when the mouse pointer is locked) in pixels.</p>
|
1547 | </div>
|
1548 |
|
1549 |
|
1550 |
|
1551 | <dl>
|
1552 | <dt>
|
1553 | Type
|
1554 | </dt>
|
1555 | <dd>
|
1556 |
|
1557 | <span class="param-type">number</span>
|
1558 |
|
1559 |
|
1560 |
|
1561 | </dd>
|
1562 | </dl>
|
1563 |
|
1564 |
|
1565 |
|
1566 |
|
1567 |
|
1568 | </dd>
|
1569 |
|
1570 |
|
1571 |
|
1572 | <hr>
|
1573 | <dt>
|
1574 | <h4 class="name" id=".getYRelative"><span class="type-signature"><static> </span>getYRelative<span class="signature">(y [, ignoreScroll])</span><span class="type-signature"> → {number}</span></h4>
|
1575 |
|
1576 |
|
1577 | </dt>
|
1578 | <dd>
|
1579 |
|
1580 |
|
1581 | <div class="description">
|
1582 | <p>Gets and returns the current Y coordinate (vertical position) in pixels of the mouse relative to a given Y position. The returning value uses the previously-cached value (updated the last time that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event was fired).</p>
|
1583 | </div>
|
1584 |
|
1585 |
|
1586 |
|
1587 |
|
1588 |
|
1589 |
|
1590 |
|
1591 |
|
1592 | <h5>Parameters:</h5>
|
1593 |
|
1594 |
|
1595 | <table class="params table table-striped">
|
1596 | <thead>
|
1597 | <tr>
|
1598 |
|
1599 | <th style="width:12%; min-width:110px;">Name</th>
|
1600 |
|
1601 |
|
1602 | <th style="width:12%; min-width:110px;">Type</th>
|
1603 |
|
1604 |
|
1605 | <th style="width:12%; min-width:110px;">Argument</th>
|
1606 |
|
1607 |
|
1608 |
|
1609 | <th style="width:12%; min-width:110px;">Default</th>
|
1610 |
|
1611 |
|
1612 | <th class="last" style="min-width:310px;">Description</th>
|
1613 | </tr>
|
1614 | </thead>
|
1615 |
|
1616 | <tbody>
|
1617 |
|
1618 |
|
1619 | <tr>
|
1620 |
|
1621 | <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>y</code></td>
|
1622 |
|
1623 |
|
1624 | <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;">
|
1625 |
|
1626 |
|
1627 | <span class="param-type">number</span>
|
1628 |
|
1629 |
|
1630 |
|
1631 |
|
1632 | </td>
|
1633 |
|
1634 |
|
1635 | <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;">
|
1636 |
|
1637 |
|
1638 |
|
1639 |
|
1640 |
|
1641 | </td>
|
1642 |
|
1643 |
|
1644 |
|
1645 | <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;">
|
1646 |
|
1647 | </td>
|
1648 |
|
1649 |
|
1650 | <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 Y coordinate (vertical position) in pixels. The returning value will be calculated relatively to it.</p></td>
|
1651 | </tr>
|
1652 |
|
1653 |
|
1654 |
|
1655 | <tr>
|
1656 |
|
1657 | <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>ignoreScroll</code></td>
|
1658 |
|
1659 |
|
1660 | <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;">
|
1661 |
|
1662 |
|
1663 | <span class="param-type">boolean</span>
|
1664 |
|
1665 |
|
1666 |
|
1667 |
|
1668 | </td>
|
1669 |
|
1670 |
|
1671 | <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;">
|
1672 |
|
1673 | <optional><br>
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 | </td>
|
1680 |
|
1681 |
|
1682 |
|
1683 | <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;">
|
1684 |
|
1685 | false
|
1686 |
|
1687 | </td>
|
1688 |
|
1689 |
|
1690 | <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 vertical scroll position will not be added to the returning value.</p></td>
|
1691 | </tr>
|
1692 |
|
1693 |
|
1694 | </tbody>
|
1695 | </table>
|
1696 |
|
1697 |
|
1698 |
|
1699 |
|
1700 | <dl class="details">
|
1701 |
|
1702 |
|
1703 |
|
1704 |
|
1705 |
|
1706 |
|
1707 |
|
1708 |
|
1709 |
|
1710 |
|
1711 |
|
1712 |
|
1713 |
|
1714 |
|
1715 |
|
1716 |
|
1717 |
|
1718 |
|
1719 |
|
1720 |
|
1721 |
|
1722 |
|
1723 |
|
1724 |
|
1725 |
|
1726 |
|
1727 |
|
1728 |
|
1729 |
|
1730 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1731 | <dd class="tag-source">
|
1732 | <ul class="dummy">
|
1733 | <li>
|
1734 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1735 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-456">line 456</a>
|
1736 | </li>
|
1737 | </ul>
|
1738 | </dd>
|
1739 |
|
1740 |
|
1741 |
|
1742 |
|
1743 |
|
1744 |
|
1745 |
|
1746 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1747 | <dd class="tag-todo">
|
1748 | <ul>
|
1749 | <li>Think about allowing to define an "e" parameter with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a>.</li>
|
1750 | </ul>
|
1751 | </dd>
|
1752 |
|
1753 | </dl>
|
1754 |
|
1755 |
|
1756 |
|
1757 |
|
1758 |
|
1759 |
|
1760 |
|
1761 |
|
1762 |
|
1763 |
|
1764 |
|
1765 |
|
1766 |
|
1767 | <h5>Returns:</h5>
|
1768 |
|
1769 |
|
1770 | <div class="param-desc">
|
1771 | <p>Returns the current Y coordinate (vertical position) in pixels of the mouse relative to a given Y position.</p>
|
1772 | </div>
|
1773 |
|
1774 |
|
1775 |
|
1776 | <dl>
|
1777 | <dt>
|
1778 | Type
|
1779 | </dt>
|
1780 | <dd>
|
1781 |
|
1782 | <span class="param-type">number</span>
|
1783 |
|
1784 |
|
1785 |
|
1786 | </dd>
|
1787 | </dl>
|
1788 |
|
1789 |
|
1790 |
|
1791 |
|
1792 |
|
1793 | </dd>
|
1794 |
|
1795 |
|
1796 |
|
1797 | <hr>
|
1798 | <dt>
|
1799 | <h4 class="name" id=".hide"><span class="type-signature"><static> </span>hide<span class="signature">( [element] [, recursive])</span><span class="type-signature"></span></h4>
|
1800 |
|
1801 |
|
1802 | </dt>
|
1803 | <dd>
|
1804 |
|
1805 |
|
1806 | <div class="description">
|
1807 | <p>Hides the mouse cursor in a given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> by changing its internal CSS code of the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">style.cursor</a> property.</p>
|
1808 | </div>
|
1809 |
|
1810 |
|
1811 |
|
1812 |
|
1813 |
|
1814 |
|
1815 |
|
1816 |
|
1817 | <h5>Parameters:</h5>
|
1818 |
|
1819 |
|
1820 | <table class="params table table-striped">
|
1821 | <thead>
|
1822 | <tr>
|
1823 |
|
1824 | <th style="width:12%; min-width:110px;">Name</th>
|
1825 |
|
1826 |
|
1827 | <th style="width:12%; min-width:110px;">Type</th>
|
1828 |
|
1829 |
|
1830 | <th style="width:12%; min-width:110px;">Argument</th>
|
1831 |
|
1832 |
|
1833 |
|
1834 | <th style="width:12%; min-width:110px;">Default</th>
|
1835 |
|
1836 |
|
1837 | <th class="last" style="min-width:310px;">Description</th>
|
1838 | </tr>
|
1839 | </thead>
|
1840 |
|
1841 | <tbody>
|
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>element</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">Element</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 | <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 | document.body
|
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>If a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse cursor will be hidden when it is over this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>. Otherwise, it will be hidden in the whole document (using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/body">document.body</a> as element).</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>recursive</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 | <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 | true
|
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 it is set to true, all the child <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM elements</a> will also be affected.</p></td>
|
1920 | </tr>
|
1921 |
|
1922 |
|
1923 | </tbody>
|
1924 | </table>
|
1925 |
|
1926 |
|
1927 |
|
1928 |
|
1929 | <dl class="details">
|
1930 |
|
1931 |
|
1932 |
|
1933 |
|
1934 |
|
1935 |
|
1936 |
|
1937 |
|
1938 |
|
1939 |
|
1940 |
|
1941 |
|
1942 |
|
1943 |
|
1944 |
|
1945 |
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 |
|
1952 |
|
1953 |
|
1954 |
|
1955 |
|
1956 |
|
1957 |
|
1958 |
|
1959 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1960 | <dd class="tag-source">
|
1961 | <ul class="dummy">
|
1962 | <li>
|
1963 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1964 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1009">line 1009</a>
|
1965 | </li>
|
1966 | </ul>
|
1967 | </dd>
|
1968 |
|
1969 |
|
1970 |
|
1971 |
|
1972 |
|
1973 |
|
1974 |
|
1975 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1976 | <dd class="tag-todo">
|
1977 | <ul>
|
1978 | <li>Check whether the path used in the "url" is right or not (now it uses the <a href="global.html#CB_scriptPath"><code>CB_scriptPath</code></a> variable).</li>
|
1979 | </ul>
|
1980 | </dd>
|
1981 |
|
1982 | </dl>
|
1983 |
|
1984 |
|
1985 |
|
1986 |
|
1987 |
|
1988 |
|
1989 |
|
1990 |
|
1991 |
|
1992 |
|
1993 |
|
1994 |
|
1995 |
|
1996 |
|
1997 |
|
1998 | </dd>
|
1999 |
|
2000 |
|
2001 |
|
2002 | <hr>
|
2003 | <dt>
|
2004 | <h4 class="name" id=".isLockSupported"><span class="type-signature"><static> </span>isLockSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
2005 |
|
2006 |
|
2007 | </dt>
|
2008 | <dd>
|
2009 |
|
2010 |
|
2011 | <div class="description">
|
2012 | <p>Tells whether mouse pointer lock is supported or not. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
2013 | </div>
|
2014 |
|
2015 |
|
2016 |
|
2017 |
|
2018 |
|
2019 |
|
2020 |
|
2021 |
|
2022 |
|
2023 |
|
2024 | <dl class="details">
|
2025 |
|
2026 |
|
2027 |
|
2028 |
|
2029 |
|
2030 |
|
2031 |
|
2032 |
|
2033 |
|
2034 |
|
2035 |
|
2036 |
|
2037 |
|
2038 |
|
2039 |
|
2040 |
|
2041 |
|
2042 |
|
2043 |
|
2044 |
|
2045 |
|
2046 |
|
2047 |
|
2048 |
|
2049 |
|
2050 |
|
2051 |
|
2052 |
|
2053 |
|
2054 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2055 | <dd class="tag-source">
|
2056 | <ul class="dummy">
|
2057 | <li>
|
2058 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
2059 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-639">line 639</a>
|
2060 | </li>
|
2061 | </ul>
|
2062 | </dd>
|
2063 |
|
2064 |
|
2065 |
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 | </dl>
|
2071 |
|
2072 |
|
2073 |
|
2074 |
|
2075 |
|
2076 |
|
2077 |
|
2078 |
|
2079 |
|
2080 |
|
2081 |
|
2082 |
|
2083 |
|
2084 | <h5>Returns:</h5>
|
2085 |
|
2086 |
|
2087 | <div class="param-desc">
|
2088 | <p>Returns whether mouse pointer lock is supported or not.</p>
|
2089 | </div>
|
2090 |
|
2091 |
|
2092 |
|
2093 | <dl>
|
2094 | <dt>
|
2095 | Type
|
2096 | </dt>
|
2097 | <dd>
|
2098 |
|
2099 | <span class="param-type">boolean</span>
|
2100 |
|
2101 |
|
2102 |
|
2103 | </dd>
|
2104 | </dl>
|
2105 |
|
2106 |
|
2107 |
|
2108 |
|
2109 |
|
2110 | </dd>
|
2111 |
|
2112 |
|
2113 |
|
2114 | <hr>
|
2115 | <dt>
|
2116 | <h4 class="name" id=".isLocked"><span class="type-signature"><static> </span>isLocked<span class="signature">( [avoidCache])</span><span class="type-signature"> → {boolean}</span></h4>
|
2117 |
|
2118 |
|
2119 | </dt>
|
2120 | <dd>
|
2121 |
|
2122 |
|
2123 | <div class="description">
|
2124 | <p>Tells whether the mouse pointer is locked or not. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
2125 | </div>
|
2126 |
|
2127 |
|
2128 |
|
2129 |
|
2130 |
|
2131 |
|
2132 |
|
2133 |
|
2134 | <h5>Parameters:</h5>
|
2135 |
|
2136 |
|
2137 | <table class="params table table-striped">
|
2138 | <thead>
|
2139 | <tr>
|
2140 |
|
2141 | <th style="width:12%; min-width:110px;">Name</th>
|
2142 |
|
2143 |
|
2144 | <th style="width:12%; min-width:110px;">Type</th>
|
2145 |
|
2146 |
|
2147 | <th style="width:12%; min-width:110px;">Argument</th>
|
2148 |
|
2149 |
|
2150 |
|
2151 | <th style="width:12%; min-width:110px;">Default</th>
|
2152 |
|
2153 |
|
2154 | <th class="last" style="min-width:310px;">Description</th>
|
2155 | </tr>
|
2156 | </thead>
|
2157 |
|
2158 | <tbody>
|
2159 |
|
2160 |
|
2161 | <tr>
|
2162 |
|
2163 | <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>avoidCache</code></td>
|
2164 |
|
2165 |
|
2166 | <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;">
|
2167 |
|
2168 |
|
2169 | <span class="param-type">boolean</span>
|
2170 |
|
2171 |
|
2172 |
|
2173 |
|
2174 | </td>
|
2175 |
|
2176 |
|
2177 | <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;">
|
2178 |
|
2179 | <optional><br>
|
2180 |
|
2181 |
|
2182 |
|
2183 |
|
2184 |
|
2185 | </td>
|
2186 |
|
2187 |
|
2188 |
|
2189 | <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;">
|
2190 |
|
2191 | false
|
2192 |
|
2193 | </td>
|
2194 |
|
2195 |
|
2196 | <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>Used as the parameter to call the <a href="CB_Mouse.html#.getLockElement"><code>CB_Mouse.getLockElement</code></a> function internally.</p></td>
|
2197 | </tr>
|
2198 |
|
2199 |
|
2200 | </tbody>
|
2201 | </table>
|
2202 |
|
2203 |
|
2204 |
|
2205 |
|
2206 | <dl class="details">
|
2207 |
|
2208 |
|
2209 |
|
2210 |
|
2211 |
|
2212 |
|
2213 |
|
2214 |
|
2215 |
|
2216 |
|
2217 |
|
2218 |
|
2219 |
|
2220 |
|
2221 |
|
2222 |
|
2223 |
|
2224 |
|
2225 |
|
2226 |
|
2227 |
|
2228 |
|
2229 |
|
2230 |
|
2231 |
|
2232 |
|
2233 |
|
2234 |
|
2235 |
|
2236 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2237 | <dd class="tag-source">
|
2238 | <ul class="dummy">
|
2239 | <li>
|
2240 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
2241 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-655">line 655</a>
|
2242 | </li>
|
2243 | </ul>
|
2244 | </dd>
|
2245 |
|
2246 |
|
2247 |
|
2248 |
|
2249 |
|
2250 |
|
2251 |
|
2252 | </dl>
|
2253 |
|
2254 |
|
2255 |
|
2256 |
|
2257 |
|
2258 |
|
2259 |
|
2260 |
|
2261 |
|
2262 |
|
2263 |
|
2264 |
|
2265 |
|
2266 | <h5>Returns:</h5>
|
2267 |
|
2268 |
|
2269 | <div class="param-desc">
|
2270 | <p>Returns whether the mouse pointer is locked or not.</p>
|
2271 | </div>
|
2272 |
|
2273 |
|
2274 |
|
2275 | <dl>
|
2276 | <dt>
|
2277 | Type
|
2278 | </dt>
|
2279 | <dd>
|
2280 |
|
2281 | <span class="param-type">boolean</span>
|
2282 |
|
2283 |
|
2284 |
|
2285 | </dd>
|
2286 | </dl>
|
2287 |
|
2288 |
|
2289 |
|
2290 |
|
2291 |
|
2292 | </dd>
|
2293 |
|
2294 |
|
2295 |
|
2296 | <hr>
|
2297 | <dt>
|
2298 | <h4 class="name" id=".isOverCircle"><span class="type-signature"><static> </span>isOverCircle<span class="signature">(centreX, centreY, radius [, element])</span><span class="type-signature"> → {boolean}</span></h4>
|
2299 |
|
2300 |
|
2301 | </dt>
|
2302 | <dd>
|
2303 |
|
2304 |
|
2305 | <div class="description">
|
2306 | <p>Tells whether the mouse is over a given circle or not.</p>
|
2307 | </div>
|
2308 |
|
2309 |
|
2310 |
|
2311 |
|
2312 |
|
2313 |
|
2314 |
|
2315 |
|
2316 | <h5>Parameters:</h5>
|
2317 |
|
2318 |
|
2319 | <table class="params table table-striped">
|
2320 | <thead>
|
2321 | <tr>
|
2322 |
|
2323 | <th style="width:12%; min-width:110px;">Name</th>
|
2324 |
|
2325 |
|
2326 | <th style="width:12%; min-width:110px;">Type</th>
|
2327 |
|
2328 |
|
2329 | <th style="width:12%; min-width:110px;">Argument</th>
|
2330 |
|
2331 |
|
2332 |
|
2333 |
|
2334 | <th class="last" style="min-width:310px;">Description</th>
|
2335 | </tr>
|
2336 | </thead>
|
2337 |
|
2338 | <tbody>
|
2339 |
|
2340 |
|
2341 | <tr>
|
2342 |
|
2343 | <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>centreX</code></td>
|
2344 |
|
2345 |
|
2346 | <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;">
|
2347 |
|
2348 |
|
2349 | <span class="param-type">number</span>
|
2350 |
|
2351 |
|
2352 |
|
2353 |
|
2354 | </td>
|
2355 |
|
2356 |
|
2357 | <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;">
|
2358 |
|
2359 |
|
2360 |
|
2361 |
|
2362 |
|
2363 | </td>
|
2364 |
|
2365 |
|
2366 |
|
2367 |
|
2368 | <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 X coordinate (horizontal position) of the center of the circle in pixels.</p></td>
|
2369 | </tr>
|
2370 |
|
2371 |
|
2372 |
|
2373 | <tr>
|
2374 |
|
2375 | <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>centreY</code></td>
|
2376 |
|
2377 |
|
2378 | <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;">
|
2379 |
|
2380 |
|
2381 | <span class="param-type">number</span>
|
2382 |
|
2383 |
|
2384 |
|
2385 |
|
2386 | </td>
|
2387 |
|
2388 |
|
2389 | <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;">
|
2390 |
|
2391 |
|
2392 |
|
2393 |
|
2394 |
|
2395 | </td>
|
2396 |
|
2397 |
|
2398 |
|
2399 |
|
2400 | <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 Y coordinate (vertical position) of the center of the circle in pixels.</p></td>
|
2401 | </tr>
|
2402 |
|
2403 |
|
2404 |
|
2405 | <tr>
|
2406 |
|
2407 | <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>radius</code></td>
|
2408 |
|
2409 |
|
2410 | <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;">
|
2411 |
|
2412 |
|
2413 | <span class="param-type">number</span>
|
2414 |
|
2415 |
|
2416 |
|
2417 |
|
2418 | </td>
|
2419 |
|
2420 |
|
2421 | <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;">
|
2422 |
|
2423 |
|
2424 |
|
2425 |
|
2426 |
|
2427 | </td>
|
2428 |
|
2429 |
|
2430 |
|
2431 |
|
2432 | <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 radius of the circle in pixels.</p></td>
|
2433 | </tr>
|
2434 |
|
2435 |
|
2436 |
|
2437 | <tr>
|
2438 |
|
2439 | <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>element</code></td>
|
2440 |
|
2441 |
|
2442 | <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;">
|
2443 |
|
2444 |
|
2445 | <span class="param-type">Element</span>
|
2446 |
|
2447 |
|
2448 |
|
2449 |
|
2450 | </td>
|
2451 |
|
2452 |
|
2453 | <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;">
|
2454 |
|
2455 | <optional><br>
|
2456 |
|
2457 |
|
2458 |
|
2459 |
|
2460 |
|
2461 | </td>
|
2462 |
|
2463 |
|
2464 |
|
2465 |
|
2466 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse coordinates will be calculated relatively to the position of this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>.</p></td>
|
2467 | </tr>
|
2468 |
|
2469 |
|
2470 | </tbody>
|
2471 | </table>
|
2472 |
|
2473 |
|
2474 |
|
2475 |
|
2476 | <dl class="details">
|
2477 |
|
2478 |
|
2479 |
|
2480 |
|
2481 |
|
2482 |
|
2483 |
|
2484 |
|
2485 |
|
2486 |
|
2487 |
|
2488 |
|
2489 |
|
2490 |
|
2491 |
|
2492 |
|
2493 |
|
2494 |
|
2495 |
|
2496 |
|
2497 |
|
2498 |
|
2499 |
|
2500 |
|
2501 |
|
2502 |
|
2503 |
|
2504 |
|
2505 |
|
2506 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2507 | <dd class="tag-source">
|
2508 | <ul class="dummy">
|
2509 | <li>
|
2510 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
2511 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-957">line 957</a>
|
2512 | </li>
|
2513 | </ul>
|
2514 | </dd>
|
2515 |
|
2516 |
|
2517 |
|
2518 |
|
2519 |
|
2520 |
|
2521 |
|
2522 | </dl>
|
2523 |
|
2524 |
|
2525 |
|
2526 |
|
2527 |
|
2528 |
|
2529 |
|
2530 |
|
2531 |
|
2532 |
|
2533 |
|
2534 |
|
2535 |
|
2536 | <h5>Returns:</h5>
|
2537 |
|
2538 |
|
2539 | <div class="param-desc">
|
2540 | <p>Returns whether the mouse is over the given circle or not.</p>
|
2541 | </div>
|
2542 |
|
2543 |
|
2544 |
|
2545 | <dl>
|
2546 | <dt>
|
2547 | Type
|
2548 | </dt>
|
2549 | <dd>
|
2550 |
|
2551 | <span class="param-type">boolean</span>
|
2552 |
|
2553 |
|
2554 |
|
2555 | </dd>
|
2556 | </dl>
|
2557 |
|
2558 |
|
2559 |
|
2560 |
|
2561 |
|
2562 | </dd>
|
2563 |
|
2564 |
|
2565 |
|
2566 | <hr>
|
2567 | <dt>
|
2568 | <h4 class="name" id=".isOverElement"><span class="type-signature"><static> </span>isOverElement<span class="signature">(element)</span><span class="type-signature"> → {boolean}</span></h4>
|
2569 |
|
2570 |
|
2571 | </dt>
|
2572 | <dd>
|
2573 |
|
2574 |
|
2575 | <div class="description">
|
2576 | <p>Tells whether the mouse is over a given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> or not.</p>
|
2577 | </div>
|
2578 |
|
2579 |
|
2580 |
|
2581 |
|
2582 |
|
2583 |
|
2584 |
|
2585 |
|
2586 | <h5>Parameters:</h5>
|
2587 |
|
2588 |
|
2589 | <table class="params table table-striped">
|
2590 | <thead>
|
2591 | <tr>
|
2592 |
|
2593 | <th style="width:12%; min-width:110px;">Name</th>
|
2594 |
|
2595 |
|
2596 | <th style="width:12%; min-width:110px;">Type</th>
|
2597 |
|
2598 |
|
2599 |
|
2600 |
|
2601 |
|
2602 | <th class="last" style="min-width:310px;">Description</th>
|
2603 | </tr>
|
2604 | </thead>
|
2605 |
|
2606 | <tbody>
|
2607 |
|
2608 |
|
2609 | <tr>
|
2610 |
|
2611 | <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>element</code></td>
|
2612 |
|
2613 |
|
2614 | <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;">
|
2615 |
|
2616 |
|
2617 | <span class="param-type">Element</span>
|
2618 |
|
2619 |
|
2620 |
|
2621 |
|
2622 | </td>
|
2623 |
|
2624 |
|
2625 |
|
2626 |
|
2627 |
|
2628 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> where we want to know whether the mouse is over or not.</p></td>
|
2629 | </tr>
|
2630 |
|
2631 |
|
2632 | </tbody>
|
2633 | </table>
|
2634 |
|
2635 |
|
2636 |
|
2637 |
|
2638 | <dl class="details">
|
2639 |
|
2640 |
|
2641 |
|
2642 |
|
2643 |
|
2644 |
|
2645 |
|
2646 |
|
2647 |
|
2648 |
|
2649 |
|
2650 |
|
2651 |
|
2652 |
|
2653 |
|
2654 |
|
2655 |
|
2656 |
|
2657 |
|
2658 |
|
2659 |
|
2660 |
|
2661 |
|
2662 |
|
2663 |
|
2664 |
|
2665 |
|
2666 |
|
2667 |
|
2668 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2669 | <dd class="tag-source">
|
2670 | <ul class="dummy">
|
2671 | <li>
|
2672 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
2673 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-853">line 853</a>
|
2674 | </li>
|
2675 | </ul>
|
2676 | </dd>
|
2677 |
|
2678 |
|
2679 |
|
2680 |
|
2681 |
|
2682 |
|
2683 |
|
2684 | </dl>
|
2685 |
|
2686 |
|
2687 |
|
2688 |
|
2689 |
|
2690 |
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 |
|
2697 |
|
2698 | <h5>Returns:</h5>
|
2699 |
|
2700 |
|
2701 | <div class="param-desc">
|
2702 | <p>Returns whether the mouse is over the given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> or not.</p>
|
2703 | </div>
|
2704 |
|
2705 |
|
2706 |
|
2707 | <dl>
|
2708 | <dt>
|
2709 | Type
|
2710 | </dt>
|
2711 | <dd>
|
2712 |
|
2713 | <span class="param-type">boolean</span>
|
2714 |
|
2715 |
|
2716 |
|
2717 | </dd>
|
2718 | </dl>
|
2719 |
|
2720 |
|
2721 |
|
2722 |
|
2723 |
|
2724 | </dd>
|
2725 |
|
2726 |
|
2727 |
|
2728 | <hr>
|
2729 | <dt>
|
2730 | <h4 class="name" id=".isOverEllipse"><span class="type-signature"><static> </span>isOverEllipse<span class="signature">(centreX, centreY, radiusX, radiusY [, rotation] [, rotationUseDegrees])</span><span class="type-signature"> → {boolean}</span></h4>
|
2731 |
|
2732 |
|
2733 | </dt>
|
2734 | <dd>
|
2735 |
|
2736 |
|
2737 | <div class="description">
|
2738 | <p>Tells whether the mouse is over a given ellipse or not.</p>
|
2739 | </div>
|
2740 |
|
2741 |
|
2742 |
|
2743 |
|
2744 |
|
2745 |
|
2746 |
|
2747 |
|
2748 | <h5>Parameters:</h5>
|
2749 |
|
2750 |
|
2751 | <table class="params table table-striped">
|
2752 | <thead>
|
2753 | <tr>
|
2754 |
|
2755 | <th style="width:12%; min-width:110px;">Name</th>
|
2756 |
|
2757 |
|
2758 | <th style="width:12%; min-width:110px;">Type</th>
|
2759 |
|
2760 |
|
2761 | <th style="width:12%; min-width:110px;">Argument</th>
|
2762 |
|
2763 |
|
2764 |
|
2765 | <th style="width:12%; min-width:110px;">Default</th>
|
2766 |
|
2767 |
|
2768 | <th class="last" style="min-width:310px;">Description</th>
|
2769 | </tr>
|
2770 | </thead>
|
2771 |
|
2772 | <tbody>
|
2773 |
|
2774 |
|
2775 | <tr>
|
2776 |
|
2777 | <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>centreX</code></td>
|
2778 |
|
2779 |
|
2780 | <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;">
|
2781 |
|
2782 |
|
2783 | <span class="param-type">number</span>
|
2784 |
|
2785 |
|
2786 |
|
2787 |
|
2788 | </td>
|
2789 |
|
2790 |
|
2791 | <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;">
|
2792 |
|
2793 |
|
2794 |
|
2795 |
|
2796 |
|
2797 | </td>
|
2798 |
|
2799 |
|
2800 |
|
2801 | <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;">
|
2802 |
|
2803 | </td>
|
2804 |
|
2805 |
|
2806 | <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 "X" coordinate of the center of the ellipse.</p></td>
|
2807 | </tr>
|
2808 |
|
2809 |
|
2810 |
|
2811 | <tr>
|
2812 |
|
2813 | <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>centreY</code></td>
|
2814 |
|
2815 |
|
2816 | <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;">
|
2817 |
|
2818 |
|
2819 | <span class="param-type">number</span>
|
2820 |
|
2821 |
|
2822 |
|
2823 |
|
2824 | </td>
|
2825 |
|
2826 |
|
2827 | <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;">
|
2828 |
|
2829 |
|
2830 |
|
2831 |
|
2832 |
|
2833 | </td>
|
2834 |
|
2835 |
|
2836 |
|
2837 | <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;">
|
2838 |
|
2839 | </td>
|
2840 |
|
2841 |
|
2842 | <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 "Y" coordinate of the center of the ellipse.</p></td>
|
2843 | </tr>
|
2844 |
|
2845 |
|
2846 |
|
2847 | <tr>
|
2848 |
|
2849 | <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>radiusX</code></td>
|
2850 |
|
2851 |
|
2852 | <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;">
|
2853 |
|
2854 |
|
2855 | <span class="param-type">number</span>
|
2856 |
|
2857 |
|
2858 |
|
2859 |
|
2860 | </td>
|
2861 |
|
2862 |
|
2863 | <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;">
|
2864 |
|
2865 |
|
2866 |
|
2867 |
|
2868 |
|
2869 | </td>
|
2870 |
|
2871 |
|
2872 |
|
2873 | <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;">
|
2874 |
|
2875 | </td>
|
2876 |
|
2877 |
|
2878 | <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 X (horizontal) radius of the ellipse.</p></td>
|
2879 | </tr>
|
2880 |
|
2881 |
|
2882 |
|
2883 | <tr>
|
2884 |
|
2885 | <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>radiusY</code></td>
|
2886 |
|
2887 |
|
2888 | <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;">
|
2889 |
|
2890 |
|
2891 | <span class="param-type">number</span>
|
2892 |
|
2893 |
|
2894 |
|
2895 |
|
2896 | </td>
|
2897 |
|
2898 |
|
2899 | <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;">
|
2900 |
|
2901 |
|
2902 |
|
2903 |
|
2904 |
|
2905 | </td>
|
2906 |
|
2907 |
|
2908 |
|
2909 | <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;">
|
2910 |
|
2911 | </td>
|
2912 |
|
2913 |
|
2914 | <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 Y (vertical) radius of the ellipse.</p></td>
|
2915 | </tr>
|
2916 |
|
2917 |
|
2918 |
|
2919 | <tr>
|
2920 |
|
2921 | <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>rotation</code></td>
|
2922 |
|
2923 |
|
2924 | <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;">
|
2925 |
|
2926 |
|
2927 | <span class="param-type">number</span>
|
2928 |
|
2929 |
|
2930 |
|
2931 |
|
2932 | </td>
|
2933 |
|
2934 |
|
2935 | <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;">
|
2936 |
|
2937 | <optional><br>
|
2938 |
|
2939 |
|
2940 |
|
2941 |
|
2942 |
|
2943 | </td>
|
2944 |
|
2945 |
|
2946 |
|
2947 | <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;">
|
2948 |
|
2949 | 0
|
2950 |
|
2951 | </td>
|
2952 |
|
2953 |
|
2954 | <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 ellipse rotation. The value given will be considered either degrees or radians depending on the given "rotationUseDegrees" parameter (by default, it is considered radians). Not implemented yet!</p></td>
|
2955 | </tr>
|
2956 |
|
2957 |
|
2958 |
|
2959 | <tr>
|
2960 |
|
2961 | <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>rotationUseDegrees</code></td>
|
2962 |
|
2963 |
|
2964 | <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;">
|
2965 |
|
2966 |
|
2967 | <span class="param-type">boolean</span>
|
2968 |
|
2969 |
|
2970 |
|
2971 |
|
2972 | </td>
|
2973 |
|
2974 |
|
2975 | <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;">
|
2976 |
|
2977 | <optional><br>
|
2978 |
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 | </td>
|
2984 |
|
2985 |
|
2986 |
|
2987 | <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;">
|
2988 |
|
2989 | false
|
2990 |
|
2991 | </td>
|
2992 |
|
2993 |
|
2994 | <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 "rotation" given should be considered degrees or not (radians). Not implemented yet!</p></td>
|
2995 | </tr>
|
2996 |
|
2997 |
|
2998 | </tbody>
|
2999 | </table>
|
3000 |
|
3001 |
|
3002 |
|
3003 |
|
3004 | <dl class="details">
|
3005 |
|
3006 |
|
3007 |
|
3008 |
|
3009 |
|
3010 |
|
3011 |
|
3012 |
|
3013 |
|
3014 |
|
3015 |
|
3016 |
|
3017 |
|
3018 |
|
3019 |
|
3020 |
|
3021 |
|
3022 |
|
3023 |
|
3024 |
|
3025 |
|
3026 |
|
3027 |
|
3028 |
|
3029 |
|
3030 |
|
3031 |
|
3032 |
|
3033 |
|
3034 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3035 | <dd class="tag-source">
|
3036 | <ul class="dummy">
|
3037 | <li>
|
3038 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
3039 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-985">line 985</a>
|
3040 | </li>
|
3041 | </ul>
|
3042 | </dd>
|
3043 |
|
3044 |
|
3045 |
|
3046 |
|
3047 |
|
3048 |
|
3049 |
|
3050 | </dl>
|
3051 |
|
3052 |
|
3053 |
|
3054 |
|
3055 |
|
3056 |
|
3057 |
|
3058 |
|
3059 |
|
3060 |
|
3061 |
|
3062 |
|
3063 |
|
3064 | <h5>Returns:</h5>
|
3065 |
|
3066 |
|
3067 | <div class="param-desc">
|
3068 | <p>Returns whether the mouse is over the given ellipse or not.</p>
|
3069 | </div>
|
3070 |
|
3071 |
|
3072 |
|
3073 | <dl>
|
3074 | <dt>
|
3075 | Type
|
3076 | </dt>
|
3077 | <dd>
|
3078 |
|
3079 | <span class="param-type">boolean</span>
|
3080 |
|
3081 |
|
3082 |
|
3083 | </dd>
|
3084 | </dl>
|
3085 |
|
3086 |
|
3087 |
|
3088 |
|
3089 |
|
3090 | </dd>
|
3091 |
|
3092 |
|
3093 |
|
3094 | <hr>
|
3095 | <dt>
|
3096 | <h4 class="name" id=".isOverLine"><span class="type-signature"><static> </span>isOverLine<span class="signature">(lineX1, lineY1, lineX2, lineY2 [, tolerance] [, element])</span><span class="type-signature"> → {boolean}</span></h4>
|
3097 |
|
3098 |
|
3099 | </dt>
|
3100 | <dd>
|
3101 |
|
3102 |
|
3103 | <div class="description">
|
3104 | <p>Tells whether the mouse is over a given line (infinite line) or not.</p>
|
3105 | </div>
|
3106 |
|
3107 |
|
3108 |
|
3109 |
|
3110 |
|
3111 |
|
3112 |
|
3113 |
|
3114 | <h5>Parameters:</h5>
|
3115 |
|
3116 |
|
3117 | <table class="params table table-striped">
|
3118 | <thead>
|
3119 | <tr>
|
3120 |
|
3121 | <th style="width:12%; min-width:110px;">Name</th>
|
3122 |
|
3123 |
|
3124 | <th style="width:12%; min-width:110px;">Type</th>
|
3125 |
|
3126 |
|
3127 | <th style="width:12%; min-width:110px;">Argument</th>
|
3128 |
|
3129 |
|
3130 |
|
3131 | <th style="width:12%; min-width:110px;">Default</th>
|
3132 |
|
3133 |
|
3134 | <th class="last" style="min-width:310px;">Description</th>
|
3135 | </tr>
|
3136 | </thead>
|
3137 |
|
3138 | <tbody>
|
3139 |
|
3140 |
|
3141 | <tr>
|
3142 |
|
3143 | <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>lineX1</code></td>
|
3144 |
|
3145 |
|
3146 | <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;">
|
3147 |
|
3148 |
|
3149 | <span class="param-type">number</span>
|
3150 |
|
3151 |
|
3152 |
|
3153 |
|
3154 | </td>
|
3155 |
|
3156 |
|
3157 | <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;">
|
3158 |
|
3159 |
|
3160 |
|
3161 |
|
3162 |
|
3163 | </td>
|
3164 |
|
3165 |
|
3166 |
|
3167 | <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;">
|
3168 |
|
3169 | </td>
|
3170 |
|
3171 |
|
3172 | <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 X coordinate (horizontal position) of the first pixel of the line.</p></td>
|
3173 | </tr>
|
3174 |
|
3175 |
|
3176 |
|
3177 | <tr>
|
3178 |
|
3179 | <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>lineY1</code></td>
|
3180 |
|
3181 |
|
3182 | <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;">
|
3183 |
|
3184 |
|
3185 | <span class="param-type">number</span>
|
3186 |
|
3187 |
|
3188 |
|
3189 |
|
3190 | </td>
|
3191 |
|
3192 |
|
3193 | <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;">
|
3194 |
|
3195 |
|
3196 |
|
3197 |
|
3198 |
|
3199 | </td>
|
3200 |
|
3201 |
|
3202 |
|
3203 | <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;">
|
3204 |
|
3205 | </td>
|
3206 |
|
3207 |
|
3208 | <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 Y coordinate (vertical position) of the first pixel of the line.</p></td>
|
3209 | </tr>
|
3210 |
|
3211 |
|
3212 |
|
3213 | <tr>
|
3214 |
|
3215 | <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>lineX2</code></td>
|
3216 |
|
3217 |
|
3218 | <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;">
|
3219 |
|
3220 |
|
3221 | <span class="param-type">number</span>
|
3222 |
|
3223 |
|
3224 |
|
3225 |
|
3226 | </td>
|
3227 |
|
3228 |
|
3229 | <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;">
|
3230 |
|
3231 |
|
3232 |
|
3233 |
|
3234 |
|
3235 | </td>
|
3236 |
|
3237 |
|
3238 |
|
3239 | <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;">
|
3240 |
|
3241 | </td>
|
3242 |
|
3243 |
|
3244 | <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 X coordinate (horizontal position) of the second pixel of the line.</p></td>
|
3245 | </tr>
|
3246 |
|
3247 |
|
3248 |
|
3249 | <tr>
|
3250 |
|
3251 | <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>lineY2</code></td>
|
3252 |
|
3253 |
|
3254 | <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;">
|
3255 |
|
3256 |
|
3257 | <span class="param-type">number</span>
|
3258 |
|
3259 |
|
3260 |
|
3261 |
|
3262 | </td>
|
3263 |
|
3264 |
|
3265 | <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;">
|
3266 |
|
3267 |
|
3268 |
|
3269 |
|
3270 |
|
3271 | </td>
|
3272 |
|
3273 |
|
3274 |
|
3275 | <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;">
|
3276 |
|
3277 | </td>
|
3278 |
|
3279 |
|
3280 | <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 Y coordinate (vertical position) of the second pixel of the line.</p></td>
|
3281 | </tr>
|
3282 |
|
3283 |
|
3284 |
|
3285 | <tr>
|
3286 |
|
3287 | <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>tolerance</code></td>
|
3288 |
|
3289 |
|
3290 | <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;">
|
3291 |
|
3292 |
|
3293 | <span class="param-type">number</span>
|
3294 |
|
3295 |
|
3296 |
|
3297 |
|
3298 | </td>
|
3299 |
|
3300 |
|
3301 | <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;">
|
3302 |
|
3303 | <optional><br>
|
3304 |
|
3305 |
|
3306 |
|
3307 |
|
3308 |
|
3309 | </td>
|
3310 |
|
3311 |
|
3312 |
|
3313 | <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;">
|
3314 |
|
3315 | 1
|
3316 |
|
3317 | </td>
|
3318 |
|
3319 |
|
3320 | <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 amount of loss of precision we can tolerate to consider a collision.</p></td>
|
3321 | </tr>
|
3322 |
|
3323 |
|
3324 |
|
3325 | <tr>
|
3326 |
|
3327 | <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>element</code></td>
|
3328 |
|
3329 |
|
3330 | <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;">
|
3331 |
|
3332 |
|
3333 | <span class="param-type">Element</span>
|
3334 |
|
3335 |
|
3336 |
|
3337 |
|
3338 | </td>
|
3339 |
|
3340 |
|
3341 | <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;">
|
3342 |
|
3343 | <optional><br>
|
3344 |
|
3345 |
|
3346 |
|
3347 |
|
3348 |
|
3349 | </td>
|
3350 |
|
3351 |
|
3352 |
|
3353 | <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;">
|
3354 |
|
3355 | </td>
|
3356 |
|
3357 |
|
3358 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse coordinates will be calculated relatively to the position of this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>.</p></td>
|
3359 | </tr>
|
3360 |
|
3361 |
|
3362 | </tbody>
|
3363 | </table>
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 | <dl class="details">
|
3369 |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 |
|
3375 |
|
3376 |
|
3377 |
|
3378 |
|
3379 |
|
3380 |
|
3381 |
|
3382 |
|
3383 |
|
3384 |
|
3385 |
|
3386 |
|
3387 |
|
3388 |
|
3389 |
|
3390 |
|
3391 |
|
3392 |
|
3393 |
|
3394 |
|
3395 |
|
3396 |
|
3397 |
|
3398 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3399 | <dd class="tag-source">
|
3400 | <ul class="dummy">
|
3401 | <li>
|
3402 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
3403 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-871">line 871</a>
|
3404 | </li>
|
3405 | </ul>
|
3406 | </dd>
|
3407 |
|
3408 |
|
3409 |
|
3410 |
|
3411 |
|
3412 |
|
3413 |
|
3414 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
3415 | <dd class="tag-todo">
|
3416 | <ul>
|
3417 | <li>Think about using a "width" parameter (apart from the "tolerance" parameter).</li>
|
3418 | </ul>
|
3419 | </dd>
|
3420 |
|
3421 | </dl>
|
3422 |
|
3423 |
|
3424 |
|
3425 |
|
3426 |
|
3427 |
|
3428 |
|
3429 |
|
3430 |
|
3431 |
|
3432 |
|
3433 |
|
3434 |
|
3435 | <h5>Returns:</h5>
|
3436 |
|
3437 |
|
3438 | <div class="param-desc">
|
3439 | <p>Returns whether the mouse is over the given line (infinite line) or not.</p>
|
3440 | </div>
|
3441 |
|
3442 |
|
3443 |
|
3444 | <dl>
|
3445 | <dt>
|
3446 | Type
|
3447 | </dt>
|
3448 | <dd>
|
3449 |
|
3450 | <span class="param-type">boolean</span>
|
3451 |
|
3452 |
|
3453 |
|
3454 | </dd>
|
3455 | </dl>
|
3456 |
|
3457 |
|
3458 |
|
3459 |
|
3460 |
|
3461 | </dd>
|
3462 |
|
3463 |
|
3464 |
|
3465 | <hr>
|
3466 | <dt>
|
3467 | <h4 class="name" id=".isOverRectangle"><span class="type-signature"><static> </span>isOverRectangle<span class="signature">(rectangleX, rectangleY, rectangleWidth, rectangleHeight [, element])</span><span class="type-signature"> → {boolean}</span></h4>
|
3468 |
|
3469 |
|
3470 | </dt>
|
3471 | <dd>
|
3472 |
|
3473 |
|
3474 | <div class="description">
|
3475 | <p>Tells whether the mouse is over a given rectangle or not.</p>
|
3476 | </div>
|
3477 |
|
3478 |
|
3479 |
|
3480 |
|
3481 |
|
3482 |
|
3483 |
|
3484 |
|
3485 | <h5>Parameters:</h5>
|
3486 |
|
3487 |
|
3488 | <table class="params table table-striped">
|
3489 | <thead>
|
3490 | <tr>
|
3491 |
|
3492 | <th style="width:12%; min-width:110px;">Name</th>
|
3493 |
|
3494 |
|
3495 | <th style="width:12%; min-width:110px;">Type</th>
|
3496 |
|
3497 |
|
3498 | <th style="width:12%; min-width:110px;">Argument</th>
|
3499 |
|
3500 |
|
3501 |
|
3502 |
|
3503 | <th class="last" style="min-width:310px;">Description</th>
|
3504 | </tr>
|
3505 | </thead>
|
3506 |
|
3507 | <tbody>
|
3508 |
|
3509 |
|
3510 | <tr>
|
3511 |
|
3512 | <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>rectangleX</code></td>
|
3513 |
|
3514 |
|
3515 | <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;">
|
3516 |
|
3517 |
|
3518 | <span class="param-type">number</span>
|
3519 |
|
3520 |
|
3521 |
|
3522 |
|
3523 | </td>
|
3524 |
|
3525 |
|
3526 | <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;">
|
3527 |
|
3528 |
|
3529 |
|
3530 |
|
3531 |
|
3532 | </td>
|
3533 |
|
3534 |
|
3535 |
|
3536 |
|
3537 | <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 X coordinate (horizontal position) of the first pixel of the rectangle (upper left corner).</p></td>
|
3538 | </tr>
|
3539 |
|
3540 |
|
3541 |
|
3542 | <tr>
|
3543 |
|
3544 | <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>rectangleY</code></td>
|
3545 |
|
3546 |
|
3547 | <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;">
|
3548 |
|
3549 |
|
3550 | <span class="param-type">number</span>
|
3551 |
|
3552 |
|
3553 |
|
3554 |
|
3555 | </td>
|
3556 |
|
3557 |
|
3558 | <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;">
|
3559 |
|
3560 |
|
3561 |
|
3562 |
|
3563 |
|
3564 | </td>
|
3565 |
|
3566 |
|
3567 |
|
3568 |
|
3569 | <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 Y coordinate (vertical position) of the first pixel of the rectangle (upper left corner).</p></td>
|
3570 | </tr>
|
3571 |
|
3572 |
|
3573 |
|
3574 | <tr>
|
3575 |
|
3576 | <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>rectangleWidth</code></td>
|
3577 |
|
3578 |
|
3579 | <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;">
|
3580 |
|
3581 |
|
3582 | <span class="param-type">number</span>
|
3583 |
|
3584 |
|
3585 |
|
3586 |
|
3587 | </td>
|
3588 |
|
3589 |
|
3590 | <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;">
|
3591 |
|
3592 |
|
3593 |
|
3594 |
|
3595 |
|
3596 | </td>
|
3597 |
|
3598 |
|
3599 |
|
3600 |
|
3601 | <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 width of the rectangle in pixels.</p></td>
|
3602 | </tr>
|
3603 |
|
3604 |
|
3605 |
|
3606 | <tr>
|
3607 |
|
3608 | <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>rectangleHeight</code></td>
|
3609 |
|
3610 |
|
3611 | <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;">
|
3612 |
|
3613 |
|
3614 | <span class="param-type">number</span>
|
3615 |
|
3616 |
|
3617 |
|
3618 |
|
3619 | </td>
|
3620 |
|
3621 |
|
3622 | <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;">
|
3623 |
|
3624 |
|
3625 |
|
3626 |
|
3627 |
|
3628 | </td>
|
3629 |
|
3630 |
|
3631 |
|
3632 |
|
3633 | <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 height of the rectangle in pixels.</p></td>
|
3634 | </tr>
|
3635 |
|
3636 |
|
3637 |
|
3638 | <tr>
|
3639 |
|
3640 | <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>element</code></td>
|
3641 |
|
3642 |
|
3643 | <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;">
|
3644 |
|
3645 |
|
3646 | <span class="param-type">Element</span>
|
3647 |
|
3648 |
|
3649 |
|
3650 |
|
3651 | </td>
|
3652 |
|
3653 |
|
3654 | <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;">
|
3655 |
|
3656 | <optional><br>
|
3657 |
|
3658 |
|
3659 |
|
3660 |
|
3661 |
|
3662 | </td>
|
3663 |
|
3664 |
|
3665 |
|
3666 |
|
3667 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse coordinates will be calculated relatively to the position of this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>.</p></td>
|
3668 | </tr>
|
3669 |
|
3670 |
|
3671 | </tbody>
|
3672 | </table>
|
3673 |
|
3674 |
|
3675 |
|
3676 |
|
3677 | <dl class="details">
|
3678 |
|
3679 |
|
3680 |
|
3681 |
|
3682 |
|
3683 |
|
3684 |
|
3685 |
|
3686 |
|
3687 |
|
3688 |
|
3689 |
|
3690 |
|
3691 |
|
3692 |
|
3693 |
|
3694 |
|
3695 |
|
3696 |
|
3697 |
|
3698 |
|
3699 |
|
3700 |
|
3701 |
|
3702 |
|
3703 |
|
3704 |
|
3705 |
|
3706 |
|
3707 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3708 | <dd class="tag-source">
|
3709 | <ul class="dummy">
|
3710 | <li>
|
3711 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
3712 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-931">line 931</a>
|
3713 | </li>
|
3714 | </ul>
|
3715 | </dd>
|
3716 |
|
3717 |
|
3718 |
|
3719 |
|
3720 |
|
3721 |
|
3722 |
|
3723 | </dl>
|
3724 |
|
3725 |
|
3726 |
|
3727 |
|
3728 |
|
3729 |
|
3730 |
|
3731 |
|
3732 |
|
3733 |
|
3734 |
|
3735 |
|
3736 |
|
3737 | <h5>Returns:</h5>
|
3738 |
|
3739 |
|
3740 | <div class="param-desc">
|
3741 | <p>Returns whether the mouse is over the given rectangle or not.</p>
|
3742 | </div>
|
3743 |
|
3744 |
|
3745 |
|
3746 | <dl>
|
3747 | <dt>
|
3748 | Type
|
3749 | </dt>
|
3750 | <dd>
|
3751 |
|
3752 | <span class="param-type">boolean</span>
|
3753 |
|
3754 |
|
3755 |
|
3756 | </dd>
|
3757 | </dl>
|
3758 |
|
3759 |
|
3760 |
|
3761 |
|
3762 |
|
3763 | </dd>
|
3764 |
|
3765 |
|
3766 |
|
3767 | <hr>
|
3768 | <dt>
|
3769 | <h4 class="name" id=".isOverSegment"><span class="type-signature"><static> </span>isOverSegment<span class="signature">(lineX1, lineY1, lineX2, lineY2 [, tolerance] [, element])</span><span class="type-signature"> → {boolean}</span></h4>
|
3770 |
|
3771 |
|
3772 | </dt>
|
3773 | <dd>
|
3774 |
|
3775 |
|
3776 | <div class="description">
|
3777 | <p>Tells whether the mouse is over a given line segment or not.</p>
|
3778 | </div>
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 |
|
3785 |
|
3786 |
|
3787 | <h5>Parameters:</h5>
|
3788 |
|
3789 |
|
3790 | <table class="params table table-striped">
|
3791 | <thead>
|
3792 | <tr>
|
3793 |
|
3794 | <th style="width:12%; min-width:110px;">Name</th>
|
3795 |
|
3796 |
|
3797 | <th style="width:12%; min-width:110px;">Type</th>
|
3798 |
|
3799 |
|
3800 | <th style="width:12%; min-width:110px;">Argument</th>
|
3801 |
|
3802 |
|
3803 |
|
3804 | <th style="width:12%; min-width:110px;">Default</th>
|
3805 |
|
3806 |
|
3807 | <th class="last" style="min-width:310px;">Description</th>
|
3808 | </tr>
|
3809 | </thead>
|
3810 |
|
3811 | <tbody>
|
3812 |
|
3813 |
|
3814 | <tr>
|
3815 |
|
3816 | <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>lineX1</code></td>
|
3817 |
|
3818 |
|
3819 | <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;">
|
3820 |
|
3821 |
|
3822 | <span class="param-type">number</span>
|
3823 |
|
3824 |
|
3825 |
|
3826 |
|
3827 | </td>
|
3828 |
|
3829 |
|
3830 | <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;">
|
3831 |
|
3832 |
|
3833 |
|
3834 |
|
3835 |
|
3836 | </td>
|
3837 |
|
3838 |
|
3839 |
|
3840 | <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;">
|
3841 |
|
3842 | </td>
|
3843 |
|
3844 |
|
3845 | <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 X coordinate (horizontal position) of the first pixel of the line segment.</p></td>
|
3846 | </tr>
|
3847 |
|
3848 |
|
3849 |
|
3850 | <tr>
|
3851 |
|
3852 | <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>lineY1</code></td>
|
3853 |
|
3854 |
|
3855 | <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;">
|
3856 |
|
3857 |
|
3858 | <span class="param-type">number</span>
|
3859 |
|
3860 |
|
3861 |
|
3862 |
|
3863 | </td>
|
3864 |
|
3865 |
|
3866 | <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;">
|
3867 |
|
3868 |
|
3869 |
|
3870 |
|
3871 |
|
3872 | </td>
|
3873 |
|
3874 |
|
3875 |
|
3876 | <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;">
|
3877 |
|
3878 | </td>
|
3879 |
|
3880 |
|
3881 | <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 Y coordinate (vertical position) of the first pixel of the line segment.</p></td>
|
3882 | </tr>
|
3883 |
|
3884 |
|
3885 |
|
3886 | <tr>
|
3887 |
|
3888 | <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>lineX2</code></td>
|
3889 |
|
3890 |
|
3891 | <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;">
|
3892 |
|
3893 |
|
3894 | <span class="param-type">number</span>
|
3895 |
|
3896 |
|
3897 |
|
3898 |
|
3899 | </td>
|
3900 |
|
3901 |
|
3902 | <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;">
|
3903 |
|
3904 |
|
3905 |
|
3906 |
|
3907 |
|
3908 | </td>
|
3909 |
|
3910 |
|
3911 |
|
3912 | <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;">
|
3913 |
|
3914 | </td>
|
3915 |
|
3916 |
|
3917 | <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 X coordinate (horizontal position) of the second pixel of the line segment.</p></td>
|
3918 | </tr>
|
3919 |
|
3920 |
|
3921 |
|
3922 | <tr>
|
3923 |
|
3924 | <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>lineY2</code></td>
|
3925 |
|
3926 |
|
3927 | <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;">
|
3928 |
|
3929 |
|
3930 | <span class="param-type">number</span>
|
3931 |
|
3932 |
|
3933 |
|
3934 |
|
3935 | </td>
|
3936 |
|
3937 |
|
3938 | <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;">
|
3939 |
|
3940 |
|
3941 |
|
3942 |
|
3943 |
|
3944 | </td>
|
3945 |
|
3946 |
|
3947 |
|
3948 | <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;">
|
3949 |
|
3950 | </td>
|
3951 |
|
3952 |
|
3953 | <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 Y coordinate (vertical position) of the second pixel of the line segment.</p></td>
|
3954 | </tr>
|
3955 |
|
3956 |
|
3957 |
|
3958 | <tr>
|
3959 |
|
3960 | <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>tolerance</code></td>
|
3961 |
|
3962 |
|
3963 | <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;">
|
3964 |
|
3965 |
|
3966 | <span class="param-type">number</span>
|
3967 |
|
3968 |
|
3969 |
|
3970 |
|
3971 | </td>
|
3972 |
|
3973 |
|
3974 | <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;">
|
3975 |
|
3976 | <optional><br>
|
3977 |
|
3978 |
|
3979 |
|
3980 |
|
3981 |
|
3982 | </td>
|
3983 |
|
3984 |
|
3985 |
|
3986 | <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;">
|
3987 |
|
3988 | 1
|
3989 |
|
3990 | </td>
|
3991 |
|
3992 |
|
3993 | <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 amount of loss of precision we can tolerate to consider a collision.</p></td>
|
3994 | </tr>
|
3995 |
|
3996 |
|
3997 |
|
3998 | <tr>
|
3999 |
|
4000 | <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>element</code></td>
|
4001 |
|
4002 |
|
4003 | <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;">
|
4004 |
|
4005 |
|
4006 | <span class="param-type">Element</span>
|
4007 |
|
4008 |
|
4009 |
|
4010 |
|
4011 | </td>
|
4012 |
|
4013 |
|
4014 | <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;">
|
4015 |
|
4016 | <optional><br>
|
4017 |
|
4018 |
|
4019 |
|
4020 |
|
4021 |
|
4022 | </td>
|
4023 |
|
4024 |
|
4025 |
|
4026 | <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;">
|
4027 |
|
4028 | </td>
|
4029 |
|
4030 |
|
4031 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse coordinates will be calculated relatively to the position of this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>.</p></td>
|
4032 | </tr>
|
4033 |
|
4034 |
|
4035 | </tbody>
|
4036 | </table>
|
4037 |
|
4038 |
|
4039 |
|
4040 |
|
4041 | <dl class="details">
|
4042 |
|
4043 |
|
4044 |
|
4045 |
|
4046 |
|
4047 |
|
4048 |
|
4049 |
|
4050 |
|
4051 |
|
4052 |
|
4053 |
|
4054 |
|
4055 |
|
4056 |
|
4057 |
|
4058 |
|
4059 |
|
4060 |
|
4061 |
|
4062 |
|
4063 |
|
4064 |
|
4065 |
|
4066 |
|
4067 |
|
4068 |
|
4069 |
|
4070 |
|
4071 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4072 | <dd class="tag-source">
|
4073 | <ul class="dummy">
|
4074 | <li>
|
4075 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
4076 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-902">line 902</a>
|
4077 | </li>
|
4078 | </ul>
|
4079 | </dd>
|
4080 |
|
4081 |
|
4082 |
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
4088 | <dd class="tag-todo">
|
4089 | <ul>
|
4090 | <li>Think about using a "width" parameter (apart from the "tolerance" parameter).</li>
|
4091 | </ul>
|
4092 | </dd>
|
4093 |
|
4094 | </dl>
|
4095 |
|
4096 |
|
4097 |
|
4098 |
|
4099 |
|
4100 |
|
4101 |
|
4102 |
|
4103 |
|
4104 |
|
4105 |
|
4106 |
|
4107 |
|
4108 | <h5>Returns:</h5>
|
4109 |
|
4110 |
|
4111 | <div class="param-desc">
|
4112 | <p>Returns whether the mouse is over the given line segment or not.</p>
|
4113 | </div>
|
4114 |
|
4115 |
|
4116 |
|
4117 | <dl>
|
4118 | <dt>
|
4119 | Type
|
4120 | </dt>
|
4121 | <dd>
|
4122 |
|
4123 | <span class="param-type">boolean</span>
|
4124 |
|
4125 |
|
4126 |
|
4127 | </dd>
|
4128 | </dl>
|
4129 |
|
4130 |
|
4131 |
|
4132 |
|
4133 |
|
4134 | </dd>
|
4135 |
|
4136 |
|
4137 |
|
4138 | <hr>
|
4139 | <dt>
|
4140 | <h4 class="name" id=".lock"><span class="type-signature"><static> </span>lock<span class="signature">( [target], callbackOk, callbackError)</span><span class="type-signature"> → {Element|null}</span></h4>
|
4141 |
|
4142 |
|
4143 | </dt>
|
4144 | <dd>
|
4145 |
|
4146 |
|
4147 | <div class="description">
|
4148 | <p>Locks the mouse pointer (if possible). More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
4149 | </div>
|
4150 |
|
4151 |
|
4152 |
|
4153 |
|
4154 |
|
4155 |
|
4156 |
|
4157 |
|
4158 | <h5>Parameters:</h5>
|
4159 |
|
4160 |
|
4161 | <table class="params table table-striped">
|
4162 | <thead>
|
4163 | <tr>
|
4164 |
|
4165 | <th style="width:12%; min-width:110px;">Name</th>
|
4166 |
|
4167 |
|
4168 | <th style="width:12%; min-width:110px;">Type</th>
|
4169 |
|
4170 |
|
4171 | <th style="width:12%; min-width:110px;">Argument</th>
|
4172 |
|
4173 |
|
4174 |
|
4175 | <th style="width:12%; min-width:110px;">Default</th>
|
4176 |
|
4177 |
|
4178 | <th class="last" style="min-width:310px;">Description</th>
|
4179 | </tr>
|
4180 | </thead>
|
4181 |
|
4182 | <tbody>
|
4183 |
|
4184 |
|
4185 | <tr>
|
4186 |
|
4187 | <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>target</code></td>
|
4188 |
|
4189 |
|
4190 | <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;">
|
4191 |
|
4192 |
|
4193 | <span class="param-type">Element</span>
|
4194 |
|
4195 |
|
4196 |
|
4197 |
|
4198 | </td>
|
4199 |
|
4200 |
|
4201 | <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;">
|
4202 |
|
4203 | <optional><br>
|
4204 |
|
4205 |
|
4206 |
|
4207 |
|
4208 |
|
4209 | </td>
|
4210 |
|
4211 |
|
4212 |
|
4213 | <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;">
|
4214 |
|
4215 | document.body
|
4216 |
|
4217 | </td>
|
4218 |
|
4219 |
|
4220 | <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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> that the mouse pointer will be locked to.</p></td>
|
4221 | </tr>
|
4222 |
|
4223 |
|
4224 |
|
4225 | <tr>
|
4226 |
|
4227 | <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>callbackOk</code></td>
|
4228 |
|
4229 |
|
4230 | <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;">
|
4231 |
|
4232 |
|
4233 | <span class="param-type">function</span>
|
4234 |
|
4235 |
|
4236 |
|
4237 |
|
4238 | </td>
|
4239 |
|
4240 |
|
4241 | <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;">
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 | </td>
|
4248 |
|
4249 |
|
4250 |
|
4251 | <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;">
|
4252 |
|
4253 | </td>
|
4254 |
|
4255 |
|
4256 | <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>Function callback that will be called (without parameters) if the mouse pointer could be locked successfully.</p></td>
|
4257 | </tr>
|
4258 |
|
4259 |
|
4260 |
|
4261 | <tr>
|
4262 |
|
4263 | <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>callbackError</code></td>
|
4264 |
|
4265 |
|
4266 | <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;">
|
4267 |
|
4268 |
|
4269 | <span class="param-type">function</span>
|
4270 |
|
4271 |
|
4272 |
|
4273 |
|
4274 | </td>
|
4275 |
|
4276 |
|
4277 | <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;">
|
4278 |
|
4279 |
|
4280 |
|
4281 |
|
4282 |
|
4283 | </td>
|
4284 |
|
4285 |
|
4286 |
|
4287 | <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;">
|
4288 |
|
4289 | </td>
|
4290 |
|
4291 |
|
4292 | <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>Function callback that will be called (without parameters) if the mouse pointer could not be locked successfully.</p></td>
|
4293 | </tr>
|
4294 |
|
4295 |
|
4296 | </tbody>
|
4297 | </table>
|
4298 |
|
4299 |
|
4300 |
|
4301 |
|
4302 | <dl class="details">
|
4303 |
|
4304 |
|
4305 |
|
4306 |
|
4307 |
|
4308 |
|
4309 |
|
4310 |
|
4311 |
|
4312 |
|
4313 |
|
4314 |
|
4315 |
|
4316 |
|
4317 |
|
4318 |
|
4319 |
|
4320 |
|
4321 |
|
4322 |
|
4323 |
|
4324 |
|
4325 |
|
4326 |
|
4327 |
|
4328 |
|
4329 |
|
4330 |
|
4331 |
|
4332 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4333 | <dd class="tag-source">
|
4334 | <ul class="dummy">
|
4335 | <li>
|
4336 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
4337 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-713">line 713</a>
|
4338 | </li>
|
4339 | </ul>
|
4340 | </dd>
|
4341 |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 |
|
4348 | </dl>
|
4349 |
|
4350 |
|
4351 |
|
4352 |
|
4353 |
|
4354 |
|
4355 |
|
4356 |
|
4357 |
|
4358 |
|
4359 |
|
4360 |
|
4361 |
|
4362 | <h5>Returns:</h5>
|
4363 |
|
4364 |
|
4365 | <div class="param-desc">
|
4366 | <p>Returns the current lock element for the mouse pointer (if any) or null otherwise.</p>
|
4367 | </div>
|
4368 |
|
4369 |
|
4370 |
|
4371 | <dl>
|
4372 | <dt>
|
4373 | Type
|
4374 | </dt>
|
4375 | <dd>
|
4376 |
|
4377 | <span class="param-type">Element</span>
|
4378 | |
|
4379 |
|
4380 | <span class="param-type">null</span>
|
4381 |
|
4382 |
|
4383 |
|
4384 | </dd>
|
4385 | </dl>
|
4386 |
|
4387 |
|
4388 |
|
4389 |
|
4390 |
|
4391 | </dd>
|
4392 |
|
4393 |
|
4394 |
|
4395 | <hr>
|
4396 | <dt>
|
4397 | <h4 class="name" id=".normalizeEvent"><span class="type-signature"><static> </span>normalizeEvent<span class="signature">(e)</span><span class="type-signature"> → {Event}</span></h4>
|
4398 |
|
4399 |
|
4400 | </dt>
|
4401 | <dd>
|
4402 |
|
4403 |
|
4404 | <div class="description">
|
4405 | <p>Tries to return the given <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> with some properties normalized (since different clients can use different values) and perhaps some new properties added (in the case they were missing), when possible. The new attached methods and properties may include polyfills, etc. It also calls the <a href="CB_Events.html#.normalize"><code>CB_Events.normalize</code></a> function internally. Some properties added or affected could be <a href="https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX">deltaX</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY">deltaY</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ">deltaZ</a>, <a href="https://developer.mozilla.org/es/docs/Web/API/MouseEvent/webkitForce">force</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX">clientX</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY">clientY</a>, etc.</p>
|
4406 | </div>
|
4407 |
|
4408 |
|
4409 |
|
4410 |
|
4411 |
|
4412 |
|
4413 |
|
4414 |
|
4415 | <h5>Parameters:</h5>
|
4416 |
|
4417 |
|
4418 | <table class="params table table-striped">
|
4419 | <thead>
|
4420 | <tr>
|
4421 |
|
4422 | <th style="width:12%; min-width:110px;">Name</th>
|
4423 |
|
4424 |
|
4425 | <th style="width:12%; min-width:110px;">Type</th>
|
4426 |
|
4427 |
|
4428 |
|
4429 |
|
4430 |
|
4431 | <th class="last" style="min-width:310px;">Description</th>
|
4432 | </tr>
|
4433 | </thead>
|
4434 |
|
4435 | <tbody>
|
4436 |
|
4437 |
|
4438 | <tr>
|
4439 |
|
4440 | <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>e</code></td>
|
4441 |
|
4442 |
|
4443 | <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;">
|
4444 |
|
4445 |
|
4446 | <span class="param-type">Event</span>
|
4447 |
|
4448 |
|
4449 |
|
4450 |
|
4451 | </td>
|
4452 |
|
4453 |
|
4454 |
|
4455 |
|
4456 |
|
4457 | <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><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">Mouse event object</a>. If not provided, it will use the value of "event", "window.event", "Event" or an empty object ("{}").</p></td>
|
4458 | </tr>
|
4459 |
|
4460 |
|
4461 | </tbody>
|
4462 | </table>
|
4463 |
|
4464 |
|
4465 |
|
4466 |
|
4467 | <dl class="details">
|
4468 |
|
4469 |
|
4470 |
|
4471 |
|
4472 |
|
4473 |
|
4474 |
|
4475 |
|
4476 |
|
4477 |
|
4478 |
|
4479 |
|
4480 |
|
4481 |
|
4482 |
|
4483 |
|
4484 |
|
4485 |
|
4486 |
|
4487 |
|
4488 |
|
4489 |
|
4490 |
|
4491 |
|
4492 |
|
4493 |
|
4494 |
|
4495 |
|
4496 |
|
4497 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4498 | <dd class="tag-source">
|
4499 | <ul class="dummy">
|
4500 | <li>
|
4501 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
4502 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-128">line 128</a>
|
4503 | </li>
|
4504 | </ul>
|
4505 | </dd>
|
4506 |
|
4507 |
|
4508 |
|
4509 |
|
4510 |
|
4511 |
|
4512 |
|
4513 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
4514 | <dd class="tag-todo">
|
4515 | <ul>
|
4516 | <li>Add more properties and methods to normalize (<a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX">pageX</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY">pageY</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/offsetX">offsetX</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/offsetY">offsetY</a>, etc.).</li>
|
4517 | </ul>
|
4518 | </dd>
|
4519 |
|
4520 | </dl>
|
4521 |
|
4522 |
|
4523 |
|
4524 |
|
4525 |
|
4526 |
|
4527 |
|
4528 |
|
4529 |
|
4530 |
|
4531 |
|
4532 |
|
4533 |
|
4534 | <h5>Returns:</h5>
|
4535 |
|
4536 |
|
4537 | <div class="param-desc">
|
4538 | <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> normalized.</p>
|
4539 | </div>
|
4540 |
|
4541 |
|
4542 |
|
4543 | <dl>
|
4544 | <dt>
|
4545 | Type
|
4546 | </dt>
|
4547 | <dd>
|
4548 |
|
4549 | <span class="param-type">Event</span>
|
4550 |
|
4551 |
|
4552 |
|
4553 | </dd>
|
4554 | </dl>
|
4555 |
|
4556 |
|
4557 |
|
4558 |
|
4559 |
|
4560 | </dd>
|
4561 |
|
4562 |
|
4563 |
|
4564 | <hr>
|
4565 | <dt>
|
4566 | <h4 class="name" id=".onButtonDown"><span class="type-signature"><static> </span>onButtonDown<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
4567 |
|
4568 |
|
4569 | </dt>
|
4570 | <dd>
|
4571 |
|
4572 |
|
4573 | <div class="description">
|
4574 | <p>Sets a function to execute when a mouse button is down (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousedown_event">onMouseDown</a> event) or removes it.</p>
|
4575 | </div>
|
4576 |
|
4577 |
|
4578 |
|
4579 |
|
4580 |
|
4581 |
|
4582 |
|
4583 |
|
4584 | <h5>Parameters:</h5>
|
4585 |
|
4586 |
|
4587 | <table class="params table table-striped">
|
4588 | <thead>
|
4589 | <tr>
|
4590 |
|
4591 | <th style="width:12%; min-width:110px;">Name</th>
|
4592 |
|
4593 |
|
4594 | <th style="width:12%; min-width:110px;">Type</th>
|
4595 |
|
4596 |
|
4597 | <th style="width:12%; min-width:110px;">Argument</th>
|
4598 |
|
4599 |
|
4600 |
|
4601 | <th style="width:12%; min-width:110px;">Default</th>
|
4602 |
|
4603 |
|
4604 | <th class="last" style="min-width:310px;">Description</th>
|
4605 | </tr>
|
4606 | </thead>
|
4607 |
|
4608 | <tbody>
|
4609 |
|
4610 |
|
4611 | <tr>
|
4612 |
|
4613 | <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>
|
4614 |
|
4615 |
|
4616 | <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;">
|
4617 |
|
4618 |
|
4619 | <span class="param-type">function</span>
|
4620 | |
|
4621 |
|
4622 | <span class="param-type">null</span>
|
4623 |
|
4624 |
|
4625 |
|
4626 |
|
4627 | </td>
|
4628 |
|
4629 |
|
4630 | <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;">
|
4631 |
|
4632 |
|
4633 |
|
4634 |
|
4635 |
|
4636 | </td>
|
4637 |
|
4638 |
|
4639 |
|
4640 | <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;">
|
4641 |
|
4642 | </td>
|
4643 |
|
4644 |
|
4645 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
4646 | </tr>
|
4647 |
|
4648 |
|
4649 |
|
4650 | <tr>
|
4651 |
|
4652 | <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>
|
4653 |
|
4654 |
|
4655 | <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;">
|
4656 |
|
4657 |
|
4658 | <span class="param-type">boolean</span>
|
4659 |
|
4660 |
|
4661 |
|
4662 |
|
4663 | </td>
|
4664 |
|
4665 |
|
4666 | <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;">
|
4667 |
|
4668 | <optional><br>
|
4669 |
|
4670 |
|
4671 |
|
4672 |
|
4673 |
|
4674 | </td>
|
4675 |
|
4676 |
|
4677 |
|
4678 | <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;">
|
4679 |
|
4680 | true
|
4681 |
|
4682 | </td>
|
4683 |
|
4684 |
|
4685 | <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>
|
4686 | </tr>
|
4687 |
|
4688 |
|
4689 |
|
4690 | <tr>
|
4691 |
|
4692 | <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>useCapture</code></td>
|
4693 |
|
4694 |
|
4695 | <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;">
|
4696 |
|
4697 |
|
4698 | <span class="param-type">boolean</span>
|
4699 |
|
4700 |
|
4701 |
|
4702 |
|
4703 | </td>
|
4704 |
|
4705 |
|
4706 | <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;">
|
4707 |
|
4708 | <optional><br>
|
4709 |
|
4710 |
|
4711 |
|
4712 |
|
4713 |
|
4714 | </td>
|
4715 |
|
4716 |
|
4717 |
|
4718 | <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;">
|
4719 |
|
4720 | false
|
4721 |
|
4722 | </td>
|
4723 |
|
4724 |
|
4725 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
4726 | </tr>
|
4727 |
|
4728 |
|
4729 |
|
4730 | <tr>
|
4731 |
|
4732 | <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>target</code></td>
|
4733 |
|
4734 |
|
4735 | <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;">
|
4736 |
|
4737 |
|
4738 | <span class="param-type">Object</span>
|
4739 |
|
4740 |
|
4741 |
|
4742 |
|
4743 | </td>
|
4744 |
|
4745 |
|
4746 | <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;">
|
4747 |
|
4748 | <optional><br>
|
4749 |
|
4750 |
|
4751 |
|
4752 |
|
4753 |
|
4754 | </td>
|
4755 |
|
4756 |
|
4757 |
|
4758 | <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;">
|
4759 |
|
4760 | document
|
4761 |
|
4762 | </td>
|
4763 |
|
4764 |
|
4765 | <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 target where we want to attach the event listener.</p></td>
|
4766 | </tr>
|
4767 |
|
4768 |
|
4769 | </tbody>
|
4770 | </table>
|
4771 |
|
4772 |
|
4773 |
|
4774 |
|
4775 | <dl class="details">
|
4776 |
|
4777 |
|
4778 |
|
4779 |
|
4780 |
|
4781 |
|
4782 |
|
4783 |
|
4784 |
|
4785 |
|
4786 |
|
4787 |
|
4788 |
|
4789 |
|
4790 |
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 |
|
4797 |
|
4798 |
|
4799 |
|
4800 |
|
4801 |
|
4802 |
|
4803 |
|
4804 |
|
4805 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4806 | <dd class="tag-source">
|
4807 | <ul class="dummy">
|
4808 | <li>
|
4809 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
4810 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-547">line 547</a>
|
4811 | </li>
|
4812 | </ul>
|
4813 | </dd>
|
4814 |
|
4815 |
|
4816 |
|
4817 |
|
4818 |
|
4819 |
|
4820 |
|
4821 | </dl>
|
4822 |
|
4823 |
|
4824 |
|
4825 |
|
4826 |
|
4827 |
|
4828 |
|
4829 |
|
4830 |
|
4831 |
|
4832 |
|
4833 |
|
4834 |
|
4835 |
|
4836 |
|
4837 | </dd>
|
4838 |
|
4839 |
|
4840 |
|
4841 | <hr>
|
4842 | <dt>
|
4843 | <h4 class="name" id=".onButtonUp"><span class="type-signature"><static> </span>onButtonUp<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
4844 |
|
4845 |
|
4846 | </dt>
|
4847 | <dd>
|
4848 |
|
4849 |
|
4850 | <div class="description">
|
4851 | <p>Sets a function to execute when a mouse button is up (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseup_event">onMouseUp</a> event) or removes it.</p>
|
4852 | </div>
|
4853 |
|
4854 |
|
4855 |
|
4856 |
|
4857 |
|
4858 |
|
4859 |
|
4860 |
|
4861 | <h5>Parameters:</h5>
|
4862 |
|
4863 |
|
4864 | <table class="params table table-striped">
|
4865 | <thead>
|
4866 | <tr>
|
4867 |
|
4868 | <th style="width:12%; min-width:110px;">Name</th>
|
4869 |
|
4870 |
|
4871 | <th style="width:12%; min-width:110px;">Type</th>
|
4872 |
|
4873 |
|
4874 | <th style="width:12%; min-width:110px;">Argument</th>
|
4875 |
|
4876 |
|
4877 |
|
4878 | <th style="width:12%; min-width:110px;">Default</th>
|
4879 |
|
4880 |
|
4881 | <th class="last" style="min-width:310px;">Description</th>
|
4882 | </tr>
|
4883 | </thead>
|
4884 |
|
4885 | <tbody>
|
4886 |
|
4887 |
|
4888 | <tr>
|
4889 |
|
4890 | <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>
|
4891 |
|
4892 |
|
4893 | <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;">
|
4894 |
|
4895 |
|
4896 | <span class="param-type">function</span>
|
4897 | |
|
4898 |
|
4899 | <span class="param-type">null</span>
|
4900 |
|
4901 |
|
4902 |
|
4903 |
|
4904 | </td>
|
4905 |
|
4906 |
|
4907 | <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;">
|
4908 |
|
4909 |
|
4910 |
|
4911 |
|
4912 |
|
4913 | </td>
|
4914 |
|
4915 |
|
4916 |
|
4917 | <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;">
|
4918 |
|
4919 | </td>
|
4920 |
|
4921 |
|
4922 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
4923 | </tr>
|
4924 |
|
4925 |
|
4926 |
|
4927 | <tr>
|
4928 |
|
4929 | <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>
|
4930 |
|
4931 |
|
4932 | <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;">
|
4933 |
|
4934 |
|
4935 | <span class="param-type">boolean</span>
|
4936 |
|
4937 |
|
4938 |
|
4939 |
|
4940 | </td>
|
4941 |
|
4942 |
|
4943 | <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;">
|
4944 |
|
4945 | <optional><br>
|
4946 |
|
4947 |
|
4948 |
|
4949 |
|
4950 |
|
4951 | </td>
|
4952 |
|
4953 |
|
4954 |
|
4955 | <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;">
|
4956 |
|
4957 | true
|
4958 |
|
4959 | </td>
|
4960 |
|
4961 |
|
4962 | <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>
|
4963 | </tr>
|
4964 |
|
4965 |
|
4966 |
|
4967 | <tr>
|
4968 |
|
4969 | <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>useCapture</code></td>
|
4970 |
|
4971 |
|
4972 | <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;">
|
4973 |
|
4974 |
|
4975 | <span class="param-type">boolean</span>
|
4976 |
|
4977 |
|
4978 |
|
4979 |
|
4980 | </td>
|
4981 |
|
4982 |
|
4983 | <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;">
|
4984 |
|
4985 | <optional><br>
|
4986 |
|
4987 |
|
4988 |
|
4989 |
|
4990 |
|
4991 | </td>
|
4992 |
|
4993 |
|
4994 |
|
4995 | <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;">
|
4996 |
|
4997 | false
|
4998 |
|
4999 | </td>
|
5000 |
|
5001 |
|
5002 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
5003 | </tr>
|
5004 |
|
5005 |
|
5006 |
|
5007 | <tr>
|
5008 |
|
5009 | <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>target</code></td>
|
5010 |
|
5011 |
|
5012 | <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;">
|
5013 |
|
5014 |
|
5015 | <span class="param-type">Object</span>
|
5016 |
|
5017 |
|
5018 |
|
5019 |
|
5020 | </td>
|
5021 |
|
5022 |
|
5023 | <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;">
|
5024 |
|
5025 | <optional><br>
|
5026 |
|
5027 |
|
5028 |
|
5029 |
|
5030 |
|
5031 | </td>
|
5032 |
|
5033 |
|
5034 |
|
5035 | <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;">
|
5036 |
|
5037 | document
|
5038 |
|
5039 | </td>
|
5040 |
|
5041 |
|
5042 | <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 target where we want to attach the event listener.</p></td>
|
5043 | </tr>
|
5044 |
|
5045 |
|
5046 | </tbody>
|
5047 | </table>
|
5048 |
|
5049 |
|
5050 |
|
5051 |
|
5052 | <dl class="details">
|
5053 |
|
5054 |
|
5055 |
|
5056 |
|
5057 |
|
5058 |
|
5059 |
|
5060 |
|
5061 |
|
5062 |
|
5063 |
|
5064 |
|
5065 |
|
5066 |
|
5067 |
|
5068 |
|
5069 |
|
5070 |
|
5071 |
|
5072 |
|
5073 |
|
5074 |
|
5075 |
|
5076 |
|
5077 |
|
5078 |
|
5079 |
|
5080 |
|
5081 |
|
5082 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5083 | <dd class="tag-source">
|
5084 | <ul class="dummy">
|
5085 | <li>
|
5086 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
5087 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-561">line 561</a>
|
5088 | </li>
|
5089 | </ul>
|
5090 | </dd>
|
5091 |
|
5092 |
|
5093 |
|
5094 |
|
5095 |
|
5096 |
|
5097 |
|
5098 | </dl>
|
5099 |
|
5100 |
|
5101 |
|
5102 |
|
5103 |
|
5104 |
|
5105 |
|
5106 |
|
5107 |
|
5108 |
|
5109 |
|
5110 |
|
5111 |
|
5112 |
|
5113 |
|
5114 | </dd>
|
5115 |
|
5116 |
|
5117 |
|
5118 | <hr>
|
5119 | <dt>
|
5120 | <h4 class="name" id=".onClick"><span class="type-signature"><static> </span>onClick<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
5121 |
|
5122 |
|
5123 | </dt>
|
5124 | <dd>
|
5125 |
|
5126 |
|
5127 | <div class="description">
|
5128 | <p>Sets a function to execute when a click happens (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event">onClick</a> event) or removes it.</p>
|
5129 | </div>
|
5130 |
|
5131 |
|
5132 |
|
5133 |
|
5134 |
|
5135 |
|
5136 |
|
5137 |
|
5138 | <h5>Parameters:</h5>
|
5139 |
|
5140 |
|
5141 | <table class="params table table-striped">
|
5142 | <thead>
|
5143 | <tr>
|
5144 |
|
5145 | <th style="width:12%; min-width:110px;">Name</th>
|
5146 |
|
5147 |
|
5148 | <th style="width:12%; min-width:110px;">Type</th>
|
5149 |
|
5150 |
|
5151 | <th style="width:12%; min-width:110px;">Argument</th>
|
5152 |
|
5153 |
|
5154 |
|
5155 | <th style="width:12%; min-width:110px;">Default</th>
|
5156 |
|
5157 |
|
5158 | <th class="last" style="min-width:310px;">Description</th>
|
5159 | </tr>
|
5160 | </thead>
|
5161 |
|
5162 | <tbody>
|
5163 |
|
5164 |
|
5165 | <tr>
|
5166 |
|
5167 | <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>
|
5168 |
|
5169 |
|
5170 | <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;">
|
5171 |
|
5172 |
|
5173 | <span class="param-type">function</span>
|
5174 | |
|
5175 |
|
5176 | <span class="param-type">null</span>
|
5177 |
|
5178 |
|
5179 |
|
5180 |
|
5181 | </td>
|
5182 |
|
5183 |
|
5184 | <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;">
|
5185 |
|
5186 |
|
5187 |
|
5188 |
|
5189 |
|
5190 | </td>
|
5191 |
|
5192 |
|
5193 |
|
5194 | <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;">
|
5195 |
|
5196 | </td>
|
5197 |
|
5198 |
|
5199 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
5200 | </tr>
|
5201 |
|
5202 |
|
5203 |
|
5204 | <tr>
|
5205 |
|
5206 | <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>
|
5207 |
|
5208 |
|
5209 | <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;">
|
5210 |
|
5211 |
|
5212 | <span class="param-type">boolean</span>
|
5213 |
|
5214 |
|
5215 |
|
5216 |
|
5217 | </td>
|
5218 |
|
5219 |
|
5220 | <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;">
|
5221 |
|
5222 | <optional><br>
|
5223 |
|
5224 |
|
5225 |
|
5226 |
|
5227 |
|
5228 | </td>
|
5229 |
|
5230 |
|
5231 |
|
5232 | <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;">
|
5233 |
|
5234 | true
|
5235 |
|
5236 | </td>
|
5237 |
|
5238 |
|
5239 | <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>
|
5240 | </tr>
|
5241 |
|
5242 |
|
5243 |
|
5244 | <tr>
|
5245 |
|
5246 | <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>useCapture</code></td>
|
5247 |
|
5248 |
|
5249 | <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;">
|
5250 |
|
5251 |
|
5252 | <span class="param-type">boolean</span>
|
5253 |
|
5254 |
|
5255 |
|
5256 |
|
5257 | </td>
|
5258 |
|
5259 |
|
5260 | <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;">
|
5261 |
|
5262 | <optional><br>
|
5263 |
|
5264 |
|
5265 |
|
5266 |
|
5267 |
|
5268 | </td>
|
5269 |
|
5270 |
|
5271 |
|
5272 | <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;">
|
5273 |
|
5274 | false
|
5275 |
|
5276 | </td>
|
5277 |
|
5278 |
|
5279 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
5280 | </tr>
|
5281 |
|
5282 |
|
5283 |
|
5284 | <tr>
|
5285 |
|
5286 | <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>target</code></td>
|
5287 |
|
5288 |
|
5289 | <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;">
|
5290 |
|
5291 |
|
5292 | <span class="param-type">Object</span>
|
5293 |
|
5294 |
|
5295 |
|
5296 |
|
5297 | </td>
|
5298 |
|
5299 |
|
5300 | <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;">
|
5301 |
|
5302 | <optional><br>
|
5303 |
|
5304 |
|
5305 |
|
5306 |
|
5307 |
|
5308 | </td>
|
5309 |
|
5310 |
|
5311 |
|
5312 | <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;">
|
5313 |
|
5314 | document
|
5315 |
|
5316 | </td>
|
5317 |
|
5318 |
|
5319 | <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 target where we want to attach the event listener.</p></td>
|
5320 | </tr>
|
5321 |
|
5322 |
|
5323 | </tbody>
|
5324 | </table>
|
5325 |
|
5326 |
|
5327 |
|
5328 |
|
5329 | <dl class="details">
|
5330 |
|
5331 |
|
5332 |
|
5333 |
|
5334 |
|
5335 |
|
5336 |
|
5337 |
|
5338 |
|
5339 |
|
5340 |
|
5341 |
|
5342 |
|
5343 |
|
5344 |
|
5345 |
|
5346 |
|
5347 |
|
5348 |
|
5349 |
|
5350 |
|
5351 |
|
5352 |
|
5353 |
|
5354 |
|
5355 |
|
5356 |
|
5357 |
|
5358 |
|
5359 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5360 | <dd class="tag-source">
|
5361 | <ul class="dummy">
|
5362 | <li>
|
5363 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
5364 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-519">line 519</a>
|
5365 | </li>
|
5366 | </ul>
|
5367 | </dd>
|
5368 |
|
5369 |
|
5370 |
|
5371 |
|
5372 |
|
5373 |
|
5374 |
|
5375 | </dl>
|
5376 |
|
5377 |
|
5378 |
|
5379 |
|
5380 |
|
5381 |
|
5382 |
|
5383 |
|
5384 |
|
5385 |
|
5386 |
|
5387 |
|
5388 |
|
5389 |
|
5390 |
|
5391 | </dd>
|
5392 |
|
5393 |
|
5394 |
|
5395 | <hr>
|
5396 | <dt>
|
5397 | <h4 class="name" id=".onDblClick"><span class="type-signature"><static> </span>onDblClick<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
5398 |
|
5399 |
|
5400 | </dt>
|
5401 | <dd>
|
5402 |
|
5403 |
|
5404 | <div class="description">
|
5405 | <p>Sets a function to execute when a click happens (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/dblclick_event">onDblClick</a> event) or removes it.</p>
|
5406 | </div>
|
5407 |
|
5408 |
|
5409 |
|
5410 |
|
5411 |
|
5412 |
|
5413 |
|
5414 |
|
5415 | <h5>Parameters:</h5>
|
5416 |
|
5417 |
|
5418 | <table class="params table table-striped">
|
5419 | <thead>
|
5420 | <tr>
|
5421 |
|
5422 | <th style="width:12%; min-width:110px;">Name</th>
|
5423 |
|
5424 |
|
5425 | <th style="width:12%; min-width:110px;">Type</th>
|
5426 |
|
5427 |
|
5428 | <th style="width:12%; min-width:110px;">Argument</th>
|
5429 |
|
5430 |
|
5431 |
|
5432 | <th style="width:12%; min-width:110px;">Default</th>
|
5433 |
|
5434 |
|
5435 | <th class="last" style="min-width:310px;">Description</th>
|
5436 | </tr>
|
5437 | </thead>
|
5438 |
|
5439 | <tbody>
|
5440 |
|
5441 |
|
5442 | <tr>
|
5443 |
|
5444 | <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>
|
5445 |
|
5446 |
|
5447 | <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;">
|
5448 |
|
5449 |
|
5450 | <span class="param-type">function</span>
|
5451 | |
|
5452 |
|
5453 | <span class="param-type">null</span>
|
5454 |
|
5455 |
|
5456 |
|
5457 |
|
5458 | </td>
|
5459 |
|
5460 |
|
5461 | <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;">
|
5462 |
|
5463 |
|
5464 |
|
5465 |
|
5466 |
|
5467 | </td>
|
5468 |
|
5469 |
|
5470 |
|
5471 | <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;">
|
5472 |
|
5473 | </td>
|
5474 |
|
5475 |
|
5476 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
5477 | </tr>
|
5478 |
|
5479 |
|
5480 |
|
5481 | <tr>
|
5482 |
|
5483 | <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>
|
5484 |
|
5485 |
|
5486 | <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;">
|
5487 |
|
5488 |
|
5489 | <span class="param-type">boolean</span>
|
5490 |
|
5491 |
|
5492 |
|
5493 |
|
5494 | </td>
|
5495 |
|
5496 |
|
5497 | <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;">
|
5498 |
|
5499 | <optional><br>
|
5500 |
|
5501 |
|
5502 |
|
5503 |
|
5504 |
|
5505 | </td>
|
5506 |
|
5507 |
|
5508 |
|
5509 | <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;">
|
5510 |
|
5511 | true
|
5512 |
|
5513 | </td>
|
5514 |
|
5515 |
|
5516 | <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>
|
5517 | </tr>
|
5518 |
|
5519 |
|
5520 |
|
5521 | <tr>
|
5522 |
|
5523 | <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>useCapture</code></td>
|
5524 |
|
5525 |
|
5526 | <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;">
|
5527 |
|
5528 |
|
5529 | <span class="param-type">boolean</span>
|
5530 |
|
5531 |
|
5532 |
|
5533 |
|
5534 | </td>
|
5535 |
|
5536 |
|
5537 | <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;">
|
5538 |
|
5539 | <optional><br>
|
5540 |
|
5541 |
|
5542 |
|
5543 |
|
5544 |
|
5545 | </td>
|
5546 |
|
5547 |
|
5548 |
|
5549 | <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;">
|
5550 |
|
5551 | false
|
5552 |
|
5553 | </td>
|
5554 |
|
5555 |
|
5556 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
5557 | </tr>
|
5558 |
|
5559 |
|
5560 |
|
5561 | <tr>
|
5562 |
|
5563 | <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>target</code></td>
|
5564 |
|
5565 |
|
5566 | <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;">
|
5567 |
|
5568 |
|
5569 | <span class="param-type">Object</span>
|
5570 |
|
5571 |
|
5572 |
|
5573 |
|
5574 | </td>
|
5575 |
|
5576 |
|
5577 | <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;">
|
5578 |
|
5579 | <optional><br>
|
5580 |
|
5581 |
|
5582 |
|
5583 |
|
5584 |
|
5585 | </td>
|
5586 |
|
5587 |
|
5588 |
|
5589 | <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;">
|
5590 |
|
5591 | document
|
5592 |
|
5593 | </td>
|
5594 |
|
5595 |
|
5596 | <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 target where we want to attach the event listener.</p></td>
|
5597 | </tr>
|
5598 |
|
5599 |
|
5600 | </tbody>
|
5601 | </table>
|
5602 |
|
5603 |
|
5604 |
|
5605 |
|
5606 | <dl class="details">
|
5607 |
|
5608 |
|
5609 |
|
5610 |
|
5611 |
|
5612 |
|
5613 |
|
5614 |
|
5615 |
|
5616 |
|
5617 |
|
5618 |
|
5619 |
|
5620 |
|
5621 |
|
5622 |
|
5623 |
|
5624 |
|
5625 |
|
5626 |
|
5627 |
|
5628 |
|
5629 |
|
5630 |
|
5631 |
|
5632 |
|
5633 |
|
5634 |
|
5635 |
|
5636 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5637 | <dd class="tag-source">
|
5638 | <ul class="dummy">
|
5639 | <li>
|
5640 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
5641 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-533">line 533</a>
|
5642 | </li>
|
5643 | </ul>
|
5644 | </dd>
|
5645 |
|
5646 |
|
5647 |
|
5648 |
|
5649 |
|
5650 |
|
5651 |
|
5652 | </dl>
|
5653 |
|
5654 |
|
5655 |
|
5656 |
|
5657 |
|
5658 |
|
5659 |
|
5660 |
|
5661 |
|
5662 |
|
5663 |
|
5664 |
|
5665 |
|
5666 |
|
5667 |
|
5668 | </dd>
|
5669 |
|
5670 |
|
5671 |
|
5672 | <hr>
|
5673 | <dt>
|
5674 | <h4 class="name" id=".onLeave"><span class="type-signature"><static> </span>onLeave<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
5675 |
|
5676 |
|
5677 | </dt>
|
5678 | <dd>
|
5679 |
|
5680 |
|
5681 | <div class="description">
|
5682 | <p>Sets a function to execute when a mouse leaves a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseleave_event">onMouseLeave</a> event) or removes it.</p>
|
5683 | </div>
|
5684 |
|
5685 |
|
5686 |
|
5687 |
|
5688 |
|
5689 |
|
5690 |
|
5691 |
|
5692 | <h5>Parameters:</h5>
|
5693 |
|
5694 |
|
5695 | <table class="params table table-striped">
|
5696 | <thead>
|
5697 | <tr>
|
5698 |
|
5699 | <th style="width:12%; min-width:110px;">Name</th>
|
5700 |
|
5701 |
|
5702 | <th style="width:12%; min-width:110px;">Type</th>
|
5703 |
|
5704 |
|
5705 | <th style="width:12%; min-width:110px;">Argument</th>
|
5706 |
|
5707 |
|
5708 |
|
5709 | <th style="width:12%; min-width:110px;">Default</th>
|
5710 |
|
5711 |
|
5712 | <th class="last" style="min-width:310px;">Description</th>
|
5713 | </tr>
|
5714 | </thead>
|
5715 |
|
5716 | <tbody>
|
5717 |
|
5718 |
|
5719 | <tr>
|
5720 |
|
5721 | <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>
|
5722 |
|
5723 |
|
5724 | <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;">
|
5725 |
|
5726 |
|
5727 | <span class="param-type">function</span>
|
5728 | |
|
5729 |
|
5730 | <span class="param-type">null</span>
|
5731 |
|
5732 |
|
5733 |
|
5734 |
|
5735 | </td>
|
5736 |
|
5737 |
|
5738 | <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;">
|
5739 |
|
5740 |
|
5741 |
|
5742 |
|
5743 |
|
5744 | </td>
|
5745 |
|
5746 |
|
5747 |
|
5748 | <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;">
|
5749 |
|
5750 | </td>
|
5751 |
|
5752 |
|
5753 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
5754 | </tr>
|
5755 |
|
5756 |
|
5757 |
|
5758 | <tr>
|
5759 |
|
5760 | <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>
|
5761 |
|
5762 |
|
5763 | <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;">
|
5764 |
|
5765 |
|
5766 | <span class="param-type">boolean</span>
|
5767 |
|
5768 |
|
5769 |
|
5770 |
|
5771 | </td>
|
5772 |
|
5773 |
|
5774 | <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;">
|
5775 |
|
5776 | <optional><br>
|
5777 |
|
5778 |
|
5779 |
|
5780 |
|
5781 |
|
5782 | </td>
|
5783 |
|
5784 |
|
5785 |
|
5786 | <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;">
|
5787 |
|
5788 | true
|
5789 |
|
5790 | </td>
|
5791 |
|
5792 |
|
5793 | <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>
|
5794 | </tr>
|
5795 |
|
5796 |
|
5797 |
|
5798 | <tr>
|
5799 |
|
5800 | <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>useCapture</code></td>
|
5801 |
|
5802 |
|
5803 | <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;">
|
5804 |
|
5805 |
|
5806 | <span class="param-type">boolean</span>
|
5807 |
|
5808 |
|
5809 |
|
5810 |
|
5811 | </td>
|
5812 |
|
5813 |
|
5814 | <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;">
|
5815 |
|
5816 | <optional><br>
|
5817 |
|
5818 |
|
5819 |
|
5820 |
|
5821 |
|
5822 | </td>
|
5823 |
|
5824 |
|
5825 |
|
5826 | <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;">
|
5827 |
|
5828 | false
|
5829 |
|
5830 | </td>
|
5831 |
|
5832 |
|
5833 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
5834 | </tr>
|
5835 |
|
5836 |
|
5837 |
|
5838 | <tr>
|
5839 |
|
5840 | <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>target</code></td>
|
5841 |
|
5842 |
|
5843 | <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;">
|
5844 |
|
5845 |
|
5846 | <span class="param-type">Object</span>
|
5847 |
|
5848 |
|
5849 |
|
5850 |
|
5851 | </td>
|
5852 |
|
5853 |
|
5854 | <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;">
|
5855 |
|
5856 | <optional><br>
|
5857 |
|
5858 |
|
5859 |
|
5860 |
|
5861 |
|
5862 | </td>
|
5863 |
|
5864 |
|
5865 |
|
5866 | <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;">
|
5867 |
|
5868 | window
|
5869 |
|
5870 | </td>
|
5871 |
|
5872 |
|
5873 | <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 target where we want to attach the event listener.</p></td>
|
5874 | </tr>
|
5875 |
|
5876 |
|
5877 | </tbody>
|
5878 | </table>
|
5879 |
|
5880 |
|
5881 |
|
5882 |
|
5883 | <dl class="details">
|
5884 |
|
5885 |
|
5886 |
|
5887 |
|
5888 |
|
5889 |
|
5890 |
|
5891 |
|
5892 |
|
5893 |
|
5894 |
|
5895 |
|
5896 |
|
5897 |
|
5898 |
|
5899 |
|
5900 |
|
5901 |
|
5902 |
|
5903 |
|
5904 |
|
5905 |
|
5906 |
|
5907 |
|
5908 |
|
5909 |
|
5910 |
|
5911 |
|
5912 |
|
5913 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5914 | <dd class="tag-source">
|
5915 | <ul class="dummy">
|
5916 | <li>
|
5917 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
5918 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-575">line 575</a>
|
5919 | </li>
|
5920 | </ul>
|
5921 | </dd>
|
5922 |
|
5923 |
|
5924 |
|
5925 |
|
5926 |
|
5927 |
|
5928 |
|
5929 | </dl>
|
5930 |
|
5931 |
|
5932 |
|
5933 |
|
5934 |
|
5935 |
|
5936 |
|
5937 |
|
5938 |
|
5939 |
|
5940 |
|
5941 |
|
5942 |
|
5943 |
|
5944 |
|
5945 | </dd>
|
5946 |
|
5947 |
|
5948 |
|
5949 | <hr>
|
5950 | <dt>
|
5951 | <h4 class="name" id=".onLockChange"><span class="type-signature"><static> </span>onLockChange<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture])</span><span class="type-signature"></span></h4>
|
5952 |
|
5953 |
|
5954 | </dt>
|
5955 | <dd>
|
5956 |
|
5957 |
|
5958 | <div class="description">
|
5959 | <p>Sets a function to execute when the mouse pointer lock functionality changes its state (it has been either locked or unlocked, using <code>pointerlockchange</code>}, <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">mozpointerlockchange</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">webkitpointerlockchange</a> event) or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
5960 | </div>
|
5961 |
|
5962 |
|
5963 |
|
5964 |
|
5965 |
|
5966 |
|
5967 |
|
5968 |
|
5969 | <h5>Parameters:</h5>
|
5970 |
|
5971 |
|
5972 | <table class="params table table-striped">
|
5973 | <thead>
|
5974 | <tr>
|
5975 |
|
5976 | <th style="width:12%; min-width:110px;">Name</th>
|
5977 |
|
5978 |
|
5979 | <th style="width:12%; min-width:110px;">Type</th>
|
5980 |
|
5981 |
|
5982 | <th style="width:12%; min-width:110px;">Argument</th>
|
5983 |
|
5984 |
|
5985 |
|
5986 | <th style="width:12%; min-width:110px;">Default</th>
|
5987 |
|
5988 |
|
5989 | <th class="last" style="min-width:310px;">Description</th>
|
5990 | </tr>
|
5991 | </thead>
|
5992 |
|
5993 | <tbody>
|
5994 |
|
5995 |
|
5996 | <tr>
|
5997 |
|
5998 | <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>
|
5999 |
|
6000 |
|
6001 | <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;">
|
6002 |
|
6003 |
|
6004 | <span class="param-type">function</span>
|
6005 | |
|
6006 |
|
6007 | <span class="param-type">null</span>
|
6008 |
|
6009 |
|
6010 |
|
6011 |
|
6012 | </td>
|
6013 |
|
6014 |
|
6015 | <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;">
|
6016 |
|
6017 |
|
6018 |
|
6019 |
|
6020 |
|
6021 | </td>
|
6022 |
|
6023 |
|
6024 |
|
6025 | <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;">
|
6026 |
|
6027 | </td>
|
6028 |
|
6029 |
|
6030 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
6031 | </tr>
|
6032 |
|
6033 |
|
6034 |
|
6035 | <tr>
|
6036 |
|
6037 | <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>
|
6038 |
|
6039 |
|
6040 | <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;">
|
6041 |
|
6042 |
|
6043 | <span class="param-type">boolean</span>
|
6044 |
|
6045 |
|
6046 |
|
6047 |
|
6048 | </td>
|
6049 |
|
6050 |
|
6051 | <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;">
|
6052 |
|
6053 | <optional><br>
|
6054 |
|
6055 |
|
6056 |
|
6057 |
|
6058 |
|
6059 | </td>
|
6060 |
|
6061 |
|
6062 |
|
6063 | <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;">
|
6064 |
|
6065 | true
|
6066 |
|
6067 | </td>
|
6068 |
|
6069 |
|
6070 | <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>
|
6071 | </tr>
|
6072 |
|
6073 |
|
6074 |
|
6075 | <tr>
|
6076 |
|
6077 | <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>useCapture</code></td>
|
6078 |
|
6079 |
|
6080 | <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;">
|
6081 |
|
6082 |
|
6083 | <span class="param-type">boolean</span>
|
6084 |
|
6085 |
|
6086 |
|
6087 |
|
6088 | </td>
|
6089 |
|
6090 |
|
6091 | <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;">
|
6092 |
|
6093 | <optional><br>
|
6094 |
|
6095 |
|
6096 |
|
6097 |
|
6098 |
|
6099 | </td>
|
6100 |
|
6101 |
|
6102 |
|
6103 | <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;">
|
6104 |
|
6105 | false
|
6106 |
|
6107 | </td>
|
6108 |
|
6109 |
|
6110 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
6111 | </tr>
|
6112 |
|
6113 |
|
6114 | </tbody>
|
6115 | </table>
|
6116 |
|
6117 |
|
6118 |
|
6119 |
|
6120 | <dl class="details">
|
6121 |
|
6122 |
|
6123 |
|
6124 |
|
6125 |
|
6126 |
|
6127 |
|
6128 |
|
6129 |
|
6130 |
|
6131 |
|
6132 |
|
6133 |
|
6134 |
|
6135 |
|
6136 |
|
6137 |
|
6138 |
|
6139 |
|
6140 |
|
6141 |
|
6142 |
|
6143 |
|
6144 |
|
6145 |
|
6146 |
|
6147 |
|
6148 |
|
6149 |
|
6150 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6151 | <dd class="tag-source">
|
6152 | <ul class="dummy">
|
6153 | <li>
|
6154 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
6155 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-777">line 777</a>
|
6156 | </li>
|
6157 | </ul>
|
6158 | </dd>
|
6159 |
|
6160 |
|
6161 |
|
6162 |
|
6163 |
|
6164 |
|
6165 |
|
6166 | </dl>
|
6167 |
|
6168 |
|
6169 |
|
6170 |
|
6171 |
|
6172 |
|
6173 |
|
6174 |
|
6175 |
|
6176 |
|
6177 |
|
6178 |
|
6179 |
|
6180 |
|
6181 |
|
6182 | </dd>
|
6183 |
|
6184 |
|
6185 |
|
6186 | <hr>
|
6187 | <dt>
|
6188 | <h4 class="name" id=".onLockError"><span class="type-signature"><static> </span>onLockError<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture])</span><span class="type-signature"></span></h4>
|
6189 |
|
6190 |
|
6191 | </dt>
|
6192 | <dd>
|
6193 |
|
6194 |
|
6195 | <div class="description">
|
6196 | <p>Sets a function to execute when the mouse pointer fails to either lock or unlock (using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerlockerror_event">pointerlockerror</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">mozpointerlockerror</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">webkitpointerlockerror</a> event) or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
6197 | </div>
|
6198 |
|
6199 |
|
6200 |
|
6201 |
|
6202 |
|
6203 |
|
6204 |
|
6205 |
|
6206 | <h5>Parameters:</h5>
|
6207 |
|
6208 |
|
6209 | <table class="params table table-striped">
|
6210 | <thead>
|
6211 | <tr>
|
6212 |
|
6213 | <th style="width:12%; min-width:110px;">Name</th>
|
6214 |
|
6215 |
|
6216 | <th style="width:12%; min-width:110px;">Type</th>
|
6217 |
|
6218 |
|
6219 | <th style="width:12%; min-width:110px;">Argument</th>
|
6220 |
|
6221 |
|
6222 |
|
6223 | <th style="width:12%; min-width:110px;">Default</th>
|
6224 |
|
6225 |
|
6226 | <th class="last" style="min-width:310px;">Description</th>
|
6227 | </tr>
|
6228 | </thead>
|
6229 |
|
6230 | <tbody>
|
6231 |
|
6232 |
|
6233 | <tr>
|
6234 |
|
6235 | <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>
|
6236 |
|
6237 |
|
6238 | <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;">
|
6239 |
|
6240 |
|
6241 | <span class="param-type">function</span>
|
6242 | |
|
6243 |
|
6244 | <span class="param-type">null</span>
|
6245 |
|
6246 |
|
6247 |
|
6248 |
|
6249 | </td>
|
6250 |
|
6251 |
|
6252 | <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;">
|
6253 |
|
6254 |
|
6255 |
|
6256 |
|
6257 |
|
6258 | </td>
|
6259 |
|
6260 |
|
6261 |
|
6262 | <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;">
|
6263 |
|
6264 | </td>
|
6265 |
|
6266 |
|
6267 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
6268 | </tr>
|
6269 |
|
6270 |
|
6271 |
|
6272 | <tr>
|
6273 |
|
6274 | <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>
|
6275 |
|
6276 |
|
6277 | <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;">
|
6278 |
|
6279 |
|
6280 | <span class="param-type">boolean</span>
|
6281 |
|
6282 |
|
6283 |
|
6284 |
|
6285 | </td>
|
6286 |
|
6287 |
|
6288 | <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;">
|
6289 |
|
6290 | <optional><br>
|
6291 |
|
6292 |
|
6293 |
|
6294 |
|
6295 |
|
6296 | </td>
|
6297 |
|
6298 |
|
6299 |
|
6300 | <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;">
|
6301 |
|
6302 | true
|
6303 |
|
6304 | </td>
|
6305 |
|
6306 |
|
6307 | <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>
|
6308 | </tr>
|
6309 |
|
6310 |
|
6311 |
|
6312 | <tr>
|
6313 |
|
6314 | <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>useCapture</code></td>
|
6315 |
|
6316 |
|
6317 | <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;">
|
6318 |
|
6319 |
|
6320 | <span class="param-type">boolean</span>
|
6321 |
|
6322 |
|
6323 |
|
6324 |
|
6325 | </td>
|
6326 |
|
6327 |
|
6328 | <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;">
|
6329 |
|
6330 | <optional><br>
|
6331 |
|
6332 |
|
6333 |
|
6334 |
|
6335 |
|
6336 | </td>
|
6337 |
|
6338 |
|
6339 |
|
6340 | <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;">
|
6341 |
|
6342 | false
|
6343 |
|
6344 | </td>
|
6345 |
|
6346 |
|
6347 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
6348 | </tr>
|
6349 |
|
6350 |
|
6351 | </tbody>
|
6352 | </table>
|
6353 |
|
6354 |
|
6355 |
|
6356 |
|
6357 | <dl class="details">
|
6358 |
|
6359 |
|
6360 |
|
6361 |
|
6362 |
|
6363 |
|
6364 |
|
6365 |
|
6366 |
|
6367 |
|
6368 |
|
6369 |
|
6370 |
|
6371 |
|
6372 |
|
6373 |
|
6374 |
|
6375 |
|
6376 |
|
6377 |
|
6378 |
|
6379 |
|
6380 |
|
6381 |
|
6382 |
|
6383 |
|
6384 |
|
6385 |
|
6386 |
|
6387 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6388 | <dd class="tag-source">
|
6389 | <ul class="dummy">
|
6390 | <li>
|
6391 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
6392 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-792">line 792</a>
|
6393 | </li>
|
6394 | </ul>
|
6395 | </dd>
|
6396 |
|
6397 |
|
6398 |
|
6399 |
|
6400 |
|
6401 |
|
6402 |
|
6403 | </dl>
|
6404 |
|
6405 |
|
6406 |
|
6407 |
|
6408 |
|
6409 |
|
6410 |
|
6411 |
|
6412 |
|
6413 |
|
6414 |
|
6415 |
|
6416 |
|
6417 |
|
6418 |
|
6419 | </dd>
|
6420 |
|
6421 |
|
6422 |
|
6423 | <hr>
|
6424 | <dt>
|
6425 | <h4 class="name" id=".onMove"><span class="type-signature"><static> </span>onMove<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
6426 |
|
6427 |
|
6428 | </dt>
|
6429 | <dd>
|
6430 |
|
6431 |
|
6432 | <div class="description">
|
6433 | <p>Sets a function to execute when a click happens (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event) or removes it.</p>
|
6434 | </div>
|
6435 |
|
6436 |
|
6437 |
|
6438 |
|
6439 |
|
6440 |
|
6441 |
|
6442 |
|
6443 | <h5>Parameters:</h5>
|
6444 |
|
6445 |
|
6446 | <table class="params table table-striped">
|
6447 | <thead>
|
6448 | <tr>
|
6449 |
|
6450 | <th style="width:12%; min-width:110px;">Name</th>
|
6451 |
|
6452 |
|
6453 | <th style="width:12%; min-width:110px;">Type</th>
|
6454 |
|
6455 |
|
6456 | <th style="width:12%; min-width:110px;">Argument</th>
|
6457 |
|
6458 |
|
6459 |
|
6460 | <th style="width:12%; min-width:110px;">Default</th>
|
6461 |
|
6462 |
|
6463 | <th class="last" style="min-width:310px;">Description</th>
|
6464 | </tr>
|
6465 | </thead>
|
6466 |
|
6467 | <tbody>
|
6468 |
|
6469 |
|
6470 | <tr>
|
6471 |
|
6472 | <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>
|
6473 |
|
6474 |
|
6475 | <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;">
|
6476 |
|
6477 |
|
6478 | <span class="param-type">function</span>
|
6479 | |
|
6480 |
|
6481 | <span class="param-type">null</span>
|
6482 |
|
6483 |
|
6484 |
|
6485 |
|
6486 | </td>
|
6487 |
|
6488 |
|
6489 | <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;">
|
6490 |
|
6491 |
|
6492 |
|
6493 |
|
6494 |
|
6495 | </td>
|
6496 |
|
6497 |
|
6498 |
|
6499 | <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;">
|
6500 |
|
6501 | </td>
|
6502 |
|
6503 |
|
6504 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
6505 | </tr>
|
6506 |
|
6507 |
|
6508 |
|
6509 | <tr>
|
6510 |
|
6511 | <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>
|
6512 |
|
6513 |
|
6514 | <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;">
|
6515 |
|
6516 |
|
6517 | <span class="param-type">boolean</span>
|
6518 |
|
6519 |
|
6520 |
|
6521 |
|
6522 | </td>
|
6523 |
|
6524 |
|
6525 | <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;">
|
6526 |
|
6527 | <optional><br>
|
6528 |
|
6529 |
|
6530 |
|
6531 |
|
6532 |
|
6533 | </td>
|
6534 |
|
6535 |
|
6536 |
|
6537 | <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;">
|
6538 |
|
6539 | true
|
6540 |
|
6541 | </td>
|
6542 |
|
6543 |
|
6544 | <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>
|
6545 | </tr>
|
6546 |
|
6547 |
|
6548 |
|
6549 | <tr>
|
6550 |
|
6551 | <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>useCapture</code></td>
|
6552 |
|
6553 |
|
6554 | <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;">
|
6555 |
|
6556 |
|
6557 | <span class="param-type">boolean</span>
|
6558 |
|
6559 |
|
6560 |
|
6561 |
|
6562 | </td>
|
6563 |
|
6564 |
|
6565 | <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;">
|
6566 |
|
6567 | <optional><br>
|
6568 |
|
6569 |
|
6570 |
|
6571 |
|
6572 |
|
6573 | </td>
|
6574 |
|
6575 |
|
6576 |
|
6577 | <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;">
|
6578 |
|
6579 | false
|
6580 |
|
6581 | </td>
|
6582 |
|
6583 |
|
6584 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
6585 | </tr>
|
6586 |
|
6587 |
|
6588 |
|
6589 | <tr>
|
6590 |
|
6591 | <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>target</code></td>
|
6592 |
|
6593 |
|
6594 | <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;">
|
6595 |
|
6596 |
|
6597 | <span class="param-type">Object</span>
|
6598 |
|
6599 |
|
6600 |
|
6601 |
|
6602 | </td>
|
6603 |
|
6604 |
|
6605 | <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;">
|
6606 |
|
6607 | <optional><br>
|
6608 |
|
6609 |
|
6610 |
|
6611 |
|
6612 |
|
6613 | </td>
|
6614 |
|
6615 |
|
6616 |
|
6617 | <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;">
|
6618 |
|
6619 | document
|
6620 |
|
6621 | </td>
|
6622 |
|
6623 |
|
6624 | <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 target where we want to attach the event listener.</p></td>
|
6625 | </tr>
|
6626 |
|
6627 |
|
6628 | </tbody>
|
6629 | </table>
|
6630 |
|
6631 |
|
6632 |
|
6633 |
|
6634 | <dl class="details">
|
6635 |
|
6636 |
|
6637 |
|
6638 |
|
6639 |
|
6640 |
|
6641 |
|
6642 |
|
6643 |
|
6644 |
|
6645 |
|
6646 |
|
6647 |
|
6648 |
|
6649 |
|
6650 |
|
6651 |
|
6652 |
|
6653 |
|
6654 |
|
6655 |
|
6656 |
|
6657 |
|
6658 |
|
6659 |
|
6660 |
|
6661 |
|
6662 |
|
6663 |
|
6664 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6665 | <dd class="tag-source">
|
6666 | <ul class="dummy">
|
6667 | <li>
|
6668 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
6669 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-505">line 505</a>
|
6670 | </li>
|
6671 | </ul>
|
6672 | </dd>
|
6673 |
|
6674 |
|
6675 |
|
6676 |
|
6677 |
|
6678 |
|
6679 |
|
6680 | </dl>
|
6681 |
|
6682 |
|
6683 |
|
6684 |
|
6685 |
|
6686 |
|
6687 |
|
6688 |
|
6689 |
|
6690 |
|
6691 |
|
6692 |
|
6693 |
|
6694 |
|
6695 |
|
6696 | </dd>
|
6697 |
|
6698 |
|
6699 |
|
6700 | <hr>
|
6701 | <dt>
|
6702 | <h4 class="name" id=".onOut"><span class="type-signature"><static> </span>onOut<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
6703 |
|
6704 |
|
6705 | </dt>
|
6706 | <dd>
|
6707 |
|
6708 |
|
6709 | <div class="description">
|
6710 | <p>Sets a function to execute when a mouse gets out of a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseout_event">onMouseOut</a> event) or removes it.</p>
|
6711 | </div>
|
6712 |
|
6713 |
|
6714 |
|
6715 |
|
6716 |
|
6717 |
|
6718 |
|
6719 |
|
6720 | <h5>Parameters:</h5>
|
6721 |
|
6722 |
|
6723 | <table class="params table table-striped">
|
6724 | <thead>
|
6725 | <tr>
|
6726 |
|
6727 | <th style="width:12%; min-width:110px;">Name</th>
|
6728 |
|
6729 |
|
6730 | <th style="width:12%; min-width:110px;">Type</th>
|
6731 |
|
6732 |
|
6733 | <th style="width:12%; min-width:110px;">Argument</th>
|
6734 |
|
6735 |
|
6736 |
|
6737 | <th style="width:12%; min-width:110px;">Default</th>
|
6738 |
|
6739 |
|
6740 | <th class="last" style="min-width:310px;">Description</th>
|
6741 | </tr>
|
6742 | </thead>
|
6743 |
|
6744 | <tbody>
|
6745 |
|
6746 |
|
6747 | <tr>
|
6748 |
|
6749 | <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>
|
6750 |
|
6751 |
|
6752 | <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;">
|
6753 |
|
6754 |
|
6755 | <span class="param-type">function</span>
|
6756 | |
|
6757 |
|
6758 | <span class="param-type">null</span>
|
6759 |
|
6760 |
|
6761 |
|
6762 |
|
6763 | </td>
|
6764 |
|
6765 |
|
6766 | <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;">
|
6767 |
|
6768 |
|
6769 |
|
6770 |
|
6771 |
|
6772 | </td>
|
6773 |
|
6774 |
|
6775 |
|
6776 | <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;">
|
6777 |
|
6778 | </td>
|
6779 |
|
6780 |
|
6781 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
6782 | </tr>
|
6783 |
|
6784 |
|
6785 |
|
6786 | <tr>
|
6787 |
|
6788 | <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>
|
6789 |
|
6790 |
|
6791 | <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;">
|
6792 |
|
6793 |
|
6794 | <span class="param-type">boolean</span>
|
6795 |
|
6796 |
|
6797 |
|
6798 |
|
6799 | </td>
|
6800 |
|
6801 |
|
6802 | <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;">
|
6803 |
|
6804 | <optional><br>
|
6805 |
|
6806 |
|
6807 |
|
6808 |
|
6809 |
|
6810 | </td>
|
6811 |
|
6812 |
|
6813 |
|
6814 | <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;">
|
6815 |
|
6816 | true
|
6817 |
|
6818 | </td>
|
6819 |
|
6820 |
|
6821 | <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>
|
6822 | </tr>
|
6823 |
|
6824 |
|
6825 |
|
6826 | <tr>
|
6827 |
|
6828 | <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>useCapture</code></td>
|
6829 |
|
6830 |
|
6831 | <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;">
|
6832 |
|
6833 |
|
6834 | <span class="param-type">boolean</span>
|
6835 |
|
6836 |
|
6837 |
|
6838 |
|
6839 | </td>
|
6840 |
|
6841 |
|
6842 | <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;">
|
6843 |
|
6844 | <optional><br>
|
6845 |
|
6846 |
|
6847 |
|
6848 |
|
6849 |
|
6850 | </td>
|
6851 |
|
6852 |
|
6853 |
|
6854 | <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;">
|
6855 |
|
6856 | false
|
6857 |
|
6858 | </td>
|
6859 |
|
6860 |
|
6861 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
6862 | </tr>
|
6863 |
|
6864 |
|
6865 |
|
6866 | <tr>
|
6867 |
|
6868 | <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>target</code></td>
|
6869 |
|
6870 |
|
6871 | <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;">
|
6872 |
|
6873 |
|
6874 | <span class="param-type">Object</span>
|
6875 |
|
6876 |
|
6877 |
|
6878 |
|
6879 | </td>
|
6880 |
|
6881 |
|
6882 | <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;">
|
6883 |
|
6884 | <optional><br>
|
6885 |
|
6886 |
|
6887 |
|
6888 |
|
6889 |
|
6890 | </td>
|
6891 |
|
6892 |
|
6893 |
|
6894 | <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;">
|
6895 |
|
6896 | document
|
6897 |
|
6898 | </td>
|
6899 |
|
6900 |
|
6901 | <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 target where we want to attach the event listener.</p></td>
|
6902 | </tr>
|
6903 |
|
6904 |
|
6905 | </tbody>
|
6906 | </table>
|
6907 |
|
6908 |
|
6909 |
|
6910 |
|
6911 | <dl class="details">
|
6912 |
|
6913 |
|
6914 |
|
6915 |
|
6916 |
|
6917 |
|
6918 |
|
6919 |
|
6920 |
|
6921 |
|
6922 |
|
6923 |
|
6924 |
|
6925 |
|
6926 |
|
6927 |
|
6928 |
|
6929 |
|
6930 |
|
6931 |
|
6932 |
|
6933 |
|
6934 |
|
6935 |
|
6936 |
|
6937 |
|
6938 |
|
6939 |
|
6940 |
|
6941 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6942 | <dd class="tag-source">
|
6943 | <ul class="dummy">
|
6944 | <li>
|
6945 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
6946 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-603">line 603</a>
|
6947 | </li>
|
6948 | </ul>
|
6949 | </dd>
|
6950 |
|
6951 |
|
6952 |
|
6953 |
|
6954 |
|
6955 |
|
6956 |
|
6957 | </dl>
|
6958 |
|
6959 |
|
6960 |
|
6961 |
|
6962 |
|
6963 |
|
6964 |
|
6965 |
|
6966 |
|
6967 |
|
6968 |
|
6969 |
|
6970 |
|
6971 |
|
6972 |
|
6973 | </dd>
|
6974 |
|
6975 |
|
6976 |
|
6977 | <hr>
|
6978 | <dt>
|
6979 | <h4 class="name" id=".onOver"><span class="type-signature"><static> </span>onOver<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
6980 |
|
6981 |
|
6982 | </dt>
|
6983 | <dd>
|
6984 |
|
6985 |
|
6986 | <div class="description">
|
6987 | <p>Sets a function to execute when a mouse is over a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseover_event">onMouseOver</a> event) or removes it.</p>
|
6988 | </div>
|
6989 |
|
6990 |
|
6991 |
|
6992 |
|
6993 |
|
6994 |
|
6995 |
|
6996 |
|
6997 | <h5>Parameters:</h5>
|
6998 |
|
6999 |
|
7000 | <table class="params table table-striped">
|
7001 | <thead>
|
7002 | <tr>
|
7003 |
|
7004 | <th style="width:12%; min-width:110px;">Name</th>
|
7005 |
|
7006 |
|
7007 | <th style="width:12%; min-width:110px;">Type</th>
|
7008 |
|
7009 |
|
7010 | <th style="width:12%; min-width:110px;">Argument</th>
|
7011 |
|
7012 |
|
7013 |
|
7014 | <th style="width:12%; min-width:110px;">Default</th>
|
7015 |
|
7016 |
|
7017 | <th class="last" style="min-width:310px;">Description</th>
|
7018 | </tr>
|
7019 | </thead>
|
7020 |
|
7021 | <tbody>
|
7022 |
|
7023 |
|
7024 | <tr>
|
7025 |
|
7026 | <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>
|
7027 |
|
7028 |
|
7029 | <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;">
|
7030 |
|
7031 |
|
7032 | <span class="param-type">function</span>
|
7033 | |
|
7034 |
|
7035 | <span class="param-type">null</span>
|
7036 |
|
7037 |
|
7038 |
|
7039 |
|
7040 | </td>
|
7041 |
|
7042 |
|
7043 | <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;">
|
7044 |
|
7045 |
|
7046 |
|
7047 |
|
7048 |
|
7049 | </td>
|
7050 |
|
7051 |
|
7052 |
|
7053 | <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;">
|
7054 |
|
7055 | </td>
|
7056 |
|
7057 |
|
7058 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
7059 | </tr>
|
7060 |
|
7061 |
|
7062 |
|
7063 | <tr>
|
7064 |
|
7065 | <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>
|
7066 |
|
7067 |
|
7068 | <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;">
|
7069 |
|
7070 |
|
7071 | <span class="param-type">boolean</span>
|
7072 |
|
7073 |
|
7074 |
|
7075 |
|
7076 | </td>
|
7077 |
|
7078 |
|
7079 | <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;">
|
7080 |
|
7081 | <optional><br>
|
7082 |
|
7083 |
|
7084 |
|
7085 |
|
7086 |
|
7087 | </td>
|
7088 |
|
7089 |
|
7090 |
|
7091 | <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;">
|
7092 |
|
7093 | true
|
7094 |
|
7095 | </td>
|
7096 |
|
7097 |
|
7098 | <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>
|
7099 | </tr>
|
7100 |
|
7101 |
|
7102 |
|
7103 | <tr>
|
7104 |
|
7105 | <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>useCapture</code></td>
|
7106 |
|
7107 |
|
7108 | <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;">
|
7109 |
|
7110 |
|
7111 | <span class="param-type">boolean</span>
|
7112 |
|
7113 |
|
7114 |
|
7115 |
|
7116 | </td>
|
7117 |
|
7118 |
|
7119 | <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;">
|
7120 |
|
7121 | <optional><br>
|
7122 |
|
7123 |
|
7124 |
|
7125 |
|
7126 |
|
7127 | </td>
|
7128 |
|
7129 |
|
7130 |
|
7131 | <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;">
|
7132 |
|
7133 | false
|
7134 |
|
7135 | </td>
|
7136 |
|
7137 |
|
7138 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
7139 | </tr>
|
7140 |
|
7141 |
|
7142 |
|
7143 | <tr>
|
7144 |
|
7145 | <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>target</code></td>
|
7146 |
|
7147 |
|
7148 | <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;">
|
7149 |
|
7150 |
|
7151 | <span class="param-type">Object</span>
|
7152 |
|
7153 |
|
7154 |
|
7155 |
|
7156 | </td>
|
7157 |
|
7158 |
|
7159 | <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;">
|
7160 |
|
7161 | <optional><br>
|
7162 |
|
7163 |
|
7164 |
|
7165 |
|
7166 |
|
7167 | </td>
|
7168 |
|
7169 |
|
7170 |
|
7171 | <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;">
|
7172 |
|
7173 | document
|
7174 |
|
7175 | </td>
|
7176 |
|
7177 |
|
7178 | <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 target where we want to attach the event listener.</p></td>
|
7179 | </tr>
|
7180 |
|
7181 |
|
7182 | </tbody>
|
7183 | </table>
|
7184 |
|
7185 |
|
7186 |
|
7187 |
|
7188 | <dl class="details">
|
7189 |
|
7190 |
|
7191 |
|
7192 |
|
7193 |
|
7194 |
|
7195 |
|
7196 |
|
7197 |
|
7198 |
|
7199 |
|
7200 |
|
7201 |
|
7202 |
|
7203 |
|
7204 |
|
7205 |
|
7206 |
|
7207 |
|
7208 |
|
7209 |
|
7210 |
|
7211 |
|
7212 |
|
7213 |
|
7214 |
|
7215 |
|
7216 |
|
7217 |
|
7218 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7219 | <dd class="tag-source">
|
7220 | <ul class="dummy">
|
7221 | <li>
|
7222 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
7223 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-589">line 589</a>
|
7224 | </li>
|
7225 | </ul>
|
7226 | </dd>
|
7227 |
|
7228 |
|
7229 |
|
7230 |
|
7231 |
|
7232 |
|
7233 |
|
7234 | </dl>
|
7235 |
|
7236 |
|
7237 |
|
7238 |
|
7239 |
|
7240 |
|
7241 |
|
7242 |
|
7243 |
|
7244 |
|
7245 |
|
7246 |
|
7247 |
|
7248 |
|
7249 |
|
7250 | </dd>
|
7251 |
|
7252 |
|
7253 |
|
7254 | <hr>
|
7255 | <dt>
|
7256 | <h4 class="name" id=".onWheel"><span class="type-signature"><static> </span>onWheel<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
|
7257 |
|
7258 |
|
7259 | </dt>
|
7260 | <dd>
|
7261 |
|
7262 |
|
7263 | <div class="description">
|
7264 | <p>Sets a function to execute when the mouse wheel is used (<a href="https://developer.mozilla.org/en-US/docs/Web/Events/wheel">onWheel</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousewheel_event">onMouseWheel</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/DOMMouseScroll_event">DOMMouseScroll</a> event) or removes it.</p>
|
7265 | </div>
|
7266 |
|
7267 |
|
7268 |
|
7269 |
|
7270 |
|
7271 |
|
7272 |
|
7273 |
|
7274 | <h5>Parameters:</h5>
|
7275 |
|
7276 |
|
7277 | <table class="params table table-striped">
|
7278 | <thead>
|
7279 | <tr>
|
7280 |
|
7281 | <th style="width:12%; min-width:110px;">Name</th>
|
7282 |
|
7283 |
|
7284 | <th style="width:12%; min-width:110px;">Type</th>
|
7285 |
|
7286 |
|
7287 | <th style="width:12%; min-width:110px;">Argument</th>
|
7288 |
|
7289 |
|
7290 |
|
7291 | <th style="width:12%; min-width:110px;">Default</th>
|
7292 |
|
7293 |
|
7294 | <th class="last" style="min-width:310px;">Description</th>
|
7295 | </tr>
|
7296 | </thead>
|
7297 |
|
7298 | <tbody>
|
7299 |
|
7300 |
|
7301 | <tr>
|
7302 |
|
7303 | <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>
|
7304 |
|
7305 |
|
7306 | <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;">
|
7307 |
|
7308 |
|
7309 | <span class="param-type">function</span>
|
7310 | |
|
7311 |
|
7312 | <span class="param-type">null</span>
|
7313 |
|
7314 |
|
7315 |
|
7316 |
|
7317 | </td>
|
7318 |
|
7319 |
|
7320 | <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;">
|
7321 |
|
7322 |
|
7323 |
|
7324 |
|
7325 |
|
7326 | </td>
|
7327 |
|
7328 |
|
7329 |
|
7330 | <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;">
|
7331 |
|
7332 | </td>
|
7333 |
|
7334 |
|
7335 | <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 and unique parameter received for this function will be the <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">mouse event object</a> (already normalized by the <a href="CB_Mouse.html#.normalizeEvent"><code>CB_Mouse.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
|
7336 | </tr>
|
7337 |
|
7338 |
|
7339 |
|
7340 | <tr>
|
7341 |
|
7342 | <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>
|
7343 |
|
7344 |
|
7345 | <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;">
|
7346 |
|
7347 |
|
7348 | <span class="param-type">boolean</span>
|
7349 |
|
7350 |
|
7351 |
|
7352 |
|
7353 | </td>
|
7354 |
|
7355 |
|
7356 | <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;">
|
7357 |
|
7358 | <optional><br>
|
7359 |
|
7360 |
|
7361 |
|
7362 |
|
7363 |
|
7364 | </td>
|
7365 |
|
7366 |
|
7367 |
|
7368 | <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;">
|
7369 |
|
7370 | true
|
7371 |
|
7372 | </td>
|
7373 |
|
7374 |
|
7375 | <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>
|
7376 | </tr>
|
7377 |
|
7378 |
|
7379 |
|
7380 | <tr>
|
7381 |
|
7382 | <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>useCapture</code></td>
|
7383 |
|
7384 |
|
7385 | <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;">
|
7386 |
|
7387 |
|
7388 | <span class="param-type">boolean</span>
|
7389 |
|
7390 |
|
7391 |
|
7392 |
|
7393 | </td>
|
7394 |
|
7395 |
|
7396 | <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;">
|
7397 |
|
7398 | <optional><br>
|
7399 |
|
7400 |
|
7401 |
|
7402 |
|
7403 |
|
7404 | </td>
|
7405 |
|
7406 |
|
7407 |
|
7408 | <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;">
|
7409 |
|
7410 | false
|
7411 |
|
7412 | </td>
|
7413 |
|
7414 |
|
7415 | <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 event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
|
7416 | </tr>
|
7417 |
|
7418 |
|
7419 |
|
7420 | <tr>
|
7421 |
|
7422 | <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>target</code></td>
|
7423 |
|
7424 |
|
7425 | <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;">
|
7426 |
|
7427 |
|
7428 | <span class="param-type">Object</span>
|
7429 |
|
7430 |
|
7431 |
|
7432 |
|
7433 | </td>
|
7434 |
|
7435 |
|
7436 | <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;">
|
7437 |
|
7438 | <optional><br>
|
7439 |
|
7440 |
|
7441 |
|
7442 |
|
7443 |
|
7444 | </td>
|
7445 |
|
7446 |
|
7447 |
|
7448 | <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;">
|
7449 |
|
7450 | document
|
7451 |
|
7452 | </td>
|
7453 |
|
7454 |
|
7455 | <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 target where we want to attach the event listener.</p></td>
|
7456 | </tr>
|
7457 |
|
7458 |
|
7459 | </tbody>
|
7460 | </table>
|
7461 |
|
7462 |
|
7463 |
|
7464 |
|
7465 | <dl class="details">
|
7466 |
|
7467 |
|
7468 |
|
7469 |
|
7470 |
|
7471 |
|
7472 |
|
7473 |
|
7474 |
|
7475 |
|
7476 |
|
7477 |
|
7478 |
|
7479 |
|
7480 |
|
7481 |
|
7482 |
|
7483 |
|
7484 |
|
7485 |
|
7486 |
|
7487 |
|
7488 |
|
7489 |
|
7490 |
|
7491 |
|
7492 |
|
7493 |
|
7494 |
|
7495 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7496 | <dd class="tag-source">
|
7497 | <ul class="dummy">
|
7498 | <li>
|
7499 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
7500 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-617">line 617</a>
|
7501 | </li>
|
7502 | </ul>
|
7503 | </dd>
|
7504 |
|
7505 |
|
7506 |
|
7507 |
|
7508 |
|
7509 |
|
7510 |
|
7511 | </dl>
|
7512 |
|
7513 |
|
7514 |
|
7515 |
|
7516 |
|
7517 |
|
7518 |
|
7519 |
|
7520 |
|
7521 |
|
7522 |
|
7523 |
|
7524 |
|
7525 |
|
7526 |
|
7527 | </dd>
|
7528 |
|
7529 |
|
7530 |
|
7531 | <hr>
|
7532 | <dt>
|
7533 | <h4 class="name" id=".restore"><span class="type-signature"><static> </span>restore<span class="signature">( [element] [, recursive])</span><span class="type-signature"></span></h4>
|
7534 |
|
7535 |
|
7536 | </dt>
|
7537 | <dd>
|
7538 |
|
7539 |
|
7540 | <div class="description">
|
7541 | <p>Restores (unhides) the mouse cursor in a given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> by changing its internal CSS code of the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">style.cursor</a> property to the default one (using "default" as the CSS code).</p>
|
7542 | </div>
|
7543 |
|
7544 |
|
7545 |
|
7546 |
|
7547 |
|
7548 |
|
7549 |
|
7550 |
|
7551 | <h5>Parameters:</h5>
|
7552 |
|
7553 |
|
7554 | <table class="params table table-striped">
|
7555 | <thead>
|
7556 | <tr>
|
7557 |
|
7558 | <th style="width:12%; min-width:110px;">Name</th>
|
7559 |
|
7560 |
|
7561 | <th style="width:12%; min-width:110px;">Type</th>
|
7562 |
|
7563 |
|
7564 | <th style="width:12%; min-width:110px;">Argument</th>
|
7565 |
|
7566 |
|
7567 |
|
7568 | <th style="width:12%; min-width:110px;">Default</th>
|
7569 |
|
7570 |
|
7571 | <th class="last" style="min-width:310px;">Description</th>
|
7572 | </tr>
|
7573 | </thead>
|
7574 |
|
7575 | <tbody>
|
7576 |
|
7577 |
|
7578 | <tr>
|
7579 |
|
7580 | <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>element</code></td>
|
7581 |
|
7582 |
|
7583 | <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;">
|
7584 |
|
7585 |
|
7586 | <span class="param-type">Element</span>
|
7587 |
|
7588 |
|
7589 |
|
7590 |
|
7591 | </td>
|
7592 |
|
7593 |
|
7594 | <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;">
|
7595 |
|
7596 | <optional><br>
|
7597 |
|
7598 |
|
7599 |
|
7600 |
|
7601 |
|
7602 | </td>
|
7603 |
|
7604 |
|
7605 |
|
7606 | <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;">
|
7607 |
|
7608 | document.body
|
7609 |
|
7610 | </td>
|
7611 |
|
7612 |
|
7613 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the mouse cursor will be restored (unhidden) when it is over this <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>. Otherwise, it will be restored (unhidden) in the whole document (using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/body">document.body</a> as the "element").</p></td>
|
7614 | </tr>
|
7615 |
|
7616 |
|
7617 |
|
7618 | <tr>
|
7619 |
|
7620 | <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>recursive</code></td>
|
7621 |
|
7622 |
|
7623 | <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;">
|
7624 |
|
7625 |
|
7626 | <span class="param-type">boolean</span>
|
7627 |
|
7628 |
|
7629 |
|
7630 |
|
7631 | </td>
|
7632 |
|
7633 |
|
7634 | <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;">
|
7635 |
|
7636 | <optional><br>
|
7637 |
|
7638 |
|
7639 |
|
7640 |
|
7641 |
|
7642 | </td>
|
7643 |
|
7644 |
|
7645 |
|
7646 | <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;">
|
7647 |
|
7648 | true
|
7649 |
|
7650 | </td>
|
7651 |
|
7652 |
|
7653 | <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 it is set to true, all the child <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM elements</a> will also be affected.</p></td>
|
7654 | </tr>
|
7655 |
|
7656 |
|
7657 | </tbody>
|
7658 | </table>
|
7659 |
|
7660 |
|
7661 |
|
7662 |
|
7663 | <dl class="details">
|
7664 |
|
7665 |
|
7666 |
|
7667 |
|
7668 |
|
7669 |
|
7670 |
|
7671 |
|
7672 |
|
7673 |
|
7674 |
|
7675 |
|
7676 |
|
7677 |
|
7678 |
|
7679 |
|
7680 |
|
7681 |
|
7682 |
|
7683 |
|
7684 |
|
7685 |
|
7686 |
|
7687 |
|
7688 |
|
7689 |
|
7690 |
|
7691 |
|
7692 |
|
7693 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7694 | <dd class="tag-source">
|
7695 | <ul class="dummy">
|
7696 | <li>
|
7697 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
7698 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1027">line 1027</a>
|
7699 | </li>
|
7700 | </ul>
|
7701 | </dd>
|
7702 |
|
7703 |
|
7704 |
|
7705 |
|
7706 |
|
7707 |
|
7708 |
|
7709 | </dl>
|
7710 |
|
7711 |
|
7712 |
|
7713 |
|
7714 |
|
7715 |
|
7716 |
|
7717 |
|
7718 |
|
7719 |
|
7720 |
|
7721 |
|
7722 |
|
7723 |
|
7724 |
|
7725 | </dd>
|
7726 |
|
7727 |
|
7728 |
|
7729 | <hr>
|
7730 | <dt>
|
7731 | <h4 class="name" id=".setCSS"><span class="type-signature"><static> </span>setCSS<span class="signature">( [CSS] [, element] [, recursive])</span><span class="type-signature"></span></h4>
|
7732 |
|
7733 |
|
7734 | </dt>
|
7735 | <dd>
|
7736 |
|
7737 |
|
7738 | <div class="description">
|
7739 | <p>Sets the desired CSS code for the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">style.cursor</a> property of the given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>.</p>
|
7740 | </div>
|
7741 |
|
7742 |
|
7743 |
|
7744 |
|
7745 |
|
7746 |
|
7747 |
|
7748 |
|
7749 | <h5>Parameters:</h5>
|
7750 |
|
7751 |
|
7752 | <table class="params table table-striped">
|
7753 | <thead>
|
7754 | <tr>
|
7755 |
|
7756 | <th style="width:12%; min-width:110px;">Name</th>
|
7757 |
|
7758 |
|
7759 | <th style="width:12%; min-width:110px;">Type</th>
|
7760 |
|
7761 |
|
7762 | <th style="width:12%; min-width:110px;">Argument</th>
|
7763 |
|
7764 |
|
7765 |
|
7766 | <th style="width:12%; min-width:110px;">Default</th>
|
7767 |
|
7768 |
|
7769 | <th class="last" style="min-width:310px;">Description</th>
|
7770 | </tr>
|
7771 | </thead>
|
7772 |
|
7773 | <tbody>
|
7774 |
|
7775 |
|
7776 | <tr>
|
7777 |
|
7778 | <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>CSS</code></td>
|
7779 |
|
7780 |
|
7781 | <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;">
|
7782 |
|
7783 |
|
7784 | <span class="param-type">string</span>
|
7785 |
|
7786 |
|
7787 |
|
7788 |
|
7789 | </td>
|
7790 |
|
7791 |
|
7792 | <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;">
|
7793 |
|
7794 | <optional><br>
|
7795 |
|
7796 |
|
7797 |
|
7798 |
|
7799 |
|
7800 | </td>
|
7801 |
|
7802 |
|
7803 |
|
7804 | <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;">
|
7805 |
|
7806 | ""
|
7807 |
|
7808 | </td>
|
7809 |
|
7810 |
|
7811 | <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>CSS code for the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/cursor">style.cursor</a> property of the given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>. If not given, an empty string will be used.</p></td>
|
7812 | </tr>
|
7813 |
|
7814 |
|
7815 |
|
7816 | <tr>
|
7817 |
|
7818 | <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>element</code></td>
|
7819 |
|
7820 |
|
7821 | <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;">
|
7822 |
|
7823 |
|
7824 | <span class="param-type">Element</span>
|
7825 |
|
7826 |
|
7827 |
|
7828 |
|
7829 | </td>
|
7830 |
|
7831 |
|
7832 | <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;">
|
7833 |
|
7834 | <optional><br>
|
7835 |
|
7836 |
|
7837 |
|
7838 |
|
7839 |
|
7840 | </td>
|
7841 |
|
7842 |
|
7843 |
|
7844 | <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;">
|
7845 |
|
7846 | document.body
|
7847 |
|
7848 | </td>
|
7849 |
|
7850 |
|
7851 | <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 a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> is given, the CSS code updated will affect the given <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a>. Otherwise, it will affect the whole document (using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/body">document.body</a> as the "element").</p></td>
|
7852 | </tr>
|
7853 |
|
7854 |
|
7855 |
|
7856 | <tr>
|
7857 |
|
7858 | <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>recursive</code></td>
|
7859 |
|
7860 |
|
7861 | <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;">
|
7862 |
|
7863 |
|
7864 | <span class="param-type">boolean</span>
|
7865 |
|
7866 |
|
7867 |
|
7868 |
|
7869 | </td>
|
7870 |
|
7871 |
|
7872 | <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;">
|
7873 |
|
7874 | <optional><br>
|
7875 |
|
7876 |
|
7877 |
|
7878 |
|
7879 |
|
7880 | </td>
|
7881 |
|
7882 |
|
7883 |
|
7884 | <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;">
|
7885 |
|
7886 | true
|
7887 |
|
7888 | </td>
|
7889 |
|
7890 |
|
7891 | <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 it is set to true, all the child <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM elements</a> will also be affected.</p></td>
|
7892 | </tr>
|
7893 |
|
7894 |
|
7895 | </tbody>
|
7896 | </table>
|
7897 |
|
7898 |
|
7899 |
|
7900 |
|
7901 | <dl class="details">
|
7902 |
|
7903 |
|
7904 |
|
7905 |
|
7906 |
|
7907 |
|
7908 |
|
7909 |
|
7910 |
|
7911 |
|
7912 |
|
7913 |
|
7914 |
|
7915 |
|
7916 |
|
7917 |
|
7918 |
|
7919 |
|
7920 |
|
7921 |
|
7922 |
|
7923 |
|
7924 |
|
7925 |
|
7926 |
|
7927 |
|
7928 |
|
7929 |
|
7930 |
|
7931 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7932 | <dd class="tag-source">
|
7933 | <ul class="dummy">
|
7934 | <li>
|
7935 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
7936 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1050">line 1050</a>
|
7937 | </li>
|
7938 | </ul>
|
7939 | </dd>
|
7940 |
|
7941 |
|
7942 |
|
7943 |
|
7944 |
|
7945 |
|
7946 |
|
7947 | </dl>
|
7948 |
|
7949 |
|
7950 |
|
7951 |
|
7952 |
|
7953 |
|
7954 |
|
7955 |
|
7956 |
|
7957 |
|
7958 |
|
7959 |
|
7960 |
|
7961 |
|
7962 |
|
7963 | </dd>
|
7964 |
|
7965 |
|
7966 |
|
7967 | <hr>
|
7968 | <dt>
|
7969 | <h4 class="name" id=".unlock"><span class="type-signature"><static> </span>unlock<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
7970 |
|
7971 |
|
7972 | </dt>
|
7973 | <dd>
|
7974 |
|
7975 |
|
7976 | <div class="description">
|
7977 | <p>Unlocks the mouse pointer (if possible). More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
7978 | </div>
|
7979 |
|
7980 |
|
7981 |
|
7982 |
|
7983 |
|
7984 |
|
7985 |
|
7986 |
|
7987 |
|
7988 |
|
7989 | <dl class="details">
|
7990 |
|
7991 |
|
7992 |
|
7993 |
|
7994 |
|
7995 |
|
7996 |
|
7997 |
|
7998 |
|
7999 |
|
8000 |
|
8001 |
|
8002 |
|
8003 |
|
8004 |
|
8005 |
|
8006 |
|
8007 |
|
8008 |
|
8009 |
|
8010 |
|
8011 |
|
8012 |
|
8013 |
|
8014 |
|
8015 |
|
8016 |
|
8017 |
|
8018 |
|
8019 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8020 | <dd class="tag-source">
|
8021 | <ul class="dummy">
|
8022 | <li>
|
8023 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
8024 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-751">line 751</a>
|
8025 | </li>
|
8026 | </ul>
|
8027 | </dd>
|
8028 |
|
8029 |
|
8030 |
|
8031 |
|
8032 |
|
8033 |
|
8034 |
|
8035 | </dl>
|
8036 |
|
8037 |
|
8038 |
|
8039 |
|
8040 |
|
8041 |
|
8042 |
|
8043 |
|
8044 |
|
8045 |
|
8046 |
|
8047 |
|
8048 |
|
8049 | <h5>Returns:</h5>
|
8050 |
|
8051 |
|
8052 | <div class="param-desc">
|
8053 | <p>Returns true if the mouse pointer has been unlocked or false otherwise.</p>
|
8054 | </div>
|
8055 |
|
8056 |
|
8057 |
|
8058 | <dl>
|
8059 | <dt>
|
8060 | Type
|
8061 | </dt>
|
8062 | <dd>
|
8063 |
|
8064 | <span class="param-type">boolean</span>
|
8065 |
|
8066 |
|
8067 |
|
8068 | </dd>
|
8069 | </dl>
|
8070 |
|
8071 |
|
8072 |
|
8073 |
|
8074 |
|
8075 | </dd>
|
8076 |
|
8077 |
|
8078 |
|
8079 | <hr>
|
8080 | <dt>
|
8081 | <h4 class="name" id=".wasLocked"><span class="type-signature"><static> </span>wasLocked<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
8082 |
|
8083 |
|
8084 | </dt>
|
8085 | <dd>
|
8086 |
|
8087 |
|
8088 | <div class="description">
|
8089 | <p>Tells whether the mouse pointer was locked before or not when the <a href="CB_Mouse.html#.isLocked"><code>CB_Mouse.isLocked</code></a> function was called the last time. More information: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API">Pointer Lock API</a>.</p>
|
8090 | </div>
|
8091 |
|
8092 |
|
8093 |
|
8094 |
|
8095 |
|
8096 |
|
8097 |
|
8098 |
|
8099 |
|
8100 |
|
8101 | <dl class="details">
|
8102 |
|
8103 |
|
8104 |
|
8105 |
|
8106 |
|
8107 |
|
8108 |
|
8109 |
|
8110 |
|
8111 |
|
8112 |
|
8113 |
|
8114 |
|
8115 |
|
8116 |
|
8117 |
|
8118 |
|
8119 |
|
8120 |
|
8121 |
|
8122 |
|
8123 |
|
8124 |
|
8125 |
|
8126 |
|
8127 |
|
8128 |
|
8129 |
|
8130 |
|
8131 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8132 | <dd class="tag-source">
|
8133 | <ul class="dummy">
|
8134 | <li>
|
8135 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
8136 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-679">line 679</a>
|
8137 | </li>
|
8138 | </ul>
|
8139 | </dd>
|
8140 |
|
8141 |
|
8142 |
|
8143 |
|
8144 |
|
8145 |
|
8146 |
|
8147 | </dl>
|
8148 |
|
8149 |
|
8150 |
|
8151 |
|
8152 |
|
8153 |
|
8154 |
|
8155 |
|
8156 |
|
8157 |
|
8158 |
|
8159 |
|
8160 |
|
8161 | <h5>Returns:</h5>
|
8162 |
|
8163 |
|
8164 | <div class="param-desc">
|
8165 | <p>Returns whether the mouse pointer was locked before or not when the <a href="CB_Mouse.html#.isLocked"><code>CB_Mouse.isLocked</code></a> function was called the last time.</p>
|
8166 | </div>
|
8167 |
|
8168 |
|
8169 |
|
8170 | <dl>
|
8171 | <dt>
|
8172 | Type
|
8173 | </dt>
|
8174 | <dd>
|
8175 |
|
8176 | <span class="param-type">boolean</span>
|
8177 |
|
8178 |
|
8179 |
|
8180 | </dd>
|
8181 | </dl>
|
8182 |
|
8183 |
|
8184 |
|
8185 |
|
8186 |
|
8187 | </dd>
|
8188 |
|
8189 | </dl>
|
8190 |
|
8191 |
|
8192 |
|
8193 |
|
8194 |
|
8195 | </article>
|
8196 |
|
8197 | </section>
|
8198 |
|
8199 |
|
8200 |
|
8201 |
|
8202 | </div>
|
8203 | </div>
|
8204 |
|
8205 | <div class="clearfix"></div>
|
8206 |
|
8207 |
|
8208 | <div class="col-md-3">
|
8209 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md" style="display:none; visibility:hidden;"></div>
|
8210 | </div>
|
8211 |
|
8212 |
|
8213 | </div>
|
8214 | </div>
|
8215 |
|
8216 |
|
8217 | <div class="modal fade" id="searchResults">
|
8218 | <div class="modal-dialog">
|
8219 | <div class="modal-content">
|
8220 | <div class="modal-header">
|
8221 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
8222 | <h4 class="modal-title">Search results</h4>
|
8223 | </div>
|
8224 | <div class="modal-body"></div>
|
8225 | <div class="modal-footer">
|
8226 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
8227 | </div>
|
8228 | </div>
|
8229 | </div>
|
8230 | </div>
|
8231 |
|
8232 |
|
8233 | <footer>
|
8234 |
|
8235 |
|
8236 | <span class="copyright">
|
8237 | <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>
|
8238 | </span>
|
8239 |
|
8240 | <span class="jsdoc-message">
|
8241 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
|
8242 |
|
8243 | on Wed Mar 22nd 2023
|
8244 |
|
8245 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
8246 | </span>
|
8247 | </footer>
|
8248 |
|
8249 | <script src="scripts/docstrap.lib.js"></script>
|
8250 | <script src="scripts/toc.js"></script>
|
8251 |
|
8252 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
8253 |
|
8254 |
|
8255 | <script>
|
8256 | $( function () {
|
8257 | $( "[id*='$']" ).each( function () {
|
8258 | var $this = $( this );
|
8259 |
|
8260 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
8261 | } );
|
8262 |
|
8263 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
8264 | var $this = $( this );
|
8265 |
|
8266 | var example = $this.find( "code" );
|
8267 | exampleText = example.html();
|
8268 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
8269 | if ( lang && lang[1] ) {
|
8270 | exampleText = exampleText.replace( lang[0], "" );
|
8271 | example.html( exampleText );
|
8272 | lang = lang[1];
|
8273 | } else {
|
8274 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
8275 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
8276 | }
|
8277 |
|
8278 | if ( lang ) {
|
8279 |
|
8280 | $this
|
8281 | .addClass( "sunlight-highlight-" + lang )
|
8282 | .addClass( "linenums" )
|
8283 | .html( example.html() );
|
8284 |
|
8285 | }
|
8286 | } );
|
8287 |
|
8288 | Sunlight.highlightAll( {
|
8289 | lineNumbers : true,
|
8290 | showMenu : true,
|
8291 | enableDoclinks : true
|
8292 | } );
|
8293 |
|
8294 | $.catchAnchorLinks( {
|
8295 | navbarOffset: 10
|
8296 | } );
|
8297 | $( "#toc" ).toc( {
|
8298 | anchorName : function ( i, heading, prefix ) {
|
8299 | return $( heading ).attr( "id" ) || ( prefix + i );
|
8300 | },
|
8301 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
8302 | showAndHide : false,
|
8303 | smoothScrolling: true
|
8304 | } );
|
8305 |
|
8306 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
8307 | $( '.dropdown-toggle' ).dropdown();
|
8308 |
|
8309 | $( "table" ).each( function () {
|
8310 | var $this = $( this );
|
8311 | $this.addClass('table');
|
8312 | } );
|
8313 |
|
8314 | } );
|
8315 | </script>
|
8316 |
|
8317 |
|
8318 |
|
8319 |
|
8320 |
|
8321 |
|
8322 |
|
8323 |
|
8324 |
|
8325 |
|
8326 | <script type="text/javascript">
|
8327 | $(document).ready(function() {
|
8328 | SearcherDisplay.init();
|
8329 | });
|
8330 | </script>
|
8331 |
|
8332 |
|
8333 | </body>
|
8334 | </html> |
\ | No newline at end of file |