Multi Theft Auto: Wiki - User contributions [en]

GetVehicleModelDummyPosition

2019-09-02T10:00:28Z

DezZolation:

{{Client function}}
__NOTOC__
{{New feature/item|3.0155|1.5.6|14406|
This function gets position of the dummies contained in a vehicle model.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleModelDummyPosition ( int modelID, string dummy )
</syntaxhighlight>
{{OOP||[[Vehicle]].getVehicleModelDummyPosition||setVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to get

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' Point at which the steer of a bike is held.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns the position of given dummy if everything went fine, ''false'' otherwise.

==Example==
Given example will draw rectangle over every dummy in vehicle player is currently sitting it.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}

function draw()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local mat = getElementMatrix(veh)
local vx,vy,vz = getMatrixPosition(mat)
local fx,fy,fz = getMatrixForward(mat)
local lx,ly,lz = getMatrixLeft(mat)
local ux,uy,uz = getMatrixUp(mat)
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
if v[1] ~= 0 or v[2] ~= 0 or v[3] ~= 0 then
local px,py,pz = vx,vy,vz
px = px+fx*v[2]+lx*v[1]+ux*v[3]
py = py+fy*v[2]+ly*v[1]+uy*v[3]
pz = pz+fz*v[2]+lz*v[1]+uz*v[3]

local sx,sy = getScreenFromWorldPosition( px,py,pz,0,false )
if sx then
dxDrawRectangle( sx-10, sy-10, 20, 20, v[4] )
dxDrawText(i-1, sx-5,sy-5,20,20,tocolor( 0,0,0 ))
end
end
end
end
addEventHandler("onClientRender", root, draw)

-- Utility functions, not related to main functionality
function getElementMatrix(element)
local rx, ry, rz = getElementRotation(element, "ZXY")
rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)
local matrix = {}
matrix[1] = {}
matrix[1][1] = math.cos(rz)*math.cos(ry) - math.sin(rz)*math.sin(rx)*math.sin(ry)
matrix[1][2] = math.cos(ry)*math.sin(rz) + math.cos(rz)*math.sin(rx)*math.sin(ry)
matrix[1][3] = -math.cos(rx)*math.sin(ry)
matrix[1][4] = 1

matrix[2] = {}
matrix[2][1] = -math.cos(rx)*math.sin(rz)
matrix[2][2] = math.cos(rz)*math.cos(rx)
matrix[2][3] = math.sin(rx)
matrix[2][4] = 1

matrix[3] = {}
matrix[3][1] = math.cos(rz)*math.sin(ry) + math.cos(ry)*math.sin(rz)*math.sin(rx)
matrix[3][2] = math.sin(rz)*math.sin(ry) - math.cos(rz)*math.cos(ry)*math.sin(rx)
matrix[3][3] = math.cos(rx)*math.cos(ry)
matrix[3][4] = 1

matrix[4] = {}
matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)
matrix[4][4] = 1

return matrix
end

function getMatrixLeft(m)
return m[1][1], m[1][2], m[1][3]
end
function getMatrixForward(m)
return m[2][1], m[2][2], m[2][3]
end
function getMatrixUp(m)
return m[3][1], m[3][2], m[3][3]
end
function getMatrixPosition(m)
return m[4][1], m[4][2], m[4][3]
end

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleModelDummyPosition

2019-09-02T09:58:34Z

DezZolation:

{{Client function}}
__NOTOC__
{{New feature/item|3.0157|1.5.6|14403|
This function sets the position of the dummies contained in a vehicle model. Use [[setVehicleComponentPosition]] to adjust the vehicle component positions.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelDummyPosition ( int modelID, string dummy, float x, float y, float z )
</syntaxhighlight>
{{OOP||[[Vehicle]].setVehicleModelDummyPosition||getVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to change
* '''posX''', '''posY''', '''posZ''': The desired position

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' Point at which the steer of a bike is held.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns ''true'' if everything went fine, ''false'' otherwise.

==Example==
Given example will move all the dummies in vehicle that player is sitting in up and down, after he uses /move command.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}
local cache = {}

function move()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
setVehicleModelDummyPosition(model, dum, cache[dum][1], cache[dum][2], cache[dum][3] + math.sin(getTickCount()/1500))
end
end

addCommandHandler( "move", function()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
cache[dum] = v
end
addEventHandler("onClientRender", root, move)
end)

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleModelDummyPosition

2019-09-02T09:46:16Z

DezZolation:

{{Client function}}
__NOTOC__
{{New feature/item|3.0157|1.5.6|14403|
This function sets the position of the dummies contained in a vehicle model. Use [[setVehicleComponentPosition]] to adjust the vehicle component positions.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelDummyPosition ( int modelID, string dummy, float x, float y, float z )
</syntaxhighlight>
{{OOP||[[Vehicle]].setVehicleModelDummyPosition||getVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to change
* '''posX''', '''posY''', '''posZ''': The desired position

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' (?)Hand rest position.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns ''true'' if everything went fine, ''false'' otherwise.

==Example==
Given example will move all the dummies in vehicle that player is sitting in up and down, after he uses /move command.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}
local cache = {}

function move()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
setVehicleModelDummyPosition(model, dum, cache[dum][1], cache[dum][2], cache[dum][3] + math.sin(getTickCount()/1500))
end
end

addCommandHandler( "move", function()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
cache[dum] = v
end
addEventHandler("onClientRender", root, move)
end)

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleModelDummyPosition

2019-09-02T09:45:46Z

DezZolation:

{{Client function}}
__NOTOC__
{{New feature/item|3.0155|1.5.6|14406|
This function gets position of the dummies contained in a vehicle model.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleModelDummyPosition ( int modelID, string dummy )
</syntaxhighlight>
{{OOP||[[Vehicle]].getVehicleModelDummyPosition||setVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to get

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' (?)Hand rest position.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns the position of given dummy if everything went fine, ''false'' otherwise.

==Example==
Given example will draw rectangle over every dummy in vehicle player is currently sitting it.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}

function draw()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local mat = getElementMatrix(veh)
local vx,vy,vz = getMatrixPosition(mat)
local fx,fy,fz = getMatrixForward(mat)
local lx,ly,lz = getMatrixLeft(mat)
local ux,uy,uz = getMatrixUp(mat)
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
if v[1] ~= 0 or v[2] ~= 0 or v[3] ~= 0 then
local px,py,pz = vx,vy,vz
px = px+fx*v[2]+lx*v[1]+ux*v[3]
py = py+fy*v[2]+ly*v[1]+uy*v[3]
pz = pz+fz*v[2]+lz*v[1]+uz*v[3]

local sx,sy = getScreenFromWorldPosition( px,py,pz,0,false )
if sx then
dxDrawRectangle( sx-10, sy-10, 20, 20, v[4] )
dxDrawText(i-1, sx-5,sy-5,20,20,tocolor( 0,0,0 ))
end
end
end
end
addEventHandler("onClientRender", root, draw)

-- Utility functions, not related to main functionality
function getElementMatrix(element)
local rx, ry, rz = getElementRotation(element, "ZXY")
rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)
local matrix = {}
matrix[1] = {}
matrix[1][1] = math.cos(rz)*math.cos(ry) - math.sin(rz)*math.sin(rx)*math.sin(ry)
matrix[1][2] = math.cos(ry)*math.sin(rz) + math.cos(rz)*math.sin(rx)*math.sin(ry)
matrix[1][3] = -math.cos(rx)*math.sin(ry)
matrix[1][4] = 1

matrix[2] = {}
matrix[2][1] = -math.cos(rx)*math.sin(rz)
matrix[2][2] = math.cos(rz)*math.cos(rx)
matrix[2][3] = math.sin(rx)
matrix[2][4] = 1

matrix[3] = {}
matrix[3][1] = math.cos(rz)*math.sin(ry) + math.cos(ry)*math.sin(rz)*math.sin(rx)
matrix[3][2] = math.sin(rz)*math.sin(ry) - math.cos(rz)*math.cos(ry)*math.sin(rx)
matrix[3][3] = math.cos(rx)*math.cos(ry)
matrix[3][4] = 1

matrix[4] = {}
matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)
matrix[4][4] = 1

return matrix
end

function getMatrixLeft(m)
return m[1][1], m[1][2], m[1][3]
end
function getMatrixForward(m)
return m[2][1], m[2][2], m[2][3]
end
function getMatrixUp(m)
return m[3][1], m[3][2], m[3][3]
end
function getMatrixPosition(m)
return m[4][1], m[4][2], m[4][3]
end

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

OnClientWeaponFire

2019-04-12T17:30:20Z

DezZolation:

{{Client event}}
__NOTOC__
This event triggers when a [[Element/Weapon|custom weapon]] fires a shot.
{{Note|This event is '''ONLY''' for custom weapons that were created with [[createWeapon]], for regular weapons use [[onClientPlayerWeaponFire]].}}
{{Note|This event is only triggered for custom weapons that are streamed in}}
==Parameters==
<syntaxhighlight lang="lua">
element hitElement, float posX, float posY, float posZ, float normalX, float normalY, float normalZ, int materialType, float lighting, int pieceHit
</syntaxhighlight>
*'''hitElement:''' the element that was hit
*'''posX:''' the position it will hit
*'''posY:''' the position it will hit
*'''posZ:''' the position it will hit
*'''normalX:''' the normal it hit ( see processLineOfSight )
*'''normalY:''' the normal it hit ( see processLineOfSight )
*'''normalZ:''' the normal it hit ( see processLineOfSight )
*'''materialType:''' the material type it hit ( see processLineOfSight )
*'''lighting:''' the lighting of the entity it hit ( see processLineOfSight )
*'''pieceHit:''' the piece of the entity it hit ( see processLineOfSight )

==Source==
The [[event system#Event source|source]] of this event is the weapon that was fired.

==Cancel Effect==
If this event was [[Event system#Canceling|canceled]], then the weapon will not fire.

==Example==
This example prevents player damage from custom weapons.
<syntaxhighlight lang="lua">
function noDamageToPlayersFromCustomWeapons(target)
if target == localPlayer then
cancelEvent() -- If the weapon hit the player, cancel the shot
end
end
addEventHandler("onClientWeaponFire", root, noDamageToPlayersFromCustomWeapons)</syntaxhighlight>

==See Also==
===Client event functions===
{{Client_event_functions}}

[[hu:onClientWeaponFire]]

GuiGridListGetColumnWidth

2019-04-10T20:06:29Z

DezZolation:

{{Client function}}
__NOTOC__
This allows you to get the width of an existing column in a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
float guiGridListGetColumnWidth ( element gridList, int columnIndex, bool relative )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getColumnWidth}}

===Required Arguments===
*'''gridList:''' The grid list you want to add a column to
*'''columnIndex:''' Column ID of the Get size
*'''relative:''' A boolean defining whether '''width''' measurements will be relative to the Gridlist size, or absolute pixels.

===Returns===
Returns the width of the gridlist column, ''false'' if bad arguments were given.

==Example==
<syntaxhighlight lang="lua">grid = guiCreateGridList(313, 354, 162, 100, false)
c = guiGridListAddColumn(grid, "test",0.5)

addCommandHandler("With",function()
With = guiGridListGetColumnWidth(grid ,c, true)
outputChatBox("Column Width = "..With)
end
)
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

PlaySound3D

2019-04-05T08:39:56Z

DezZolation:

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.<br />
<br />
{{Note|
*The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
*For performance reasons, when using playSound3D for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundURL, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound|Sound3D]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag. And also can use url instead of [[filepath]] )
*'''soundURL:''' the URL. (In this version the file does not has to be predefined in the [[meta.xml]] )
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)
</syntaxhighlight>
</section>
This example play internet radio in groove street.
<section name="Example 2" class="client" show="true" >
<syntaxhighlight lang="lua">
addEventHandler( 'onClientResourceStart', resourceRoot,
function( )
local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 )
setSoundMaxDistance( uSound, 100 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[HU:playSound3D]]
[[AR:playSound3D]]
[[DE:playSound3D]]
[[RU:playSound3D]]

Vehicle variants

2019-04-03T22:20:56Z

DezZolation:

== Custom Variants ==
With the introduction of vehicle variants we now have the ability to add custom variants using custom models. Variants can be anything from different adverts to additional parts of the model..
[[Image:Infernus.png|200px|thumb|left|Custom Infernus Variant]]

==How to Add Variants==
Adding variants requires modifying your DFF by adding a part of the model you wish to be a variant and naming it extra1, extra2, extra3, extra4 or extra5 then setting it's parent to the chassis_dummy this tells GTA it has variant information and after this your variant will work in MTA.

==Spawning Custom Variants==
Spawning custom variants is more complicated as we do not know the variants are there so the random variant spawner (TM) will not spawn the added variant.

A way around this is to implicitly specify which variant you require in createVehicle this will bypass our random variant spawner (TM) and allow you to spawn it.

Any invalid variant will show up as the default model with no variation.

==GTA Variants==
{| class="wikitable sortable" style="width: auto; table-layout: fixed;"
|-
! scope="col" | Vehicle Name
! scope="col" | Vehicle ID
! scope="col" class="unsortable" | Variants
|-
| Ambulance
| 416
| Numbers: 0 = 37, 1 = 71
|-
| Trailer 1
| 435
| Side Ads: 0 = Cok-o-Pops, 1 = Munky Juice, 2 = Hinterland, 3 = Zip, 4 = RS Haul, 5 = Ranch
|-
| Trailer 2
| 450
| Contents: 0 = Filled with gravel/coal/stone
|-
| Bagboxb
| 607
| Contents: 0,1,2 = Various distributions of loose baggage
|-
| Baggage
| 485
| Rear Cargo Items: 0 = Earmuffs, 1 = Small Case, 2 = Large Case
|-
| Barracks
| 433
| Bed Covering: 0 = Opaque Fabric, 1 = Camo Netting
|-
| Benson
| 499
| Side Ads: 0 = Shady Industries, 1 = LSD, 2 = The Uphill Gardener, 3 = Discount Furniture
|-
| BF-400
| 581
| Exhausts: 0 = Single Type1, 1 = Single Type2, 2 = Dual Type3 - Fairings (with Windshields): 3 = Half-size, 4 = Full-size
|-
| BF Injection
| 424
| Body: 0 = Side Panels
|-
| Bloodring Banger
| 504
| Numbers/Roof Color: 0 = 328/White, 1 = 464/Check, 2 = 172/Check, 3 = 100/White, 4 = 284/White, 5 = 505/Check
|-
| Bobcat
| 422
| Bed Items: 0 = Spare Tire, 1 = Sprunk Cans
|-
| Burrito
| 482
| Roof Items: 0 = Roof Lights + Spoiler
|-
| Caddy
| 457
| Rear Cargo (Driver Side): 0 = Golfbag1, 1 = Satchel1, 2 = Golfbag2, Rear Cargo (Pass Side): 3 = Satchel2, 4 = Golfbag3, 5 = Golfbag4
|-
| Camper
| 483
| 0 = Open Curtains & Second Bench Seat, 1 = Open Roof Vent, Closed Curtains, Bed in Back, Peace Sign
|-
| Cheetah
| 415
| Side Mirrors: 0 = Single, Placed High, 1 = Dual, Placed Normally
|-
| Coach
| 437
| Name on Side: 0 = Big O Tours, 1 = Bikini Line
|-
| Coastguard
| 472
| Various Items 0 = Items all Over, 1 = Items Grouped in Back, 2 = Items all Over + 2 Oars in Front
|-
| FCR-900
| 521
| Exhausts: 0 = Single Type1, 1 = Dual Type1, 2 = Dual Type2, Fairings (with Windshields): 3 = Half-size, 4 = Full-size
|-
| Fire Truck
| 407
| Numbers: 0 = 64, 1 = 16, 2 = 47
|-
| Flatbed
| 455
| Numbers: 0 = 64, 1 = 16, 2 = 47
|-
| Hotknife
| 434
| 0 = Partial Engine Cover
|-
| Hotring Racer 2
| 502
| Numbers: 0 = 82, 1 = 26, 2 = 65, 3 = 07, 4 = 36, 5 = 60
|-
| Hotring Racer 3
| 503
| Numbers: 0 = 96, 1 = 67, 2 = 73, 3 = 52, 4 = 45, 5 = 14
|-
| Kart
| 571
| Body Panels: 0 = Both Sides, 1 = Steering Column
|-
| Launch
| 595
| Roofs: 0 = Over passenger section, 1 = Over driver section
|-
| Marquis
| 484
| 0 = Windshield over Cabin Entrance
|-
| Mesa
| 500
| 0 = Roof Over Back, 1 = Roll Bar in Back
|-
| Monster 2
| 556
| 0 = Roof Spoiler, 1 = Roof Lights, 2 = Roll Bar with Lights
|-
| Monster 3
| 557
| 0 = Couldn't Determine 1 = Roof Lights
|-
| Mr. Whoopee
| 423
| Rear Sign: 0 = Cherry Popping Good, 1 = Slow Children Ahead
|-
| Mule
| 414
| Side Ads: 0 = Toy Corner, 1 = Binco, 2 = Semi, 3 = Shafted Appliances
|-
| NRG-500
| 522
| Exhausts: 0 = Single Pair1, 1 = Single Pair2, 2 = Dual Pair2 - Fairings (with Windshields): 3 = Smooth, 4 = With Side Cutouts
|-
| Patriot
| 470
| Cargo Area 0 = Low Cover, 1 = Roof/High Cover, 2 = Roll Bar
|-
| Perennial
| 404
| Cargo Area 0 = Low Cover, 1 = Roof/High Cover, 2 = Roll Bar
|-
| Picador
| 600
| Items in Bed: 0 = Planks, 1 = Sprunk Cans
|-
| Pony
| 413
| 0 = Sound System in Back
|-
| Reefer
| 453
| Items in Back: 0 = Boxes of Fish, 1 = Bench
|-
| Romero
| 442
| Coffins: 0 = Brown Style1, 1 = Black Style2, 2 = Brown Style3
|-
| Rumpo
| 440
| Side Ads: 0 = Cok-o-Pops, 1 = Harry Plums, 2 = Dick Goblin's, 3 = Final Build, 4 = Transfender, 5 = Wheel Arch Angels
|-
| Sadler
| 543
| Items in Bed: 0 = Two Propane Tanks & Crate, 1 = Two Barrels, 2 = Sprunk Cans, 3 = Open Crates, 4+ = Empty bed
|-
| Damaged Sadler
| 605
| Items in Bed: 0 = Two Propane Tanks & Crate, 1 = Two Barrels, 2 = Sprunk Cans, 3 = Open Crates, 4+ = Empty bed
|-
| Securicar
| 428
| Side Logo: 0 = Chuff, 1 = Lock&Load
|-
| Slamvan
| 535
| Steering Wheel: 0 = Normal, 1 = Chain (Default has none!)
|-
| Stallion
| 439
| Roof: 0 = Hardtop, 1 = Softtop (up), 2 = Softtop (folded)
|-
| Super GT
| 506
| 0 = Full Roof
|-
| S.W.A.T.
| 601
| Number: 0 = 1, 1 = 9, 2 = 6, 3 = 7
|-
| Berkley's RC Van
| 459
| 0 = Boxes of Toys in Back
|-
| Tram
| 449
| 0,1,2,3 = (4 defined extras, but I don't know what they are)
|-
| Trashmaster
| 408
| 0 = Some bits of trash sticking out of the back
|-
| Tug
| 583
| Case in Back: 0 = Red Case, 1 = Green Case
|-
| Utility Van
| 552
| 0 = Cones, Barrel in back + Cone lying on passenger side rail, 1 = Cones, Barrel in back + Cone lying on driver side rail
|-
| Walton
| 478
| Items in Bed: 0 = Two Propane Tanks, 1 = Open Crates, 2 = Propane Tank and Barrel
|-
| Windsor
| 555
| 0 = Roof, 1 = No Roof
|-
| Yankee
| 456
| Side Ads: 0 = Big Gas, 1 = RS Haul, 2 = Star Balls, 3 = Flower Power
|-
| ZR-350
| 477
| 0 = Rear Spoiler
|- class="sortbottom"
! Vehicle Name
! Vehicle ID
! Variants
|-
|}

Above table serialized in Lua:

<syntaxhighlight lang="lua">
local vehicleModelVariants={
[404]={0,1,2},
[407]={0,1,2},
[408]={0},
[413]={0},
[414]={0,1,2,3},
[415]={0,1},
[416]={0,1},
[422]={0,1},
[423]={0,1},
[424]={0},
[428]={0,1},
[433]={0,1},
[434]={0},
[435]={0,1,2,3,4,5},
[437]={0,1},
[439]={0,1,2},
[440]={0,1,2,3,4,5},
[442]={0,1,2},
[449]={0,1,2,3,4},
[450]={0},
[453]={0,1},
[455]={0,1,2},
[456]={0,1,2,3},
[457]={0,1,2,3,4,5},
[459]={0},
[470]={0,1,2},
[472]={0,1,2},
[477]={0},
[478]={0,1,2},
[482]={0},
[483]={0,1},
[484]={0},
[485]={0,1,2},
[499]={0,1,2,3},
[500]={0,1},
[502]={0,1,2,3,4,5},
[503]={0,1,2,3,4,5},
[504]={0,1,2,3,4,5},
[506]={0},
[521]={0,1,2,3,4},
[522]={0,1,2,3,4},
[535]={0,1},
[543]={0,1,2,3,4},
[552]={0,1},
[555]={0,1},
[556]={0,1,2},
[557]={0,1},
[571]={0,1},
[581]={0,1,2,3,4},
[583]={0,1},
[595]={0,1},
[600]={0,1},
[601]={0,1,2,3},
[605]={0,1,2,3,4},
[607]={0,1,2},
}
</syntaxhighlight>

[[Category:ID Lists]]

[[hu:Vehicle variants]]
[[ru:Vehicle variants]]
[[de:Fahrzeug Varianten]]

GetVehicleColor

2019-04-01T21:51:06Z

DezZolation:

__NOTOC__
{{Server client function}}
This function returns the color of the specified vehicle. A vehicle can have up to four colors.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int, int, int, int, int, int, int, int = getVehicleColor ( vehicle theVehicle, bool bRGB )
</syntaxhighlight>

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

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the color of.
*'''bRGB :''' A boolean specifying whether to return RGB values. A setting of ''false'' will result in the function returning color ids instead.

===Returns===
*Returns 12 [[int|ints]] (if bRGB is ''true'') indicating the red, green and blue components of each of the 4 vehicle colors.
*Returns 4 [[int|ints]] (if bRGB is ''false'') indicating the color ids of each of the 4 vehicle colors.
*Returns ''false'' if the vehicle doesn't exist.

Valid color ids if bRGB is set to false:
{{Vehicle_colors}}
<br>

==Example==
<section name="Server" class="server" show="true">
This will output the 4 colors of any car that the player enters.
<syntaxhighlight lang="lua">
function playerEnterVehicle ( theVehicle, seat, jacked )
-- Get the colors of the car and store them to 4 seperate variables
local color1, color2, color3, color4 = getVehicleColor ( theVehicle )
-- Output the four retrieved car colors into the chatbox
outputChatBox ( "Car color 1: " .. color1 )
outputChatBox ( "Car color 2: " .. color2 )
outputChatBox ( "Car color 3: " .. color3 )
outputChatBox ( "Car color 4: " .. color4 )
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), playerEnterVehicle )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

GetVehicleColor

2019-04-01T21:48:26Z

DezZolation:

__NOTOC__
{{Server client function}}
This function returns the color of the specified vehicle. A vehicle can have up to four colors.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int, int, int, int, int, int, int, int = getVehicleColor ( vehicle theVehicle, bool bRGB )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to get the color of.
*'''bRGB :''' A boolean specifying whether to return RGB values. A setting of ''false'' will result in the function returning color ids instead.

===Returns===
*Returns 12 [[int|ints]] (if bRGB is ''true'') indicating the red, green and blue components of each of the 4 vehicle colors.
*Returns 4 [[int|ints]] (if bRGB is ''false'') indicating the color ids of each of the 4 vehicle colors.
*Returns ''false'' if the vehicle doesn't exist.

Valid color ids if bRGB is set to false:
{{Vehicle_colors}}
<br>

==Example==
<section name="Server" class="server" show="true">
This will output the 4 colors of any car that the player enters.
<syntaxhighlight lang="lua">
function playerEnterVehicle ( theVehicle, seat, jacked )
-- Get the colors of the car and store them to 4 seperate variables
local color1, color2, color3, color4 = getVehicleColor ( theVehicle )
-- Output the four retrieved car colors into the chatbox
outputChatBox ( "Car color 1: " .. color1 )
outputChatBox ( "Car color 2: " .. color2 )
outputChatBox ( "Car color 3: " .. color3 )
outputChatBox ( "Car color 4: " .. color4 )
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), playerEnterVehicle )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

GetElementAngularVelocity

2019-03-31T20:29:32Z

DezZolation:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0156|1.5.5|14165|Gets the current angular velocity of a specified, supported element.}}

==Syntax==
<syntaxhighlight lang="lua">
float rx, float ry, float rz getElementAngularVelocity ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getAngularVelocity|angularVelocity|setElementAngularVelocity}}
===Required Arguments===
*'''theElement:''' The [[element]] to retrieve the angular velocity from. Can be either a [[player]], [[ped]], [[object]], [[vehicle]] or a [[Element/Weapon|custom weapon]]. '''Server side supports only vehicles currently.'''

===Returns===
Returns three floats describing the x, y and z rotation

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getangularvelocity", function(player)
--retrieve angular velocity of the player
local avx, avy, avz = getElementAngularVelocity(player)
outputChatBox("Your current angular velocity is: X: "..avx.." Y: "..avy.." Z: "..avz, player, 0, 255, 0, false)
end)
</syntaxhighlight>

==Requirements==
{{Requirements|1.5.5-9.14060|1.5.5-9.14060|}}

==See Also==
{{Element functions}}

DxDrawMaterialSectionLine3D

2019-03-27T21:58:48Z

DezZolation:

__NOTOC__
{{Client function}}
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.

The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialSectionLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,
float u, float v, float usize, float vsize, element material, float width,
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )
</syntaxhighlight>

