Difference between revisions of "love.mouse.setGrab"

m (1 revision: Importing from potato (again).)
m (Forgot type for oldin)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
+
{{oldin|[[0.9.0]]|090|type=function|text=It has been renamed to [[love.mouse.setGrabbed]]}}
 
Grabs the mouse and confines it to the window.
 
Grabs the mouse and confines it to the window.
 
== Function ==
 
== Function ==
Line 10: Line 10:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
== Examples ==
 +
Toggles whether the mouse is grabbed by pressing tab, with the help of [[love.mouse.isGrabbed]].
 +
<source lang="lua">
 +
function love.keypressed(key)
 +
  if key == "tab" then
 +
      local state = not love.mouse.isGrabbed()  -- the opposite of whatever it currently is
 +
      love.mouse.setGrab(state)
 +
  end
 +
end
 +
</source>
 
== See Also ==
 
== See Also ==
 
* [[parent::love.mouse]]
 
* [[parent::love.mouse]]
 +
* [[love.mouse.isGrabbed]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Grabs the mouse and confines it to the window.}}
 
{{#set:Description=Grabs the mouse and confines it to the window.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.mouse.setGrab}}

Latest revision as of 15:31, 16 September 2013

Removed in LÖVE 0.9.0
It has been renamed to love.mouse.setGrabbed.

Grabs the mouse and confines it to the window.

Function

Synopsis

love.mouse.setGrab( grab )

Arguments

boolean grab
True to confine the mouse, false to let it leave the window.

Returns

Nothing.

Examples

Toggles whether the mouse is grabbed by pressing tab, with the help of love.mouse.isGrabbed.

function love.keypressed(key)
   if key == "tab" then
      local state = not love.mouse.isGrabbed()   -- the opposite of whatever it currently is
      love.mouse.setGrab(state)
   end
end

See Also


Other Languages