Difference between revisions of "Joystick:getGamepadMapping"
(Created page) |
m |
||
(2 intermediate revisions by the same user not shown) | |||
Line 10: | Line 10: | ||
=== Returns === | === Returns === | ||
{{param|JoystickInputType|inputtype|The type of input the virtual gamepad axis is bound to.}} | {{param|JoystickInputType|inputtype|The type of input the virtual gamepad axis is bound to.}} | ||
− | {{param|number|inputindex|The index of the Joystick's button, axis or hat that the virtual gamepad axis is bound to.}} | + | {{param|number|inputindex|The 1-based index of the Joystick's button, axis or hat that the virtual gamepad axis is bound to.}} |
{{param|JoystickHat|hatdirection (nil)|The direction of the hat, if the virtual gamepad axis is bound to a hat. nil otherwise.}} | {{param|JoystickHat|hatdirection (nil)|The direction of the hat, if the virtual gamepad axis is bound to a hat. nil otherwise.}} | ||
=== Notes === | === Notes === | ||
Line 24: | Line 24: | ||
=== Returns === | === Returns === | ||
{{param|JoystickInputType|inputtype|The type of input the virtual gamepad button is bound to.}} | {{param|JoystickInputType|inputtype|The type of input the virtual gamepad button is bound to.}} | ||
− | {{param|number|inputindex|The index of the Joystick's button, axis or hat that the virtual gamepad button is bound to.}} | + | {{param|number|inputindex|The 1-based index of the Joystick's button, axis or hat that the virtual gamepad button is bound to.}} |
{{param|JoystickHat|hatdirection (nil)|The direction of the hat, if the virtual gamepad button is bound to a hat. nil otherwise.}} | {{param|JoystickHat|hatdirection (nil)|The direction of the hat, if the virtual gamepad button is bound to a hat. nil otherwise.}} | ||
=== Notes === | === Notes === | ||
Returns nil if the Joystick isn't recognized as a gamepad or the virtual gamepad button is not bound to a Joystick input. | Returns nil if the Joystick isn't recognized as a gamepad or the virtual gamepad button is not bound to a Joystick input. | ||
+ | |||
+ | == Notes == | ||
+ | The physical locations for the virtual gamepad axes and buttons correspond as closely as possible to the layout of a standard Xbox 360 controller. | ||
+ | |||
+ | [[File:360_controller.png]] | ||
== See Also == | == See Also == | ||
Line 34: | Line 39: | ||
* [[Joystick:isGamepadDown]] | * [[Joystick:isGamepadDown]] | ||
* [[Joystick:getGamepadAxis]] | * [[Joystick:getGamepadAxis]] | ||
+ | * [[love.joystick.setGamepadMapping]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Gets the button, axis or hat that a virtual gamepad input is bound to.}} | {{#set:Description=Gets the button, axis or hat that a virtual gamepad input is bound to.}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|Joystick:getGamepadMapping}} | {{i18n|Joystick:getGamepadMapping}} |
Latest revision as of 00:38, 14 January 2023
Available since LÖVE 0.9.0 |
This function is not supported in earlier versions. |
Gets the button, axis or hat that a virtual gamepad input is bound to.
Contents
Function
Synopsis
inputtype, inputindex, hatdirection = Joystick:getGamepadMapping( axis )
Arguments
GamepadAxis axis
- The virtual gamepad axis to get the binding for.
Returns
JoystickInputType inputtype
- The type of input the virtual gamepad axis is bound to.
number inputindex
- The 1-based index of the Joystick's button, axis or hat that the virtual gamepad axis is bound to.
JoystickHat hatdirection (nil)
- The direction of the hat, if the virtual gamepad axis is bound to a hat. nil otherwise.
Notes
Returns nil if the Joystick isn't recognized as a gamepad or the virtual gamepad axis is not bound to a Joystick input.
Function
Synopsis
inputtype, inputindex, hatdirection = Joystick:getGamepadMapping( button )
Arguments
GamepadButton button
- The virtual gamepad button to get the binding for.
Returns
JoystickInputType inputtype
- The type of input the virtual gamepad button is bound to.
number inputindex
- The 1-based index of the Joystick's button, axis or hat that the virtual gamepad button is bound to.
JoystickHat hatdirection (nil)
- The direction of the hat, if the virtual gamepad button is bound to a hat. nil otherwise.
Notes
Returns nil if the Joystick isn't recognized as a gamepad or the virtual gamepad button is not bound to a Joystick input.
Notes
The physical locations for the virtual gamepad axes and buttons correspond as closely as possible to the layout of a standard Xbox 360 controller.
See Also
- Joystick
- Joystick:isGamepad
- Joystick:isGamepadDown
- Joystick:getGamepadAxis
- love.joystick.setGamepadMapping
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info