Multi Theft Auto: Wiki - User contributions [en]

GetElementID

2025-06-02T12:05:07Z

1Lorenzo:

__NOTOC__
{{Server client function}}
This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar.
{{Note| This function can also be used to get the resource name of any ''resource-data''.}}

==Syntax==
<syntaxhighlight lang="lua">
string getElementID ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getID|id|setElementID}}

===Required Arguments===
*'''theElement:''' the element from which to retrieve the ID.

===Returns===
This returns a ''string'' containing the element ID. It will return an empty ''string'' if it has no ID. It will return ''false'' if the element is invalid.

==Example==
To get the ID of the following element:
<syntaxhighlight lang="xml"><flag id="northflag" posX="2365" posY="215" posZ="32" /></syntaxhighlight>
You could use the following code:
<syntaxhighlight lang="lua">
-- assume flag refers to the flag element in the above XML code
idstring = getElementID ( flag ) -- get the id of the flag element
outputChatBox ( "The flag's ID is: " .. idstring ) -- output: The flag's ID is: northflag
</syntaxhighlight>

Another ex;
<syntaxhighlight lang="lua">
local obj = createObject(971, 0, 0, 3)
setElementID(obj, 'testObj')

idstring = getElementID ( obj ) -- get the id of the object
outputChatBox ( "The obket's ID is: " .. idstring ) -- output: The object ID is: testObj
</syntaxhighlight>

==See Also==
{{Element_functions}}
[[de:GetElementID]]

IsPlayerCrosshairVisible

2024-12-05T02:03:34Z

1Lorenzo: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22751|This function checks if the local player has showing crosshair.}}

{{Note|This function checks if the crosshair is rendered by GTA. Please note that hud components are not associated with this function, so the function may return '''true''' even if the ''"crosshair"'' component is hidden with [[setPlayerHudComponentVisible]]. If you need checking use [[isPlayerHudComponentVisible]].}}

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerCrosshairVisible()</syntaxhighlight>

===Returns===
Returns ''true'' if the player has the crosshair visible, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("aim", function()
local AimStatusText = isPlayerCrosshairVisible() and "Visbile" or "Hidden"
outputChatBox("Your AIM is: ".. AimStatusText)
end)
</syntaxhighlight>

==See Also==
{{Client player functions}}

DxGetBlendMode

2024-08-30T11:11:07Z

1Lorenzo:

{{Client function}}
__NOTOC__
This function returns the current blend mode for the dxDraw functions. The blend mode is set using [[dxSetBlendMode]]

==Syntax==
<syntaxhighlight lang="lua">
string dxGetBlendMode ( )
</syntaxhighlight>

==Returns==
Returns the current blend mode, which can be one of:
*'''blend'''
*'''add'''
*'''modulate_add'''
*'''overwrite'''

==Example==
<syntaxhighlight lang="lua">
-- Function to draw a rectangle with the current blend mode displayed
function renderBlendModeExample()
-- Get the current blend mode
local blendMode = dxGetBlendMode()

-- Draw a background rectangle
dxDrawRectangle(100, 100, 300, 200, tocolor(0, 0, 255, 100))

-- Draw some text on top of the rectangle
dxDrawText("Current Blend Mode: " .. blendMode, 110, 110, 390, 190, tocolor(255, 255, 255, 255), 1.5, "default-bold")
end

-- Add an event handler to render the rectangle and text every frame
addEventHandler("onClientRender", root, renderBlendModeExample)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.03782|}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetBlendMode]]

DxSetShaderTransform

2024-08-30T11:10:52Z

1Lorenzo:

{{Client function}}
__NOTOC__
This function applies a 3D transformation to a [[shader]] element when it is drawn with [[dxDrawImage]].

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetShaderTransform ( element theShader,
float rotationX, float rotationY, float rotationZ,
[ float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, float rotationCenterOffsetZ = 0,
bool bRotationCenterOffsetOriginIsScreen = false,
float perspectiveCenterOffsetX = 0, float perspectiveCenterOffsetY = 0,
bool bPerspectiveCenterOffsetOriginIsScreen = false ] )
</syntaxhighlight>
{{OOP||[[shader]]:setTransform}}

