Difference between revisions of "love.mousepressed"
(Add an example) |
(→See Also) |
||
| (16 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
Callback function triggered when a mouse button is pressed. | Callback function triggered when a mouse button is pressed. | ||
== Function == | == Function == | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | love.mousepressed( x, y, button, istouch, presses ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|number|x|Mouse x position, in pixels.}} | ||
| + | {{param|number|y|Mouse y position, in pixels.}} | ||
| + | {{param|number|button|The button index that was pressed. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.}} | ||
| + | {{param|boolean|istouch|True if the mouse button press originated from a touchscreen touch-press.}} | ||
| + | {{New feature|11.0| | ||
| + | {{param|number|presses|The number of presses in a short time frame and small area, used to simulate double, triple clicks}} | ||
| + | |110}} | ||
| + | === Returns === | ||
| + | Nothing. | ||
| + | === Notes === | ||
| + | Use [[love.wheelmoved]] to detect mouse wheel motion. It will not register as a button press in version [[0.10.0]] and newer. | ||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 18: | Line 37: | ||
printy = 0 | printy = 0 | ||
end | end | ||
| + | |||
function love.draw() | function love.draw() | ||
love.graphics.print("Text", printx, printy) | love.graphics.print("Text", printx, printy) | ||
end | end | ||
| − | function love.mousepressed(x, y, button) | + | |
| − | if button == | + | function love.mousepressed(x, y, button, istouch) |
| + | if button == 1 then -- Versions prior to 0.10.0 use the MouseConstant 'l' | ||
printx = x | printx = x | ||
printy = y | printy = y | ||
| Line 28: | Line 49: | ||
end | end | ||
</source> | </source> | ||
| + | |||
== See Also == | == See Also == | ||
* [[parent::love]] | * [[parent::love]] | ||
| + | * [[love.mouse]] | ||
| + | * [[love.mousemoved]] | ||
| + | * [[love.mousereleased]] | ||
| + | * [[love.mouse.isDown]] | ||
[[Category:Callbacks]] | [[Category:Callbacks]] | ||
{{#set:Description=Callback function triggered when a mouse button is pressed.}} | {{#set:Description=Callback function triggered when a mouse button is pressed.}} | ||
| + | {{#set:Subcategory=Mouse}} | ||
{{#set:Since=000}} | {{#set:Since=000}} | ||
| + | |||
== Other Languages == | == Other Languages == | ||
{{i18n|love.mousepressed}} | {{i18n|love.mousepressed}} | ||
Latest revision as of 07:47, 8 March 2023
Callback function triggered when a mouse button is pressed.
Contents
Function
Synopsis
love.mousepressed( x, y, button, istouch, presses )
Arguments
number x- Mouse x position, in pixels.
number y- Mouse y position, in pixels.
number button- The button index that was pressed. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.
boolean istouch- True if the mouse button press originated from a touchscreen touch-press.
Available since LÖVE 11.0
number presses- The number of presses in a short time frame and small area, used to simulate double, triple clicks
Returns
Nothing.
Notes
Use love.wheelmoved to detect mouse wheel motion. It will not register as a button press in version 0.10.0 and newer.
Function
| Removed in LÖVE 0.10.0 |
| This variant is not supported in that and later versions. |
Synopsis
love.mousepressed( x, y, button )
Arguments
number x- Mouse x position.
number y- Mouse y position.
MouseConstant button- Mouse button pressed.
Returns
Nothing.
Examples
Position a string ("Text") wherever the user left-clicks.
function love.load()
printx = 0
printy = 0
end
function love.draw()
love.graphics.print("Text", printx, printy)
end
function love.mousepressed(x, y, button, istouch)
if button == 1 then -- Versions prior to 0.10.0 use the MouseConstant 'l'
printx = x
printy = y
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
