LordHenry: /* Syntax */

2023-04-04T01:09:42Z

Syntax

← Older revision		Revision as of 01:09, 4 April 2023
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">~~float,~~ float getElementRelatedAngle (element thisElement, element targetElement)</syntaxhighlight>		<syntaxhighlight lang="lua">float getElementRelatedAngle (element thisElement, element targetElement)</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	* '''thisElement''': The element whose '''XY position''' will be checked to obtain the angle relative to the other element.		* '''thisElement''': The element whose '''XY position''' will be checked to obtain the angle relative to the other element.

LordHenry: Created page with "NOTOC {{Useful Function}} This function returns the related angle between one element to another. This is useful to check if a player is on the left side of a vehicle, for example. ==Syntax== float, float getElementRelatedAngle (element thisElement, element targetElement) ===Required Arguments=== * '''thisElement''': The element whose '''XY position''' will be checked to obtain the angle relative to the other..."

2023-04-04T01:09:15Z

Created page with "__NOTOC__ {{Useful Function}} This function returns the related angle between one element to another. This is useful to check if a player is on the left side of a vehicle, for example. ==Syntax== <syntaxhighlight lang="lua">float, float getElementRelatedAngle (element thisElement, element targetElement)</syntaxhighlight> ===Required Arguments=== * '''thisElement''': The element whose '''XY position''' will be checked to obtain the angle relative to the other..."

New page

__NOTOC__
{{Useful Function}}
This function returns the related angle between one [[Element|element]] to another. This is useful to check if a player is on the left side of a vehicle, for example.

==Syntax==
<syntaxhighlight lang="lua">float, float getElementRelatedAngle (element thisElement, element targetElement)</syntaxhighlight>
===Required Arguments===
* '''thisElement''': The element whose '''XY position''' will be checked to obtain the angle relative to the other element.
* '''targetElement''': The element whose '''XY position''' and '''Z rotation''' will be checked to obtain the angle relative to the other element.

===Returns===
Returns a float indicating the related angle between the first element and the second. It returns ''false'' if invalid parameters are provided.

==Code==
<section name="Server/Client-side script" class="both" show="true">
<syntaxhighlight lang="lua">
function getElementRelatedAngle (thisElement, targetElement)
if isElement(thisElement) and isElement(targetElement) then
local pointX, pointY = getElementPosition(thisElement)
local x, y = getElementPosition(targetElement)
local _, _, rz = getElementRotation(targetElement)
local anglePointToElement = math.atan2(pointX - x, pointY - y)
local formattedAnglePointToElement = math.deg(anglePointToElement)
local elementRelatedPosition = formattedAnglePointToElement + rz

-- Valid angles must be from 0 to 359.9999999999
if (elementRelatedPosition < 0) then
elementRelatedPosition = elementRelatedPosition + 360 -- Sets any negative angle to valid angle.
elseif (elementRelatedPosition >= 360) then
elementRelatedPosition = elementRelatedPosition - 360 -- Sets any angle higher than 360 to valid angle. 360 becomes 0.
end

return elementRelatedPosition
else
return false
end
end
</syntaxhighlight></section>

==Example==
<section name="Client" class="client" show="true">
This example allows the player to press ''H'' near a vehicle to open its door according to the vehicle related angle. If the player is on the front of the vehicle, it opens the hood, if the player is on the back of the vehicle, it opens the trunk and so on.
<syntaxhighlight lang="lua">
function getNearestElement(thePlayer, elementType) -- Useful function (simplified version)
local dist = 20 -- Only gets elements nearer than this distance.
local x, y, z = getElementPosition(thePlayer)
local nearest = false
for _,veh in pairs(getElementsByType(elementType)) do
local vx, vy, vz = getElementPosition(veh)
local newDist = getDistanceBetweenPoints3D(x, y, z, vx, vy, vz)
if newDist < dist then
dist = newDist
nearest = veh
end
end
return nearest, dist
end

bindKey("h", "down", function(key, state)
local veh, distance = getNearestElement(localPlayer, "vehicle")
if veh and isElement(veh) then
if distance < 5 then
local angle = getElementRelatedAngle(localPlayer, veh)
local door
if angle >= 340 or angle < 20 then
door = 0
elseif angle >= 20 and angle < 90 then
door = 3
elseif angle >= 90 and angle < 160 then
door = 5
elseif angle >= 160 and angle < 200 then
door = 1
elseif angle >= 200 and angle < 270 then
door = 4
elseif angle >= 270 and angle < 340 then
door = 2
end
if getVehicleDoorOpenRatio (veh, door) > 0 then
setVehicleDoorOpenRatio (veh, door, 0, 500)
else
setVehicleDoorOpenRatio (veh, door, 1, 500)
end
end
end
end)
</syntaxhighlight>
</section>
Author: [[User:LordHenry|LordHenry]]

==See Also==
{{Useful_Functions}}

GetElementRelatedAngle - Revision history

LordHenry: /* Syntax */