===Required Arguments===
*'''theShader:''' The shader element whose transformation is to be changed
*'''rotationX:''' Rotation angle in degrees around the X axis (Left,right). This will make the shader rotate along its width.
*'''rotationY:''' Rotation angle in degrees around the Y axis (Up,down). This will make the shader rotate along its height.
*'''rotationZ:''' Rotation angle in degrees around the Z axis (In,out). This will make the shader rotate in a similar way to the rotation argument in [[dxDrawImage]].

===Optional Arguments===
{{OptionalArg}}
*'''rotationCenterOffsetX :''' The center of rotation offset X position in screen relative units.
*'''rotationCenterOffsetY :''' The center of rotation offset Y position in screen relative units.
*'''rotationCenterOffsetZ :''' The center of rotation offset Z position in screen relative units.
*'''bRotationCenterOffsetOriginIsScreen :''' Set to [[boolean|true]] if the center of rotation origin should be the center of the screen rather than the center of the image.
*'''perspectiveCenterOffsetX :''' The center of perspective offset X position in screen relative units.
*'''perspectiveCenterOffsetY :''' The center of perspective offset Y position in screen relative units.
*'''bPerspectiveCenterOffsetOriginIsScreen :''' Set to [[boolean|true]] if the center of perspective origin should be the center of the screen rather than the center of the image.

To convert screen relative units into screen pixel coordinates, ''multiply'' by the screen size. Conversely, to convert screen pixel coordinates to screen relative units, '''''divide''''' by the screen size.

===Returns===
Returns ''true'' if the shader element's transform was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local shader
local texture
local angle = 0 -- Initialize angle for rotation
local radius = 50 -- Reduced radius for the circular motion
local centerX, centerY -- Center of the screen

function startShaderExample()
-- Create a shader
shader = dxCreateShader("texture.fx")

-- Load a texture
texture = dxCreateTexture("myTexture.png")

-- Apply the texture to the shader
dxSetShaderValue(shader, "gTexture", texture)

-- Get the center of the screen
local screenWidth, screenHeight = guiGetScreenSize()
centerX = screenWidth / 2
centerY = screenHeight / 2

-- Start rendering the shader
addEventHandler("onClientRender", root, renderShader)
end
addEventHandler("onClientResourceStart", resourceRoot, startShaderExample)

function renderShader()
-- Increment the angle to create rotation over time
angle = angle + 0.02
if angle > 2 * math.pi then
angle = 0
end

-- Calculate the position based on a smaller circular path
local positionX = centerX + math.cos(angle) * radius
local positionY = centerY + math.sin(angle) * radius

-- Apply transformation: translation along a smaller circular path and rotation
dxSetShaderTransform(shader, positionX, positionY, 0, 0, 0, angle)

-- Draw a rectangle with the shader applied, following the circular path
dxDrawImage(positionX - 128, positionY - 128, 256, 256, shader)
end

function stopShaderExample()
if shader then
destroyElement(shader)
shader = nil
end
if texture then
destroyElement(texture)
texture = nil
end
removeEventHandler("onClientRender", root, renderShader)
end
addEventHandler("onClientResourceStop", resourceRoot, stopShaderExample)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.2.0-9.03618|}}

==See Also==
{{Drawing_functions}}

GetVehicleEntryPoints

2024-08-01T15:14:07Z

1Lorenzo: /* Example */

{{Client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|22649|
This function returns a table containing the positions to 4 possible entry points to a vehicle. This function can be used alongside [[setPedEnterVehicle]] to make a ped enter a specific seat by first moving the ped to a entry point retrieved through '''getVehicleEntryPoints''' and then using [[setPedEnterVehicle]] to make them enter.
}}

{{Note|This does not directly relate to the amount of doors a vehicle has as vehicles with two doors can have multiple entry points to the same door.}}
{{Note|The vehicle needs to be streamed in for this function to work.}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleEntryPoints(vehicle)
</syntaxhighlight>

{{OOP||[[vehicle]]:getEntryPoints}}

===Required arguments===
*'''vehicle''': The vehicle from which we want to get entry points.

===Returns===
If the vehicle has entry points, it returns a table containing the positions of the 4 possible entry points to the vehicle, otherwise it returns ''false''.

==Example==

'''Example 1''': This example renders 3D (''text & circle'') on each '''streamed-in''' vehicle entry point
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root, function()
for _, vehicle in pairs(getElementsByType("vehicle", root, true)) do
local entryX, entryY, entryZ = getElementPosition(vehicle)
for index, position in pairs(getVehicleEntryPoints(vehicle)) do
local drawX, drawY, distance = getScreenFromWorldPosition(
position[1], position[2], position[3], 100
)

if (drawX ~= false) then
local cameraX, cameraY, cameraZ = getCameraMatrix()

dxDrawCircle(drawX, drawY, 8 / (distance * 0.1), 0, 360, tocolor(255, 0, 0, 255))
dxDrawText(tostring(index), drawX, drawY + ((8 / (distance * 0.1)) / 2) + ((2 / (distance * 0.1)) + 0.5), 0, 0, tocolor(255, 0, 0, 255),
3 / (distance * 0.1), "default-bold")
end
end
end
end)
</syntaxhighlight>