===Required Arguments===
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.
*'''u:''' the absolute X coordinate of the top left corner of the section
*'''v:''' the absolute Y coordinate of the top left corner of the section
*'''usize:''' the absolute width of the section
*'''vsize:''' the absolute height of the section
* '''material:''' A [[material]] to draw the line with.
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

==Optional Arguments==
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
{{New items|5.0155|1.5.5-9.11998|
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.
}}
* '''faceTowardX/Y/Z:''' The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.

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

==Example==
This example draws corona like effects near the player
<syntaxhighlight lang="lua">
coronaTexture = dxCreateTexture("corona.png")
red = tocolor(255,0,0)
green = tocolor(0,255,0)
blue = tocolor(0,0,255)

addEventHandler("onClientPreRender",root,
function()
local x,y,z = getElementPosition(localPlayer)

dxSetBlendMode("add") -- Add blend mode looks best for corona effects
drawCorona( x+2, y+2, z+1, 1, red )
drawCorona( x+1, y+3, z+2, 1, green )
drawCorona( x-1, y+2, z+3, 1, blue )
dxSetBlendMode("blend") -- Restore default
end
)

-- Draw the corona texture
function drawCorona( x, y, z, size, color )
dxDrawMaterialSectionLine3D ( x, y, z+size,
x, y, z-size,
0,0,1,1, coronaTexture, size, color)
end

