Multi Theft Auto: Wiki - User contributions [en]

Weapons

2021-10-01T14:54:22Z

JessePinkman: Add table with weapon IDs grouped by slot

Scripting functions that ask for a weapon ID need an integer that refers to the GTASA weapon ID list. They are listed below.
{{Note|
*Clip size () denotes clip size when the weapon is dual wielded. Weapons without this specification are not dual wield weapons.
*GTASA [[Weapon_skill_levels|weapon stats]] will affect movement, accuracy, damage, and dual wield capability. See [[setPedStat]] to change these stats. The default MTA server package comes with a resource called "defaultStats" that sets GTASA weapon stats to 999. See the weapon stats link for more info.
*For death reasons, especially in event handlers for onPlayerWasted or similar, also have a look at the [[Damage Types]].
*'''Name''' is compatible with functions [[getWeaponNameFromID]], [[getWeaponIDFromName]].
}}
{|class="wikitable sortable" style="text-align:center; margin: 1em auto 1em auto; border:1px solid black"
|-
! Slot || class="unsortable" | Type || class="unsortable" | Image || Name || ID || class="unsortable" | Model ID || class="unsortable" | Clip || class="unsortable" | Sharing slot ammo
|-
! rowspan="2" | 0
! rowspan="2" | Hand
| [[Image:Fist.png]] || align="left" | Fist || 0 || - || -
| rowspan="2" | -
|-
| [[Image:Knuckle.png]] || align="left" | Brassknuckle || 1 || 331 || -
|-
! rowspan="8" | 1
! rowspan="8" | Melee
| [[Image:Golfclub.png]] || align="left" | Golfclub || 2 || 333 || -
| rowspan="8" | -
|-
| [[Image:Nitestik.png]] || align="left" | Nightstick || 3 || 334 || -
|-
| [[Image:Knife.png]] || align="left" | Knife || 4 || 335 || -
|-
| [[Image:Bat.png]] || align="left" | Bat || 5 || 336 || -
|-
| [[Image:Shovel.png]] || align="left" | Shovel || 6 || 337 || -
|-
| [[Image:Poolcue.png]] || align="left" | Poolstick || 7 || 338 || -
|-
| [[Image:Katana.png]] || align="left" | Katana || 8 || 339 || -
|-
| [[Image:Saw.png]] || align="left" | Chainsaw || 9 || 341 || -
|-
! rowspan="3" | 2
! rowspan="3" | Handguns
| [[Image:Colt45.png]] || align="left" | Colt 45 || 22 || 346 || 17 (34)
| rowspan="3" | '''No''' ''Replacing handgun resets slot 2 ammo''
|-
| [[Image:Silenced.png]] || align="left" | Silenced || 23 || 347 || 17
|-
| [[Image:Deagle.png]] || align="left" | Deagle || 24 || 348 || 7
|-
! rowspan="3" | 3
! rowspan="3" | Shotguns
| [[Image:Shotgun.png]] || align="left" | Shotgun || 25 || 349 || 1
| rowspan="3" | Yes
|-
| [[Image:Sawnoff.png]] || align="left" | Sawed-off || 26 || 350 || 2 (4)
|-
| [[Image:Spas12.png]] || align="left" | Combat Shotgun || 27 || 351 || 7
|-
! rowspan="3" | 4
! rowspan="3" | Sub-Machine Guns
| [[Image:Mac10.png]] || align="left" | Uzi || 28 || 352 || 50 (100)
| rowspan="3" | Yes
|-
| [[Image:Mp5.png]] || align="left" | MP5 || 29 || 353 || 30
|-
| [[Image:Tec9.png]] || align="left" | Tec-9 || 32 || 372 || 50 (100)
|-
! rowspan="2" | 5
! rowspan="2" | Assault Rifles
| [[Image:Ak47.png]] || align="left" | AK-47 || 30 || 355 || 30
| rowspan="2" | Yes
|-
| [[Image:M4.png]] || align="left" | M4 || 31 || 356 || 50
|-
! rowspan="2" | 6
! rowspan="2" | Rifles
| [[Image:Rifle.png]] || align="left" | Rifle || 33 || 357 || 1
| rowspan="2" | '''No''' ''Replacing rifle resets slot 6 ammo''
|-
| [[Image:Sniper.png]] || align="left" | Sniper || 34 || 358 || 1
|-
! rowspan="4" | 7
! rowspan="4" | Heavy Weapons
| [[Image:Rocketla.png]] || align="left" | Rocket Launcher || 35 || 359 || 1
| rowspan="4" | '''No''' ''Replacing heavy weapon resets slot 7 ammo''
|-
| [[Image:Heatseek.png]] || align="left" | Rocket Launcher HS || 36 || 360 || 1
|-
| [[Image:Flame.png]] || align="left" | Flamethrower || 37 || 361 || 50
|-
| [[Image:Minigun.png]] || align="left" | Minigun || 38 || 362 || 500
|-
! rowspan="4" | 8
! rowspan="4" | Projectiles
| [[Image:Grenade.png]] || align="left" | Grenade || 16 || 342 || 1
| rowspan="4" | '''No''' ''Replacing projectile resets slot 8 ammo''
|-
| [[Image:Teargas.png]] || align="left" | Teargas || 17 || 343 || 1
|-
| [[Image:Molotov.png]] || align="left" | Molotov || 18 || 344 || 1
|-
| [[Image:Satchel.png]] || align="left" | Satchel || 39 || 363 || 1
|-
! rowspan="3" | 9
! rowspan="3" | Special 1
| [[Image:Spraycan.png]] || align="left" | Spraycan || 41 || 365 || 500
| rowspan="3" | '''No''' ''Replacing slot 9 weapon resets slot 9 ammo''
|-
| [[Image:Fire_ex.png]] || align="left" | Fire Extinguisher || 42 || 366 || 500
|-
| [[Image:Camera.png]] || align="left" | Camera || 43 || 367 || 36
|-
! rowspan="5" | 10
! rowspan="5" | Gifts
| [[Image:Dildo1.png]] || align="left" | Dildo || 10 || 321 || -
| rowspan="5" | -
|-
| [[Image:Dildo2.png]] || align="left" | Dildo || 11 || 322 || -
|-
| [[Image:Vibe1.png]] || align="left" | Vibrator || 12 || 323 || -
|-
| [[Image:Flowers.png]] || align="left" | Flower || 14 || 325 || -
|-
| [[Image:Cane.png]] || align="left" | Cane || 15 || 326 || -
|-
! rowspan="3" | 11
! rowspan="3" | Special 2
| [[Image:Irgoggle.png]] || align="left" | Nightvision || 44 || 368 || -
| rowspan="3" | -
|-
| [[Image:Irgoggle.png]] || align="left" | Infrared || 45 || 369 || -
|-
| [[Image:Paracute.png]] || align="left" | Parachute || 46 || 371 || -
|-
! rowspan="1" | 12
! rowspan="1" | Satchel Detonator
| [[Image:Bomb.png]] || align="left" | Bomb || 40 || 364 || -
| rowspan="1" | -
|}
Lua table of all weapon IDs
<syntaxhighlight lang="lua">
local weapons = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 22, 23, 24, 25, 26, 27, 28, 29, 32, 30, 31, 33, 34, 35, 36, 37, 38, 16, 17, 18, 39, 41, 42, 43, 10, 11, 12, 14, 15, 44, 45, 46, 40}
</syntaxhighlight>
Lua table of all weapon IDs grouped by slot
<syntaxhighlight lang="lua">
local weapons = {
[0] = {0, 1}, -- Hand
[1] = {2, 3, 4, 5, 6, 7, 8, 9}, -- Melee
[2] = {22, 23, 24}, -- Handguns
[3] = {25, 26, 27}, -- Shotguns
[4] = {28, 29, 32}, -- Sub-Machine Guns
[5] = {30, 31}, -- Assault Rifles
[6] = {33, 34}, -- Rifles
[7] = {35, 36, 37, 38}, -- Heavy Weapons
[8] = {16, 17, 18, 39}, -- Projectiles
[9] = {41, 42, 43}, -- Special 1
[10] = {10, 11, 12, 14, 15}, -- Gifts
[11] = {44, 45, 46}, -- Special 2
[12] = {40} -- Satchel Detonator
}
</syntaxhighlight>