'''Example 2''': This example checks if the player is near the vehicle door to ''enter''

<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleStartEnter", root, function(thePlayer, seat, door)
if thePlayer == localPlayer then
local entryPoints = getVehicleEntryPoints(source)
if entryPoints then
local entryPoint = entryPoints[door + 1]
if entryPoint then
local distance = getDistanceBetweenPoints3D(Vector3(getElementPosition(localPlayer)), unpack(entryPoint))
if distance > 2.5 then
outputChatBox("You are too far away from the door to enter this vehicle!")
cancelEvent()
end
end
end
end
end)
</syntaxhighlight>

==See Also==
{{Client vehicle functions}}

GetVehicleEntryPoints

2024-08-01T15:12:14Z

1Lorenzo: /* Example */

{{Client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|22649|
This function returns a table containing the positions to 4 possible entry points to a vehicle. This function can be used alongside [[setPedEnterVehicle]] to make a ped enter a specific seat by first moving the ped to a entry point retrieved through '''getVehicleEntryPoints''' and then using [[setPedEnterVehicle]] to make them enter.
}}

{{Note|This does not directly relate to the amount of doors a vehicle has as vehicles with two doors can have multiple entry points to the same door.}}
{{Note|The vehicle needs to be streamed in for this function to work.}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleEntryPoints(vehicle)
</syntaxhighlight>

{{OOP||[[vehicle]]:getEntryPoints}}

===Required arguments===
*'''vehicle''': The vehicle from which we want to get entry points.

===Returns===
If the vehicle has entry points, it returns a table containing the positions of the 4 possible entry points to the vehicle, otherwise it returns ''false''.

==Example==

'''Example 1''': This example renders 3D (''text & circle'') on each '''streamed-in''' vehicle entry point.
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root, function()
for _, vehicle in pairs(getElementsByType("vehicle", root, true)) do
local entryX, entryY, entryZ = getElementPosition(vehicle)
for index, position in pairs(getVehicleEntryPoints(vehicle)) do
local drawX, drawY, distance = getScreenFromWorldPosition(
position[1], position[2], position[3], 100
)

if (drawX ~= false) then
local cameraX, cameraY, cameraZ = getCameraMatrix()

dxDrawCircle(drawX, drawY, 8 / (distance * 0.1), 0, 360, tocolor(255, 0, 0, 255))
dxDrawText(tostring(index), drawX, drawY + ((8 / (distance * 0.1)) / 2) + ((2 / (distance * 0.1)) + 0.5), 0, 0, tocolor(255, 0, 0, 255),
3 / (distance * 0.1), "default-bold")
end
end
end
end)
</syntaxhighlight>

'''Example 2''': This example checks if the player is near the vehicle door and not far.

<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleStartEnter", root, function(thePlayer, seat, door)
if thePlayer == localPlayer then
local entryPoints = getVehicleEntryPoints(source)
if entryPoints then
local entryPoint = entryPoints[door + 1]
if entryPoint then
local distance = getDistanceBetweenPoints3D(Vector3(getElementPosition(localPlayer)), unpack(entryPoint))
if distance > 2.5 then
outputChatBox("You are too far away from the door to enter this vehicle!")
cancelEvent()
end
end
end
end
end)
</syntaxhighlight>

==See Also==
{{Client vehicle functions}}

GetVehicleEntryPoints

2024-08-01T15:11:37Z

1Lorenzo: /* nN Example */

{{Client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|22649|
This function returns a table containing the positions to 4 possible entry points to a vehicle. This function can be used alongside [[setPedEnterVehicle]] to make a ped enter a specific seat by first moving the ped to a entry point retrieved through '''getVehicleEntryPoints''' and then using [[setPedEnterVehicle]] to make them enter.
}}

