GetPlayerTargetStart: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function allows retrieval of the position a player's target range begins.
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">
float float float getPlayerTargetStart ( player theplayer )
float float float getPlayerTargetStart ( player targetingPlayer )
</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 -->
*'''targetingPlayer:''' The player whose target start you wish to retrieve
*'''argumentName:''' description
 
<!-- 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 three floats, x,y,z, representing the position where the player's target starts, or false if it was unsuccessful.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This page does not have an example
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...
--add an example here
blabhalbalhb --abababa
--This line does this...
mooo
</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 -->
{{Player_functions}}
{{FunctionArea_functions}}
[[Category:Needs_Example]]
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 15:48, 26 August 2007

This function allows retrieval of the position a player's target range begins.

Syntax

float float float getPlayerTargetStart ( player targetingPlayer )

Required Arguments

  • targetingPlayer: The player whose target start you wish to retrieve

Returns

Returns three floats, x,y,z, representing the position where the player's target starts, or false if it was unsuccessful.

Example

This page does not have an example 

--add an example here

See Also

Shared

Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerTargetStart?oldid=11415"