Difference between revisions of "love.mousepressed"

(Undo revision 16549 by Mhliebano (talk))
(Added missing "presses" param and new varient of function)
Line 1: Line 1:
 
Callback function triggered when a mouse button is pressed.
 
Callback function triggered when a mouse button is pressed.
 +
== Function ==
 +
 +
{{newin|[[0.11.0]]|100|type=variant}}
 +
=== 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.}}
 +
{{param|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 ==
 
== Function ==
 
{{newin|[[0.10.0]]|100|type=variant}}
 
{{newin|[[0.10.0]]|100|type=variant}}
Line 11: Line 29:
 
{{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|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.}}
 
{{param|boolean|istouch|True if the mouse button press originated from a touchscreen touch-press.}}
 
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.

Revision as of 21:24, 23 July 2018

Callback function triggered when a mouse button is pressed.

Function

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

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.
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

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

Synopsis

love.mousepressed( x, y, button, istouch )

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.

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