{{Note|This does not directly relate to the amount of doors a vehicle has as vehicles with two doors can have multiple entry points to the same door.}}
{{Note|The vehicle needs to be streamed in for this function to work.}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleEntryPoints(vehicle)
</syntaxhighlight>

{{OOP||[[vehicle]]:getEntryPoints}}

===Required arguments===
*'''vehicle''': The vehicle from which we want to get entry points.

===Returns===
If the vehicle has entry points, it returns a table containing the positions of the 4 possible entry points to the vehicle, otherwise it returns ''false''.

==Example==

Example 1: This example renders 3D (''text & circle'') on each '''streamed-in''' vehicle entry point.
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root, function()
for _, vehicle in pairs(getElementsByType("vehicle", root, true)) do
local entryX, entryY, entryZ = getElementPosition(vehicle)
for index, position in pairs(getVehicleEntryPoints(vehicle)) do
local drawX, drawY, distance = getScreenFromWorldPosition(
position[1], position[2], position[3], 100
)

if (drawX ~= false) then
local cameraX, cameraY, cameraZ = getCameraMatrix()

dxDrawCircle(drawX, drawY, 8 / (distance * 0.1), 0, 360, tocolor(255, 0, 0, 255))
dxDrawText(tostring(index), drawX, drawY + ((8 / (distance * 0.1)) / 2) + ((2 / (distance * 0.1)) + 0.5), 0, 0, tocolor(255, 0, 0, 255),
3 / (distance * 0.1), "default-bold")
end
end
end
end)
</syntaxhighlight>

'''Example 2''': This example checks if the player is near the vehicle door and not far.

<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleStartEnter", root, function(thePlayer, seat, door)
if thePlayer == localPlayer then
local entryPoints = getVehicleEntryPoints(source)
if entryPoints then
local entryPoint = entryPoints[door + 1]
if entryPoint then
local distance = getDistanceBetweenPoints3D(Vector3(getElementPosition(localPlayer)), unpack(entryPoint))
if distance > 2.5 then
outputChatBox("You are too far away from the door to enter this vehicle!")
cancelEvent()
end
end
end
end
end)
</syntaxhighlight>

==See Also==
{{Client vehicle functions}}

GetLatentEventHandles

2023-12-12T20:40:19Z

1Lorenzo: /* Example */

__NOTOC__
{{Server client function}}
{{Needs_Example}}
Gets the currently queued latent events. The last one in the table is always the latest event queued. Each returned handle can be used with [[getLatentEventStatus]] or [[cancelLatentEvent]]

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getLatentEventHandles ( player thePlayer )
</syntaxhighlight>
===Required Arguments===
*'''thePlayer:''' The player who is receiving the events.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table getLatentEventHandles ( )
</syntaxhighlight>
</section>

===Returns===
Returns a table of handles or false if invalid arguments were passed.

==Example==
This command is triggering an latent-event to server, and if you write the command again and the trigger still didn't end then you have to wait.
<syntaxhighlight lang="lua">

-- CLIENT SIDE:

local lastTriggerd = false

addCommandHandler("trigger",function()
local triggers = getLatentEventHandles() -- get all latent events
if triggers[lastTriggerd] then -- you can use (getLatentEventStatus) too!
outputChatBox("Wait until the trigger ("..lastTriggerd..") ends!",255,0,0)
return
end
triggerLatentServerEvent("LatentEventsCheck",20000,resourceRoot,localPlayer)
lastTriggerd = #getLatentEventHandles() -- set the lastTriggerd with the id for last event triggerd
end)

-- SERVER SIDE:

addEvent("LatentEventsCheck",true)
addEventHandler("LatentEventsCheck",root,function (thePlayer)
outputChatBox("Latent trigger done from: " .. getPlayerName(thePlayer), root,math.random(255),0,0)
end)

</syntaxhighlight>

==Requirements==
{{Requirements|1.3.0-9.03772|1.3.0-9.03772|}}

==See Also==
{{Event functions}}

GetElementBoneMatrix

2023-12-12T20:25:22Z

1Lorenzo: /* Example */

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|20704|This function returns the transformation matrix of a specific bone. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}
{{Tip|For [[matrix]] manipulation which goes beyond the basic examples given on this page, see the [[Lua matrix library]]. Using the built-in [[matrix]] class is also recommended.}}

