Multi Theft Auto: Wiki - User contributions [en]

Vector/Vector3

2022-01-15T12:10:56Z

Jayceon: Add syntax to intersectsSegmentTriangle (PR #1711)

[[Category:Incomplete]]
The '''vector3''' class represents a three-dimensional [[vector]].

==Methods==
===create===
This is default constructor for the Vector3 class and returns a Vector3 object.

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3 ( [ float x = 0, float y = 0, float z = 0 ] )</syntaxhighlight>

=====Optional arguments=====
* '''x''', '''y''' and '''z''': coordinates for the vector. If not specified, they default to 0.
* Instead of these three coordinates, a single Vector3 object may be inserted to clone it.

====Example====
This example sorts all players in a nice line on the center of the map.
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local players = getElementsByType("player")
local newPlayerPosition = Vector3(-#players - 1, 0, 10) -- Initialize the position vector for the first player in the list
for _, player in ipairs(players) do
-- Move each player 1 unit forward in X from the previous one
newPlayerPosition.x = newPlayerPosition.x + 1
setElementPosition(player, newPlayerPosition)
end
</syntaxhighlight>
</section>

===cross===
Calculates the cross product of two vectors, A and B, and is written as A × B. The result is another vector which:

* Is orthogonal to both A and B.
* Its direction is determined by the [https://upload.wikimedia.org/wikipedia/commons/d/d2/Right_hand_rule_cross_product.svg right-hand rule].
* Its length is equal to the area of the parallelogram that A and B form (which in turn is equal to A's length by B's length by the sine of the minimum angle between A and B).

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3:cross ( vector3 vector )</syntaxhighlight>

=====Required arguments=====
* '''vector''': a vector3 object to get the cross product with.

====Example====
This example creates a tiny sun which is always at the right of the vehicle the local player drives. By default it will draw the vectors used to compute the position where it should be, so you can understand what does this function do. Note that the code could be made simpler by simply getting the right component of the vehicle matrix. '''Make sure that you put this code in a resource which has OOP enabled, or it won't work'''.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">-- OPTIONS --
local debugMode = true -- If true, the script will draw the vectors used to compute the effect

-- EFFECT CONTROL FUNCTIONS --
local playerVehicle, lightMarker, light
local function applyDrivingLightEffect()
-- Get the vehicle matrix and use it to get the vehicle and vehicle base position
local vehicleMatrix = playerVehicle.matrix
local vehiclePosition = vehicleMatrix:getPosition()
-- Get the vehicle upwards vector and vehicle forward direction vector
local vehicleUpwardsVector, vehicleForwardVector = vehicleMatrix:getUp(), vehicleMatrix:getForward()
-- Get the normalized cross product of the vehicle forward vector and the vehicleUpwardsVector vector
local crossVector = vehicleForwardVector:cross(vehicleUpwardsVector):getNormalized()
-- Draw all the interesting vectors we have now
if debugMode then
local forwardPoint = vehiclePosition + vehicleForwardVector
dxDrawLine3D(vehiclePosition, forwardPoint, tocolor(255, 0, 0))
local sx, sy = getScreenFromWorldPosition(forwardPoint)
if sx then
dxDrawText("F", sx, sy)
end

local vehicleUpwardsVectorPoint = vehiclePosition + vehicleUpwardsVector
dxDrawLine3D(vehiclePosition, vehicleUpwardsVectorPoint, tocolor(0, 255, 0))
local sx, sy = getScreenFromWorldPosition(vehicleUpwardsVectorPoint, 1.1)
if sx then
dxDrawText("U", sx, sy)
end

local crossPoint = vehiclePosition + crossVector
dxDrawLine3D(vehiclePosition, crossPoint, tocolor(0, 0, 255))
local sx, sy = getScreenFromWorldPosition(crossPoint)
if sx then
dxDrawText("C", sx, sy)
end
end
-- Calculate the half length of the vehicle based in its bounding box, and use it to position the light effects at the right
local _, bmy, _, _, bMy = playerVehicle:getBoundingBox()
local newEffectPosition = vehiclePosition + crossVector * (bMy - bmy) / 2
lightMarker.position = newEffectPosition
light.position = newEffectPosition
end

local function startDrivingLightEffect()
-- Create the effects and start updating them every frame
addEventHandler("onClientPreRender", root, applyDrivingLightEffect)
playerVehicle, lightMarker, light = localPlayer.vehicle, createMarker(0, 0, 0, "corona", 0.5, 255, 255, 0), createLight(0, 0, 0, 0, 8, 255, 255)
-- If we are in debug mode, render the vehicle invisible to see the vectors clearly
if debugMode then
playerVehicle.alpha = 0
end
end

local function stopDrivingLightEffect()
-- Stop applyDrivingLightEffect from being called and destroy everything created
removeEventHandler("onClientPreRender", root, applyDrivingLightEffect)
destroyElement(lightMarker)
destroyElement(light)
-- If we are in debug mode, reset the vehicle alpha to normal again
if debugMode then
playerVehicle.alpha = 255
end
playerVehicle, lightMarker, light = nil, nil, nil
end

-- FUNCTIONS THAT MANAGE THE EFFECT --
-- Start or stop the effect when the player is driving a car
local function manageDrivingLightEffectStatus(_, seat)
if eventName == "onClientPlayerVehicleEnter" then
if seat == 0 then
-- The player has just entered a vehicle as the driver. Start the effect
startDrivingLightEffect()
end
elseif playerVehicle then
-- The player has just exited a vehicle and we were applying the effect. Stop it
stopDrivingLightEffect()
end
end
addEventHandler("onClientPlayerVehicleEnter", localPlayer, manageDrivingLightEffectStatus)
addEventHandler("onClientPlayerVehicleExit", localPlayer, manageDrivingLightEffectStatus)

-- Start the effect when the resource starts if the player is driving a vehicle, and reset vehicle alpha back to normal if necessary
local function handleResourceStartStop()
if eventName == "onClientResourceStart" then
playerVehicle = localPlayer.vehicle or nil
if playerVehicle then
startDrivingLightEffect()
end
elseif playerVehicle then
-- It is not necessary to call this function to just reset the car alpha, but it is a good practise to ALWAYS clean up everything nevertheless
stopDrivingLightEffect()
end
end
addEventHandler("onClientResourceStart", resourceRoot, handleResourceStartStop)
addEventHandler("onClientResourceStop", resourceRoot, handleResourceStartStop)</syntaxhighlight></section>

===dot===
Calculates the (standard) dot/scalar product of two vectors. If we call that vectors A and B, the dot product is written as A · B. This can be used to calculate the angle between them. If the standard scalar product is 0, both vectors are orthogonal.

====Syntax====
<syntaxhighlight lang="lua">float Vector3:dot ( vector3 vector )</syntaxhighlight>

=====Required arguments=====
* '''vector''': a vector3 object to get the dot product with.

====Example====
This examples illustrates the concept of dot/scalar product and implements a useful function which can be used to get the angle between two vectors.
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local vec1 = Vector3(1, 0, 0)
local vec2 = Vector3(0, 0, 0)
local dotproduct = vec1:dot(vec2)

if dotproduct == 0 then
outputDebugString("vec1 is orthogonal to vec2")
end

-- Calculate angle between vec1 and vec2
function angle(vec1, vec2)
-- Calculate the angle by applying law of cosines
return math.acos(vec1:dot(vec2)/(vec1.length*vec2.length))
end

outputDebugString("Angle between vec1 and vec2: "..math.deg(angle(vec1, vec2)).."°")
</syntaxhighlight>
</section>

===normalize===
Converts a vector to a unit vector (a vector of length 1).

====Syntax====
<syntaxhighlight lang="lua">bool Vector3:normalize ( )</syntaxhighlight>

====Example====
This example slowly moves all the players' camera to look at the Mount Chilliad.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local targetPosition = Vector3(-2627.32, -1083.2, 433.35) -- Somewhere in Mount Chilliad

local function moveCameraToTarget(deltaTime)
local currentPosition = Vector3(getCameraMatrix())
local direction = targetPosition - currentPosition
direction:normalize() -- Get a direction vector by normalizing the vector from the current position to the target position
setCameraMatrix(currentPosition + direction * deltaTime * 0.05, -2589.45, -1174.49, 418.09)
end
addEventHandler("onClientPreRender", root, moveCameraToTarget)
</syntaxhighlight>
</section>

===getX and setX===
===getY and setY===
===getZ and setZ===
===getNormalized===
Returns a normalized vector (of length 1) of the vector it's used on. Differently from the ''Vector3:normalize'' method, this one returns a ''vector3'' and doesn't modify the original vector.

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3:getNormalized ( )</syntaxhighlight>

====Example====
This example slowly moves all the players' camera to look at the Mount Chilliad with a shorter code than the previous example.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local targetPosition = Vector3(-2627.32, -1083.2, 433.35) -- Somewhere in Mount Chilliad

local function moveCameraToTarget(deltaTime)
local currentPosition = Vector3(getCameraMatrix())
local direction = (targetPosition - currentPosition):getNormalized() -- Get a direction vector by normalizing the vector from the current position to the target position
setCameraMatrix(currentPosition + direction * deltaTime * 0.05, -2589.45, -1174.49, 418.09)
end
addEventHandler("onClientPreRender", root, moveCameraToTarget)
</syntaxhighlight>
</section>

===getSquaredLength===
===getLength===
===intersectsSegmentTriangle===
Returns the intersection of the given triangle, or false if there is no intersection.
====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3.intersectsSegmentTriangle ( vector3 origin, vector3 segmentDir, vector3 triVert0, vector3 triVert1, vector3 triVert2 )</syntaxhighlight>
<syntaxhighlight lang="lua">vector3 Vector3:intersectsSegmentTriangle ( vector3 segmentDir, vector3 triVert0, vector3 triVert1, vector3 triVert2 )</syntaxhighlight>

[[ru:Vector/Vector3]]

Vector/Vector3

2022-01-15T12:02:13Z

Jayceon: Missing documentation from PR #1711.

GetDynamicDoorObjectOpenRatio

2021-06-03T19:58:15Z

Jayceon:

{{Useful_Function}}
This function tells you how open a dynamic (interactive - pushable) door is (the 'open ratio') just like the [[GetVehicleDoorOpenRatio]] function.

{{Note|This function only works properly on objects that have the special collision-response IDE flag #6 (SWINGDOOR). These are: '''1491''', '''1492''', '''1494''', '''1499''', '''1502''', '''1523'''}}

==Syntax==
<syntaxhighlight lang="lua">float getDynamicDoorObjectOpenRatio ( object theObject )</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The [[object]] that you wish to get the door open ratio of.

===Returns===
Returns a number between 0 and 1 that indicates how open the door is. 0 is closed, and 1 is fully open. Returns false if invalid arguments are passed.

==Code==
<syntaxhighlight lang="lua">
function getDynamicDoorObjectOpenRatio(theObject)
if isElement(theObject) then
if getElementType(theObject) == "object" then
local angularVelocity = select(3, getElementAngularVelocity(theObject))

if math.abs(angularVelocity) > 0 then
local objectMatrix = getElementMatrix(theObject)
local initialAngle = select(3, getElementRotation(theObject, "ZXY"))
local currentAngle = -math.deg(math.atan2(objectMatrix[2][1], objectMatrix[2][2]))

if initialAngle + 180 >= currentAngle then
if initialAngle - 180 > currentAngle then
currentAngle = currentAngle + 360
end
else
currentAngle = currentAngle - 360
end

return math.abs(currentAngle - initialAngle) / 108
end

return 0
end
end

return false
end
</syntaxhighlight>
{{Useful_Functions}}

Template:Useful Functions

2021-06-03T13:20:08Z

Jayceon:

__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.
*[[addTableChangeHandler]] » This function monitors the changes of a 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.
*[[getAccountsRanks]] » This function is used to detect the account name groups and put them in the chat.

=== 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.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.

=== 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.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[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.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.

=== 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.
*[[getRealMonth]] » This function returns the current month 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.
*[[gradientString]] » This function transforms a string in a new coloured gradient string.
*[[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.
*[[math.lerp]] » Get val between two integer.
*[[math.getBezierPoint]] » Get N-th order bezier point.

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

=== 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.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[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.
*[[getPlayersInRange]]» This function make a table of players within certain range.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.

=== 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.
*[[getFilesInResourceFolder]] » This function gets a list of files that are inside a folder of a resource.

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isSoundPlaying]] » This function checks if a sound element is playing or not.
*[[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.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[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.

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.

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

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

=== 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>

GetDynamicDoorObjectOpenRatio

2021-06-03T13:06:05Z

Jayceon:

{{Useful_Function}}
This function tells you how open a dynamic (interactive - pushable) door is (the 'open ratio') just like the [[GetVehicleDoorOpenRatio]] function.

{{Note|This function only works properly on objects that have the special collision-response IDE flag #6 (SWINGDOOR). They are: '''1491''', '''1492''', '''1494''', '''1499''', '''1502''', '''1523'''}}

==Syntax==
<syntaxhighlight lang="lua">float getDynamicDoorObjectOpenRatio ( object theObject )</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The [[object]] that you wish to get the door open ratio of.

===Returns===
Returns a number between 0 and 1 that indicates how open the door is. 0 is closed, and 1 is fully open. Returns false if invalid arguments are passed.

==Code==
<syntaxhighlight lang="lua">
function getDynamicDoorObjectOpenRatio(theObject)
if isElement(theObject) then
if getElementType(theObject) == "object" then
local angularVelocity = select(3, getElementAngularVelocity(theObject))

if math.abs(angularVelocity) > 0 then
local objectMatrix = getElementMatrix(theObject)
local initialAngle = select(3, getElementRotation(theObject, "ZXY"))
local currentAngle = -math.deg(math.atan2(objectMatrix[2][1], objectMatrix[2][2]))

if initialAngle + 180 >= currentAngle then
if initialAngle - 180 > currentAngle then
currentAngle = currentAngle + 360
end
else
currentAngle = currentAngle - 360
end

return math.abs(currentAngle - initialAngle) / 108
end

return 0
end
end

return false
end
</syntaxhighlight>
{{Useful_Functions}}

GetDynamicDoorObjectOpenRatio

2021-06-03T12:51:56Z

Jayceon: Created page with "{{Useful_Function}} This function tells you how open a dynamic (interactive - pushable) door is (the 'open ratio') just like the GetVehicleDoorOpenRatio function. Note tha..."

{{Useful_Function}}
This function tells you how open a dynamic (interactive - pushable) door is (the 'open ratio') just like the [[GetVehicleDoorOpenRatio]] function.
Note that this function only works properly on objects that have the special collision-response IDE flag #6 (SWINGDOOR).
They are: '''1491''', '''1492''', '''1494''', '''1499''', '''1502''', '''1523'''

==Syntax==
<syntaxhighlight lang="lua">float getDynamicDoorObjectOpenRatio ( object theObject )</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The [[object]] that you wish to get the door open ratio of.

===Returns===
Returns a number between 0 and 1 that indicates how open the door is. 0 is closed, and 1 is fully open. Returns false if invalid arguments are passed.

==Code==
<syntaxhighlight lang="lua">
function getDynamicDoorObjectOpenRatio(theObject)
if isElement(theObject) then
if getElementType(theObject) == "object" then
local angularVelocity = select(3, getElementAngularVelocity(theObject))

if math.abs(angularVelocity) > 0 then
local objectMatrix = getElementMatrix(theObject)
local initialAngle = select(3, getElementRotation(theObject, "ZXY"))
local currentAngle = -math.deg(math.atan2(objectMatrix[2][1], objectMatrix[2][2]))

if initialAngle + 180 >= currentAngle then
if initialAngle - 180 > currentAngle then
currentAngle = currentAngle + 360
end
else
currentAngle = currentAngle - 360
end

return math.abs(currentAngle - initialAngle) / 108
end

return 0
end
end

return false
end
</syntaxhighlight>
{{Useful_Functions}}

GetScreenFromWorldPosition

2020-08-14T14:01:20Z

Jayceon:

__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, 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}}

User:Jayceon

2020-08-09T11:55:41Z

Jayceon: Created page with "__NOTOC__ left == Contact == Discord: '''Jayceon#9063''' [https://github.com/jayceon123 GitHub Profile] [https://forum.mtasa.com/profile/52..."

__NOTOC__
[[File:Jay blue.png|thumb|left]]
== Contact ==
Discord: '''Jayceon#9063''' 
[https://github.com/jayceon123 GitHub Profile] 
[https://forum.mtasa.com/profile/52346-jayceon/ Forum Profile]

File:Jay blue.png

2020-08-09T11:53:30Z

Jayceon:

Jayceon Profile Avatar

DxDrawMaterialPrimitive3D

2020-08-04T13:52:10Z

Jayceon: Created page with "__NOTOC__ {{Client function}} This function draws a 3D primitive shape with material applied to it in the 3D world - rendered for one frame. This should be used in conjuncti..."

__NOTOC__
{{Client function}}
This function draws a 3D primitive shape with material applied to it in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.
If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring.
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, bool postGUI, table vertice1 [, table vertice2, ...] )
</syntaxhighlight>

===Required Arguments===
* '''pType:''' Type of primitive to be drawn.
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
* '''vertices:''' Tables representing each primitive vertice, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291(v=vs.85).aspx this MSDN site]
* '''pointlist:''' Renders the vertices as a collection of isolated points.
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.
* '''linestrip:''' Renders the vertices as a single polyline.
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
* '''trianglestrip:''' Renders the vertices as a triangle strip.
* '''trianglefan:''' Renders the vertices as a triangle fan.

==Vertices format==
* '''posX:''' An float representing the X position of the vertice in the GTA world.
* '''posY:''' An float representing the Y position of the vertice in the GTA world.
* '''posZ:''' An float representing the Z position of the vertice in the GTA world.
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image

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

==Example==
{{Example}}

==See Also==
{{Drawing_functions}}

[[hu:dxDrawMaterialPrimitive3D]]

SetVehicleSirens

2020-04-10T17:45:09Z

Jayceon:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0130|1.3.0|3968|
This function changes the properties of a vehicles siren point.
}}
{{Note|Although you may be able to add sirens to any vehice, this function may not work. This function fails on certain vehicle models (https://wiki.multitheftauto.com/wiki/Vehicle_IDs#Lua_table_of_vehicles_that_doesn.27t_support_siren_lights).}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleSirens ( vehicle theVehicle, int sirenPoint, float posX, float posY, float posZ, float red, float green, float blue, [float alpha = 255, float minAlpha = 0.0] )
</syntaxhighlight>
{{OOP||[[vehicle]]:setSirens||getVehicleSirens}}
===Required Arguments===
*'''theVehicle:''' The vehicle to modify
*'''sirenPoint:''' The siren point to modify
*'''posX:''' The x position of this siren point from the center of the vehicle
*'''posY:''' The y position of this siren point from the center of the vehicle
*'''posZ:''' The z position of this siren point from the center of the vehicle
*'''red:''' The amount of red from 0 to 255
*'''green:''' The amount of green from 0 to 255
*'''blue:''' The amount of blue from 0 to 255

===Optional Arguments===
*'''alpha:''' The alpha of the siren from 0 to 255
*'''minAlpha:''' The minimum alpha of the light during day time

===Returns===
Returns ''true'' if the siren point was successfully changed on the vehicle, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example adds a siren then sets the vehicle siren in the center of the car. (Not sure if it works...)
<syntaxhighlight lang="lua">
addEventHandler("onVehicleEnter",root,function(player,seat)
if(player)and(seat==0)then
addVehicleSirens(source,1,1)
setVehicleSirens(source,1,0,0,0,100,0,100)
end
end)
addEventHandler("onVehicleExit",root,function(player,seat)
if(player)and(seat==0)then
removeVehicleSirens(source)
end
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.0-9.03968|1.3.0-9.03968|}}

==See Also==
{{Vehicle_functions}}

Vehicle IDs

2020-04-10T17:43:29Z

Jayceon: /* Introduction */

==Introduction==
This is a list of GTA:SA's vehicle ID numbers, as listed in the vehicles.ide file. These vehicle ID numbers are used for several vehicle scripting functions.

====Lua table of all the valid vehicle IDs listed on this page====
<syntaxhighlight lang="lua">vehicleIds = {400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415,
416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433,
434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451,
452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469,
470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487,
488, 489, 490, 491, 492, 493, 494, 495, 496, 497, 498, 499, 500, 501, 502, 503, 504, 505,
506, 507, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523,
524, 525, 526, 527, 528, 529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541,
542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559,
560, 561, 562, 563, 564, 565, 566, 567, 568, 569, 570, 571, 572, 573, 574, 575, 576, 577,
578, 579, 580, 581, 582, 583, 584, 585, 586, 587, 588, 589, 590, 591, 592, 593, 594, 595,
596, 597, 598, 599, 600, 601, 602, 603, 604, 605, 606, 607, 608, 609, 610, 611
}</syntaxhighlight>

====Lua table of all vehicle names====

<syntaxhighlight lang="lua">
-- (when indexing just do a <vehicle model id you want the name of> - 399 to get the name)
vehicleNames = {"Landstalker", "Bravura", "Buffalo", "Linerunner", "Perennial", "Sentinel", "Dumper", "Fire Truck", "Trashmaster", "Stretch", "Manana",
"Infernus", "Voodoo", "Pony", "Mule", "Cheetah", "Ambulance", "Leviathan", "Moonbeam", "Esperanto", "Taxi", "Washington", "Bobcat",
"Mr. Whoopee", "BF Injection", "Hunter", "Premier", "Enforcer", "Securicar", "Banshee", "Predator", "Bus", "Rhino", "Barracks", "Hotknife",
"Trailer 1", "Previon", "Coach", "Cabbie", "Stallion", "Rumpo", "RC Bandit", "Romero", "Packer", "Monster", "Admiral", "Squalo",
"Seasparrow", "Pizzaboy", "Tram", "Trailer 2", "Turismo", "Speeder", "Reefer", "Tropic", "Flatbed", "Yankee", "Caddy", "Solair",
"Berkley's RC Van", "Skimmer", "PCJ-600", "Faggio", "Freeway", "RC Baron", "RC Raider", "Glendale", "Oceanic", "Sanchez", "Sparrow", "Patriot",
"Quadbike", "Coastguard", "Dinghy", "Hermes", "Sabre", "Rustler", "ZR-350", "Walton", "Regina", "Comet", "BMX", "Burrito", "Camper", "Marquis",
"Baggage", "Dozer", "Maverick", "News Chopper", "Rancher", "FBI Rancher", "Virgo", "Greenwood", "Jetmax", "Hotring Racer", "Sandking",
"Blista Compact", "Police Maverick", "Boxville", "Benson", "Mesa", "RC Goblin", "Hotring Racer 3", "Hotring Racer 2", "Bloodring Banger",
"Rancher Lure", "Super GT", "Elegant", "Journey", "Bike", "Mountain Bike", "Beagle", "Cropduster", "Stuntplane", "Tanker", "Roadtrain", "Nebula",
"Majestic", "Buccaneer", "Shamal", "Hydra", "FCR-900", "NRG-500", "HPV1000", "Cement Truck", "Towtruck", "Fortune", "Cadrona", "FBI Truck",
"Willard", "Forklift", "Tractor", "Combine Harvester", "Feltzer", "Remington", "Slamvan", "Blade", "Freight", "Streak", "Vortex", "Vincent",
"Bullet", "Clover", "Sadler", "Fire Truck Ladder", "Hustler", "Intruder", "Primo", "Cargobob", "Tampa", "Sunrise", "Merit", "Utility Van",
"Nevada", "Yosemite", "Windsor", "Monster 2", "Monster 3", "Uranus", "Jester", "Sultan", "Stratum", "Elegy", "Raindance", "RC Tiger", "Flash",
"Tahoma", "Savanna", "Bandito", "Freight Train Flatbed", "Streak Train Trailer", "Kart", "Mower", "Dune", "Sweeper", "Broadway", "Tornado",
"AT-400", "DFT-30", "Huntley", "Stafford", "BF-400", "Newsvan", "Tug", "Trailer (Tanker Commando)", "Emperor", "Wayfarer", "Euros", "Hotdog",
"Club", "Box Freight", "Trailer 3", "Andromada", "Dodo", "RC Cam", "Launch", "Police LS", "Police", "Police SF", "Police LV", "Police Ranger",
"Ranger", "Picador", "S.W.A.T.", "Alpha", "Phoenix", "Glendale Damaged", "Sadler", "Sadler Damaged", "Baggage Trailer (covered)",
"Baggage Trailer (Uncovered)", "Trailer (Stairs)", "Boxville Mission", "Farm Trailer", "Street Clean Trailer"
}</syntaxhighlight>

====Lua table of vehicles that are not lockable====
<syntaxhighlight lang="lua">nonLockableVehicles = {
594, 606, 607, 611, 584, 608, 435, 450, 591, 539, 441, 464, 501, 465, 564, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454, 581, 509, 481,
462, 521, 463, 510, 522, 461, 448, 468, 586, 425, 520
}</syntaxhighlight>

====Lua table of vehicles without number plates====
<syntaxhighlight lang="lua">noNumberPlates = {
592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460, 417, 469, 487, 513, 509, 481, 510, 472, 473, 493, 595, 484,
430, 453, 452, 446, 454
}</syntaxhighlight>

====Lua table of vehicles that support up to three different colors====
<syntaxhighlight lang="lua">maxColorVehicles = {
483, 524, 446
}</syntaxhighlight>

====Lua table of vehicles that doesn't support siren lights====
<syntaxhighlight lang="lua">noSirenLights = {
400, 401, 402, 403, 404, 405, 406, 417, 420, 423, 425, 430, 432, 433, 435, 438, 441, 446, 447, 448, 452, 453, 454, 460, 461, 462, 463, 464,
465, 468, 469, 472, 473, 476, 481, 484, 487, 488, 493, 497, 501, 509, 510, 511, 512, 513, 519, 520, 521, 522, 523, 528, 537, 538, 539, 544,
548, 553, 563, 564, 569, 570, 577, 581, 586, 590, 592, 593, 595, 600, 601, 602, 603, 604, 605, 606, 607, 608, 610, 611
}</syntaxhighlight>

==Aircrafts==
{|
|- style="vertical-align: top;"
| style="padding-right: 50px;" |

===Airplanes===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Andromada || 592 || align="center" | [[Image:Androm.png]]
|-
| AT-400 || 577 || align="center" | [[Image:At400.png]]
|-
| Beagle || 511 || align="center" | [[Image:Beagle.png]]
|-
| Cropduster || 512 || align="center" | [[Image:Cropdust.png]]
|-
| Dodo || 593 || align="center" | [[Image:Dodo.png]]
|-
| Hydra || 520 || align="center" | [[Image:Hydra.png]]
|-
| Nevada || 553 || align="center" | [[Image:Nevada.png]]
|-
| Rustler || 476 || align="center" | [[Image:Rustler.png]]
|-
| Shamal || 519 || align="center" | [[Image:Shamal.png]]
|-
| Skimmer || 460 || align="center" | [[Image:Skimmer.png]]
|-
| Stuntplane || 513 || align="center" | [[Image:Stunt.png]]
|}

| style="padding-right: 50px;" |

===Helicopters===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Cargobob || 548 || align="center" | [[Image:Cargobob.png]]
|-
| Hunter || 425 || align="center" | [[Image:Hunter.png]]
|-
| Leviathan || 417 || align="center" | [[Image:Leviathn.png]]
|-
| Maverick || 487 || align="center" | [[Image:Maverick.png]]
|-
| News Chopper || 488 || align="center" | [[Image:Newschop.png]]
|-
| Police Maverick || 497 || align="center" | [[Image:Polmav.png]]
|-
| Raindance || 563 || align="center" | [[Image:Raindanc.png]]
|-
| Seasparrow || 447 || align="center" | [[Image:Seaspar.png]]
|-
| Sparrow || 469 || align="center" | [[Image:Sparrow.png]]
|}

|}

==Boats==
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Coastguard || 472 || align="center" | [[Image:Coastg.png]]
|-
| Dinghy || 473 || align="center" | [[Image:Dinghy.png]]
|-
| Jetmax || 493 || align="center" | [[Image:Jetmax.png]]
|-
| Launch || 595 || align="center" | [[Image:Launch.png]]
|-
| Marquis || 484 || align="center" | [[Image:Marquis.png]]
|-
| Predator || 430 || align="center" | [[Image:Predator.png]]
|-
| Reefer || 453 || align="center" | [[Image:Reefer.png]]
|-
| Speeder || 452 || align="center" | [[Image:Speeder.png]]
|-
| Squalo || 446 || align="center" | [[Image:Squalo.png]]
|-
| Tropic || 454 || align="center" | [[Image:Tropic.png]]
|}

==Land vehicles==
{|
|- style="vertical-align: top;"
| style="padding-right: 50px;" |

===Bikes===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| BF-400 || 581 || align="center" | [[Image:Bf400.png]]
|-
| Bike || 509 || align="center" | [[Image:Bike.png]]
|-
| BMX || 481 || align="center" | [[Image:Bmx.png]]
|-
| Faggio || 462 || align="center" | [[Image:Faggio.png]]
|-
| FCR-900 || 521 || align="center" | [[Image:Fcr900.png]]
|-
| Freeway || 463 || align="center" | [[Image:Freeway.png]]
|-
| Mountain Bike || 510 || align="center" | [[Image:Mtbike.png]]
|-
| NRG-500 || 522 || align="center" | [[Image:Nrg500.png]]
|-
| PCJ-600 || 461 || align="center" | [[Image:Pcj600.png]]
|-
| Pizzaboy || 448 || align="center" | [[Image:Pizzaboy.png]]
|-
| Sanchez || 468 || align="center" | [[Image:Sanchez.png]]
|-
| Wayfarer || 586 || align="center" | [[Image:Wayfarer.png]]
|}

| style="padding-right: 50px;" |

===2-Door & Compact cars===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Alpha || 602 || align="center" | [[Image:Alpha.png]]
|-
| Blista Compact || 496 || align="center" | [[Image:Blistac.png]]
|-
| Bravura || 401 || align="center" | [[Image:Bravura.png]]
|-
| Buccaneer || 518 || align="center" | [[Image:Buccanee.png]]
|-
| Cadrona || 527 || align="center" | [[Image:Cadrona.png]]
|-
| Club || 589 || align="center" | [[Image:Club.png]]
|-
| Esperanto || 419 || align="center" | [[Image:Esperant.png]]
|-
| Euros || 587 || align="center" | [[Image:Euros.png]]
|-
| Feltzer || 533 || align="center" | [[Image:Feltzer.png]]
|-
| Fortune || 526 || align="center" | [[Image:Fortune.png]]
|-
| Hermes || 474 || align="center" | [[Image:Hermes.png]]
|-
| Hustler || 545 || align="center" | [[Image:Hustler.png]]
|-
| Majestic || 517 || align="center" | [[Image:Majestic.png]]
|-
| Manana || 410 || align="center" | [[Image:Manana.png]]
|-
| Picador || 600 || align="center" | [[Image:Picador.png]]
|-
| Previon || 436 || align="center" | [[Image:Previon.png]]
|-
| Stallion || 439 || align="center" | [[Image:Stallion.png]]
|-
| Tampa || 549 || align="center" | [[Image:Tampa.png]]
|-
| Virgo || 491 || align="center" | [[Image:Virgo.png]]
|}

| style="padding-right: 50px;" |

=== 4-Door & Luxury cars===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Admiral || 445 || align="center" | [[Image:Admiral.png]]
|-
| Damaged Glendale || 604 || align="center" | [[Image:Glenshit.png]]
|-
| Elegant || 507 || align="center" | [[Image:Elegant.png]]
|-
| Emperor || 585 || align="center" | [[Image:Emperor.png]]
|-
| Glendale || 466 || align="center" | [[Image:Glendale.png]]
|-
| Greenwood || 492 || align="center" | [[Image:Greenwoo.png]]
|-
| Intruder || 546 || align="center" | [[Image:Intruder.png]]
|-
| Merit || 551 || align="center" | [[Image:Merit.png]]
|-
| Nebula || 516 || align="center" | [[Image:Nebula.png]]
|-
| Oceanic || 467 || align="center" | [[Image:Oceanic.png]]
|-
| Premier || 426 || align="center" | [[Image:Premier.png]]
|-
| Primo || 547 || align="center" | [[Image:Primo.png]]
|-
| Sentinel || 405 || align="center" | [[Image:Sentinel.png]]
|-
| Stafford || 580 || align="center" | [[Image:Stafford.png]]
|-
| Stretch || 409 || align="center" | [[Image:Stretch.png]]
|-
| Sunrise || 550 || align="center" | [[Image:Sunrise.png]]
|-
| Tahoma || 566 || align="center" | [[Image:Tahoma.png]]
|-
| Vincent || 540 || align="center" | [[Image:Vincent.png]]
|-
| Washington || 421 || align="center" | [[Image:Washing.png]]
|-
| Willard || 529 || align="center" | [[Image:Willard.png]]
|}

|}
{|
|- style="vertical-align: top;"
| style="padding-right: 50px;" |

===Civil service===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Baggage || 485 || align="center" | [[Image:Baggage.png]]
|-
| Bus || 431 || align="center" | [[Image:Bus.png]]
|-
| Cabbie || 438 || align="center" | [[Image:Cabbie.png]]
|-
| Coach || 437 || align="center" | [[Image:Coach.png]]
|-
| Sweeper || 574 || align="center" | [[Image:Sweeper.png]]
|-
| Taxi || 420 || align="center" | [[Image:Taxi.png]]
|-
| Towtruck || 525 || align="center" | [[Image:Towtruck.png]]
|-
| Trashmaster || 408 || align="center" | [[Image:Trash.png]]
|-
| Utility Van || 552 || align="center" | [[Image:Utility.png]]
|}

| style="padding-right: 50px;" |

===Government vehicles===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Ambulance || 416 || align="center" | [[Image:Ambulan.png]]
|-
| Barracks || 433 || align="center" | [[Image:Barracks.png]]
|-
| Enforcer || 427 || align="center" | [[Image:Enforcer.png]]
|-
| FBI Rancher || 490 || align="center" | [[Image:Fbiranch.png]]
|-
| FBI Truck || 528 || align="center" | [[Image:Fbitruck.png]]
|-
| Fire Truck || 407 || align="center" | [[Image:Firetruk.png]]
|-
| Fire Truck || 544 || align="center" | [[Image:Firela.png]]
|-
| HPV1000 || 523 || align="center" | [[Image:Hpv1000.png]]
|-
| Patriot || 470 || align="center" | [[Image:Patriot.png]]
|-
| Police LS || 596 || align="center" | [[Image:Policels.png]]
|-
| Police LV || 598 || align="center" | [[Image:Policelv.png]]
|-
| Police Ranger || 599 || align="center" | [[Image:Policeru.png]]
|-
| Police SF || 597 || align="center" | [[Image:Policesf.png]]
|-
| Rhino || 432 || align="center" | [[Image:Rhino.png]]
|-
| S.W.A.T. || 601 || align="center" | [[Image:Swatvan.png]]
|-
| Securicar || 428 || align="center" | [[Image:Securica.png]]
|}

| style="padding-right: 50px;" |

===Heavy & Utility trucks===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Benson || 499 || align="center" | [[Image:Benson.png]]
|-
| Boxville Mission|| 609 || align="center" | [[Image:Boxburg.png]]
|-
| Boxville || 498 || align="center" | [[Image:Boxville.png]]
|-
| Cement Truck || 524 || align="center" | [[Image:Cement.png]]
|-
| Combine Harvester || 532 || align="center" | [[Image:Combine.png]]
|-
| DFT-30 || 578 || align="center" | [[Image:Dft30.png]]
|-
| Dozer || 486 || align="center" | [[Image:Dozer.png]]
|-
| Dumper || 406 || align="center" | [[Image:Dumper.png]]
|-
| Dune || 573 || align="center" | [[Image:Dune.png]]
|-
| Flatbed || 455 || align="center" | [[Image:Flatbed.png]]
|-
| Hotdog || 588 || align="center" | [[Image:Hotdog.png]]
|-
| Linerunner || 403 || align="center" | [[Image:Linerun.png]]
|-
| Mr. Whoopee || 423 || align="center" | [[Image:Mrwhoop.png]]
|-
| Mule || 414 || align="center" | [[Image:Mule.png]]
|-
| Packer || 443 || align="center" | [[Image:Packer.png]]
|-
| Roadtrain || 515 || align="center" | [[Image:Rdtrain.png]]
|-
| Tanker || 514 || align="center" | [[Image:Tanker.png]]
|-
| Tractor || 531 || align="center" | [[Image:Tractor.png]]
|-
| Yankee || 456 || align="center" | [[Image:Yankee.png]]
|}

| style="padding-right: 50px;" |

===Light trucks & Vans===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Berkley's RC Van || 459 || align="center" | [[Image:Topfun.png]]
|-
| Bobcat || 422 || align="center" | [[Image:Bobcat.png]]
|-
| Burrito || 482 || align="center" | [[Image:Burrito.png]]
|-
| Damaged Sadler || 605 || align="center" | [[Image:Sadlshit.png]]
|-
| Forklift || 530 || align="center" | [[Image:Forklift.png]]
|-
| Moonbeam || 418 || align="center" | [[Image:Moonbeam.png]]
|-
| Mower || 572 || align="center" | [[Image:Mower.png]]
|-
| News Van || 582 || align="center" | [[Image:Newsvan.png]]
|-
| Pony || 413 || align="center" | [[Image:Pony.png]]
|-
| Rumpo || 440 || align="center" | [[Image:Rumpo.png]]
|-
| Sadler || 543 || align="center" | [[Image:Sadler.png]]
|-
| Tug || 583 || align="center" | [[Image:Tug.png]]
|-
| Walton || 478 || align="center" | [[Image:Walton.png]]
|-
| Yosemite || 554 || align="center" | [[Image:Yosemite.png]]
|}

| style="padding-right: 50px;" |

===SUVs & Wagons===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Huntley || 579 || align="center" | [[Image:Huntley.png]]
|-
| Landstalker || 400 || align="center" | [[Image:Landstal.png]]
|-
| Perennial || 404 || align="center" | [[Image:Peren.png]]
|-
| Rancher || 489 || align="center" | [[Image:Rancher.png]]
|-
| Rancher || 505 || align="center" | [[Image:Rnchlure.png]]
|-
| Regina || 479 || align="center" | [[Image:Regina.png]]
|-
| Romero || 442 || align="center" | [[Image:Romero.png]]
|-
| Solair || 458 || align="center" | [[Image:Solair.png]]
|}