==Client Functions==
{{Client_weapon_functions}}
==Server Function==
{{Weapon functions}}

[[Category:ID Lists]]

[[hu:Weapons]]
[[it:Armi]]
[[ru:Weapons]]
[[de:Waffen]]
[[pl:Weapons]]

OnPedDamage

2021-08-20T15:00:38Z

JessePinkman:

__NOTOC__
{{Server event}}
{{Needs Checking|Event is not triggered. There might be more parameters to this event. The cancel effect hasn't been tested.}}
This event is triggered when a ped is damaged. For player damage, use [[onPlayerDamage]] instead.

==Parameters==
<syntaxhighlight lang="lua">float loss</syntaxhighlight>

*'''loss''': an [[int]] representing the percentage of health the ped lost.

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

==Cancel Effect==
Canceling this event has no effect. Cancel the client-side event [[onClientPedDamage]] instead.

==Example==
This example outputs a message to the console when a specific ped is damaged.
<syntaxhighlight lang="lua">
local ped1 = createPed(112, 0, 0, 0) -- create our ped

function pedDamaged(loss)
outputConsole("ped1 damaged! loss: " .. tostring(loss))
end

addEventHandler("onPedDamage", ped1, pedDamaged) -- triggered only when ped1 gets damaged
</syntaxhighlight>

{{See also/Server event|Ped events}}

OnPedDamage

2021-08-20T14:58:56Z

JessePinkman: slight improvements

__NOTOC__
{{Server event}}
{{Needs Checking|There might be more parameters to this event, and the cancel effect hasn't been tested.}}
This event is triggered when a ped is damaged. For player damage, use [[onPlayerDamage]] instead.

==Parameters==
<syntaxhighlight lang="lua">float loss</syntaxhighlight>

*'''loss''': an [[int]] representing the percentage of health the ped lost.

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

==Cancel Effect==
Canceling this event has no effect. Cancel the client-side event [[onClientPedDamage]] instead.

==Example==
This example outputs a message to the console when a specific ped is damaged.
<syntaxhighlight lang="lua">
local ped1 = createPed(112, 0, 0, 0) -- create our ped

function pedDamaged(loss)
outputConsole("ped1 damaged! loss: " .. tostring(loss))
end

addEventHandler("onPedDamage", ped1, pedDamaged) -- triggered only when ped1 gets damaged
</syntaxhighlight>

{{See also/Server event|Ped events}}

GetNearestVehicle

2020-08-22T02:36:29Z

JessePinkman: Add a note linking getNearestElement

{{Note|You can use [[GetNearestElement|getNearestElement]] for other element types, and not just vehicles}}
{{Useful Function}}
==Syntax==
<syntaxhighlight lang="lua">vehicle getNearestVehicle( element thePlayer )</syntaxhighlight>
===Required Arguments===
* '''thePlayer''': The player you want to get the nearest vehicle of.

===Returns===
Return a vehicle element if success, false if there's no vehicles in a 10meter circle..
==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestVehicle(player,distance)
local lastMinDis = distance-0.0001
local nearestVeh = false
local px,py,pz = getElementPosition(player)
local pint = getElementInterior(player)
local pdim = getElementDimension(player)

for _,v in pairs(getElementsByType("vehicle")) do
local vint,vdim = getElementInterior(v),getElementDimension(v)
if vint == pint and vdim == pdim then
local vx,vy,vz = getElementPosition(v)
local dis = getDistanceBetweenPoints3D(px,py,pz,vx,vy,vz)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestVeh = v
end
end
end
end
return nearestVeh
end

</syntaxhighlight></section>

{{Useful_Functions}}

Template:Useful Functions

2020-08-22T02:20:05Z

JessePinkman: Add a function. Change 'Elements' to 'Element'

__NOTOC__
=== Table functions ===
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[table.element]] » This function returns a new table with only userdata content.
*[[pairsByKeys]] » This function sort pairs table.

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

=== Account functions ===
*[[getPlayerFromAccountName]] » This function is used to obtain a player by the name of his account.

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[dxDrawRombo]] » This function creates a Rhombus.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.

=== Element functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.

=== Events ===
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[getClipboard]] » This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[formatDate]] » This function formats a date on the basis of a format string and returns it.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getDistance]] » Returns the distance between two elements.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getEasterDate]] » This function returns easter date monthday and month for a given year.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getRealMonthH]] » This function convert english months to arabic months
*[[getRealMonthM]] » This function gives you the real months name
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isValidMail]] » This function checks whether a provided e-mail string is valid.
*[[removeHex]] » This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.
*[[getFreeDimension]] » This function get free dimension.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
*[[isMouseOnGUICloseButton]] » This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.
*[[guiSetStaticImageMovable]] » This function allows you to move a static image like a gui window.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.

