Deploying to gh-pages from @ 72797cc 🚀

utilities/Controls.html

@@ -14,4 +14,4 @@
 If binder is a literal you can inline this</p></div></div><div class="field "><a name="checkByName"></a><h3 class="anchor"><code><a href="#checkByName"><span class="identifier">checkByName</span></a>(<span style="white-space:nowrap">name:<a class="type" title="utilities.Action" href="../utilities/Action.html">Action</a></span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="copyFrom"></a><h3 class="anchor"><code><a href="#copyFrom"><span class="identifier">copyFrom</span></a>(<span style="white-space:nowrap">controls:<a class="type" title="utilities.Controls - A list of actions that a player would invoke via some input device." href="../utilities/Controls.html">Controls</a>,</span> <span style="white-space:nowrap">?device:<a class="type" title="utilities.Device" href="../utilities/Device.html">Device</a></span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="copyTo"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#copyTo"><span class="identifier">copyTo</span></a>(<span style="white-space:nowrap">controls:<a class="type" title="utilities.Controls - A list of actions that a player would invoke via some input device." href="../utilities/Controls.html">Controls</a>,</span> <span style="white-space:nowrap">?device:<a class="type" title="utilities.Device" href="../utilities/Device.html">Device</a></span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getDialogueName"></a><h3 class="anchor"><code><a href="#getDialogueName"><span class="identifier">getDialogueName</span></a>(<span style="white-space:nowrap">action:<a class="type" title="flixel.input.actions.FlxActionDigital - A digital action is a binary on/off event like &quot;jump&quot; or &quot;fire&quot;." href="../flixel/input/actions/FlxActionDigital.html">FlxActionDigital</a></span>):<a class="type" title="String - The basic String class." href="../String.html">String</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getDialogueNameFromToken"></a><h3 class="anchor"><code><a href="#getDialogueNameFromToken"><span class="identifier">getDialogueNameFromToken</span></a>(<span style="white-space:nowrap">token:<a class="type" title="String - The basic String class." href="../String.html">String</a></span>):<a class="type" title="String - The basic String class." href="../String.html">String</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getInputsFor"></a><h3 class="anchor"><code><a href="#getInputsFor"><span class="identifier">getInputsFor</span></a>(<span style="white-space:nowrap">control:<a class="type" title="utilities.Control - Since, in many cases multiple actions should use similar keys, we don&#039;t want the rebinding UI to list every action." href="../utilities/Control.html">Control</a>,</span> <span style="white-space:nowrap">device:<a class="type" title="utilities.Device" href="../utilities/Device.html">Device</a>,</span> <span style="white-space:nowrap">?list:<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a>&gt;</span>):<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a>&gt;</code></h3><div class="doc"><p></p></div></div><div class="field "><a name="loadKeyBinds"></a><h3 class="anchor"><code><a href="#loadKeyBinds"><span class="identifier">loadKeyBinds</span></a>():<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="removeDevice"></a><h3 class="anchor"><code><a href="#removeDevice"><span class="identifier">removeDevice</span></a>(<span style="white-space:nowrap">device:<a class="type" title="utilities.Device" href="../utilities/Device.html">Device</a></span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="removeGamepad"></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({ deviceID : FlxInputDeviceID.ALL })</span><a href="#removeGamepad"><span class="identifier">removeGamepad</span></a>(<span style="white-space:nowrap">deviceID:<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a> = FlxInputDeviceID.ALL</span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="replaceBinding"></a><h3 class="anchor"><code><a href="#replaceBinding"><span class="identifier">replaceBinding</span></a>(<span style="white-space:nowrap">control:<a class="type" title="utilities.Control - Since, in many cases multiple actions should use similar keys, we don&#039;t want the rebinding UI to list every action." href="../utilities/Control.html">Control</a>,</span> <span style="white-space:nowrap">device:<a class="type" title="utilities.Device" href="../utilities/Device.html">Device</a>,</span> <span style="white-space:nowrap">?toAdd:<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a>,</span> <span style="white-space:nowrap">?toRemove:<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="setKeyboardScheme"></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({ reset : true })</span><a href="#setKeyboardScheme"><span class="identifier">setKeyboardScheme</span></a>(<span style="white-space:nowrap">scheme:<a class="type" title="utilities.KeyboardScheme" href="../utilities/KeyboardScheme.html">KeyboardScheme</a>,</span> <span style="white-space:nowrap">reset:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a> = true</span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="unbindButtons"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#unbindButtons"><span class="identifier">unbindButtons</span></a>(<span style="white-space:nowrap">control:<a class="type" title="utilities.Control - Since, in many cases multiple actions should use similar keys, we don&#039;t want the rebinding UI to list every action." href="../utilities/Control.html">Control</a>,</span> <span style="white-space:nowrap">gamepadID:<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a>,</span> <span style="white-space:nowrap">buttons:<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="flixel.input.gamepad.FlxGamepadInputID - A high-level list of unique values for gamepad inputs." href="../flixel/input/gamepad/FlxGamepadInputID.html">FlxGamepadInputID</a>&gt;</span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p>Sets all actions that pertain to the binder to trigger when the supplied keys are used.
 If binder is a literal you can inline this</p></div></div><div class="field "><a name="unbindKeys"></a><h3 class="anchor"><code><a href="#unbindKeys"><span class="identifier">unbindKeys</span></a>(<span style="white-space:nowrap">control:<a class="type" title="utilities.Control - Since, in many cases multiple actions should use similar keys, we don&#039;t want the rebinding UI to list every action." href="../utilities/Control.html">Control</a>,</span> <span style="white-space:nowrap">keys:<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="flixel.input.keyboard.FlxKey - Maps enum values and strings to integer keycodes." href="../flixel/input/keyboard/FlxKey.html">FlxKey</a>&gt;</span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p>Sets all actions that pertain to the binder to trigger when the supplied keys are used.
 If binder is a literal you can inline this</p></div></div></div>  <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.input.actions.FlxActionSet - Available since 4." href="../flixel/input/actions/FlxActionSet.html">FlxActionSet</a></h4><div style="display:none"><div class="field "><a name="active"></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(true)</span><a href="#active"><span class="identifier">active</span></a>:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a><span> = true</span></code></h3><div class="doc"><p>Whether this action set runs when update() is called</p></div></div><div class="field "><a name="analogActions"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#analogActions"><span class="identifier">analogActions</span></a>:<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="flixel.input.actions.FlxActionAnalog - Analog actions are events with continuous (floating-point) values, and up to two axes (x,y)." href="../flixel/input/actions/FlxActionAnalog.html">FlxActionAnalog</a>&gt;</code></h3><div class="doc"><p>Analog actions in this set</p></div></div><div class="field "><a name="digitalActions"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#digitalActions"><span class="identifier">digitalActions</span></a>:<a class="type" title="Array - An Array is a storage for values." href="../Array.html">Array</a>&lt;<a class="type" title="flixel.input.actions.FlxActionDigital - A digital action is a binary on/off event like &quot;jump&quot; or &quot;fire&quot;." href="../flixel/input/actions/FlxActionDigital.html">FlxActionDigital</a>&gt;</code></h3><div class="doc"><p>Digital actions in this set</p></div></div><div class="field "><a name="name"></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(&quot;&quot;)</span><span class="label">read only</span><a href="#name"><span class="identifier">name</span></a>:<a class="type" title="String - The basic String class." href="../String.html">String</a><span> = &quot;&quot;</span></code></h3><div class="doc"><p>Name of the action set</p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="flixel.input.actions.FlxActionSet - Available since 4." href="../flixel/input/actions/FlxActionSet.html">FlxActionSet</a></h4><div style="display:none"><div class="field "><a name="add"></a><h3 class="anchor"><code><a href="#add"><span class="identifier">add</span></a>(<span style="white-space:nowrap">Action:<a class="type" title="flixel.input.actions.FlxAction - Available since 4." href="../flixel/input/actions/FlxAction.html">FlxAction</a></span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="attachSteamController"></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({ Attach : true })</span><a href="#attachSteamController"><span class="identifier">attachSteamController</span></a>(<span style="white-space:nowrap">Handle:<a class="type" title="Int - The standard Int type." href="../Int.html">Int</a>,</span> <span style="white-space:nowrap">Attach:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a> = true</span>):<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p>Automatically adds or removes inputs for a steam controller
-to any steam-affiliated actions</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Handle</code></th><td><p>steam controller handle from FlxSteam.getConnectedControllers(), or FlxInputDeviceID.FIRST_ACTIVE / ALL</p></td></tr><tr><th style="width:25%;"><code>Attach</code></th><td><p>true: adds inputs, false: removes inputs</p></td></tr></table></div></div><div class="field "><a name="destroy"></a><h3 class="anchor"><code><a href="#destroy"><span class="identifier">destroy</span></a>():<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="remove"></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({ Destroy : true })</span><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">Action:<a class="type" title="flixel.input.actions.FlxAction - Available since 4." href="../flixel/input/actions/FlxAction.html">FlxAction</a>,</span> <span style="white-space:nowrap">Destroy:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a> = true</span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></h3><div class="doc"><p>Remove an action from this set</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Action</code></th><td><p>a FlxAction</p></td></tr><tr><th style="width:25%;"><code>Destroy</code></th><td><p>whether to destroy it as well</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>whether it was found and removed</p></div></div></div><div class="field "><a name="toJson"></a><h3 class="anchor"><code><a href="#toJson"><span class="identifier">toJson</span></a>():<a class="type" title="String - The basic String class." href="../String.html">String</a></code></h3><div class="doc"><p></p></div></div></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>
+to any steam-affiliated actions</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Handle</code></th><td><p>steam controller handle from FlxSteam.getConnectedControllers(), or FlxInputDeviceID.FIRST_ACTIVE / ALL</p></td></tr><tr><th style="width:25%;"><code>Attach</code></th><td><p>true: adds inputs, false: removes inputs</p></td></tr></table></div></div><div class="field "><a name="destroy"></a><h3 class="anchor"><code><a href="#destroy"><span class="identifier">destroy</span></a>():<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="remove"></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({ Destroy : true })</span><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">Action:<a class="type" title="flixel.input.actions.FlxAction - Available since 4." href="../flixel/input/actions/FlxAction.html">FlxAction</a>,</span> <span style="white-space:nowrap">Destroy:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a> = true</span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></h3><div class="doc"><p>Remove an action from this set</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>Action</code></th><td><p>a FlxAction</p></td></tr><tr><th style="width:25%;"><code>Destroy</code></th><td><p>whether to destroy it as well</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>whether it was found and removed</p></div></div></div><div class="field "><a name="toJson"></a><h3 class="anchor"><code><a href="#toJson"><span class="identifier">toJson</span></a>():<a class="type" title="String - The basic String class." href="../String.html">String</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="update"></a><h3 class="anchor"><code><a href="#update"><span class="identifier">update</span></a>():<a class="type" title="Void - The standard Void type." href="../Void.html">Void</a></code></h3><div class="doc"><p>Update all the actions in this set (each will check inputs &amp; potentially trigger)</p></div></div></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>