Difference between revisions of "Joystick:isDown"

(Created page)
 
m (Added table variant available since 0.10.2)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function|text=It has been moved from [[love.joystick.isDown]]}}
 
{{newin|[[0.9.0]]|090|type=function|text=It has been moved from [[love.joystick.isDown]]}}
 
Checks if a button on the Joystick is pressed.
 
Checks if a button on the Joystick is pressed.
 +
 +
LÖVE [[0.9.0]] had a bug which required the button indices passed to Joystick:isDown to be 0-based instead of 1-based, for example button 1 would be 0 for this function. It was fixed in [[0.9.1]].
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
anyDown = Joystick:isDown( button1, button2, button3, ... )
+
anyDown = Joystick:isDown( buttonN, ... )
 
</source>
 
</source>
 +
 
=== Arguments ===
 
=== Arguments ===
 
{{param|number|buttonN|The index of a button to check.}}
 
{{param|number|buttonN|The index of a button to check.}}
 +
{{param|number|...|Additional buttons to check.}}
 
=== 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:isDown({ buttonN, ... })
 +
</source>
 +
 +
=== Arguments ===
 +
{{param|table|buttons|Table of button indexes to check.}}
 +
{{subparam|number|buttonN|The index of a button to check.}}
 +
{{subparam|number|...|Additional buttons to check.}}
 +
=== Returns ===
 +
{{param|boolean|anyDown|True if any supplied button is down, false if not.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::Joystick]]
 
* [[parent::Joystick]]
 
* [[Joystick:getButtonCount]]
 
* [[Joystick:getButtonCount]]
 +
* [[love.joystickpressed]]
 +
* [[love.joystickreleased]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Checks if a button on the Joystick is pressed.}}
 
{{#set:Description=Checks if a button on the Joystick is pressed.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Joystick:isDown}}
 
{{i18n|Joystick:isDown}}

Latest revision as of 13:14, 7 December 2022

Available since LÖVE 0.9.0
It has been moved from love.joystick.isDown.

Checks if a button on the Joystick is pressed.

LÖVE 0.9.0 had a bug which required the button indices passed to Joystick:isDown to be 0-based instead of 1-based, for example button 1 would be 0 for this function. It was fixed in 0.9.1.

Function

Synopsis

anyDown = Joystick:isDown( buttonN, ... )

Arguments

number buttonN
The index of a button to check.
number ...
Additional buttons 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:isDown({ buttonN, ... })

Arguments

table buttons
Table of button indexes to check.
number buttonN
The index of a button to check.
number ...
Additional buttons to check.

Returns

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

See Also

Other Languages