|}
{|
|- style="vertical-align: top;"
| style="padding-right: 50px;" |

===Lowriders===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Blade || 536 || align="center" | [[Image:Blade.png]]
|-
| Broadway || 575 || align="center" | [[Image:Broadway.png]]
|-
| Remington || 534 || align="center" | [[Image:Remingtn.png]]
|-
| Savanna || 567 || align="center" | [[Image:Savanna.png]]
|-
| Slamvan || 535 || align="center" | [[Image:Slamvan.png]]
|-
| Tornado || 576 || align="center" | [[Image:Tornado.png]]
|-
| Voodoo || 412 || align="center" | [[Image:Voodoo.png]]
|}

| style="padding-right: 50px;" |

===Muscle cars===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Buffalo || 402 || align="center" | [[Image:Buffalo.png]]
|-
| Clover || 542 || align="center" | [[Image:Clover.png]]
|-
| Phoenix || 603 || align="center" | [[Image:Phoenix.png]]
|-
| Sabre || 475 || align="center" | [[Image:Sabre.png]]
|}

| style="padding-right: 50px;" |

===Street racers===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Banshee || 429 || align="center" | [[Image:Banshee.png]]
|-
| Bullet || 541 || align="center" | [[Image:Bullet.png]]
|-
| Cheetah || 415 || align="center" | [[Image:Cheetah.png]]
|-
| Comet || 480 || align="center" | [[Image:Comet.png]]
|-
| Elegy || 562 || align="center" | [[Image:Elegy.png]]
|-
| Flash || 565 || align="center" | [[Image:Flash.png]]
|-
| Hotknife || 434 || align="center" | [[Image:Hotknife.png]]
|-
| Hotring Racer || 494 || align="center" | [[Image:Hotring.png]]
|-
| Hotring Racer 2 || 502 || align="center" | [[Image:Hotrina.png]]
|-
| Hotring Racer 3 || 503 || align="center" | [[Image:Hotrinb.png]]
|-
| Infernus || 411 || align="center" | [[Image:411.png]]
|-
| Jester || 559 || align="center" | [[Image:Jester.png]]
|-
| Stratum || 561 || align="center" | [[Image:Stratum.png]]
|-
| Sultan || 560 || align="center" | [[Image:Sultan.png]]
|-
| Super GT || 506 || align="center" | [[Image:Supergt.png]]
|-
| Turismo || 451 || align="center" | [[Image:Turismo.png]]
|-
| Uranus || 558 || align="center" | [[Image:Uranus.png]]
|-
| Windsor || 555 || align="center" | [[Image:Windsor.png]]
|-
| ZR-350 || 477 || align="center" | [[Image:Zr350.png]]
|}