=====Gridlists=====
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[guiGridListGetColumnIDFromTitle]] » This function gets a gridlist's column ID from the column title.
*[[guiGridListSetColumnNonSortable]] » This function makes a gridlist column become non-sortable.
*[[guiGridListSetColumnsFixedWidth]] » This function makes a gridlist have all its columns fixed width.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.
*[[convertGridListToText]] » This function converts grid list contents to text.

=====Labels=====
*[[guiLabelAddEffect]] » This function add an effects to the gui-label like (shadow, outline).

=== Marker functions ===
*[[createMarkerAttachedTo]] » This function creates a marker that is attached to an element.

=== Math functions ===
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[reMap]] » Re-maps a number from one range to another.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.polygonArea]] » Compute area of any polygon.
*[[math.randomDiff]] » Generates a pseudo-random integer that's always different from the last random number generated.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object

=== Ped functions ===
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[isPlayerHitByVehicle]]» This function cancels event when a element is hit by a vehicle.
*[[warpToPlayer]]» This function make player warp to another player.

=== Resource functions ===
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getResourceSize]] » This function returns the size of a specified resource in kB(kilobyte)
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[refreshResource]] » This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] » This function set resource download priority group.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[stopSoundSlowly]] » This function stop your sound element slowly.

=== Browser functions ===
*[[playVideo]] » This function plays a video on the screen.