</syntaxhighlight>

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

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-9.11998|Added postGUI argument}}

==See Also==
{{Drawing_functions}}

[[hu:dxDrawMaterialSectionLine3D]]

DxDrawCircle

2019-03-26T20:32:46Z

DezZolation:

{{Client Function}}
<lowercasetitle/>
__NOTOC__
{{New feature/item|3.0156|1.5.5|13977|This function draws a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to be display continuously.}}

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( float posX, float posY, float radius [, float startAngle = 0.0, float stopAngle = 360.0, int theColor = white,
int theCenterColor = theColor, int segments = 32, int ratio = 1, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_Saml1er.png|thumb|An example of how dxDrawCircle function works in practice.]]

* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.
* '''radius''': An integer representing the radius scale of the circle that is being drawn.

===Optional Arguments===
{{OptionalArg}}
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''theColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''theCenterColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''segments''': An integer ranging from 3-1024 representing how many triangles are used to form the circle, more segments = smoother circle. Note: using lots of segments may cause lag.
* '''ratio''': Ratio between width and height, e.g: 2 would mean that the width of the circle is 2 times the height.
* '''postGUI''': A bool representing whether the circle should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if the creation of the 2D circle was successful, ''false'' otherwise.

==Example==
This function draws a rectangle with rounded corners.
<syntaxhighlight lang="lua">
function dxDrawRoundedRectangle(x, y, rx, ry, color, radius)
rx = rx - radius * 2
ry = ry - radius * 2
x = x + radius
y = y + radius

if (rx >= 0) and (ry >= 0) then
dxDrawRectangle(x, y, rx, ry, color)
dxDrawRectangle(x, y - radius, rx, radius, color)
dxDrawRectangle(x, y + ry, rx, radius, color)
dxDrawRectangle(x - radius, y, radius, ry, color)
dxDrawRectangle(x + rx, y, radius, ry, color)

dxDrawCircle(x, y, radius, 180, 270, color, color, 7)
dxDrawCircle(x + rx, y, radius, 270, 360, color, color, 7)
dxDrawCircle(x + rx, y + ry, radius, 0, 90, color, color, 7)
dxDrawCircle(x, y + ry, radius, 90, 180, color, color, 7)
end
end
dxDrawRoundedRectangle(350, 50, 100, 100, tocolor(0, 255, 0, 255), 20)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxDrawCircle]]

SetSearchLightStartRadius

2019-03-20T11:12:29Z

DezZolation:

__NOTOC__
{{Client function}}

This function sets the start radius of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
bool setSearchLightStartRadius ( searchlight theSearchlight, float startRadius )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setStartRadius|startRadius|getSearchLightStartRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''startRadius''': the radius of the searchlight's light cone in its beginning.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

