IsCursorShowing: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function is used to determine whether or not a player's cursor is showing | This function is used to determine whether or not a player's cursor is showing. | ||
Note that this retrieves the cursor state that has been set using [[showCursor]], and thus doesn't take into account the cursor shown while the chatbox, menu or console are open. Also, keep in mind that while the client is aware of cursor states set from the server, the server doesn't know about cursor states set from the client. | |||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 10: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer''' The player you want to | *'''thePlayer:''' The [[player]] you want to get cursor state of. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the player's cursor is showing | Returns ''true'' if the player's cursor is showing, ''false'' if it isn't or if invalid parameters were passed. | ||
==Example== | ==Example== | ||
This | This function toggles a player's cursor state. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
thePlayer = | function toggleCursor ( thePlayer ) | ||
local currentState = isCursorShowing ( thePlayer ) -- get the current cursor state as a boolean | |||
local oppositeState = not currentState -- get the new state as its logical opposite | |||
showCursor ( thePlayer, oppositeState ) -- set it as the new cursor state | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 14:56, 29 July 2007
This function is used to determine whether or not a player's cursor is showing.
Note that this retrieves the cursor state that has been set using showCursor, and thus doesn't take into account the cursor shown while the chatbox, menu or console are open. Also, keep in mind that while the client is aware of cursor states set from the server, the server doesn't know about cursor states set from the client.
Syntax
bool isCursorShowing ( player thePlayer )
Required Arguments
- thePlayer: The player you want to get cursor state of.
Returns
Returns true if the player's cursor is showing, false if it isn't or if invalid parameters were passed.
Example
This function toggles a player's cursor state.
function toggleCursor ( thePlayer ) local currentState = isCursorShowing ( thePlayer ) -- get the current cursor state as a boolean local oppositeState = not currentState -- get the new state as its logical opposite showCursor ( thePlayer, oppositeState ) -- set it as the new cursor state end
See Also