ShowCursor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to show or hide a player's cursor for 'click-events'.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
returnType functionName ( arguments )
bool showCursor ( player thePlayer, bool show )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''thePlayer''' The player you want to show or hide the cursor of.
*'''argumentName:''' description
*'''show''' A boolean value determining whether to show ( true ) or hide ( false ) the cursor.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the player's cursor was shown or hidden successfully, otherwise ''false''.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example shows the players cursor, then prints "success" if it was shown successfully.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
thePlayer = getPlayerFromNick ( "Dave" ) -- grab the player named Dave
blabhalbalhb --abababa
if ( thePlayer ) then -- if we got him
--This line does this...
  showCursor ( thePlayer, true ) -- make his cursor show
mooo
  if ( isCursorShowing ( thePlayer ) ) then -- did it show?
    outputChatBox ( "success" ) -- print "success" to the chat box
  end
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Cursor_functions}}
{{FunctionArea_functions}}
[[Category:Incomplete]]

Revision as of 21:06, 3 November 2006

This function is used to show or hide a player's cursor for 'click-events'.

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, otherwise false.

Example

This example shows the players cursor, then prints "success" if it was shown successfully. 

thePlayer = getPlayerFromNick ( "Dave" ) -- grab 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 ( "success" ) -- print "success" to the chat box
  end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ShowCursor?oldid=6216"