==Syntax==
<syntaxhighlight lang="lua">
table getElementBoneMatrix ( element theElement, int boneId )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' the [[element]] to get the bone matrix on.
*'''boneId:''' the ID of the bone to get the matrix of. See [[Bone IDs]].

===Returns===
Returns a multi-dimensional array (which can be transformed into a proper [[matrix]] class using ''Matrix.create'' method) containing a 4x4 matrix. Returns ''false'' if invalid arguments were passed.

==Example==
this example will output bone position and rotation for id 5.
<syntaxhighlight lang="lua">
local boneMatrix = getElementBoneMatrix(localPlayer, 5) -- get the bone matrix for localPlayer, id: 5
if boneMatrix then
-- extract position and rotation from the matrix
local posX, posY, posZ = boneMatrix[4][1], boneMatrix[4][2], boneMatrix[4][3]
local rotX, rotY, rotZ = math.deg(math.asin(-boneMatrix[3][2])), math.deg(math.atan2(boneMatrix[3][1], boneMatrix[3][3])), math.deg(math.atan2(boneMatrix[1][2], boneMatrix[2][2]))

outputChatBox("Bone position: (" .. posX .. ", " .. posY .. ", " .. posZ .. ")")
outputChatBox("Bone rotation: (" .. rotX .. ", " .. rotY .. ", " .. rotZ .. ")")
else
outputChatBox("Invalid element or bone ID.")
end
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20704|}}

==See Also==
{{Client_element_functions}}

EngineResetSurfaceProperties

2023-12-12T20:18:04Z

1Lorenzo: /* Example */

{{Client function}}
__NOTOC__
{{New feature/item|3.0157|1.5.6|16365|This function resets a surface property to its default value. If no ID is provided, it will reset all surfaces' properties to their original values.}}

==Syntax==
<syntaxhighlight lang="lua">
mixed engineResetSurfaceProperties ( [ int surfaceID ] )
</syntaxhighlight>
===Required Arguments===
*'''surfaceID:''' [[Material IDs|Material ID]] from 0 to 178

===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.

== Properties ==
{{Material_Properties}}

==Example==
This will reset any '''Surface Properties''' for id: ''5''
<syntaxhighlight lang="lua">
local surfaceID = 5 -- the material ID to reset properties
local success = engineResetSurfaceProperties(surfaceID)

if success then
outputChatBox("Surface properties reset successfully.")
else
outputChatBox("Invalid surface ID or error occurred.")
end
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineGetSurfaceProperties

2023-12-12T20:15:37Z

1Lorenzo: /* Example */

{{Client function}}
__NOTOC__
{{New feature/item|3.0157|1.5.6|16365|This function retrieves the value of a surface property.}}

==Syntax==
<syntaxhighlight lang="lua">
mixed engineGetSurfaceProperties ( int surfaceID, string property )
</syntaxhighlight>
===Required Arguments===
*'''surfaceID:''' [[Material IDs|Material ID]] from 0 to 178
*'''property:''' Property name

===Returns===
Returns the current property value. See the table below for possible values.

== Properties ==
{{Material_Properties}}

==Example==
In this example, we retrieve the surface property value for a material with ID 5 and the property name “audio.” If successful, it displays the value; otherwise, it indicates an invalid input
<syntaxhighlight lang="lua">
local surfaceID = 5 -- the material ID
local property = "audio" -- the property name
local propertyValue = engineGetSurfaceProperties(surfaceID, property)
if propertyValue then
outputChatBox("Surface property '" .. property .. "' value: " .. tostring(propertyValue))
-- returns : Surface property 'audio' value: concrete
else
outputChatBox("Invalid surface ID or property name.")
end
</syntaxhighlight>

==See Also==
{{Engine_functions}}

UpdateElementRpHAnim

2023-12-12T01:37:25Z

1Lorenzo: /* Example */

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20704|This function updates GTA bone animation for a given [[element]]. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted. It must be called after [[setElementBoneRotation]] for changes to take effect. It should only be called once per frame, after you are done rotating bones on that element, as it is quite heavy.}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool updateElementRpHAnim ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' the [[element]] to update the bone animations.

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientPedsProcessed",root,function()
for i,v in ipairs(getElementsByType('player',root,true)) do -- loop all players

-- just an exmaple anim
setElementBoneRotation(v, 33, 0, 295.2, 0)
setElementBoneRotation(v, 23, 0, 298.8, 0)
setElementBoneRotation(v, 4, 0, 46.8, 0)
setElementBoneRotation(v, 2, 0, 0, 32.4)

updateElementRpHAnim(v) -- Update ped bones animations

end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20704|}}

