Difference between revisions of "love.mouse.isGrabbed"

 
m (Edit links to point to setGrabbed().)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
+
Checks if the mouse is grabbed.
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 10: Line 9:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|grabbed|True if the cursor is grabbed, false if it is not.}}
 
{{param|boolean|grabbed|True if the cursor is grabbed, false if it is not.}}
 +
== Examples ==
 +
Toggles whether the mouse is grabbed by pressing tab, using [[love.mouse.setGrabbed]].
 +
<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.setGrabbed(state) --Use love.mouse.setGrab(state) for 0.8.0 or lower
 +
  end
 +
end
 +
</source>
 
== See Also ==
 
== See Also ==
 
* [[parent::love.mouse]]
 
* [[parent::love.mouse]]
 +
* [[love.mouse.setGrabbed]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Checks if the mouse is grabbed.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.mouse.isGrabbed}}

Latest revision as of 12:10, 22 December 2014

Checks if the mouse is grabbed.

Function

Synopsis

grabbed = love.mouse.isGrabbed( )

Arguments

None.

Returns

boolean grabbed
True if the cursor is grabbed, false if it is not.

Examples

Toggles whether the mouse is grabbed by pressing tab, using love.mouse.setGrabbed.

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

See Also


Other Languages