|}
{|
|- style="vertical-align: top;"
| style="padding-right: 50px;" |

===RC Vehicles===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| RC Bandit || 441 || align="center" | [[Image:Rcbandit.png]]
|-
| RC Baron || 464 || align="center" | [[Image:Rcbaron.png]]
|-
| RC Cam || 594 || align="center" | [[Image:Rccam.png]]
|-
| RC Goblin || 501 || align="center" | [[Image:Rcgoblin.png]]
|-
| RC Raider || 465 || align="center" | [[Image:Rcraider.png]]
|-
| RC Tiger || 564 || align="center" | [[Image:Rctiger.png]]
|}

| style="padding-right: 50px;" |

===Trailers===
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Baggage Trailer || 606 || align="center" | [[Image:Bagboxa.png]]
|-
| Baggage Trailer || 607 || align="center" | [[Image:Bagboxb.png]]
|-
| Farm Trailer || 610 || align="center" | [[Image:Farmtr1.png]]
|-
| Petrol trailer || 584 || align="center" | [[Image:Petrotr.png]]
|-
| Trailer || 611 || align="center" | [[Image:Utiltr1.png]]
|-
| Trailer || 608 || align="center" | [[Image:Tugstair.png]]
|-
| Trailer 1 || 435 || align="center" | [[Image:Artict1.png]]
|-
| Trailer 2 || 450 || align="center" | [[Image:Artict2.png]]
|-
| Trailer 3 || 591 || align="center" | [[Image:Artict3.png]]
|-
|}

