Difference between revisions of "love.mouse.isGrabbed"
m (Edit links to point to setGrabbed().) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Checks if the mouse is grabbed. | |
| − | == | + | == Function == |
| − | === | + | === Synopsis === |
<source lang="lua"> | <source lang="lua"> | ||
grabbed = love.mouse.isGrabbed( ) | grabbed = love.mouse.isGrabbed( ) | ||
</source> | </source> | ||
| − | === | + | === Arguments === |
| − | + | None. | |
| − | === | + | === Returns === |
| − | {{param|boolean | + | {{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"> | <source lang="lua"> | ||
function love.keypressed(key) | function love.keypressed(key) | ||
if key == "tab" then | if key == "tab" then | ||
| − | local state = not love.mouse.isGrabbed() -- | + | local state = not love.mouse.isGrabbed() -- the opposite of whatever it currently is |
| − | love.mouse.setGrab(state) | + | love.mouse.setGrabbed(state) --Use love.mouse.setGrab(state) for 0.8.0 or lower |
end | end | ||
end | end | ||
</source> | </source> | ||
| − | == | + | == See Also == |
| − | * [[parent::love.mouse | + | * [[parent::love.mouse]] |
| − | * [[love.mouse. | + | * [[love.mouse.setGrabbed]] |
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description= | + | {{#set:Description=Checks if the mouse is grabbed.}} |
{{#set:Since=000}} | {{#set:Since=000}} | ||
| − | == | + | == Other Languages == |
{{i18n|love.mouse.isGrabbed}} | {{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
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
