Add a new player object to the players array.
If an index is provided and a player object at that index already exists, this will be returned instead of another object created
Get player object
\nReturns a struct to hold input control information\nSet up a struct for each player in the game\nDirection and Buttons contain the input from the devices\nThe keys struct contains arrays of keyboard characters or mouse buttons that will trigger the action
\nDefine a key for a player/action combination
\nA ButtonCombo will listen for a specific combination of buttons from the given player's gamepad, and when it receives them it will emit a buttoncombomatch event.
\nPass one or more button names to check whether one or more buttons were pressed during an update tick.
\nPass one or more button names to check whether one or more buttons were released during an update tick.
\nPass one or more button names to check whether one or more buttons are held down during an update tick.
\nPass one or more button names to check whether one or more buttons are held down during an update tick. You may provide a duration to this method and it will return true every X milliseconds.
\nnumber | \n\n\n\n\n### getPlayer(index)\nGet player object\n\n| Param | Type |\n| --- | --- |\n| thisPlayer | number | \n\n\n\n\n### defineKey(player, action, value, append)\nDefine a key for a player/action combination\n| Param | Type | |\n| --- | --- | --- |\n| player | number | The player ID on which we're defining a key |\n| action | string | The action to define |\n| value | string | The key to use |\n| append | boolean | When true, this key definition will be appended to the existing key(s) for this action |\n\n\n\n### createButtonCombo(player, buttons, [config])\nA ButtonCombo will listen for a specific combination of buttons from the given player's gamepad, and when it receives them it will emit a buttoncombomatch event.\n\n| Param | Type | |\n| --- | --- | --- |\n| player | object | The player object on which we're defining a key |\n| buttons | array | An array of buttons to act as the combo. You may use directions ['UP'], button IDs ['B12'] or mapped buttons ['LC_N'] |\n| config | Phaser.Types.Input.Keyboard.KeyComboConfig | A Key Combo configuration object. Uses the same config as Phaser's native KeyCombo classes |\n\n\n\n\n### {player}.isPressed(button)\nCheck if button(s) were pressed during an update tick\n\n| Param | Type |\n| --- | --- |\n| button | string/array | \n\n\n\n\n### {player}.isReleased(button)\nCheck if button(s) were released during an update tick\n\n| Param | Type |\n| --- | --- |\n| button | string/array | \n\n\n\n### {player}.isDown(button)\nCheck if button(s) were held down during an update tick\n\n| Param | Type |\n| --- | --- |\n| button | string/array | \n\n\n\n### {player}.checkDown(button)\nCheck if button(s) were held down during an update tick \nYou may provide a duration to this method and it will return true every X milliseconds.\n\n| Param | Type |\n| --- | --- |\n| button | string/array | \n| duration | number | The duration which must have elapsed before this button is considered as being down.\n| includeFirst | boolean | When true, include the first press of a button, otherwise wait for the first passing of the duration.\n\n\n\n\n## Events\n\n| Event | Description | Data |\n| --- | --- | --- |\n| gamepad_connected | Gamepad is connected | gamepad instance |\n| device_changed | The last input device has changed | last device used (keyboard/gamepad/mouse) |\n| keyboard_keydown | Keyboard key pressed | player: player instance, key: keycode pressed |\n| keyboard_keyup | Keyboard key released | player: player instance, key: keycode pressed |\n| gamepad_buttondown | Gamepad button pressed | player: player instance, button: button number pressed |\n| gamepad_buttonup | Gamepad button released | player: player instance, button: button number released |\n| gamepad_directiondown | Gamepad D-Pad pressed | player: player instance, direction: D-Pad direction pressed |\n| gamepad_directionup | Gamepad D-Pad released | player: player instance, direction: D-Pad direction released |\n| gamepad_directionup | Gamepad D-Pad released | player: player instance, direction: D-Pad direction released |\n| pointer_down | Mouse button pressed | button number pressed |\n| pointer_up | Mouse button released | button number released |\n| buttoncombomatch | A button combo match has occurred | player: player instance, combo: The ButtonCombo object that matched |","readmeFilename":"README.md"}