Difference between revisions of "love.mousereleased"

m
(See Also)
 
(11 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
Callback function triggered when a mouse button is released.
 
Callback function triggered when a mouse button is released.
 +
 
== Function ==
 
== Function ==
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.mousereleased( 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 released. 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 release originated from a touchscreen touch-release.}}
 +
{{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.
 +
 +
== Function ==
 +
{{oldin|[[0.10.0]]|100|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 8: Line 26:
 
{{param|number|x|Mouse x position.}}
 
{{param|number|x|Mouse x position.}}
 
{{param|number|y|Mouse y position.}}
 
{{param|number|y|Mouse y position.}}
{{param|MouseConstant|button|Mouse button released.}}
+
{{param|MouseConstant|button|Mouse button released, except Mouse Wheel.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Examples ==
 
== Examples ==
Position a string ("Text") wherever the user releases the left mouse button.
+
Position a string ("Text") wherever the user releases the primary mouse button.
 
<source lang="lua">
 
<source lang="lua">
 
function love.load()
 
function love.load()
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.mousereleased(x, y, button)
 
function love.mousereleased(x, y, button)
   if button == "l" then
+
   if button == 1 then
 
       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.mousepressed]]
 +
* [[love.mousemoved]]
 +
 +
 
[[Category:Callbacks]]
 
[[Category:Callbacks]]
 
{{#set:Description=Callback function triggered when a mouse button is released.}}
 
{{#set:Description=Callback function triggered when a mouse button is released.}}
{{#set:Subcategory=General}}
+
{{#set:Subcategory=Mouse}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 +
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.mousereleased}}
 
{{i18n|love.mousereleased}}

Latest revision as of 07:48, 8 March 2023

Callback function triggered when a mouse button is released.

Function

Synopsis

love.mousereleased( 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 released. 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 release originated from a touchscreen touch-release.
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.

Function

Removed in LÖVE 0.10.0
This variant is not supported in that and later versions.

Synopsis

love.mousereleased( x, y, button )

Arguments

number x
Mouse x position.
number y
Mouse y position.
MouseConstant button
Mouse button released, except Mouse Wheel.

Returns

Nothing.

Examples

Position a string ("Text") wherever the user releases the primary mouse button.

function love.load()
   printx = 0
   printy = 0
end

function love.draw()
   love.graphics.print("Text", printx, printy)
end

function love.mousereleased(x, y, button)
   if button == 1 then
      printx = x
      printy = y
   end
end

See Also



Other Languages