==Example==
This example creates a skywalker light on top of Los Santos' skyscraper and turns it on/off every second by setting it's ending radius and starting radius to 0.
<syntaxhighlight lang="lua">
skywalkerLight = createSearchLight (1544, -1353.5, 330, 1528, -1347, 360, 0.2, 3, false)

setTimer (function ()
if not off then
setSearchLightStartRadius (skywalkerLight, 0)
setSearchLightEndRadius (skywalkerLight, 0)
off = true
else
setSearchLightStartRadius (skywalkerLight, 0.2)
setSearchLightEndRadius (skywalkerLight, 3)
off = false
end
end, 1000, 0)
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

SetSearchLightStartPosition

2019-03-20T11:12:21Z

DezZolation:

__NOTOC__
{{Client function}}

This function sets the start position of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
bool setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setStartPosition|startPosition|getSearchLightStartPosition}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''startX''': the X coordinate where the searchlight light cone will start.
*'''startY''': the Y coordinate where the searchlight light cone will start.
*'''startZ''': the Z coordinate where the searchlight light cone will start.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

==Example==
This example creates a searchlight that originates in the camera position and targets the center of the map.
<syntaxhighlight lang="lua">
local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)

if searchLight then
local function updateSearchLight()
-- Set its start position to the camera position
setSearchLightStartPosition(searchLight, getCameraMatrix())
end
addEventHandler("onClientPreRender", root, updateSearchLight)
end
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

SetSearchLightEndRadius

2019-03-20T11:12:14Z

DezZolation:

__NOTOC__
{{Client function}}

This function sets the end radius of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
bool setSearchLightEndRadius ( searchlight theSearchlight, float endRadius )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setEndRadius|endRadius|getSearchLightEndRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''endRadius''': the radius of the searchlight's light cone in its end.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

