<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>InputsController | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/inputs_controller.html">inputs-controller</a></li><li><ahref="inputs_controller.InputsController.html">InputsController</a></li></ul><h1>Class InputsController</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>Manages and handles all input controls for the game, including keyboard and gamepad interactions.</p>
</div><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This class is designed to centralize input management across the game. It facilitates the setup,
configuration, and handling of all game inputs, making it easier to manage various input devices
such as keyboards and gamepads. The class provides methods for setting up input devices, handling
their events, and responding to changes in input state (e.g., button presses, releases).</p>
<p>The <code>InputsController</code> class also includes mechanisms to handle game focus events to ensure input
states are correctly reset and managed when the game loses or regains focus, maintaining robust
and responsive control handling throughout the game's lifecycle.</p>
<p>Key responsibilities include:</p>
<ul>
<li>Initializing and configuring gamepad and keyboard controls.</li>
<li>Emitting events related to specific input actions.</li>
<li>Responding to external changes such as gamepad connection/disconnection.</li>
<li>Managing game state transitions in response to input events, particularly focus loss and recovery.</li>
</ul>
<p>Usage of this class is intended to simplify input management across various parts of the game,
providing a unified interface for all input-related interactions.</p>
</div></section></div></details></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Constructors</h2><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_InputsController"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new <wbr/>Inputs<wbr/>Controller</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="inputs_controller.InputsController.html"class="tsd-signature-type tsd-kind-class">InputsController</a><ahref="#constructor.new_InputsController"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Initializes a new instance of the game control system, setting up initial state and configurations.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">scene</span>: <ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p>The Phaser scene associated with this instance.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="inputs_controller.InputsController.html"class="tsd-signature-type tsd-kind-class">InputsController</a></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This constructor initializes the game control system with necessary setups for handling inputs.
It prepares an interactions array indexed by button identifiers and configures default states for each button.
Specific buttons like MENU and STATS are set not to repeat their actions.
It concludes by calling the <code>init</code> method to complete the setup.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is used to reset the state of all buttons within the <code>interactions</code> dictionary,
effectively deactivating any currently pressed keys. It performs the following actions:</p>
<ul>
<li>Releases button locks for predefined buttons (<code>buttonLock</code> and <code>buttonLock2</code>), allowing them
to be pressed again or properly re-initialized in future interactions.</li>
<li>Iterates over all possible button values obtained via <code>Utils.getEnumValues(Button)</code>, and for
each button:<ul>
<li>Checks if the button is currently registered in the <code>interactions</code> dictionary.</li>
<li>Resets <code>pressTime</code> to null, indicating that there is no ongoing interaction.</li>
<li>Sets <code>isPressed</code> to false, marking the button as not currently active.</li>
<li>Clears the <code>source</code> field, removing the record of which device the button press came from.</li>
</ul>
</li>
</ul>
<p>This method is typically called when needing to ensure that all inputs are neutralized.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L526">src/inputs-controller.ts:526</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="delLastProcessedMovementTime"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>del<wbr/>Last<wbr/>Processed<wbr/>Movement<wbr/>Time</span><ahref="#delLastProcessedMovementTime"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="delLastProcessedMovementTime.delLastProcessedMovementTime-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">del<wbr/>Last<wbr/>Processed<wbr/>Movement<wbr/>Time</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#delLastProcessedMovementTime.delLastProcessedMovementTime-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Clears the last interaction for a specified button.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The button for which to clear the interaction.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method resets the interaction details of the button, allowing it to be processed as a new input when pressed again.
If the button is not registered in the <code>interactions</code> dictionary, this method returns immediately, otherwise:</p>
<ul>
<li><code>pressTime</code> is cleared. This was previously storing the timestamp of when the button was initially pressed.</li>
<li><code>isPressed</code> is set to false, indicating that the button is no longer being pressed.</li>
<li><code>source</code> is set to null, which had been indicating the device from which the button input was originating.</li>
</ul>
<p>It releases the button lock, which prevents the button from being processed repeatedly until it's explicitly released.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pad</span>: <spanclass="tsd-signature-type">Gamepad</span></span><divclass="tsd-comment tsd-typography"><p>The gamepad on which the button press occurred.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">button</span>: <spanclass="tsd-signature-type">Button</span></span><divclass="tsd-comment tsd-typography"><p>The button that was pressed.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The value associated with the button press, typically indicating pressure or degree of activation.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is triggered when a gamepad button is pressed. If gamepad support is enabled, it:</p>
<ul>
<li>Retrieves the current gamepad action mapping.</li>
<li>Checks if the pressed button is mapped to a game action.</li>
<li>If mapped, emits an 'input_down' event with the controller type and button action, and updates the interaction of this button.</li>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pad</span>: <spanclass="tsd-signature-type">Gamepad</span></span><divclass="tsd-comment tsd-typography"><p>The gamepad on which the button release occurred.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">button</span>: <spanclass="tsd-signature-type">Button</span></span><divclass="tsd-comment tsd-typography"><p>The button that was released.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The value associated with the button release, typically indicating pressure or degree of deactivation.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is triggered when a gamepad button is released. If gamepad support is enabled, it:</p>
<ul>
<li>Retrieves the current gamepad action mapping.</li>
<li>Checks if the released button is mapped to a game action.</li>
<li>If mapped, emits an 'input_up' event with the controller type and button action, and clears the interaction for this button.</li>
</div><h4class="tsd-returns-title">Returns <ahref="../interfaces/inputs_controller.ActionGamepadMapping.html"class="tsd-signature-type tsd-kind-interface">ActionGamepadMapping</a></h4><p>An object mapping gamepad buttons to in-game actions based on the player's current gamepad configuration.</p>
<divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method constructs a mapping of gamepad buttons to in-game action buttons according to the player's
current gamepad configuration. If no configuration is available, it returns an empty mapping.
The mapping includes directional controls, action buttons, and system commands among others,
adjusted for any custom settings such as swapped action buttons.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method configures event listeners for both gamepad and keyboard inputs.
It handles gamepad connections/disconnections and button press events, and ensures keyboard controls are set up.
Additionally, it manages the game's behavior when it loses focus to prevent unwanted game actions during this state.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L101">src/inputs-controller.ts:101</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="isButtonLocked"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Button<wbr/>Locked</span><ahref="#isButtonLocked"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="isButtonLocked.isButtonLocked-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Button<wbr/>Locked</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isButtonLocked.isButtonLocked-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Checks if a specific button is currently locked.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The button to check for a lock status.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p><code>true</code> if the button is either of the two potentially locked buttons (<code>buttonLock</code> or <code>buttonLock2</code>), otherwise <code>false</code>.</p>
<divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is used to determine if a given button is currently prevented from being processed due to a lock.
It checks against two separate lock variables, allowing for up to two buttons to be locked simultaneously.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L548">src/inputs-controller.ts:548</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="listenInputKeyboard"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>listen<wbr/>Input<wbr/>Keyboard</span><ahref="#listenInputKeyboard"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="listenInputKeyboard.listenInputKeyboard-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">listen<wbr/>Input<wbr/>Keyboard</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#listenInputKeyboard.listenInputKeyboard-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets up event listeners for keyboard inputs on all registered keys.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method iterates over an array of keyboard button rows (<code>this.buttonKeys</code>), adding 'down' and 'up'
event listeners for each key. These listeners handle key press and release actions respectively.</p>
<ul>
<li><p><strong>Key Down Event</strong>: When a key is pressed down, the method emits an 'input_down' event with the button
and the source ('keyboard'). It also records the time and state of the key press by calling
<code>setLastProcessedMovementTime</code>.</p>
</li>
<li><p><strong>Key Up Event</strong>: When a key is released, the method emits an 'input_up' event similarly, specifying the button
and source. It then clears the recorded press time and state by calling
<code>delLastProcessedMovementTime</code>.</p>
</li>
</ul>
<p>This setup ensures that each key on the keyboard is monitored for press and release events,
and that these events are properly communicated within the system.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L394">src/inputs-controller.ts:394</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="loseFocus"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>lose<wbr/>Focus</span><ahref="#loseFocus"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="loseFocus.loseFocus-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">lose<wbr/>Focus</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#loseFocus.loseFocus-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Handles actions to take when the game loses focus, such as deactivating pressed keys.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is triggered when the game or the browser tab loses focus. It ensures that any keys pressed are deactivated to prevent stuck keys affecting gameplay when the game is not active.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L135">src/inputs-controller.ts:135</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="mapGamepad"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>map<wbr/>Gamepad</span><ahref="#mapGamepad"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="mapGamepad.mapGamepad-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">map<wbr/>Gamepad</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">id</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="../interfaces/inputs_controller.GamepadConfig.html"class="tsd-signature-type tsd-kind-interface">GamepadConfig</a><ahref="#mapGamepad.mapGamepad-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Maps a gamepad ID to a specific gamepad configuration based on the ID's characteristics.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">id</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The gamepad ID string, typically representing a unique identifier for a gamepad model or make.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="../interfaces/inputs_controller.GamepadConfig.html"class="tsd-signature-type tsd-kind-interface">GamepadConfig</a></h4><p>A <code>GamepadConfig</code> object corresponding to the identified gamepad model.</p>
<divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This function analyzes the provided gamepad ID and matches it to a predefined configuration based on known identifiers:</p>
<ul>
<li>If the ID includes both '081f' and 'e401', it is identified as an unlicensed SNES gamepad.</li>
<li>If the ID contains 'xbox' and '360', it is identified as an Xbox 360 gamepad.</li>
<li>If the ID contains '054c', it is identified as a DualShock gamepad.</li>
<li>If the ID includes both '057e' and '2009', it is identified as a Pro controller gamepad.
If no specific identifiers are recognized, a generic gamepad configuration is returned.</li>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L429">src/inputs-controller.ts:429</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="refreshGamepads"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>refresh<wbr/>Gamepads</span><ahref="#refreshGamepads"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="refreshGamepads.refreshGamepads-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">refresh<wbr/>Gamepads</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#refreshGamepads.refreshGamepads-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Refreshes and re-indexes the list of connected gamepads.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method updates the list of gamepads to exclude any that are undefined.
It corrects the index of each gamepad to account for any previously undefined entries,
ensuring that all gamepads are properly indexed and can be accurately referenced within the game.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L217">src/inputs-controller.ts:217</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="releaseButtonLock"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>release<wbr/>Button<wbr/>Lock</span><ahref="#releaseButtonLock"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="releaseButtonLock.releaseButtonLock-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">release<wbr/>Button<wbr/>Lock</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#releaseButtonLock.releaseButtonLock-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Releases a lock on a specific button, allowing it to be processed again.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The button whose lock is to be released.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method checks both lock variables (<code>buttonLock</code> and <code>buttonLock2</code>).
If either lock matches the specified button, that lock is cleared.
This action frees the button to be processed again, ensuring it can respond to new inputs.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>has been held down long
enough to fire a repeated input. A button must claim the buttonLock before
firing a repeated input - this is to prevent multiple buttons from firing repeatedly.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L450">src/inputs-controller.ts:450</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setButtonLock"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Button<wbr/>Lock</span><ahref="#setButtonLock"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setButtonLock.setButtonLock-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Button<wbr/>Lock</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setButtonLock.setButtonLock-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets a lock on a given button if it is not already locked.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The button to lock.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method ensures that a button is not processed multiple times inadvertently.
It checks if the button is already locked by either of the two lock variables (<code>buttonLock</code> or <code>buttonLock2</code>).
If not, it locks the button using the first available lock variable.
This mechanism allows for up to two buttons to be locked at the same time.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L563">src/inputs-controller.ts:563</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setGamepadSupport"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Gamepad<wbr/>Support</span><ahref="#setGamepadSupport"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setGamepadSupport.setGamepadSupport-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Gamepad<wbr/>Support</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">value</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setGamepadSupport.setGamepadSupport-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Enables or disables support for gamepad input.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>A boolean indicating whether gamepad support should be enabled (true) or disabled (false).</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method toggles gamepad support. If disabled, it also ensures that all currently pressed gamepad buttons are deactivated to avoid stuck inputs.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L147">src/inputs-controller.ts:147</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setLastProcessedMovementTime"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Last<wbr/>Processed<wbr/>Movement<wbr/>Time</span><ahref="#setLastProcessedMovementTime"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setLastProcessedMovementTime.setLastProcessedMovementTime-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Last<wbr/>Processed<wbr/>Movement<wbr/>Time</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span>, <spanclass="tsd-kind-parameter">source</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setLastProcessedMovementTime.setLastProcessedMovementTime-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This method updates the interaction state to reflect that the button is pressed.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The button for which to set the interaction.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">source</span>: <spanclass="tsd-signature-type">String</span><spanclass="tsd-signature-symbol"> = "keyboard"</span></span><divclass="tsd-comment tsd-typography"><p>The source of the input (defaults to 'keyboard'). This helps identify the origin of the input, especially useful in environments with multiple input devices.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method is responsible for updating the interaction state of a button within the <code>interactions</code> dictionary. If the button is not already registered, this method returns immediately.
When invoked, it performs the following updates:</p>
<ul>
<li><code>pressTime</code>: Sets this to the current time, representing when the button was initially pressed.</li>
<li><code>isPressed</code>: Marks the button as currently being pressed.</li>
<li><code>source</code>: Identifies the source device of the input, which can vary across different hardware (e.g., keyboard, gamepad).</li>
</ul>
<p>Additionally, this method locks the button (by calling <code>setButtonLock</code>) to prevent it from being re-processed until it is released, ensuring that each press is handled distinctly.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L474">src/inputs-controller.ts:474</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setupGamepad"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setup<wbr/>Gamepad</span><ahref="#setupGamepad"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setupGamepad.setupGamepad-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setup<wbr/>Gamepad</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">thisGamepad</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setupGamepad.setupGamepad-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Configures a gamepad for use based on its device ID.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">thisGamepad</span>: <spanclass="tsd-signature-type">Gamepad</span></span><divclass="tsd-comment tsd-typography"><p>The gamepad to set up.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method initializes a gamepad by mapping its ID to a predefined configuration.
It updates the player's gamepad mapping based on the identified configuration, ensuring
that the gamepad controls are correctly mapped to in-game actions.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L203">src/inputs-controller.ts:203</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setupKeyboardControls"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setup<wbr/>Keyboard<wbr/>Controls</span><ahref="#setupKeyboardControls"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setupKeyboardControls.setupKeyboardControls-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setup<wbr/>Keyboard<wbr/>Controls</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setupKeyboardControls.setupKeyboardControls-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Configures keyboard controls for the game, mapping physical keys to game actions.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>This method sets up keyboard bindings for game controls using Phaser's <code>KeyCodes</code>. Each game action, represented
by a button in the <code>Button</code> enum, is associated with one or more physical keys. For example, movement actions
(up, down, left, right) are mapped to both arrow keys and WASD keys. Actions such as submit, cancel, and other
game-specific functions are mapped to appropriate keys like Enter, Space, etc.</p>
<p>The method does the following:</p>
<ul>
<li>Defines a <code>keyConfig</code> object that associates each <code>Button</code> enum value with an array of <code>KeyCodes</code>.</li>
<li>Iterates over all values of the <code>Button</code> enum to set up these key bindings within the Phaser game scene.</li>
<li>For each button, it adds the respective keys to the game's input system and stores them in <code>this.buttonKeys</code>.</li>
<li>Additional configurations for mobile or alternative input schemes are stored in <code>mobileKeyConfig</code>.</li>
</ul>
<p>Post-setup, it initializes touch controls (if applicable) and starts listening for keyboard inputs using
<code>listenInputKeyboard</code>, ensuring that all configured keys are actively monitored for player interactions.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/6c4b60a2faca4f52fd83808e1bd6c331aa98a2c3/src/inputs-controller.ts#L339">src/inputs-controller.ts:339</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="update"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>update</span><ahref="#update"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="update.update-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">update</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#update.update-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Updates the interaction handling by processing input states.
This method gives priority to certain buttons by reversing the order in which they are checked.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><h4>Remarks</h4><p>The method iterates over all possible buttons, checking for specific conditions such as:</p>
<ul>
<li>If the button is registered in the <code>interactions</code> dictionary.</li>
<li>If the button has been held down long enough.</li>
<li>If the button is currently pressed.</li>
</ul>
<p>Special handling is applied if gamepad support is disabled but a gamepad source is still triggering inputs,
preventing potential infinite loops by removing the last processed movement time for the button.</p>
