Difference between revisions of "Joystick:isDown"

(Added notice about 0.9.0 bug)
m
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
Checks if a button on the Joystick is pressed.
 
Checks if a button on the Joystick is pressed.
  
{{notice|There is a bug in version [[0.9.0]] which requires 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.}}
+
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.}}
Line 15: Line 16:
 
* [[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}}

Revision as of 00:03, 7 January 2016

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.

Returns

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

See Also

Other Languages