| style="padding-right: 50px;" |

===Trains & Railroad cars===

{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Box Freight || 590 || align="center" | [[Image:Freibox.png]]
|-
| Brown Streak || 538 || align="center" | [[Image:Streak.png]]
|-
| Brown Streak Carriage || 570 || align="center" | [[Image:Streakc.png]]
|-
| Flat Freight || 569 || align="center" | [[Image:Freiflat.png]]
|-
| Freight || 537 || align="center" | [[Image:Freight.png]]
|-
| Tram || 449 || align="center" | [[Image:Tram.png]]
|}

|}

==Recreational==
{|class="wikitable sortable"
|-
! Name || ID || class="unsortable" | Image
|-
| Bandito || 568 || align="center" | [[Image:Bandito.png]]
|-
| BF Injection || 424 || align="center" | [[Image:Bfinject.png]]
|-
| Bloodring Banger || 504 || align="center" | [[Image:Bloodra.png]]
|-
| Caddy || 457 || align="center" | [[Image:Caddy.png]]
|-
| Camper || 483 || align="center" | [[Image:Camper.png]]
|-
| Journey || 508 || align="center" | [[Image:Journey.png]]
|-
| Kart || 571 || align="center" | [[Image:Kart.png]]
|-
| Mesa || 500 || align="center" | [[Image:Mesa.png]]
|-
| Monster || 444 || align="center" | [[Image:Monster.png]]
|-
| Monster 2 || 556 || align="center" | [[Image:Monstera.png]]
|-
| Monster 3 || 557 || align="center" | [[Image:Monsterb.png]]
|-
| Quadbike || 471 || align="center" | [[Image:Quad.png]]
|-
| Sandking || 495 || align="center" | [[Image:Sandking.png]]
|-
| Vortex || 539 || align="center" | [[Image:Vortex.png]]
|}