==Example==
This example creates a skywalker light on top of Los Santos' skyscraper and turns it on/off every second by setting it's ending radius and starting radius to 0.
<syntaxhighlight lang="lua">
skywalkerLight = createSearchLight (1544, -1353.5, 330, 1528, -1347, 360, 0.2, 3, false)

setTimer (function ()
if not off then
setSearchLightStartRadius (skywalkerLight, 0)
setSearchLightEndRadius (skywalkerLight, 0)
off = true
else
setSearchLightStartRadius (skywalkerLight, 0.2)
setSearchLightEndRadius (skywalkerLight, 3)
off = false
end
end, 1000, 0)
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

SetSearchLightEndPosition

2019-03-20T11:12:03Z

DezZolation:

__NOTOC__
{{Client function}}

==Syntax==
<syntaxhighlight lang="lua">
bool setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setEndPosition|endPosition|getSearchLightEndPosition}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''endX''': the X coordinate where the searchlight light cone will end.
*'''endY''': the Y coordinate where the searchlight light cone will end.
*'''endZ''': the Z coordinate where the searchlight light cone will end.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

==Example==
This example creates a searchlight that originates in the camera position and targets to the front of it.
<syntaxhighlight lang="lua">
local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)

if searchLight then
local function updateSearchLight()
-- Get camera position and look at point
local sx, sy, sz, ex, ey, ez = getCameraMatrix()
-- Set searchlight's start position to the camera position, and end position to the look at point
setSearchLightStartPosition(searchLight, sx, sy, sz)
setSearchLightEndPosition(searchLight, ex, ey, ez)
end
addEventHandler("onClientPreRender", root, updateSearchLight)
end
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

GetSearchLightStartRadius

2019-03-20T11:06:02Z

DezZolation:

__NOTOC__
{{Client function}}
{{Needs_Example}}

This function gets the start radius of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
float getSearchLightStartRadius ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the radius of the searchlight's light cone in its beginning.

===Returns===
If the specified searchlight element is valid, this function will return one ''float'', which is the searchlight's start radius. If not, it will return ''false'' plus an error message.

==Example==
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

GetSearchLightEndRadius

2019-03-20T11:05:50Z

DezZolation:

__NOTOC__
{{Client function}}
{{Needs_Example}}

This function gets the end radius of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
float getSearchLightEndRadius ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getEndRadius|endRadius|setSearchLightEndRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the radius of the searchlight's light cone in its end.

===Returns===
If the specified searchlight element is valid, this function will return one ''float'', which is the searchlight's end radius. If not, it will return ''false'' plus an error message.

==Example==
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

GetSearchLightStartPosition

2019-03-20T11:05:04Z

DezZolation:

__NOTOC__
{{Client function}}
{{Needs_Example}}

This function gets the start position of a [[Element/Searchlight|searchlight]] element.

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getSearchLightStartPosition ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getStartPosition|startPosition|setSearchLightStartPosition}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the position where the searchlight's light cone starts.

===Returns===
If the specified searchlight element is valid, this function will return three ''float'', which are the three coordinates of searchlight's start position. If not, it will return ''false'' plus an error message.

==Example==
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}

CreateWater

2019-03-19T09:28:47Z

DezZolation:

__NOTOC__
{{Server client function}}

Creates an area of [[water]].

The largest possible size of a water area is 5996×5996. Also be aware that the function will change all x and y coordinates you specify into even integer numbers if necessary: this is because of a limitation of San Andreas.

You are able to give the water a shallow water effect, which practically changes the water invisible to the eye. However, all elements still work the same way as without the shallow effect - allowing swimming, diving, vehicles to sink, etc.
{{Note|X and Y positions will be changed to an even integer. i.e. -2, 0, 2, 4 etc.}}
{{Important Note|If you're working with dimensions, be sure to apply it by using [[setElementDimension]].}}
==Syntax==
<syntaxhighlight lang="lua">water createWater ( float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3 [, float x4, float y4, float z4 ] [, bool bShallow = false ] )</syntaxhighlight>
[[Image:WaterAreas.jpg|thumb|Example of water quadrant.|284x230px]]

{{OOP||[[Water]]}}

===Required Arguments===
*'''x1, y1, z1:''' position of bottom left (south-west) corner.
*'''x2, y2, z2:''' position of bottom right (south-east) corner.
*'''x3, y3, z3:''' position of top left (north-west) corner.
''Note: Only 3 coords creates a triangle''

===Optional Arguments===
*'''x4, y4, z4:''' position of top right (north-east) corner.
*'''bShallow:''' gives the water a shallow water effect.

===Returns===
Returns a water element if successful, ''false'' otherwise. The water element can be repositioned with [[setElementPosition]] and destroyed with [[destroyElement]].

==Example==
<section name="Client" class="client" show="true">
Example code for creating a water area to cover the entire San Andreas Map (flood the cities). Also, [[setWaterLevel]] is used to raise the existing rivers and lakes.
<syntaxhighlight lang="lua">
-- Setting water properties.
height = 40
SizeVal = 2998
-- Defining variables.
southWest_X = -SizeVal
southWest_Y = -SizeVal
southEast_X = SizeVal
southEast_Y = -SizeVal
northWest_X = -SizeVal
northWest_Y = SizeVal
northEast_X = SizeVal
northEast_Y = SizeVal

-- OnClientResourceStart function that creates the water.
function thaResourceStarting( )
water = createWater ( southWest_X, southWest_Y, height, southEast_X, southEast_Y, height, northWest_X, northWest_Y, height, northEast_X, northEast_Y, height )
setWaterLevel ( height )
end
addEventHandler("onClientResourceStart", resourceRoot, thaResourceStarting)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This example creates water at the given coordinates and sets the height of the water level to 20 for when the client joins.
<syntaxhighlight lang="lua">
function thaResourceStarting( )
water = createWater ( 1866, -1444, 10, 1968, -1442, 10, 1866, -1372, 10, 1968, -1370, 10 )
setWaterLevel ( water, 20 )
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), thaResourceStarting)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
This example fills the Easter Basin with water.
<syntaxhighlight lang="lua">
function fillDock()
local water = createWater (-1715, 47, 0, -1574, 47, 0, -1715, 170, 0, -1574, 170, 0)
end
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()), fillDock)
</syntaxhighlight>
</section>

== Issues ==
{{Issues|
{{Issue|7542|Water functions in general do not work outside the -3000 -3000 3000 3000 bounds}}
{{Issue|9608|(Fixed in r13987) "shallow" argument only works client-side}}
}}

==See Also==
{{Client water functions}}

GetScreenFromWorldPosition

2019-03-18T23:45:05Z

DezZolation:

__NOTOC__
{{Client function}}
This function gets the screen position of a point in the world. This is useful for attaching 2D gui elements to parts of the world (e.g. players) or detecting if a point is on the screen (though it does not check if it is actually visible, you should use [[processLineOfSight]] for that).

==Syntax==
<syntaxhighlight lang="lua">
float, float getScreenFromWorldPosition ( float x, float y, float z [, float edgeTolerance = 0.0, bool relative = true ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float value indicating the x position in the world.
*'''y:''' A float value indicating the y position in the world.
*'''z:''' A float value indicating the z position in the world.

===Optional Arguments===
{{OptionalArg}}
{{New feature/item|3|1.0||
*'''edgeTolerance:''' A [[float]] value indicating the distance the position can be off screen before the function returns false. Note: it's clamped down on both axies to the size of screen at the given axis*10
*'''relative:''' A [[boolean]] value that indicates if edgeTolerance is in pixels [false], or relative to the screen size [true].
}}

===Returns===
Returns two ''x'', ''y'' [[float]]s indicating the screen position and [[float]] distance between screen and given position if successful, ''false'' otherwise.

===Example===
<section class="client" name="Client-side Script" show="true">
This example add a '3d' text at coordinates 0, 0, 0 (center of map).
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
if ( getDistanceBetweenPoints3D ( 0, 0, 3, getElementPosition ( localPlayer ) ) ) < 50 then
local coords = { getScreenFromWorldPosition ( 0, 0, 3 ) }
if coords[1] and coords[2] then
dxDrawText ( "Hello !", coords[1], coords[2], coords[1], coords[2], tocolor(255,255,255), 1, "default-bold" )
end
end
end )
</syntaxhighlight>
</section>

==See Also==
{{Client_world_functions}}

CreateMarker

2019-03-17T22:51:24Z

DezZolation:

__NOTOC__
{{Server client function}}

[[Image:Mtasa_markers.png|thumb|337px|This image shows all the different marker types available using this function.]]

This function creates a marker. A marker is a 3D model in the world that can highlight a particular point or area, often used to instruct players where to go to perform actions such as entering buildings.

There are various limits that govern the maximum number of each type that can be visible at once. These are:
* Coronas: 32
* Checkpoints, Rings, Cylinders and Arrows combined: 32

You are able to create as many markers as you wish (memory and element limit permitting), but the player will only be able to see the nearest ones up to the limit.

<br><br><br><br>

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
marker createMarker ( float x, float y, float z [, string theType = "checkpoint", float size = 4.0, int r = 0, int g = 0, int b = 255, int a = 255, element visibleTo = getRootElement( ) ] )
</syntaxhighlight>
{{OOP||Marker}}
===Required Arguments===
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
* '''z''': A floating point number representing the Z coordinate on the map.

===Optional arguments===
{{OptionalArg}}
* '''theType''': The visual type of the marker to be created. Possible values:
{{Marker_types}}
* '''size''': The diameter of the marker to be created, in meters.
* '''r''': An integer number representing the amount of red to use in the colouring of the marker (0 - 255).
* '''g''': An integer number representing the amount of green to use in the colouring of the marker (0 - 255).
* '''b''': An integer number representing the amount of blue to use in the colouring of the marker (0 - 255).
* '''a''': An integer number representing the amount of alpha to use in the colouring of the marker (0 - 255 where 0 is transparent and 255 is opaque).
* '''visibleTo''': This defines which elements can see the marker. Defaults to visible to everyone. See [[visibility]].
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
marker createMarker ( float x, float y, float z [, string theType = "checkpoint", float size = 4.0, int r = 0, int g = 0, int b = 255, int a = 255 ] )
</syntaxhighlight>
{{OOP||Marker}}
===Required Arguments===
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
* '''z''': A floating point number representing the Z coordinate on the map.

===Optional arguments===
{{OptionalArg}}
* '''theType''': The visual type of the marker to be created. Possible values:
{{Marker_types}}
* '''size''': The diameter of the marker to be created, in meters.
* '''r''': An integer number representing the amount of red to use in the colouring of the marker (0 - 255).
* '''g''': An integer number representing the amount of green to use in the colouring of the marker (0 - 255).
* '''b''': An integer number representing the amount of blue to use in the colouring of the marker (0 - 255).
* '''a''': An integer number representing the amount of alpha to use in the colouring of the marker (0 - 255 where 0 is transparent and 255 is opaque).
</section>

===Returns===
Returns the [[marker]] element that was created, or ''false'' if the arguments are incorrect.

==Example==
<section name="Example 1" class="server" show="true">
This example creates a marker next to the player when they type 'createmarker':
<syntaxhighlight lang="lua">
-- this function is called whenever someone types 'createmarker' in the console:
function consoleCreateMarker ( thePlayer, commandName )
if ( thePlayer ) then
local x, y, z = getElementPosition ( thePlayer ) -- get the player's position
-- create a cylindrical marker next to the player:
local theMarker = createMarker ( x + 2, y + 2, z, "cylinder", 1.5, 255, 255, 0, 170 )
if ( theMarker ) then -- check if the marker was created successfully
outputConsole ( "Marker created successfully", thePlayer )
else
outputConsole ( "Failed to create marker", thePlayer )
end
end
end
addCommandHandler ( "createmarker", consoleCreateMarker )
</syntaxhighlight>
</section>

==See Also==
{{Marker functions}}
[[ru:createMarker]]
[[ar:createMarker]]
[[pl:createMarker]]