GetPlayerTargetEnd: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(11 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{Client function}}
This fake function is for use with blah & blah and does blahblahblabhalbhl
{{Deprecated|getPedTargetEnd}}
 
This function allows retrieval of the position where a players target range ends, when he is aiming with a weapon.


==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 )
float, float, float getPlayerTargetEnd ( 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 who is targeting whose target end 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 ends according to his range, or false if it was unsuccessful.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
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...
addEventHandler("onClientPlayerTarget", localPlayer,
blabhalbalhb --abababa
    function()
--This line does this...
        local endPosition = Vector3(getPlayerTargetEnd(source))
mooo
        outputChatBox("your target ends at point (" .. endPosition.x .. ", " .. endPosition.y .. ", " .. endPosition.z .. ")")
    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 -->
{{Player_functions}}
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Latest revision as of 17:45, 23 July 2018

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedTargetEnd instead.


This function allows retrieval of the position where a players target range ends, when he is aiming with a weapon.

Syntax

float, float, float getPlayerTargetEnd ( player targetingPlayer )

Required Arguments

  • targetingPlayer: The player who is targeting whose target end you wish to retrieve

Returns

Returns three floats, x,y,z, representing the position where the player's target ends according to his range, or false if it was unsuccessful.

Example

addEventHandler("onClientPlayerTarget", localPlayer,
    function()
        local endPosition = Vector3(getPlayerTargetEnd(source))
        outputChatBox("your target ends at point (" .. endPosition.x .. ", " .. endPosition.y .. ", " .. endPosition.z .. ")")
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerTargetEnd?oldid=56781"