Useful Functions

	Don't forget to check out the Useful Classes
	That page lists user-made classes that are not included by default in MTA.

Contributors: Did you create a page but it's not on this list? Confused? Read: Adding Pages to Categories and Templates

This page lists user-made Lua functions that are not included by default in MTA. Its purpose is to quickly provide some useful functions for scripters, so they do not waste time recreating them when needed.

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

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.
isPlayerStaff » This function checks if a player is server admin or staff.
renameAclGroup » This function gives an existing ACL group a new name.

Account functions

removeAccountData » This function is used to remove data from an account.
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.

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

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.

Comboboxes

guiComboBoxAdjustHeight » This function adjusts a CEGUI combobox element to have the correct height.
guiComboBoxAddPlayersName » This function is add players name in combobox .

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 » 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.
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.
warpToPlayer» This function make player warp to another player.

Resource functions

getResourceScripts » This function returns a table of the resource scripts.
getResourceSettings » This function returns a table of the resource settings.
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.

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

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.
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.
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.
thisCommandHandlersExist » This method checks a string if this exist as command Handlers
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.