GetPlayerTargetEnd: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed "DeprecatedWithAlt" template to "Deprecated")
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Deprecated|getPedTargetEnd|}}
{{Deprecated|getPedTargetEnd}}


This function allows retrieval of the position where a players target range ends, when he is aiming with a weapon.
This function allows retrieval of the position where a players target range ends, when he is aiming with a weapon.
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float float getPlayerTargetEnd ( player targetingPlayer )
float, float, float getPlayerTargetEnd ( player targetingPlayer )
</syntaxhighlight>  
</syntaxhighlight>  


Line 17: Line 17:


==Example==  
==Example==  
This page does not have an example
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--add an example here
addEventHandler("onClientPlayerTarget", localPlayer,
    function()
        local endPosition = Vector3(getPlayerTargetEnd(source))
        outputChatBox("your target ends at point (" .. endPosition.x .. ", " .. endPosition.y .. ", " .. endPosition.z .. ")")
    end
)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Player_functions}}
{{Player_functions}}

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