==See Also==
{{Client_element_functions}}

OnClientPedsProcessed

2023-12-12T01:36:40Z

1Lorenzo: /* Example */

__NOTOC__
{{Client event}}
{{Added feature/item|1.5.9|1.5.8|20704|This event is triggered after GTA updates bone transformations for all peds. This event can be used for updating bones.}}

==Parameters==
None.

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientPedsProcessed",root,function() -- add the event
for i,v in ipairs(getElementsByType('player',root,true)) do -- loop all players

-- just an exmaple anim
setElementBoneRotation(v, 33, 0, 295.2, 0)
setElementBoneRotation(v, 23, 0, 298.8, 0)
setElementBoneRotation(v, 4, 0, 46.8, 0)
setElementBoneRotation(v, 2, 0, 0, 32.4)

updateElementRpHAnim(v) -- Update ped bones animations

end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20704}}

==Warning==
This event will trigger whatever function it is attached to with every frame. Depending on the server's maximum FPS and what your computer might handle - you might end up triggering the function 30-60 times '''per second'''.

As a result, this event may cause severe lag and/or even crashes if not used cautiously.

==See Also==
===[[Game_Processing_Order|Game Processing Order]]===
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

GetPedAnalogControlState

2023-12-12T01:30:03Z

1Lorenzo: /* Example */

__NOTOC__
{{Client function}}
This function retrieves the analog control state of a [[ped]], as set by [[setPedAnalogControlState]].

==Syntax==
<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The ped you wish to retrieve the control state of.
*'''controlName:''' The control. See [[control names]] for a list of possible controls.

===Optional Arguments===
{{New feature/item|3.0158|1.5.7|20383|
*'''rawValue:''' A [[bool]] indicating if it should return the raw player input value (will always return script value for non-player peds).
}}

===Returns===
Returns a [[float]] between 0 (full release) and 1 (full push) indicating the amount the control is pushed.

==Example==
This exmaple creating a ped can drive with command '''/drive'''
<syntaxhighlight lang="lua">
local ped = createPed(0, 0,0,3)
local vehicle = createVehicle(554,0,0,3)
warpPedIntoVehicle(ped, vehicle)

addCommandHandler("drive",function()
isDriving = getPedAnalogControlState ( ped, "accelerate" ) -- get the analaog state of (accelerate)
if isDriving==1 then -- checks if equals 1 that means is driving
outputChatBox("Ped is driving stoping..")
setPedAnalogControlState( ped, "accelerate", 0 ) -- set the analaog (accelerate) to 0
else
outputChatBox("Starting drive")
setPedAnalogControlState( ped, "accelerate", 1 ) -- set the analaog (accelerate) to 1
end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04185|}}

==See Also==
{{Ped functions}}

[[hu:getPedAnalogControlState]]

GetPedAnalogControlState

2023-12-12T01:29:56Z

1Lorenzo: /* Example */

__NOTOC__
{{Client function}}
This function retrieves the analog control state of a [[ped]], as set by [[setPedAnalogControlState]].

==Syntax==
<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The ped you wish to retrieve the control state of.
*'''controlName:''' The control. See [[control names]] for a list of possible controls.

===Optional Arguments===
{{New feature/item|3.0158|1.5.7|20383|
*'''rawValue:''' A [[bool]] indicating if it should return the raw player input value (will always return script value for non-player peds).
}}

===Returns===
Returns a [[float]] between 0 (full release) and 1 (full push) indicating the amount the control is pushed.

==Example==
This exmaple creating a ped can drive with command '''drive'''
<syntaxhighlight lang="lua">
local ped = createPed(0, 0,0,3)
local vehicle = createVehicle(554,0,0,3)
warpPedIntoVehicle(ped, vehicle)

addCommandHandler("drive",function()
isDriving = getPedAnalogControlState ( ped, "accelerate" ) -- get the analaog state of (accelerate)
if isDriving==1 then -- checks if equals 1 that means is driving
outputChatBox("Ped is driving stoping..")
setPedAnalogControlState( ped, "accelerate", 0 ) -- set the analaog (accelerate) to 0
else
outputChatBox("Starting drive")
setPedAnalogControlState( ped, "accelerate", 1 ) -- set the analaog (accelerate) to 1
end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04185|}}

==See Also==
{{Ped functions}}

[[hu:getPedAnalogControlState]]

GetPedAnalogControlState

2023-12-12T01:25:18Z

1Lorenzo: /* Example */

__NOTOC__
{{Client function}}
This function retrieves the analog control state of a [[ped]], as set by [[setPedAnalogControlState]].

==Syntax==
<syntaxhighlight lang="lua">float getPedAnalogControlState ( ped thePed, string controlName [, bool rawValue ] )</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The ped you wish to retrieve the control state of.
*'''controlName:''' The control. See [[control names]] for a list of possible controls.

===Optional Arguments===
{{New feature/item|3.0158|1.5.7|20383|
*'''rawValue:''' A [[bool]] indicating if it should return the raw player input value (will always return script value for non-player peds).
}}

===Returns===
Returns a [[float]] between 0 (full release) and 1 (full push) indicating the amount the control is pushed.

==Example==
This exmaple creating a ped and vehicle, making the ped accelerate and driving
<syntaxhighlight lang="lua">
local ped = createPed(0, 0,0,3)
local vehicle = createVehicle(554,0,0,3)
warpPedIntoVehicle(ped, vehicle)

addCommandHandler("drive",function()
isDriving = getPedAnalogControlState ( ped, "accelerate" ) -- get the analaog state of (accelerate)
if isDriving==1 then -- checks if equals 1 that means is driving
outputChatBox("Ped is driving stoping..")
setPedAnalogControlState( ped, "accelerate", 0 ) -- set the analaog (accelerate) to 0
else
outputChatBox("Starting drive")
setPedAnalogControlState( ped, "accelerate", 1 ) -- set the analaog (accelerate) to 1
end
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04185|}}

==See Also==
{{Ped functions}}

[[hu:getPedAnalogControlState]]

GetGroundPosition

2023-12-12T00:51:22Z

1Lorenzo:

__NOTOC__
{{Client function}}
This function gets the Z level of the highest ground below a point.

It is required that the point is near enough to the local player so that it's within the area where collision data is loaded. If this is not the case, an incorrect position will be returned.

==Syntax==
<syntaxhighlight lang="lua">
float getGroundPosition ( float x, float y, float z )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A floating point number representing the X world coordinate of the point.
*'''y:''' A floating point number representing the Y world coordinate of the point.
*'''z:''' A floating point number representing the Z world coordinate of the point.

===Returns===
Returns a float with the highest ground-level Z coord if parameters are valid, ''0'' if the point you tried to test is outside the loaded world map, ''false'' otherwise.

==Example==
This clientside function determines if a player is under a ceiling or not.
<syntaxhighlight lang="lua">
function isPlayerUnderCover ( thePlayer )
--we get the player's position
local px, py, pz = getElementPosition ( thePlayer )
--we'll check for ground level at the player's position, and also 500 units over him.
--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
return getGroundPosition ( px, py, pz ) ~= getGroundPosition ( px, py, pz + 530 )
end
</syntaxhighlight>

==Another exmaple==
clientside function returns the distance between you and the ground (if there is)
<syntaxhighlight lang="lua">
function getGroundDistance( thePlayer, zHeight )
local x,y,z = getElementPosition(thePlayer) -- get position
local groundPosition = getGroundPosition(x,y,z) -- get default ground pos
local hit, x1, y1, groundPosition = processLineOfSight(x,y,z+1,x,y,z-(zHeight+0.7)) -- using zHeight get a better ground position
local distance = getDistanceBetweenPoints3D(x, y, z, x,y, (groundPosition or z)) -- get distance between both positions
return distance -- return the distance
end

-- Some cool examples:
addCommandHandler("gdistance",function(_, amount)
distance = getGroundDistance(localPlayer, tonumber(amount))
outputChatBox("The distance to reach ground is: " .. distance)
end)

addCommandHandler("do_im_flying",function()
distance = getGroundDistance(localPlayer, 20)
if (distance>1) then
outputChatBox("Superman!! the distance between you and ground is: " .. distance)
else
outputChatBox("naah")
end
end)
</syntaxhighlight>

==See Also==
{{Client_world_functions}}

[[ru:getGroundPosition]]