Difference between revisions of "love.mouse.isDown"
m (1 revision: Imported docs from potato.) |
m (Added table variant available since 0.10.2) |
||
| (22 intermediate revisions by 12 users not shown) | |||
| Line 1: | Line 1: | ||
| + | Checks whether a certain mouse button is down. | ||
| + | This function does not detect mouse wheel scrolling; you must use the [[love.wheelmoved]] (or [[love.mousepressed]] in version [[0.9.2]] and older) callback for that. | ||
== Function == | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | down = love.mouse.isDown( button, ... ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|number|button|The index of a button to check. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependant.}} | ||
| + | {{param|number|...|Additional button numbers to check.}} | ||
| + | |||
| + | === Returns === | ||
| + | {{param|boolean|down|True if any specified button is down.}} | ||
| + | |||
| + | == Function == | ||
| + | {{newin|[[0.10.2]]|102|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | down = love.mouse.isDown({ button, ... }) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|table|buttons|Table containing indexes of mouse buttons to check.}} | ||
| + | {{subparam|table|button|The index of a button to check. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependant.}} | ||
| + | {{subparam|number|...|Additional button numbers to check.}} | ||
| + | |||
| + | === Returns === | ||
| + | {{param|boolean|down|True if any specified button is down.}} | ||
| + | |||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 10: | Line 41: | ||
=== Returns === | === Returns === | ||
{{param|boolean|down|True if the specified button is down.}} | {{param|boolean|down|True if the specified button is down.}} | ||
| + | |||
| + | == Function == | ||
| + | {{newinoldin|[[0.7.2]]|072|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | anyDown = love.mouse.isDown( button1, button2, button3, ... ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|MouseConstant|buttonN|A button to check.}} | ||
| + | === Returns === | ||
| + | {{param|boolean|anyDown|True if any specified button is down, false otherwise.}} | ||
| + | |||
| + | == Example == | ||
| + | === Increase a value while the right mouse button is held === | ||
| + | <source lang="lua"> | ||
| + | val = 0 -- establish a variable for later use | ||
| + | function love.update(dt) | ||
| + | if love.mouse.isDown(2) then | ||
| + | val = val + dt -- we will increase the variable by 1 for every second the button is held down | ||
| + | end | ||
| + | end | ||
| + | </source> | ||
| + | |||
== See Also == | == See Also == | ||
| + | * [[MouseConstant|Mouse Constant / buttons]] | ||
* [[parent::love.mouse]] | * [[parent::love.mouse]] | ||
| + | * [[love.mousepressed]] | ||
| + | * [[love.mousereleased]] | ||
| + | * [[love.keyboard.isDown]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=}} | + | {{#set:Description=Checks whether a certain button is down.}} |
| + | {{#set:Since=000}} | ||
| + | == Other Languages == | ||
| + | {{i18n|love.mouse.isDown}} | ||
Latest revision as of 13:08, 7 December 2022
Checks whether a certain mouse button is down.
This function does not detect mouse wheel scrolling; you must use the love.wheelmoved (or love.mousepressed in version 0.9.2 and older) callback for that.
Contents
Function
| Available since LÖVE 0.10.0 |
| This variant is not supported in earlier versions. |
Synopsis
down = love.mouse.isDown( button, ... )
Arguments
number button- The index of a button to check. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependant.
number ...- Additional button numbers to check.
Returns
boolean down- True if any specified button is down.
Function
| Available since LÖVE 0.10.2 |
| This variant is not supported in earlier versions. |
Synopsis
down = love.mouse.isDown({ button, ... })
Arguments
table buttons- Table containing indexes of mouse buttons to check.
Returns
boolean down- True if any specified button is down.
Function
| Removed in LÖVE 0.10.0 |
| This variant is not supported in that and later versions. |
Synopsis
down = love.mouse.isDown( button )
Arguments
MouseConstant button- The button to check.
Returns
boolean down- True if the specified button is down.
Function
| Available since LÖVE 0.7.2 and removed in LÖVE 0.10.0 |
| This variant is not supported in earlier or later versions. |
Synopsis
anyDown = love.mouse.isDown( button1, button2, button3, ... )
Arguments
MouseConstant buttonN- A button to check.
Returns
boolean anyDown- True if any specified button is down, false otherwise.
Example
Increase a value while the right mouse button is held
val = 0 -- establish a variable for later use
function love.update(dt)
if love.mouse.isDown(2) then
val = val + dt -- we will increase the variable by 1 for every second the button is held down
end
end
See Also
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
