Multi Theft Auto: Wiki - User contributions [en]

SetColPolygonHeight

2021-02-15T09:21:10Z

Remaked: /* Example */

{{Server client function}}
__NOTOC__
{{New feature/item|3.0160|1.5.8|20807|This function is used to change the height of an existing [[createColPolygon|colshape polygon]].
By default, a colshape polygon is infinitely tall.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setColPolygonHeight( colshape shape, float floor, float ceil )
</syntaxhighlight>
{{OOP||[[colshape]]:setHeight|}}

===Required Arguments===
*'''shape:''' The [[colshape]] polygon
*'''floor:''' The polygon floor (lowest Z coordinate). Parse ''false'' to reset this value to 0.
*'''ceil:''' The polygon ceiling (highest Z coordinate). Parse ''false'' to reset this value to infinitely tall.

===Returns===
Returns ''true'' if the polygon was changed, ''false'' if invalid arguments were passed.

==Example==
This example sets every polygon colshape's max heigh to 50 units once resource starts.
<section name="Server side script" class="server" show="true">
<syntaxhighlight lang="lua">
function setPolygonsHeight()
for i, v in ipairs(getElementsByType("colshape")) do
if (getColShapeType(v) == 4) then -- if it's a polygon colshape do it otherwise don't
setColPolygonHeight(v, false, 50)
end
end
end
addEventHandler("onResourceStart", resourceRoot, setPolygonsHeight)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.8-9.20807|1.5.8-9.20807|}}

==See Also==
{{Collision_shape_functions}}

SetElementBonePosition

2021-02-15T09:14:24Z

