Difference between revisions of "love.mouse.setPosition"

m (1 revision: Imported docs from potato.)
m (Shorten description.)
 
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
+
Sets the current position of the mouse. Non-integer values are floored.
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 11: Line 10:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
== Examples ==
 +
Snap the mouse to the horizontal center of the screen while maintaining the coordinate along the y-axis by using [[love.mouse.getY]].
 +
<source lang="lua">
 +
function love.keypressed( )
 +
  love.mouse.setPosition( love.graphics.getWidth() * 0.5, love.mouse.getY() )
 +
end
 +
</source>
 
== See Also ==
 
== See Also ==
 
* [[parent::love.mouse]]
 
* [[parent::love.mouse]]
 +
* [[love.mouse.getPosition]]
 +
* [[love.mouse.getX]]
 +
* [[love.mouse.getY]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Sets the current position of the mouse.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.mouse.setPosition}}

Latest revision as of 09:34, 10 March 2017

Sets the current position of the mouse. Non-integer values are floored.

Function

Synopsis

love.mouse.setPosition( x, y )

Arguments

number x
The new position of the mouse along the x-axis.
number y
The new position of the mouse along the y-axis.

Returns

Nothing.

Examples

Snap the mouse to the horizontal center of the screen while maintaining the coordinate along the y-axis by using love.mouse.getY.

function love.keypressed( )
  love.mouse.setPosition( love.graphics.getWidth() * 0.5, love.mouse.getY() )
end

See Also


Other Languages