IsMouseCursorEnabled: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsMouseCursorEnabled()}} {{FuncParameters}} {{FuncNoParam}} {{FuncReturnValue|__EDIT_ME__}} == E...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Check if the player's mouse cursor is enabled.}} | ||
{{FuncSyntax|IsMouseCursorEnabled()}} | {{FuncSyntax|IsMouseCursorEnabled()}} | ||
| Line 8: | Line 8: | ||
{{FuncNoParam}} | {{FuncNoParam}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns ''true'' on success.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang='Lua'> | |||
if IsMouseCursorEnabled() == false then -- If mouse cursor is not enabled | |||
ShowMouseCursor(true) -- Enable it | |||
end | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:ClientMouseFunctions}} | |||
Latest revision as of 10:30, 2 March 2020
Description
Check if the player's mouse cursor is enabled.
Syntax
IsMouseCursorEnabled()
Parameters
- This function has no parameters.
Return Value
- Returns true on success.
Example
if IsMouseCursorEnabled() == false then -- If mouse cursor is not enabled
ShowMouseCursor(true) -- Enable it
end
