It is recommended that you familiarise yourself with the general way in which input works in Defold, how to receive input and in which order input is received in your script files. Learn more about the input system in the Input Overview manual.
Gamepad triggers allow you to bind standard gamepad input to game functions. Gamepad input offers bindings for:
The examples below use the actions shown in the image above. As with all input you are free to name your input actions any way you want to.
Digital buttons generate pressed, released and repeated events. Example showing how to detect input for a digital button (either pressed or released):
function on_input(self, action_id, action) if action_id == hash("gamepad_lpad_left") then if action.pressed then -- start moving left elseif action.released then -- stop moving left end end end
Analog sticks generate continuous input events when the stick is moved outside the dead zone defined in the gamepad settings file (see below). Example showing how to detect input for an analog stick:
function on_input(self, action_id, action) if action_id == hash("gamepad_lstick_down") then -- left stick was moved down print(action.value) -- a value between 0.0 an -1.0 end end
Analog sticks also generate pressed and released events when moved in the cardinal directions above a certain threshold value. This makes it easy to also use an analog stick as digital directional input:
function on_input(self, action_id, action) if action_id == hash("gamepad_lstick_down") and action.pressed then -- left stick was moved to its extreme down position end end
Defold supports multiple gamepads through the host operating system, actions set the
gamepad field of the action table to the gamepad number the input originated from:
function on_input(self, action_id, action) if action_id == hash("gamepad_start") then if action.gamepad == 0 then -- gamepad 0 wants to join the game end end end
Gamepad input bindings also provide two separate bindings named
Disconnected to detect when a gamepad is connected (even those connected from the start) or disconnected.
function on_input(self, action_id, action) if action_id == hash("gamepad_connected") then if action.gamepad == 0 then -- gamepad 0 was connected end elseif action_id == hash("gamepad_dicconnected") then if action.gamepad == 0 then -- gamepad 0 was dicconnected end end end
(From Defold 1.2.183)
Gamepad input bindings also provide a separate binding named
Raw to give the unfiltered (without applied deadzone) button, axis and hat input of any connected gamepad.
function on_input(self, action_id, action) if action_id == hash("raw") then pprint(action.gamepad_buttons) pprint(action.gamepad_axis) pprint(action.gamepad_hats) end end
On Windows, only XBox 360 controllers are currently supported. To hook up your 360 controller to your Windows machine, make sure it is setup correctly. See http://www.wikihow.com/Use-Your-Xbox-360-Controller-for-Windows
Gamepad input setup uses a separate mapping file for each hardware gamepad type. Gamepad mappings for specific hardware gamepads are set in a gamepads file. Defold ships with a built-in gamepads file with settings for common gamepads:
If you need to create a new gamepad settings file, we have a simple tool to help:
It includes binaries for Windows, Linux and macOS. Run it from the command line:
The tool will ask you to press different buttons on your connected controller. It will then output a new gamepads file with correct mappings for your controller. Save the new file, or merge it with your existing gamepads file, then update the setting in “game.project”:
(From Defold 1.2.186)
When a gamepad is connected and no mapping exists for the gamepad the gamepad will only generate “connected”, “disconnected” and “raw” actions. In this case you need to manually map the raw gamepad data to actions in your game.
Gamepads are supported in HTML5 builds and generate the same input events as on other platforms. Support for gamepads is based on the Gamepad API which is supported in most browsers (refer to this support chart). If the browser doesn’t support the Gamepad API Defold will silently ignore any Gamepad triggers in your project. You can check if the browser supports the Gamepad API by checking if the
getGamepads function exists on the
local function supports_gamepads() return not html5 or (html5.run('typeof navigator.getGamepads === "function"') == "true") end if supports_gamepads() then print("Platform supports gamepads") end
If your game is running from inside an
iframe you must also make sure that the
iframe has the
gamepad permission added:
(From Defold 1.2.183)
Gamepads are supported in Android builds and generate the same input events as on other platforms. Support for gamepads is based on the Android input system for key and motion events. The Android input events will be translated to Defold gamepad events using the same gamepad file as described above.
When adding additional gamepad bindings on Android you can use the following lookup tables to translate from the Android input events to gamepad file values:
|Key event to button index||Index||Version|
|Motion event to axis index||Index|
Use this lookup table in combination with a gamepad test app from the Google Play Store to figure out which key event each button on your gamepad is mapped to.