Remaked: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the following element types are accepted:
* [[Element/Player|Player]]
* [[Element/Ped|Ped]]
}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]]}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementBonePosition ( element theElement, int bone, float x, float y, float z )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' the element to set the bone position on.
*'''bone:''' the ID of the bone to set the position of. See [[Bone IDs]]
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''z:''' The z coordinate of the destination.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Example==
This example is a command where the player should input the bone ID, x, y, z to set one of his bones' position.
<syntaxhighlight lang="lua">
function setBonePosition(cmd, ID, x, y, z)
if (not ID or not x or not y or not z) then
outputChatBox("Syntax: '/setbonepos ID x y z'", 255, 25, 25)
return false
end
if (not tonumber(ID) or not tonumber(x) or not tonumber(y) or not tonumber(z)) then
outputChatBox("Command arguments should be numbers", 255, 25, 25)
return false
end
setElementBonePosition(localPlayer, ID, x, y, z)
outputChatBox("Bone position set successfully", 0, 255, 0)
end
addCommandHandler("setbonepos", setBonePosition)
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

OnClientResourceFileDownload

2021-02-15T09:06:50Z

Remaked: /* Example */

__NOTOC__
{{Client event}}
{{New feature/item|3.0160|1.5.8|20788|This event is triggered every time a resource file download is queued, finished or has failed.}}

{{Warning|This event is '''NOT''' related to [[downloadFile]] and [[onClientFileDownloadComplete]]!|true}}

==Parameters==
<syntaxhighlight lang="lua">
resource fileResource, string fileName, number fileSize, string state
</syntaxhighlight>
*'''fileResource:''' resource the file belongs to
*'''fileName:''' relative resource file path
*'''fileSize:''' size of the file in bytes
*'''state:''' possible values: <code>"queued"</code> or <code>"finished"</code> or <code>"failed"</code>

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

==Example==
This example will output the file's resource name/file name/size/state when downloading
<syntaxhighlight lang="lua">
function writeMsg(resourceName, fileName, fileSize, fileState)
outputChatBox("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState)
end
addEventHandler("onClientResourceFileDownload", root, writeMsg)
</syntaxhighlight>

==Requirements==
{{Requirements||1.5.8-9.20788|}}

==See Also==
===Client resource events===
{{Client_resource_events}}
===Client event functions===
{{Client_event_functions}}

GetVehicleCurrentGear

2021-02-14T15:09:10Z

Remaked: /* Example */

__NOTOC__
{{Client function}}

Gets the specified vehicle's current gear.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleCurrentGear ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle to get the gear of

===Returns===
Returns the gear if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
Example of a program that outputs the current gear to the lower, center of the screen
<syntaxhighlight lang="lua">
function makeGearGui( )
local sx, sy = guiGetScreenSize()
local wx = 50
local wy = 50
gearLabel = guiCreateLabel(((sx / 2) - wx), (sy - wy), wx, wy, "5", false)
end
makeGearGui()

function onRender()
g_vehicle = getPedOccupiedVehicle(localPlayer)
if g_vehicle then
g_curGear = tostring(getVehicleCurrentGear(g_vehicle))
guiSetText(gearLabel, g_curGear)
else
guiSetText(gearLabel, "")
end
end
addEventHandler("onClientRender", root, onRender)
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

AddColPolygonPoint

2021-02-04T02:50:59Z

Remaked: /* Returns */

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20397|This function is used to add a new point to an existing [[createColPolygon|colshape polygon]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool addColPolygonPoint ( colshape shape, float fX, float fY [, int index = 0 ] )
</syntaxhighlight>
{{OOP||[[colshape]]:addPoint||removeColPolygonPoint|}}

===Required Arguments===
*'''shape:''' The [[colshape]] polygon you wish add a point to.
*'''fX:''' The X position of the new bound point.
*'''fY:''' The Y position of the new bound point.

==Optional Arguments==
{{OptionalArg}}
*'''index:''' The index where the new point will be inserted in the polygon. The points are indexed in order, with 1 being the first bound point. Passing 0 will insert the point as the last one in the polygon.

===Returns===
Returns ''true'' if the polygon was changed, ''false'' if invalid arguments were passed.

===Example===
<section name="Server" class="server" show="true">
This examples adds a point to an existing polygon shape by a command.
<syntaxhighlight lang="lua">
local shape = createColPolygon(2, 2, 5, 5, 6, 6, 8, 8) -- Somewhere in the map
function addPointToPolygon(plr, cmd, fX, fY, index)
if (not fX or not fY) then
outputChatBox("Correct syntax: /addpoint <fX fY>", plr, 255, 25, 25)
return false
end
if (not index or index == 0) then
addColPolygonPoint(shape, fX, fY)
else
addColPolygonPoint(shape, fX, fY, index)
end
outputChatBox("Point added", plr, 0, 255, 0)
end
addCommandHandler("addpoint", addPointToPolygon)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20397|1.5.7-9.20397|}}

==See Also==
{{Collision_shape_functions}}

AddColPolygonPoint

2021-02-04T02:49:27Z

Remaked: /* Example */

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20397|This function is used to add a new point to an existing [[createColPolygon|colshape polygon]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool addColPolygonPoint ( colshape shape, float fX, float fY [, int index = 0 ] )
</syntaxhighlight>
{{OOP||[[colshape]]:addPoint||removeColPolygonPoint|}}

===Required Arguments===
*'''shape:''' The [[colshape]] polygon you wish add a point to.
*'''fX:''' The X position of the new bound point.
*'''fY:''' The Y position of the new bound point.

==Optional Arguments==
{{OptionalArg}}
*'''index:''' The index where the new point will be inserted in the polygon. The points are indexed in order, with 1 being the first bound point. Passing 0 will insert the point as the last one in the polygon.

===Returns===
Returns ''true'' if the polygon was changed, ''false'' if invalid arguments were passed.

<section name="Server" class="server" show="true">
This examples adds a point to an existing polygon shape by a command.
<syntaxhighlight lang="lua">
local shape = createColPolygon(2, 2, 5, 5, 6, 6, 8, 8) -- Somewhere in the map
function addPointToPolygon(plr, cmd, fX, fY, index)
if (not fX or not fY) then
outputChatBox("Correct syntax: /addpoint <fX fY>", plr, 255, 25, 25)
return false
end
if (not index or index == 0) then
addColPolygonPoint(shape, fX, fY)
else
addColPolygonPoint(shape, fX, fY, index)
end
outputChatBox("Point added", plr, 0, 255, 0)
end
addCommandHandler("addpoint", addPointToPolygon)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20397|1.5.7-9.20397|}}

==See Also==
{{Collision_shape_functions}}

GetVehicleDummyPosition

2021-02-04T02:36:56Z

Remaked: /* Example */

{{Client function}}
__NOTOC__

{{New feature/item|3.0160|1.5.8|20797|
This function returns the position of the dummy for the given vehicle.}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleDummyPosition ( vehicle theVehicle, string dummy )
</syntaxhighlight>
{{OOP||[[vehicle]]:getDummyPosition||setVehicleDummyPosition}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you want to get the dummy positions from
*'''dummy:''' The dummy whose position you want to get

==Allowed dummies==
{{VehicleDummies}}

===Returns===
Returns three floats indicating the position ''x'', ''y'' and ''z'' of the vehicle's dummy. It returns ''false'' otherwise.

This is a command to get the position of the player's vehicle dummy position specified as an argument.
<syntaxhighlight lang="lua">
function getDummyPosition(cmd, dummy)
if (not dummy) then
return false
end
local veh = getPedOccupiedVehicle(localPlayer)
if (not veh) then
outputChatBox("You should be in a vehicle to use this command", 255, 25, 25)
return false
end
local x, y, z = getVehicleDummyPosition(veh, dummy)
outputChatBox("X: "..x..", Y: "..y..", Z: "..z, 0, 255, 0)
end
addCommandHandler("getdummy", getDummyPosition)
</syntaxhighlight>

==Requirements==
{{Requirements||1.5.8-9.20797|}}

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

OnPedVehicleEnter

2021-02-04T02:18:48Z

Remaked: /* Example */

__NOTOC__
{{Server event}}
{{New feature/item|3.0160|1.5.8|20740|This event is triggered when a ped enters a vehicle.}}

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat, ped jacked
</syntaxhighlight>

*'''theVehicle''': a [[vehicle]] element representing the vehicle that was entered.
*'''seat''': an [[int]] representing the seat in which the ped is entering.
*'''jacked''': a [[player]] or [[ped]] element representing who has been jacked.

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that entered the vehicle.

<section name="Example 1" class="server" show="true">
Sending a message to every player when ped has entered to a vehicle
<syntaxhighlight lang="lua">
function sendMessage(theVehicle, seat)
local vehicleName = getVehicleName(theVehicle) -- Get name of the vehicle
if seat==0 then -- if the ped is a driver
outputChatBox("Ped is now a driver of "..vehicleName, root)
else -- if not
outputChatBox("Ped has entered to "..vehicleName, root)
end
end
addEventHandler("onPedVehicleEnter", root, sendMessage)
</syntaxhighlight>
</section>
{{See also/Server event|Ped events}}

OnPedVehicleExit

2021-02-04T02:16:50Z

Remaked: /* Example */

__NOTOC__
{{Server event}}
{{New feature/item|3.0160|1.5.8|20740|This event is triggered when a ped leaves a vehicle.}}

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat, ped jacker, bool forcedByScript
</syntaxhighlight>

*'''theVehicle''': a [[vehicle]] element representing the vehicle in which the ped exited from.
*'''seat''': an [[int]] representing the seat in which the ped was before exiting.
*'''jacker''': a [[player]] or [[ped]] element representing who jacked the driver.
*'''forcedByScript:''' a [[boolean]] representing whether the exit was forced using [[removePedFromVehicle]] or by the ped.

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that left the vehicle.

<section name="Example 1" class="server" show="true">
Destroy the vehicle when ped has been jacked and kick the jacker if exists
<syntaxhighlight lang="lua">
function destroyVehicle(theVehicle, seat, jacker, forcedByScript)
if seat==0 then -- If ped was a driver
if forcedByScript then
destroyElement(theVehicle) -- If the exit was forced using removePedFromVehicle then destroy the vehicle
elseif jacker then
kickPlayer(jacker)
destroyElement(theVehicle)
end
end
end
addEventHandler("onPedVehicleExit", root, destroyVehicle)
</syntaxhighlight>
</section>
{{See also/Server event|Ped events}}

GetElementBonePosition

2020-12-14T12:27:46Z

Remaked: /* Example */

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20704|Returns the 3D world coordinates of a specific bone of a given [[element]]. Currently the following element types are accepted:
* [[Element/Player|Player]]
* [[Element/Ped|Ped]]
}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]]}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getElementBonePosition ( element theElement, int bone )
</syntaxhighlight>

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

===Returns===
Returns the x, y, z world position of the bone.

==Example==
This example outputs the x, y, z world position of the local player bone specified through a command.
<syntaxhighlight lang="lua">
function getBonePosition(cmd, ID)
if (not ID) then
outputChatBox("You didn't insert an ID", 255, 0, 0)
return false
end
local x, y, z = getElementBonePosition(localPlayer, ID)
outputChatBox("The bone position is: "..x..", "..y..", "..z)
end
addCommandHandler("getboneposition", getBonePosition)
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

GetVehicleRespawnPosition

2020-12-14T12:09:04Z

Remaked: /* Example */

{{Server function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|14053|This function retrieves the respawn coordinates of a [[vehicle]].}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleRespawnPosition ( element theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getRespawnPosition|respawnPosition|setVehicleRespawnPosition}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] which you'd like to retrieve the respawn coordinates of.

===Returns===
Returns three [[float|floats]] indicating the respawn coordinates of the [[vehicle]], ''x'', ''y'' and ''z'' respectively.

==Example==
This example outputs the player's current vehicle respawn position.
<syntaxhighlight lang="lua">
function getRespawnPosition(plr)
if (not plr) then
return false
end
local veh = getPedOccupiedVehicle(plr)
if (not veh) then
return false
end
local x, y, z = getVehicleRespawnPosition(veh)
return x, y, z
end
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

OnClientPedVehicleExit

2020-12-14T11:55:39Z

Remaked: /* Example */

{{Client event}}
__NOTOC__
{{New feature/item|3.0160|1.5.8|20740|This event is fired when a [[ped]] has exited a [[vehicle]].}}

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat
</syntaxhighlight>
*'''theVehicle:''' the vehicle that the ped exited.
*'''seat:''' the number of the seat that the ped was sitting on.

==Source==
The source of this event is the [[ped]] that exited the vehicle.

==Example==
This example will immediately delete any vehicle a ped exits if the vehicle's health is below 500.
<syntaxhighlight lang="lua">
function deleteVehicleOnExit(theVehicle, seat)
local vehHealth = getElementHealth(theVehicle)
if (vehHealth < 500) then
destroyElement(theVehicle)
end
end
addEventHandler("onClientPedVehicleExit", root, deleteVehicleOnExit)
</syntaxhighlight>

==See Also==

===Client ped events===
{{Client_ped_events}}
===Client ped functions===
{{Client_ped_functions}}

OnClientPedVehicleExit

2020-12-08T20:18:18Z

Remaked: /* Example */

{{Client event}}
__NOTOC__
{{New feature/item|3.0160|1.5.8|20740|This event is fired when a [[ped]] has exited a [[vehicle]].}}

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat
</syntaxhighlight>
*'''theVehicle:''' the vehicle that the ped exited.
*'''seat:''' the number of the seat that the ped was sitting on.

==Source==
The source of this event is the [[ped]] that exited the vehicle.

==Example==
This example will immediately blow any vehicle a ped exits if the vehicle's health is below 500.
<syntaxhighlight lang="lua">
function blowVehicleOnExit(theVehicle, seat)
local vehHealth = getElementHealth(theVehicle)
if (vehHealth < 500) then
blowVehicle(theVehicle)
end
end
addEventHandler("onClientPedVehicleExit", root, blowVehicleOnExit)
</syntaxhighlight>

==See Also==

===Client ped events===
{{Client_ped_events}}
===Client ped functions===
{{Client_ped_functions}}

OnClientPedVehicleEnter

2020-12-08T20:06:40Z

Remaked: /* Example */

{{Client event}}
__NOTOC__
{{New feature/item|3.0160|1.5.8|20740|This event is fired when a [[ped]] has entered a [[vehicle]].}}

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat
</syntaxhighlight>
*'''theVehicle:''' the [[vehicle]] that the ped entered
*'''seat:''' the seat that the ped now is on. Driver's seat = 0, higher numbers are passenger seats.

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that entered the vehicle.

==Example==
This example outputs a text when a ped enters a bike as a driver.
<syntaxhighlight lang="lua">
function detectVehicleEnterByPed(theVehicle, seat)
if (getVehicleType(theVehicle) == "Bike" and seat == 0) then
outputChatBox("A ped has entered a bike as a driver!", 0, 255, 0)
end
end
addEventHandler("onClientPedVehicleEnter", root, detectVehicleEnterByPed)
</syntaxhighlight>

==See Also==

===Client ped events===
{{Client_ped_events}}
===Client ped functions===
{{Client_ped_functions}}