ShowCursor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 17: | Line 17: | ||
Returns ''true'' if the player's cursor was shown or hidden successfully, ''false'' otherwise. | Returns ''true'' if the player's cursor was shown or hidden successfully, ''false'' otherwise. | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
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"> | ||
| Line 28: | Line 29: | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Cursor_functions}} | {{Cursor_functions}} | ||
Revision as of 18:58, 21 August 2007
This function is used to show or hide a player's cursor.
Note that, regardless of the cursor state you set using this function, the cursor will always be visible while the menu or chatbox are open.
Syntax
bool showCursor ( player thePlayer, bool show )
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.
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 = getPlayerFromNick ( "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
See Also