Difference between revisions of "Joystick:isGamepadDown"

m (Removed wrong newin text)
m (Added table variant available since 0.10.2)
 
(One intermediate revision by one other user not shown)
Line 10: Line 10:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|anyDown|True if any supplied button is down, false if not.}}
 
{{param|boolean|anyDown|True if any supplied button is down, false if not.}}
 +
 +
== Function ==
 +
{{newin|[[0.10.2]]|102|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
anyDown = Joystick:isGamepadDown({ button1, button2, button3, ... })
 +
</source>
 +
=== Arguments ===
 +
{{param|table|buttons|Table of gamepad buttons to check.}}
 +
{{subparam|GamepadButton|buttonN|The gamepad button to check.}}
 +
=== Returns ===
 +
{{param|boolean|anyDown|True if any supplied button is down, false if not.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::Joystick]]
 
* [[parent::Joystick]]
Line 15: Line 28:
 
* [[Joystick:getGamepadAxis]]
 
* [[Joystick:getGamepadAxis]]
 
* [[Joystick:isConnected]]
 
* [[Joystick:isConnected]]
 +
 +
* [[love.gamepadpressed]]
 +
* [[love.gamepadreleased]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Checks if a virtual gamepad button on the Joystick is pressed.}}
 
{{#set:Description=Checks if a virtual gamepad button on the Joystick is pressed.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Joystick:isGamepadDown}}
 
{{i18n|Joystick:isGamepadDown}}

Latest revision as of 13:16, 7 December 2022

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Checks if a virtual gamepad button on the Joystick is pressed. If the Joystick is not recognized as a Gamepad or isn't connected, then this function will always return false.

Function

Synopsis

anyDown = Joystick:isGamepadDown( button1, button2, button3, ... )

Arguments

GamepadButton buttonN
The gamepad button to check.

Returns

boolean anyDown
True if any supplied button is down, false if not.

Function

Available since LÖVE 0.10.2
This variant is not supported in earlier versions.

Synopsis

anyDown = Joystick:isGamepadDown({ button1, button2, button3, ... })

Arguments

table buttons
Table of gamepad buttons to check.
GamepadButton buttonN
The gamepad button to check.

Returns

boolean anyDown
True if any supplied button is down, false if not.

See Also

Other Languages