Update documentation to 6886828.

api/kha/input/Gamepad.html

@@ -7,4 +7,6 @@
 	float: none;
 	text-shadow: 0 0 0 transparent;
 }
-</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Gamepad</h1><h4><small>package <a href="../../kha/input/index.html">kha.input</a></small></h4>    <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-allow" title="Allows private access from package, type or field.">@:allow(kha.SystemImpl)</span><span class="label label-meta label-meta-expose" title="Includes the class or field in Haxe exports (default name is the classpath).">@:expose</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="get"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ index : 0 })</span><span class="label label-static">static</span><a href="#get"><span class="identifier">get</span></a>(<span style="white-space:nowrap">index:<span class="type">Int</span> = 0</span>):<a class="type" title="kha.input.Gamepad" href="../../kha/input/Gamepad.html">Gamepad</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="notifyOnConnect"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#notifyOnConnect"><span class="identifier">notifyOnConnect</span></a>(<span style="white-space:nowrap">?connectListener:<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?disconnectListener:<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="removeConnect"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#removeConnect"><span class="identifier">removeConnect</span></a>(<span style="white-space:nowrap">?connectListener:<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?disconnectListener:<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="connected"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#connected"><span class="identifier">connected</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="id"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#id"><span class="identifier">id</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="vendor"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#vendor"><span class="identifier">vendor</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="notify"></a><h3 class="anchor"><code><a href="#notify"><span class="identifier">notify</span></a>(<span style="white-space:nowrap">?axisListener:(<span class="type">Int</span>, <span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?buttonListener:(<span class="type">Int</span>, <span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="remove"></a><h3 class="anchor"><code><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">?axisListener:(<span class="type">Int</span>, <span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?buttonListener:(<span class="type">Int</span>, <span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="rumble"></a><h3 class="anchor"><code><a href="#rumble"><span class="identifier">rumble</span></a>(<span style="white-space:nowrap">leftAmount:<span class="type">Float</span>,</span> <span style="white-space:nowrap">rightAmount:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2024 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>
+</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Gamepad</h1><h4><small>package <a href="../../kha/input/index.html">kha.input</a></small></h4>    <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-allow" title="Allows private access from package, type or field.">@:allow(kha.SystemImpl)</span><span class="label label-meta label-meta-expose" title="Includes the class or field in Haxe exports (default name is the classpath).">@:expose</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="get"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ index : 0 })</span><span class="label label-static">static</span><a href="#get"><span class="identifier">get</span></a>(<span style="white-space:nowrap">index:<span class="type">Int</span> = 0</span>):<span class="type">Null</span>&lt;<a class="type" title="kha.input.Gamepad" href="../../kha/input/Gamepad.html">Gamepad</a>&gt;</code></h3><div class="doc"><p></p></div></div><div class="field "><a name="notifyOnConnect"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#notifyOnConnect"><span class="identifier">notifyOnConnect</span></a>(<span style="white-space:nowrap">?connectListener:(index:<span class="type">Int</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?disconnectListener:(index:<span class="type">Int</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Use this event to get connected gamepad <code>index</code> and listen to it with <code><a href="../../kha/input/Gamepad.html#get">Gamepad.get</a>(index).notify(axisListener, buttonListener)</code>.</p>
+<p>Remember to also check <code><a href="../../kha/input/Gamepad.html#get">Gamepad.get</a>(0)</code>, gamepads may already be connected before the application was initialized.</p></div></div><div class="field "><a name="removeConnect"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#removeConnect"><span class="identifier">removeConnect</span></a>(<span style="white-space:nowrap">?connectListener:(index:<span class="type">Int</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?disconnectListener:(index:<span class="type">Int</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="connected"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#connected"><span class="identifier">connected</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="id"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#id"><span class="identifier">id</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="vendor"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#vendor"><span class="identifier">vendor</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="notify"></a><h3 class="anchor"><code><a href="#notify"><span class="identifier">notify</span></a>(<span style="white-space:nowrap">?axisListener:(axisId:<span class="type">Int</span>, value:<span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?buttonListener:(buttonId:<span class="type">Int</span>, value:<span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>In <code>axisListener</code>, <code>axisId</code> is axis id (for example <code>axis == 0</code> is L-stick <code>x</code>, <code>1</code> is L-stick <code>y</code>, <code>2</code> is R-stick <code>x</code>, <code>3</code> is R-stick <code>y</code>, ...) and <code>value</code> is in <code>-1.0 - 1.0</code> range.</p>
+<p>In <code>buttonListener</code>, <code>buttonId</code> is pressed button id (layout depends on <code>vendor</code>), and <code>value</code> is in <code>0 - 1.0</code> range how hard the button is pressed.</p></div></div><div class="field "><a name="remove"></a><h3 class="anchor"><code><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">?axisListener:(axisId:<span class="type">Int</span>, value:<span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>,</span> <span style="white-space:nowrap">?buttonListener:(buttonId:<span class="type">Int</span>, value:<span class="type">Float</span>)&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="rumble"></a><h3 class="anchor"><code><a href="#rumble"><span class="identifier">rumble</span></a>(<span style="white-space:nowrap">leftAmount:<span class="type">Float</span>,</span> <span style="white-space:nowrap">rightAmount:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2024 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>