=== Team functions ===
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.

=== Vehicle functions ===
*[[findEmptyCarSeat]] » This function finds you the first empty seat in a vehicle.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[isVehicleUpgraded]] » This function checks is vehicle upgraded by upgrade ID.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleTurnVelocityCenterOfMass]]» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getPreviousAndNextWeapon]] » This function returns the next weapon and previous.

=== XML functions ===
*[[getXMLNodes]] » This function returns all children of a XML node.

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[checkPassiveTimer]] » This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.

<noinclude>[[Category:Useful Functions]]</noinclude>

GetNearestElement

2020-08-22T02:09:33Z

JessePinkman: Edit layout

__NOTOC__
{{Useful Function}}
This function returns the nearest [[Element|element]] (of a specific type) to a [[Player|player]].

==Syntax==
<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>
===Required Arguments===
* '''thePlayer''': The player who you want to get the nearest element from.
* '''elementType''': The type of the element you want to get. ("player", "ped", "object", etc.)
* '''distance''': A number for the maximum distance the element can be from the player.

===Returns===
Returns an [[Element|element]] if it's within the specified '''distance''', ''false'' otherwise.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(thePlayer, elementType, distance)
local lastMinDis = distance-0.0001
local nearestElement = false
local px,py,pz = getElementPosition(thePlayer)
local pInt = getElementInterior(thePlayer)
local pDim = getElementDimension(thePlayer)

for _,e in pairs(getElementsByType(elementType)) do
local eInt,eDim = getElementInterior(e),getElementDimension(e)
if eInt == pInt and eDim == pDim and e ~= thePlayer then
local ex,ey,ez = getElementPosition(e)
local dis = getDistanceBetweenPoints3D(px,py,pz,ex,ey,ez)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestElement = e
end
end
end
end
return nearestElement
end
</syntaxhighlight></section>

==Example==
<section name="Client" class="client" show="true">
This example outputs the name of the nearest vehicle within 300 metres.
<syntaxhighlight lang="lua">
addCommandHandler("findVehicle", function()
local nearestVehicle = getNearestElement(localPlayer, "vehicle", 300) -- nearest vehicle within 300m
if nearestVehicle then -- if there is a vehicle (true)
outputChatBox("#7aff69"..getVehicleName(nearestVehicle).."#ffffff is the nearest vehicle!",255,255,255,true)
else -- no vehicle (false)
outputChatBox("There are#ff2e2e NO#ffffff vehicles nearby",255,255,255,true)
end
end)
</syntaxhighlight>
</section>

Modified version of [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}

GetNearestElement

2020-08-22T02:07:30Z

JessePinkman: Add an example code.

{{Useful Function}}
__NOTOC__
This function returns the nearest [[Element|element]] (of a specific type) to a [[Player|player]].

==Syntax==
<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player who you want to get the nearest element from.
* '''elementType''': The type of the element you want to get. ("player", "ped", "object", etc.)
* '''distance''': A number for the maximum distance the element can be from the player.

===Returns===
Returns an [[Element|element]] if it's within the specified '''distance''', ''false'' otherwise.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(thePlayer, elementType, distance)
local lastMinDis = distance-0.0001
local nearestElement = false
local px,py,pz = getElementPosition(thePlayer)
local pInt = getElementInterior(thePlayer)
local pDim = getElementDimension(thePlayer)

for _,e in pairs(getElementsByType(elementType)) do
local eInt,eDim = getElementInterior(e),getElementDimension(e)
if eInt == pInt and eDim == pDim and e ~= thePlayer then
local ex,ey,ez = getElementPosition(e)
local dis = getDistanceBetweenPoints3D(px,py,pz,ex,ey,ez)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestElement = e
end
end
end
end
return nearestElement
end
</syntaxhighlight></section>

==Example==
<section name="Client" class="client" show="true">
This example outputs the name of the nearest vehicle within 300 metres.
<syntaxhighlight lang="lua">
addCommandHandler("findVehicle", function()
local nearestVehicle = getNearestElement(localPlayer, "vehicle", 300) -- nearest vehicle within 300m
if nearestVehicle then -- if there is a vehicle (true)
outputChatBox("#7aff69"..getVehicleName(nearestVehicle).."#ffffff is the nearest vehicle!",255,255,255,true)
else -- no vehicle (false)
outputChatBox("There are#ff2e2e NO#ffffff vehicles nearby",255,255,255,true)
end
end)
</syntaxhighlight>
</section>

Modified version of [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}

GetNearestElement

2020-08-22T01:51:01Z

JessePinkman: Add new useful function getNearestElement, "inspired" by getNearestVehicle.

{{Useful Function}}
__NOTOC__
This function returns the nearest [[Element|element]] (of a specific type) to a [[Player|player]].

==Syntax==
<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player who you want to get the nearest element from.
* '''elementType''': The type of the element you want to get. ("player", "ped", "object", etc.)
* '''distance''': A number for the maximum distance the element can be from the player.

===Returns===
Returns an [[Element|element]] if it's within the specified '''distance''', ''false'' otherwise.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(thePlayer, elementType, distance)
local lastMinDis = distance-0.0001
local nearestElement = false
local px,py,pz = getElementPosition(thePlayer)
local pInt = getElementInterior(thePlayer)
local pDim = getElementDimension(thePlayer)

for _,e in pairs(getElementsByType(elementType)) do
local eInt,eDim = getElementInterior(e),getElementDimension(e)
if eInt == pInt and eDim == pDim and e ~= thePlayer then
local ex,ey,ez = getElementPosition(e)
local dis = getDistanceBetweenPoints3D(px,py,pz,ex,ey,ez)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestElement = e
end
end
end
end
return nearestElement
end
</syntaxhighlight></section>

Modified version of [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}