Difference between revisions of "Template:Useful Functions"

From Multi Theft Auto: Wiki
(Table functions)
(Utility)
(40 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
=== Table functions ===
 
=== Table functions ===
 +
*[[isValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span>
 
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span>
 
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span>
 
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span>
 
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span>
Line 15: Line 16:
 
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span>
 
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span>
 
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span>
 
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span>
*[[table.exist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span>
 
  
 
=== ACL functions ===
 
=== ACL functions ===
 
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span>
 
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span>
 +
*[[getPlayersInACLGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all players in an ACL group.</span>
 
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span>
 
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span>
 
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span>
 
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span>
 +
*[[isPlayerStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is server admin or staff.</span>
 
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span>
 
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span>
  
Line 32: Line 34:
 
=== Cursor functions ===
 
=== Cursor functions ===
 
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>
 
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>
 +
*[[isInSlot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks your cursor is in slot.</span>
  
 
=== Drawing functions ===
 
=== Drawing functions ===
Line 38: Line 41:
 
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span>
 
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span>
 
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span>
 
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span>
 +
*[[dxDrawRing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a ring with dx lines.</span>
 
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span>
 
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span>
 
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span>
 
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span>
 
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span>
 
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span>
 +
*[[dxDrawSprite]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draw a sprite in the 3D world.</span>
 
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span>
 
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span>
 
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span>
 
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span>
Line 53: Line 58:
 
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span>
 
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span>
 
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span>
 
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span>
 +
*[[dxDrawRombo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a Rhombus.</span>
  
 
=== Effects functions ===
 
=== Effects functions ===
Line 88: Line 94:
 
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span>
 
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span>
 
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span>
 
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span>
 +
*[[getDistance]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns the distance between two elements.</span>
 
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span>
 
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span>
 
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
 
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
Line 111: Line 118:
 
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span>
 
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span>
 
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span>
 
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span>
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span>
 
  
 
=== GUI functions ===  
 
=== GUI functions ===  
 
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span>
 
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span>
 
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span>
 
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span>
 +
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span>
 
=====Comboboxes=====
 
=====Comboboxes=====
 
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span>
 
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span>
Line 123: Line 130:
 
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span>
 
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span>
 
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span>
 
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span>
 +
*[[guiGridListSetColumnNonSortable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function makes a gridlist column become non-sortable.</span>
 +
*[[guiGridListSetColumnsFixedWidth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function makes a gridlist have all its columns fixed width.</span>
 
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span>
 
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span>
 
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span>
 
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span>
Line 129: Line 138:
  
 
=====Labels=====
 
=====Labels=====
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span>
+
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add an effects to the gui-label like (shadow, outline).</span>
  
 
=== Marker functions ===
 
=== Marker functions ===
Line 143: Line 152:
 
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span>
 
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span>
 
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span>
 
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span>
 +
 +
=== Map functions ===
 +
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span>
  
 
=== Ped functions ===
 
=== Ped functions ===
Line 156: Line 168:
 
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span>
 
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span>
 
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span>
 
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span>
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span>
 
 
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span>
 
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span>
 
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span>
 
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span>
Line 165: Line 176:
 
=== Player functions ===
 
=== Player functions ===
 
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span>
 
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span>
 +
*[[warpToPlayer]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function make player warp to another player.</span>
  
 
=== Resource functions ===
 
=== Resource functions ===
Line 170: Line 182:
 
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
 
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
 
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files
 
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files
 +
*[[setResourcePriority]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function set resource download priority group.</span>
  
 
=== Sound functions ===
 
=== Sound functions ===
Line 182: Line 195:
 
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span>
 
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span>
  
=== Vehicle funcions ===  
+
=== Vehicle functions ===  
 
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span>
 
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span>
 
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span>
 
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span>
Line 191: Line 204:
 
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
 
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
 
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span>
 
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span>
 +
*[[isVehicleUpgraded]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks is vehicle upgraded by upgrade ID.</span>
 
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
 
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
 
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span>
 
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span>
Line 210: Line 224:
 
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span>
 
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span>
 
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span>
 
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span>
 +
*[[getServerIp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the public IP of the server.</span>
 
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span>
 
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span>
 
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span>
 
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span>
 
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span>
 
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span>
 
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span>
 
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span>
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span>
 
 
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span>
 
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span>
 
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span>
 
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span>
 
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span>
 
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span>
 
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span>
 
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span>
 +
*[[PlotTrajectoryAtTime]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Calculate projectile/water trajectory.</span>
  
 
<noinclude>[[Category:Useful Functions]]</noinclude>
 
<noinclude>[[Category:Useful Functions]]</noinclude>

Revision as of 22:58, 23 October 2019

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

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.
  • isInSlot » This function checks your cursor is in slot.

Drawing functions

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
Gridlists
Labels
  • guiLabelAddEffect » This function add an effects to the gui-label like (shadow, outline).

Marker functions

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

Sound functions

Browser functions

  • playVideo » This function plays a video on the screen.

Team functions

Vehicle functions

Weapon functions

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.
  • getServerIp » This function returns the public IP of the server.
  • 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.