ShowCursor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
{{Server client function}} | {{Server client function}} | ||
This function is used to show or hide a [[player]]'s cursor. | This function is used to show or hide a [[player]]'s cursor. | ||
{{Note|Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.}} | |||
Note | |||
==Syntax== | ==Syntax== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
| Line 17: | Line 15: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled. | *'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled. | ||
</section> | </section> | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
| Line 32: | Line 27: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled. | *'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled. | ||
</section> | </section> | ||
| Line 45: | Line 37: | ||
This example shows the cursor for a player named "Dave", then outputs a message if it was shown successfully. | This example shows the cursor for a player named "Dave", then outputs a message if it was shown successfully. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local thePlayer = | local thePlayer = getPlayerFromName ( "Dave" ) -- get the player named Dave | ||
if thePlayer then -- if we got him | if thePlayer then -- if we got him | ||
showCursor ( thePlayer, true ) -- make his cursor show | showCursor ( thePlayer, true ) -- make his cursor show | ||
| Line 66: | Line 58: | ||
==See Also== | ==See Also== | ||
{{Cursor_functions}} | {{Cursor_functions}} | ||
[[hu:showCursor]] | |||
Latest revision as of 10:56, 13 October 2018
This function is used to show or hide a player's cursor.
| Note: Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function. |
Syntax
Click to collapse [-]
Serverbool showCursor ( player thePlayer, bool show, [ bool toggleControls = true ] )
Required Arguments
- thePlayer: The player you want to show or hide the cursor of.
- show: A boolean value determining whether to show (true) or hide (false) the cursor.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- toggleControls: A boolean value determining whether to disable controls whilst the cursor is showing. true implies controls are disabled, false implies controls remain enabled.
Click to collapse [-]
Clientbool showCursor ( bool show, [ bool toggleControls = true ] )
Required Arguments
- show: A boolean value determining whether to show (true) or hide (false) the cursor.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- toggleControls: A boolean value determining whether to disable controls whilst the cursor is showing. true implies controls are disabled, false implies controls remain enabled.
Returns
Returns true if the player's cursor was shown or hidden successfully, false otherwise.
Example
Click to collapse [-]
ServerThis example shows the cursor for a player named "Dave", then outputs a message if it was shown successfully.
local thePlayer = getPlayerFromName ( "Dave" ) -- get the player named Dave
if thePlayer then -- if we got him
showCursor ( thePlayer, true ) -- make his cursor show
if isCursorShowing ( thePlayer ) then -- did it show?
outputChatBox ( "Cursor is now showing for Dave." ) -- print a message to the chat box
end
end
Click to collapse [-]
ClientThis example shows the cursor all the time
showCursor ( true ) -- Shows cursor showCursor ( false ) -- Doesnt Show Cursor