==Vehicle Functions==
{{Vehicle functions}}

==See Also==

[[hu:Vehicle IDs]]
[[id|ID Lists]]
[[tr:Araç ID'leri]]
[[it:ID Veicoli]]
[[ru:Vehicle IDs]]
[[de:Fahrzeug IDs]]

[[Category:ID Lists]]

ReMap

2020-02-09T17:50:43Z

Jayceon: /* Example */

{{Useful_Function}}
Re-maps a number from one range to another.

==Syntax==
<syntaxhighlight lang="lua">int/float reMap(float value, float low1, float high1, float low2, float high2)</syntaxhighlight>

===Required Arguments===
* '''value''': The incoming value to be converted
* '''low1''': Lower bound of the value's current range
* '''high1''': Upper bound of the value's current range
* '''low2''': Lower bound of the value's target range
* '''high2''': Upper bound of the value's target range

===Returns===
Returns the re-mapped number.

==Code==
<syntaxhighlight lang="lua">
function reMap(value, low1, high1, low2, high2)
return low2 + (value - low1) * (high2 - low2) / (high1 - low1)
end
</syntaxhighlight>

==Example==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua" lang="lua">
local alpha = 127.5
local opacity = reMap(alpha, 0, 255, 0, 1)

-- And the "opacity" return 0.5 because 255/2 = 127.5 and 0 to 1 range is 0.5

-- Reverse:
local opacity = 0.5
local alpha = reMap(opacity, 0, 1, 0, 255)

-- And the "alpha " return 127.5 because 1/2 = 0.5 and 0 to 255 range is 127.5
</syntaxhighlight>
</section>
{{Useful_Functions}}

SetVehicleDoorState

2019-01-29T13:01:35Z

Jayceon: /* Required Arguments */

__NOTOC__
{{Server client function}}
This function sets the state of the specified door on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
{{OOP||[[vehicle]]:setDoorState||getVehicleDoorState}}

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] that you wish to change the door state of.
*'''door:''' An integer representing which door to set the state of. Valid values are:
**'''0:''' Hood
**'''1:''' Trunk
**'''2:''' Front left
**'''3:''' Front right
**'''4:''' Rear left
**'''5:''' Rear right
*'''state:''' An integer representing the state to set the door to. Valid values are:
**'''0:''' Shut, intact (aka Closed, undamaged)
**'''1:''' Ajar, intact (aka Slightly open, undamaged)
**'''2:''' Shut, damaged (aka Closed, damaged)
**'''3:''' Ajar, damaged (aka Slightly open, damaged)
**'''4:''' Missing

==Returns==
Returns ''true'' if the door state was successfully set, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break its front left door off
state = setVehicleDoorState ( newcar, 2, 4 )
</syntaxhighlight>

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

ReMap

2017-08-03T09:45:15Z

Jayceon: /* Syntax */

Re-maps a number from one range to another.

==Syntax==
<syntaxhighlight lang="lua">int/float reMap(float value, float low1, float high1, float low2, float high2)</syntaxhighlight>

===Required Arguments===
* '''value''': The incoming value to be converted
* '''low1''': Lower bound of the value's current range
* '''high1''': Upper bound of the value's current range
* '''low2''': Lower bound of the value's target range
* '''high2''': Upper bound of the value's target range

===Returns===
Returns the re-mapped number.

==Code==
<syntaxhighlight lang="lua">
function reMap(value, low1, high1, low2, high2)
return low2 + (value - low1) * (high2 - low2) / (high1 - low1)
end
</syntaxhighlight>

==Example==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua" lang="lua">
local realAlpha = 127.5
local alpha = reMap(realAlpha, 0, 255, 0, 1)

-- And the "alpha" return 0.5 because 255/2 = 127.5 and 0 to 1 range is 0.5

-- Reverse:
local alpha = 0.5
local realAlpha = reMap(realAlpha, 0, 1, 0, 255)

-- And the "realAlpha " return 127.5 because 1/2 = 0.5 and 0 to 255 range is 127.5
</syntaxhighlight>
</section>

Author: Jayceon

Template:Useful Functions

2017-08-02T20:48:38Z

Jayceon: /* Math functions */

=== ACL functions ===
*[[aclGroupClone]] » This function clone a group to another group with/without ACLs and/or objects.
*[[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 ===
*[[setAccountName]] » This function is used to change an existing account's name.
*[[removeAccountData]] » This function is used to remove data from account .

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle .
*[[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.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.

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

=== Elements 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.
*[[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]].

=== Data functions ===
*[[Byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertNumber]] » This function converts and formats large numbers.
*[[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.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[getRealMonthM]] » This function gives you the real months name
*[[getRealMonthH]] » This function convert english months to arabic months
*[[generateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[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.
*[[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.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[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.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.
*[[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.

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
=====Gridlists=====
*[[getGridListRowIndexFromText]] » This function returns the GridList row index from the specified text.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[guiGridListAddPlayers]] » This function add all online players to a grid list.
*[[isTextInGridList]] » This function checks if some text exist or not in the GridList.

=== 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.

=== 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.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[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.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersInGroup]] » This function returns all Players In Group .
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getDimensionEmpty]] » This function returns id Dimension Empty .
*[[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.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.

=== Resource functions ===
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[refreshResource]] » This function refreshes your resource if you changed any of the files

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

=== Table functions ===
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[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.size]] » This function returns the absolute size of a table.
*[[table.removeValue]] » This function removes a specified value from a table.

=== 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 funcions ===
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[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.
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.

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

=== Utility ===
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[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.
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[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.
*[[isCursorOnElement]] » This function checks whether the cursor is in a particular area.
*[[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.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.

[[Category:Useful Functions]]

ReMap

2017-08-02T20:47:08Z

Jayceon: /* Example */

Re-maps a number from one range to another.

==Syntax==
<syntaxhighlight lang="lua">int/float reMap( float value, float low1, float high1, float low2, float high2)</syntaxhighlight>

===Required Arguments===
* '''value''': The incoming value to be converted
* '''low1''': Lower bound of the value's current range
* '''high1''': Upper bound of the value's current range
* '''low2''': Lower bound of the value's target range
* '''high2''': Upper bound of the value's target range

===Returns===
Returns the re-mapped number.

==Code==
<syntaxhighlight lang="lua">
function reMap(value, low1, high1, low2, high2)
return low2 + (value - low1) * (high2 - low2) / (high1 - low1)
end
</syntaxhighlight>

==Example==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua" lang="lua">
local realAlpha = 127.5
local alpha = reMap(realAlpha, 0, 255, 0, 1)

-- And the "alpha" return 0.5 because 255/2 = 127.5 and 0 to 1 range is 0.5

-- Reverse:
local alpha = 0.5
local realAlpha = reMap(realAlpha, 0, 1, 0, 255)

-- And the "realAlpha " return 127.5 because 1/2 = 0.5 and 0 to 255 range is 127.5
</syntaxhighlight>
</section>

Author: Jayceon

ReMap

2017-08-02T20:46:41Z

Jayceon: Created page with "Re-maps a number from one range to another. ==Syntax== <syntaxhighlight lang="lua">int/float reMap( float value, float low1, float high1, float low2, float high2)</syntaxhigh..."

Re-maps a number from one range to another.

==Syntax==
<syntaxhighlight lang="lua">int/float reMap( float value, float low1, float high1, float low2, float high2)</syntaxhighlight>

===Required Arguments===
* '''value''': The incoming value to be converted
* '''low1''': Lower bound of the value's current range
* '''high1''': Upper bound of the value's current range
* '''low2''': Lower bound of the value's target range
* '''high2''': Upper bound of the value's target range

===Returns===
Returns the re-mapped number.

==Code==
<syntaxhighlight lang="lua">
function reMap(value, low1, high1, low2, high2)
return low2 + (value - low1) * (high2 - low2) / (high1 - low1)
end
</syntaxhighlight>

==Example==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua" lang="lua">
local realAlpha = 127.5
local alpha = reMap(realAlpha, 0, 255, 0, 1)

-- And the "alpha" return 0.5 because 255/2 = 127.5 and 0 to 1 range is 0.5

-- Reverse:
local alpha = 0.5
local realAlpha = reMap(realAlpha, 0, 1, 0, 255)

-- And the "realAlpha " return 127.5 because 1/2 = 0.5 and 0 to 255 range is 127.5
</syntaxhighlight>
</section>