Multi Theft Auto: Wiki - User contributions [en]

GetAccountName

2025-12-23T18:20:25Z

AirNewSCR: Added a new example, and fixed wide spaces.

{{Server function}}
__NOTOC__
This function retrieves the name of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
string getAccountName ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getName|name|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the name of.

===Returns===
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",root,outputOnLogin ) --add an event handler
</syntaxhighlight>

This example shows the account you are logged into.
<syntaxhighlight lang="lua">
addCommandHandler("mylogin", function(source)
local account = getPlayerAccount(source)
if account and not isGuestAccount(account) then
local accountName = getAccountName(account)
outputChatBox("Your login is: "..accountName, source)
else
outputChatBox("You are not logged in!", source)
end
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[ru:getAccountName]]
[[es:getAccountName]]
[[ar:getAccountName]]
[[pl:GetAccountName]]
[[zh-cn:GetAccountName]]

FormatNumber

2025-06-14T05:29:21Z

AirNewSCR: Improved and optimized for performance and reliability issues, removed unnecessary codes.

{{Useful Function}} __NOTOC__
This function formats large numbers by adding separators for thousands. For example, 100000 becomes 100 000. 

==Syntax==
<syntaxhighlight lang="lua">
string formatNumber( int number, [ string sep = "." ] )
</syntaxhighlight>

===Required Arguments===
* '''number''': The number to be formatted.

===Optional Arguments===
* '''sep''': A string used as the thousands separator. Default is '''"."'''.

===Returns===
Returns a string containing the formatted number.

==Code==
<section name="Example 1: Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function formatNumber(n, sep)
assert(type(n) == "number", "Bad argument @'formatNumber' [Expected number at argument 1, got "..type(n).."]")
assert(not sep or type(sep) == "string", "Bad argument @'formatNumber' [Expected string or nil at argument 2, got "..type(sep).."]")
sep = sep or '.'
local s = string.format("%.0f", n)
repeat s, c = s:gsub("^(-?%d+)(%d%d%d)", "%1"..sep.."%2") until c == 0
return s
end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example converts a player's money and outputs it to the chatbox when they type '''money''' into the console:
<syntaxhighlight lang="lua">
function convertPlayerMoney()
local pMoney = getPlayerMoney()
local convertedMoney = formatNumber(pMoney)
outputChatBox(convertedMoney)
end
addCommandHandler("money", convertPlayerMoney)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

HandlingGetABS

2024-11-03T13:54:05Z

AirNewSCR:

__NOTOC__
{{Server function}}
{{Disabled}}
Returns the ABS (Anti-lock Braking System) setting of a handling element or vehicle ID.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingGetABS ( handling theHandling )
bool handlingGetABS ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the ABS setting, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the ABS setting.

===Returns===
If you specified a handling element, returns its ABS setting if one is set (''true'' if ABS is active, ''false'' if not), or ''nil'' otherwise. If you specified a vehicle ID, returns the ABS setting that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingGetSteeringLock

2024-11-03T13:53:12Z

AirNewSCR:

__NOTOC__
{{Server function}}
{{Disabled}}
Returns the steering lock of a handling element or vehicle ID (how strongly the car can steer).

==Syntax==
<syntaxhighlight lang="lua">
float handlingGetSteeringLock ( handling theHandling )
float handlingGetSteeringLock ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the steering lock, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the steering lock.

===Returns===
If you specified a handling element, returns its steering lock if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the steering lock that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingGetEngineInertia

2024-11-03T13:41:30Z

AirNewSCR:

__NOTOC__
{{Server function}}
{{Disabled}}
Returns the engine interia of a handling element or vehicle ID. A higher inertia makes a slower car.

==Syntax==
<syntaxhighlight lang="lua">
float handlingGetEngineInertia ( handling theHandling )
float handlingGetEngineInertia ( int vehicleID )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to get the inertia, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the inertia.

===Returns===
If you specified a handling element, returns its inertia if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the inertia that currently applies to vehicles of that ID. Returns ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

HandlingSetEngineInertia

2024-11-03T13:41:05Z

AirNewSCR:

__NOTOC__
{{Server function}}
{{Disabled}}
Sets the engine inertia of a handling element. The higher this value, the slower the vehicle goes.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetEngineInertia ( handling theHandling, float inertia )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the inertia.
*'''inertia:''' the inertia value to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

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

==See Also==
{{Handling_functions}}

UsePickup

2024-10-24T14:20:41Z

AirNewSCR: Is only server-side function

__NOTOC__
{{Server function}}
This function is used to simulate the player using a pickup

==Syntax==
<syntaxhighlight lang="lua">
bool usePickup ( pickup thePickup, player thePlayer )
</syntaxhighlight>

===Required Arguments===
* '''thePickup''': The pickup element to be picked up/used.
* '''thePlayer''': The player to use the pickup.

==Example==
<section name="Server" class="server" show="true">
This example gives a random player 100% armor by using a pickup.
<syntaxhighlight lang="lua">
local pickup = createPickup(3,3,3,1,100) -- Create a pickup for 100% armor
usePickup(pickup,getRandomPlayer()) -- Make a random player use the pickup (shall recieve 100% armor)
</syntaxhighlight>
</section>

==See Also==
{{Pickup functions}}

GetNearestElement

2024-10-17T02:10:20Z

AirNewSCR: added if element ~= player then in getNearestElement to prevent return player passed to call function

__NOTOC__
{{Useful Function}}

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

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

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

==Code==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(player, type, distance)
local result = false
local dist = nil
if player and isElement(player) then
local elements = getElementsWithinRange(Vector3(getElementPosition(player)), distance, type, getElementInterior(player), getElementDimension(player))
for i = 1, #elements do
local element = elements[i]
if element ~= player then
if not dist then
result = element
dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
else
local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
if newDist <= dist then
result = element
dist = newDist
end
end
end
end
end
return result
end
</syntaxhighlight>
</section>

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

'''Modified version of''' [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}

SetPedRotation

2024-09-08T04:57:59Z

AirNewSCR: FileEX - read note and remove-it

__NOTOC__
{{Server client function}}

This function allows you to set the current rotation of the specified ped.

{{Note|setPedRotation function is not obsolete, when using setElementRotation with NPCs they do not rotate correctly when making them walk, so FileEX stop stating that the function is obsolete when it is not!}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedRotation ( ped thePed, float rotation [, bool conformPedRotation = false ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] to set the rotation of
*'''rotation:''' A [[float]] specifying the desired rotation in degrees.

===Optional Arguments===
{{New feature/item|3.0152|1.3.2|4680|
*'''conformPedRotation:''' A bool which should be set to ''true'' to ensure the ped rotation is correctly set in all circumstances. Failing to set this argument may result in the rotation being inverted when the ped is in the air and other inconsistencies. The default value of false is for backward compatibility with scripts which may depend upon the incorrect behaviour
}}

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to type the command 'disco', which will result in the player being rotated to a random direction every 1 second, infinite times.
<syntaxhighlight lang="lua">function discoTime ( )
-- Randomly choose a new player rotation and set it
newRotation = math.random ( 0, 360 )
setPedRotation ( getLocalPlayer(), newRotation )
end

function initiateDiscoMode ( commandName )
-- Trigger a random change in player rotation every second
setTimer ( discoTime, 1000, 0 )
end
addCommandHandler ( "disco", initiateDiscoMode )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04680|Added conformPedRotation argument}}

==See Also==
{{Ped_functions}}
[[ru:setPedRotation]]

SetPedRotation

2024-09-07T06:40:34Z

AirNewSCR: Undo revision 80020 by FileEX (talk)

__NOTOC__
{{Server client function}}
This function allows you to set the current rotation of the specified ped.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedRotation ( ped thePed, float rotation [, bool conformPedRotation = false ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] to set the rotation of
*'''rotation:''' A [[float]] specifying the desired rotation in degrees.

===Optional Arguments===
{{New feature/item|3.0152|1.3.2|4680|
*'''conformPedRotation:''' A bool which should be set to ''true'' to ensure the ped rotation is correctly set in all circumstances. Failing to set this argument may result in the rotation being inverted when the ped is in the air and other inconsistencies. The default value of false is for backward compatibility with scripts which may depend upon the incorrect behaviour
}}

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to type the command 'disco', which will result in the player being rotated to a random direction every 1 second, infinite times.
<syntaxhighlight lang="lua">function discoTime ( )
-- Randomly choose a new player rotation and set it
newRotation = math.random ( 0, 360 )
setPedRotation ( getLocalPlayer(), newRotation )
end

function initiateDiscoMode ( commandName )
-- Trigger a random change in player rotation every second
setTimer ( discoTime, 1000, 0 )
end
addCommandHandler ( "disco", initiateDiscoMode )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04680|Added conformPedRotation argument}}

==See Also==
{{Ped_functions}}
[[ru:setPedRotation]]

SetPedRotation

2024-08-15T19:50:02Z

AirNewSCR: Undo revision 44613 by AlexTMjugador (talk)

OnPlayerMarkerHit

2024-07-06T14:54:41Z

AirNewSCR: Many errors

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] hits a [[marker]].
{{Note|This event is triggered for players only. Attaching this event to a marker does nothing.}}

==Parameters==
<syntaxhighlight lang="lua">
marker markerHit, bool matchingDimension
</syntaxhighlight>

*'''markerHit''': the [[marker]] the [[player]] hit.
*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the marker.

==Example==
This example outputs when a player hits a marker.
<syntaxhighlight lang="lua">
addEventHandler('onPlayerMarkerHit', root, function(marker, matchingDimension)
if not matchingDimension then return end -- checks if the dimension of the player who activated the marker is the same as the one the marker is in (in this case, if not, it will stop here)
outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end)
</syntaxhighlight>

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

OnPlayerMarkerHit

2024-07-06T14:52:50Z

AirNewSCR:

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] hits a [[marker]].
{{Note|This event is triggered for players only. Attaching this event to a marker does nothing.}}

==Parameters==
<syntaxhighlight lang="lua">
marker markerHit, bool matchingDimension
</syntaxhighlight>

*'''markerHit''': the [[marker]] the [[player]] hit.
*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the marker.

==Example==
This example outputs when a player hits a marker.
<syntaxhighlight lang="lua">
addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
if not dimension then return end -- check if player is actually going into the marker
outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end)
</syntaxhighlight>

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

OnPlayerMarkerHit

2024-07-06T14:52:34Z

AirNewSCR: Fixed variable name incorrect (change dim to dimension)

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] hits a [[marker]].
{{Note|This event is triggered for players only. Attaching this event to a marker does nothing.}}

==Parameters==
<syntaxhighlight lang="lua">
marker markerHit, bool matchingDimension
</syntaxhighlight>

*'''markerHit''': the [[marker]] the [[player]] hit.
*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the marker.

==Example==
This example outputs when a player hits a marker.
<syntaxhighlight lang="lua">
addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
if not dimension then return end -- check if player is actually going into the marker
outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end)
</syntaxhighlight>

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

User:AirNewSCR

2024-06-25T08:42:01Z

AirNewSCR: Created page with "Discord: airnewscr"

Discord: airnewscr

TriggerClientEvent

2024-06-25T08:36:53Z

AirNewSCR: Added example 3 (with resourceRoot)

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note | Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [ table/element sendTo = getRootElement(), ] string name, element sourceElement [, arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Important Note|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Example==
===Example 1===
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

===Example 2===
This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

===Example 3===
This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function nameFunction(message)
if source == resourceRoot then
outputChatBox(message)
end
end
addEvent("toClientSide", true )
addEventHandler("toClientSide", resourceRoot, nameFunction)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function commandFunction(source)
triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
end
addCommandHandler("cool", commandFunction)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions}}
[[ru:triggerClientEvent]]

TriggerServerEvent

2024-04-18T22:11:21Z

AirNewSCR: /* Removed 'localPlayer', changed to resourceRoot */

__NOTOC__
{{Client function}}
This function triggers an event previously registered on the server. This is the primary means of passing information between the client and the server. Servers have a similar [[triggerClientEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerClientEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client. '''Elements of the Vector or Matrix classes cannot be passed!'''

Events are sent reliably, so the server will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note|You should use the global variable [[Predefined_variables_list|''client'']] server-side instead of passing the [[localPlayer]] by parameter or source. Otherwise event faking (passing another player instead of the [[localPlayer]]) would be possible. For more information see: [[Script security]] article.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}
==Syntax==
<syntaxhighlight lang="lua">
bool triggerServerEvent ( string event, element theElement, [arguments...] )
</syntaxhighlight>

===Required Arguments===
*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''theElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Note|To save server CPU, you should avoid setting '''theElement''' to the [[root element]] where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using [[localPlayer]] is preferred and highly advisable. [[GetThisResource|resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified or a client side element was a parameter.

==Example==
This example shows how you can pass some data from client to server.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function sendTestData()
local dataToSend = "Hello, world!"
triggerServerEvent("onServerSendTestData", resourceRoot, dataToSend)
end
addCommandHandler("data", sendTestData)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function onServerSendTestData(sentData)
if (not client) then -- 'client' points to the player who triggered the event, and should be used as security measure (in order to prevent player faking)
return false -- if this variable doesn't exists at the moment (for unknown reason, or it was the server who triggered this event), stop code execution
end
if (source ~= resourceRoot) then
return false
end
local chatMessage = "Data sent from client: "..sentData
outputChatBox(chatMessage, client) -- output data sent from client-side
end
addEvent("onServerSendTestData", true) -- 2nd argument should be set to true, in order to be triggered from counter side (in this case client-side)
addEventHandler("onServerSendTestData", resourceRoot, onServerSendTestData)
</syntaxhighlight>
</section>

When the command '''data''' is executed (by typing it in the player's console or in chat: '''/data'''), '''sendTestData''' function is called. This triggers the server-side event ''onServerSendTestData'' with the string ''"Hello, world!"''. This event is then handled by function on server-side which displays the message.

==See Also==
{{Client_event_functions}}
[[ru:triggerServerEvent]]

GetBanBySerial

2024-02-21T16:22:06Z

AirNewSCR:

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban if the serial is banned, otherwise false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanBySerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': The banned player serial.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanBySerial(serial)
local result = false
if serial then
for _, ban in ipairs(getBans()) do
if getBanSerial(ban) == serial then
result = ban
break
end
end
end
return result
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example removes the player's ban from the serial provided.
<syntaxhighlight lang="lua">
addCommandHandler("unban", function(source, _, serial)
if not serial then
outputChatBox("The command is /unban serial", source, 255, 0, 0)
return
end
local ban = getBanBySerial(serial)
if ban then
removeBan(ban, source)
outputChatBox("The serial "..serial.." has been unbanned!", source, 0, 255, 0)
else
outputChatBox("This serial is not banned!", source, 255, 0, 0)
end
end)
</syntaxhighlight>
</section>

Author: AirNewSCR

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2024-02-21T16:19:28Z

AirNewSCR: /* Utility */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[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.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.flip]] » This function returns the table from the last value to the first value, such as reflection.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[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.

=== 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.
*[[getPlayersInACLGroup]] » This function returns all players in an ACL group.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

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

=== Camera functions ===
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.
*[[sCamera]] » The function creates a speed camera in-game, fines speeding vehicles, and notifies the driver and take money from player based on vehicle speed.

=== Colshape functions ===
*[[createGarageColShape]] » This function creates a collision shape from the specified garage.

=== Cursor functions ===
*[[getCursorMovedOn]] » This function checks in which way the cursor is currently moving.
*[[setCursorCenteredOnRectangle]] » This functions will center the cursor inside a rectangle.

=== 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.
*[[dxDrawEditbox]] » This function draws a edit box across the screen - rendered for one frame. This should be used in conjunction with '''onClientRender''' in order to display continuously.
*[[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.
*[[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.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxFade]] » This function fade-in or fade-out any dxDraw by gradually changing its alpha value.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.
*[[setScreenFlash]] » This function will make the screen flash(like a screenshot).

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getElementZoneFullName]] » This function allows you to retrieve the zone full name of a element.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInAir]] » This function checks if an element is in air or not.
*[[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.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[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.
*[[getPositionInFrontOfElement]] » This function returns position in provided distance away from element, including element's rotation.

=== Events ===
*[[onClientPlayerTimeChange]] » This code implements an event that is triggered when the player's real time change.
*[[onPlayerZoneChange]] » This code implements an event that is triggered when the player enters a new area on the map.
*[[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]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[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.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[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.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenElements]] » Returns the distance between two elements.
*[[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.
*[[getElementRelatedAngle]] » This function returns the related angle between one element to another. This is useful to check which side an element is to another.
*[[getFreeDimension]] » This function get free dimension.
*[[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.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[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.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[RGBToDecimal]] » This function convert RGB to Decimal color.
*[[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.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[splitMultiple]] » This function improves the split function so that multiple characters can be used as the split at character.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[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.

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

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

=====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 ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[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.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.
*[[math.average]] » This function returns the simple arithmetic mean of multiple numbers.
*[[math.absin]] » This function returns a formula representing the just positive half of a sine wave.

=== 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 ===
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[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.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[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.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[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.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[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.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedNearbyWall]] » This function checks if player/ped is nearby a objects like buildings or walls.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]] » This function make a table of players within certain range.
*[[isPlayerActuallyInVehicle]] » This function checks if a player is actually in a vehicle instead of just in the process of entering.
*[[isPlayerHitByVehicle]] » This function cancels event when a element is hit by a vehicle.

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

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[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.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[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.
*[[isVehicleOnFire]] » This function checks if the vehicle is on fire or not.
*[[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.
*[[setVehicleTurnVelocityCenterOfMass]] » This function sets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleHandlingFromText]] » This function sets a vehicle's handling from text.
*[[setVehicleWheelModel]] » This function changes the wheel model of the informed vehicle.

=== 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.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== 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.
*[[compact]] » This function create table containing variables and their values.
*[[getBanBySerial]] » This function returns the ban if the serial is banned.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[isLastExecuteInTimer]] » This function check if the execute is the last execute in the timer.
*[[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.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[svgCreateRoundedRectangle]] » This function creates a rectangle with rounded edges.
*[[debounce]] » This function is removing unwanted input noise.

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

GetBanBySerial

2024-02-21T16:17:33Z

AirNewSCR: Created page with "{{Useful_Function}} <lowercasetitle/> __NOTOC__ This function returns the ban if the serial is banned, otherwise false. ==Syntax== <syntaxhighlight lang="lua">ban getBanBySerial ( string serial )</syntaxhighlight> ===Required Arguments=== * '''serial''': The banned player serial. ==Code== <section name="Server" class="server" show="true"> <syntaxhighlight lang="lua"> function getBanBySerial(serial) local result = false if serial then for _, ban in ipai..."

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban if the serial is banned, otherwise false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanBySerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': The banned player serial.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanBySerial(serial)
local result = false
if serial then
for _, ban in ipairs(getBans()) do
if getBanSerial(ban) == serial then
result = ban
break
end
end
end
return result
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example removes the player's ban from the serial provided.
<syntaxhighlight lang="lua">
addCommandHandler("unban", function(source, _, serial)
if not serial then
outputChatBox("The command is /unban serial", source, 255, 0, 0)
return
end
local ban = getBanBySerial(serial)
if ban then
removeBan(ban, source)
outputChatBox("The serial "..serial.." has been unbanned!", source, 255, 0, 0)
else
outputChatBox("This serial is not banned!", source, 255, 0, 0)
end
end)
</syntaxhighlight>
</section>

Author: AirNewSCR

==See Also==
{{Useful_Functions}}

GetResourceRootElement

2023-12-17T04:52:25Z

AirNewSCR:

__NOTOC__
{{Shared function}}
{{Disabled}}
{{New feature/item|3.0160|1.6|7485|
}}

GetResourceRootElement

2023-12-17T04:52:17Z

AirNewSCR: Replaced content with "__NOTOC__ {{Shared function}} {{Disabled}} {{New feature/item|3.0160|1.6|7485| Sets the track of a train }}"

__NOTOC__
{{Shared function}}
{{Disabled}}
{{New feature/item|3.0160|1.6|7485|
Sets the track of a train
}}

Installing and Running MTASA Server on GNU Linux

2023-12-13T05:18:16Z

AirNewSCR: Added another URL to download latest resources.

== Installation 64 bit ==

=== Main binary ===
Download the latest stable 64 bit Linux binaries:
rm -f multitheftauto_linux_x64.tar.gz
wget <nowiki>https</nowiki>://linux.mtasa.com/dl/multitheftauto_linux_x64.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux_x64.tar.gz

=== Default config ===
Download the default config files:
rm -f baseconfig.tar.gz
wget <nowiki>https</nowiki>://linux.mtasa.com/dl/baseconfig.tar.gz

Unpack and move into the deathmatch directory: 
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig.tar.gz
mv baseconfig/* multitheftauto_linux_x64/mods/deathmatch

Change to the MTA server install directory:
cd multitheftauto_linux_x64

=== Test ===
You can now test if the server will start correctly:
./mta-server64
If your server comes up with issues such as:
libtinfo.so.5: cannot open shared object file: No such file or directory
you may have either a newer or older version of the Shared Object file.
In such cases, it is warranted to create a symbolic link with that same name to the newer or older Shared Object file, with for example:
sudo ln -s /usr/lib/libtinfo.so.6 /usr/lib/libtinfo.so.5
Of course, the location of these files could depend on your distribution of GNU/Linux; refer to your distribution's documentation on the location of the files.

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from https://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
 
'''Make sure you are in the MTA server install directory when following this example:'''
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm -f mtasa-resources-latest.zip

wget <nowiki>https</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
'''OR'''
wget <nowiki>https</nowiki>://mirror.multitheftauto.com/mtasa/resources/mtasa-resources-latest.zip

unzip mtasa-resources-latest.zip
rm -f mtasa-resources-latest.zip
cd ../../..

== Installation 32 bit ==

=== Main binary===
Download the latest stable 32 bit Linux binaries:
rm -f multitheftauto_linux.tar.gz
wget <nowiki>https</nowiki>://linux.mtasa.com/dl/multitheftauto_linux.tar.gz

Unpack into a directory:
tar -xf multitheftauto_linux.tar.gz

=== Default config ===
Download the default config files:
rm -f baseconfig.tar.gz
wget <nowiki>https</nowiki>://linux.mtasa.com/dl/baseconfig.tar.gz

Unpack and move into the deathmatch directory: 
('''''Note:''' Only do this for new installations as it will overwrite any existing config files.)''
tar -xf baseconfig.tar.gz
mv baseconfig/* multitheftauto_linux/mods/deathmatch

Change to the MTA server install directory:
cd multitheftauto_linux

=== Test ===
You can now test if the server will start correctly:
./mta-server

=== Default resources ===
If you need the default resources:
Download the latest default resources zip from https://mirror.mtasa.com/mtasa/resources/
and unzip into '''mods/deathmatch/resources'''
 
'''Make sure you are in the MTA server install directory when following this example:'''
apt-get install unzip
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
rm -f mtasa-resources-latest.zip

wget <nowiki>https</nowiki>://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
'''OR'''
wget <nowiki>https</nowiki>://mirror.multitheftauto.com/mtasa/resources/mtasa-resources-latest.zip

unzip mtasa-resources-latest.zip
rm -f mtasa-resources-latest.zip
cd ../../..

== Running with 32 or 64 bit Linux==
=== Make sure your server libraries and stuff are up to date ===
On Debian/Ubuntu this is done with:
apt-get update
apt-get upgrade

===Troubleshooting===
* If you get a problem with such as "libreadline.so.5: cannot open shared object file: No such file or directory.", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libreadline5

* If you get a problem with such as "libncursesw.so.5 cannot open shared object file: No such file or directory", it can be solved on 32 bit Debian/Ubuntu by doing this:

apt-get install libncursesw5

'''Note:''' If you experience this issue on a 64-bit machine while trying to run the 32-bit MTA server, then you should install the following package on a 64-bit Debian/Ubuntu machine (as root):

apt-get install lib32ncursesw5

You can find more 32-bit library alternatives on this page: [https://www.debian.org/distrib/packages#search_contents www.debian.org/distrib/packages#search_contents].

== MySQL Troubleshooting==
* If you are using the inbuilt MySQL functions such as [[dbConnect]] and [[dbQuery]], you will need to have '''libmysqlclient.so.16''' installed.
* If you get a problem with such as "libmysqlclient.so.16: cannot open shared object file: No such file or directory", it can be solved on Debian/Ubuntu by doing this:

apt-get install libmysqlclient16

If that fails:
* For 32 bit Linux, download [https://nightly.mtasa.com/files/modules/32/libmysqlclient.so.16 32 bit libmysqlclient.so.16] and put it in '''/usr/lib/'''
* For 64 bit Linux, download [https://nightly.mtasa.com/files/modules/64/libmysqlclient.so.16 64 bit libmysqlclient.so.16] and put it in '''/usr/lib/'''

==[Optional] Installing and Configuring an External Web Server==
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]

== Server crashes ==

If your Linux server crashes, please obtain a backtrace and post a report on our [https://github.com/multitheftauto/mtasa-blue/issues Bug tracker]

====To obtain a backtrace:====
===Do you have a core dump file in the the MTA server directory?===
It's usually called 'core', and usually over 100MB, and looks something like this:
[[Image:Core.png]]
====If you have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA install directory do this command
gdb mta-server -c core
*When gdb launches, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

====If you do not have a core dump file in the the MTA server directory:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb -ex "set print thread-events off" --eval-command run --args mta-server -q
*Now wait for a crash. (Ignore any weird screen output in the meantime)
*When a crash occurs, do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*Save the output
*(To exit gdb, use the quit command)

== '''Server freezes''' ==

If your Linux server freezes, please obtain a backtrace with thread information and post a report on our [https://bugs.mtasa.com/ Bug tracker]

====To obtain a backtrace with thread information:====
*Install gdb. To install gdb on Debian, use this command:
apt-get install gdb
*And from the MTA server directory start the mta-server like this:
gdb -ex "set print thread-events off" --eval-command run --args mta-server -q
*Now wait for a freeze. (Ignore any weird screen output in the meantime)
*When a freeze occurs, press ctrl-c to start gdb
*Then do this command to get a module list:
i sh
*And then this command to get a backtrace:
bt
*And then this command to get thread information:
info threads
*Save the output
*(To exit gdb, use the quit command)

== Automatic installer ==

=== Prerequisites ===
Make sure you have bash, unzip, tar and wget available on your server.
Also notice that for 64-bit servers the 64-bit binary will be installed, otherwise 32-bit binary will be.

=== Source code ===
#!/bin/bash -x
#==============================================================================#
# mtasa-install #
#------------------------------------------------------------------------------#
# This shellscript installs MTA:SA on your server. You can configure it and #
# modify it as desired, you can even improve it if you want. #
#==============================================================================#

ARCH_TYPE=""

getArchitecture()
{
if ((1<<32)); then
ARCH_TYPE="_x64"
fi
}

downloadFiles()
{
wget https://linux.mtasa.com/dl/multitheftauto_linux${ARCH_TYPE}.tar.gz
wget https://linux.mtasa.com/dl/baseconfig.tar.gz
}

unpack()
{
tar -xf multitheftauto_linux${ARCH_TYPE}.tar.gz
tar -xf baseconfig.tar.gz
}

moveConfig()
{
mv baseconfig/* multitheftauto_linux${ARCH_TYPE}/mods/deathmatch
rm -rf baseconfig
cd multitheftauto_linux${ARCH_TYPE}
}

installResources()
{
mkdir mods/deathmatch/resources
cd mods/deathmatch/resources
wget https://mirror.mtasa.com/mtasa/resources/mtasa-resources-latest.zip
unzip mtasa-resources-latest.zip
cd ../../..
}

clean()
{
rm -f ../multitheftauto_linux${ARCH_TYPE}.tar.gz
rm -f ../baseconfig.tar.gz
rm -f mods/deathmatch/resources/mtasa-resources-latest.zip
}

main()
{
getArchitecture
clean
downloadFiles
unpack
moveConfig
installResources
clean

if ((1<<32)); then # 64 bits
echo "Installation ready! Use ./mta-server64 to initialize server"
else
echo "Installation ready! Use ./mta-server to initialize server"
fi
}

main # calling program entry point

=== Procedure ===
To proceed with installation, save somewhere with read-write-execute access (777) the mtasa-install shell. Finally, proceed to execute it (./mtasa-install for example).

=== Alternative way to install server ===
https://linuxgsm.com/lgsm/mtaserver/

SetCameraDrunkLevel

2023-07-21T19:16:58Z

AirNewSCR:

{{Client function}}{{Important Note|This function usually presents bugs when trying to return the state to 0 (normal).}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|21795|This function sets the camera drunk level (as seen on the ''Are you going to San Fierro?'' singleplayer mission). This function was renamed from [[setCameraShakeLevel]].}}

Drunk effect is a wavy motion of the camera depicting the player being drunk. This function used to be called [[setCameraShakeLevel]] which has since been deprecated.

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraDrunkLevel ( int shakeLevel )
</syntaxhighlight>

===Required arguments===
*'''drunkLevel''': an integer between 0 and 255, which represents the camera drunk intensity level.

===Returns===
Returns ''true'' if the camera drunk level was changed, ''false'' if the required argument is incorrect or missing.

==Example==
This example adds a ''/camdrunk'' command which allows any player to manually change its camera drunk level.
<syntaxhighlight lang="lua">
addCommandHandler( "camdrunk",
function( _, level )
local level = math.floor( level )
if level and level >= 0 and level <= 255 then
setCameraDrunkLevel( level )
outputChatBox( "Camera drunk level updated to " .. level .. "." )
else
outputChatBox( "Camera drunk level must be between 0 and 255." )
end
end
)
</syntaxhighlight>

==See also==
{{Client_camera_functions}}

SetCameraDrunkLevel

2023-07-21T19:15:39Z

AirNewSCR:

{{Client function}}
__NOTOC__
{{Important Note|This function usually presents bugs when trying to return the state to 0 (normal).}}
{{New feature/item|3.0161|1.6.0|21795|This function sets the camera drunk level (as seen on the ''Are you going to San Fierro?'' singleplayer mission). This function was renamed from [[setCameraShakeLevel]].}}

Drunk effect is a wavy motion of the camera depicting the player being drunk. This function used to be called [[setCameraShakeLevel]] which has since been deprecated.

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraDrunkLevel ( int shakeLevel )
</syntaxhighlight>

===Required arguments===
*'''drunkLevel''': an integer between 0 and 255, which represents the camera drunk intensity level.

===Returns===
Returns ''true'' if the camera drunk level was changed, ''false'' if the required argument is incorrect or missing.

==Example==
This example adds a ''/camdrunk'' command which allows any player to manually change its camera drunk level.
<syntaxhighlight lang="lua">
addCommandHandler( "camdrunk",
function( _, level )
local level = math.floor( level )
if level and level >= 0 and level <= 255 then
setCameraDrunkLevel( level )
outputChatBox( "Camera drunk level updated to " .. level .. "." )
else
outputChatBox( "Camera drunk level must be between 0 and 255." )
end
end
)
</syntaxhighlight>

==See also==
{{Client_camera_functions}}

HandlingSetBrakeDeceleration

2023-07-13T20:26:58Z

AirNewSCR:

__NOTOC__
{{Server function}}
{{Disabled}}
Sets the brake deceleration of a handling element. This determines how strongly a vehicle can lock its wheels when braking. High values will allow cars to immediately lock their wheels and cause skidding. Low values will merely slow down the wheels.

==Syntax==
<syntaxhighlight lang="lua">
bool handlingSetBrakeDeceleration ( handling theHandling, float deceleration )
</syntaxhighlight>

===Required Arguments===
*'''theHandling:''' the handling of which you want to change the brake deceleration.
*'''deceleration:''' the brake decelertion to set.

===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
Select a player and damage its vehicle's brakes
<syntaxhighlight lang="lua">
function damageBreaks()
local player = getPlayerFromName("David") -- get a player
local vehicle = getPedOccupiedVehicle(player) -- get the vehicle David is in
handlingSetBrakeDeceleration(vehicle, 0.08) -- reduce brake's strength
outputChatBox("Your brakes are damaged. Drive careful!", player, 255, 0, 0)
end
</syntaxhighlight>

==See Also==
{{Handling_functions}}

Template:Useful Functions

2023-07-10T16:47:24Z

AirNewSCR: /* Vehicle functions */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[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.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[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.toString]] » This function converts table to a string.

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

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

=== Colshape functions ===
*[[createGarageColShape]] » This function creates a collision shape from the specified garage.

=== 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.
*[[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.
*[[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.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[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.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.
*[[setScreenFlash]] » This function will make the screen flash(like a screenshot).

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[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.
*[[isElementInAir]]» This function checks if an element is in air or not.
*[[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.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.

=== 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]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[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.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[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.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenElements]] » Returns the distance between two elements.
*[[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.
*[[getElementRelatedAngle]] » This function returns the related angle between one element to another. This is useful to check which side an element is to another.
*[[getFreeDimension]] » This function get free dimension.
*[[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.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[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.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[RGBToDecimal]] » This function convert RGB to Decimal color.
*[[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.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[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.

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

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

=====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 ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[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.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.
*[[math.average]] » This function returns the simple arithmetic mean of multiple numbers.

=== 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.
*[[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.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[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.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[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.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[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.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]]» This function make a table of players within certain range.
*[[isPlayerActuallyInVehicle]]» This function checks if a player is actually in a vehicle instead of just in the process of entering.
*[[isPlayerHitByVehicle]]» This function cancels event when a element is hit by a vehicle.
*[[warpToPlayer]]» This function make player warp to another player.

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

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[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.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[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.
*[[isVehicleOnFire]] » This function checks if the vehicle is on fire or not.
*[[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.
*[[setVehicleTurnVelocityCenterOfMass]] » This function sets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleHandlingFromText]] » This function sets a vehicle's handling from text.
*[[setVehicleWheelModel]] » This function changes the wheel model of the informed vehicle.

=== 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.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== 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.
*[[compact]] » This function create table containing variables and their values.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[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.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[svgCreateRoundedRectangle]] » This function creates a rectangle with rounded edges.

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

SetVehicleWheelModel

2023-07-10T16:47:19Z

AirNewSCR:

{{Useful_Function}} __NOTOC__
This function changes the wheel model of the informed vehicle.
==Syntax==
<syntaxhighlight lang="lua">
int setVehicleWheelModel(element veh, int wheelId)
</syntaxhighlight>

==Required arguments==
* '''veh''': The vehicle you want to change the wheel.
* '''wheelId''': The ID of the new wheel you want.

==Returns==
Returns the ID of the new wheel if successfully changed, otherwise it returns false.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelModel(veh, wheelId)
if veh and isElement(veh) then
if validWheels[tonumber(wheelId)] then
local success = addVehicleUpgrade(veh, tonumber(wheelId))
if success then
return wheelId
end
end
end
return false
end
</syntaxhighlight></section>
'''Author:''' AirNewSCR

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("wset", function(player, _, wheelId)
if wheelId and tonumber(wheelId) then
local veh = getPedOccupiedVehicle(player)
if veh and isElement(veh) then
local result = setVehicleWheelModel(veh, wheelId)
if result then
outputChatBox("Wheel id is now "..result, player, 0, 255, 0)
else
outputChatBox("Error!", player, 255, 0, 0)
end
end
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2023-07-10T16:46:08Z

AirNewSCR: /* Vehicle functions */

__NOTOC__
=== Table functions ===
*[[addTableChangeHandler]] » This function monitors the changes of a table.
*[[getTableFromSql]] » This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).
*[[isValueInTable]] » This function returns true if the value exists in the table, false if the value does not exist in the table.
*[[pairsByKeys]] » This function sort pairs table.
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setTableToSql]] » This function is used to save the table in the database (sql).
*[[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.deepmerge]] » This function deep merges two tables. Every nested table will be correspondingly merged.
*[[table.element]] » This function returns a new table with only userdata content.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.fromString]] » This function converts string to a table.
*[[table.getRandomRows]] » This function returns random rows from table.
*[[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.toString]] » This function converts table to a string.

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

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

=== Colshape functions ===
*[[createGarageColShape]] » This function creates a collision shape from the specified garage.

=== 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.
*[[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.
*[[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.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[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.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

=== Effects functions ===
*[[attachEffect]] » This function allows you attach an effect to an element.
*[[setScreenFlash]] » This function will make the screen flash(like a screenshot).

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[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.
*[[isElementInAir]]» This function checks if an element is in air or not.
*[[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.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.

=== 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]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

=== Data functions ===
*[[byte2human]] » This function converts an integer (number of bytes) into a human-readable unit.
*[[capitalize]] » This function capitalizes a given string.
*[[convertDate]] » This function converts date to another look.
*[[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.
*[[findRotation3D]] » This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.
*[[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.
*[[formatNumber]] » This function formats large numbers by adding commas.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[generateString]] » This function generates a random string with any characters.
*[[getAge]] » This function calculates the age of a given birthday.
*[[getDistanceBetweenElements]] » Returns the distance between two elements.
*[[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.
*[[getElementRelatedAngle]] » This function returns the related angle between one element to another. This is useful to check which side an element is to another.
*[[getFreeDimension]] » This function get free dimension.
*[[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.
*[[hex2rgb]] » This function convert hex to rgb.
*[[hexColorToRGB]] » This function convert hex string/number to RGBA values.
*[[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.
*[[RGBToHSV]] » This function convert RGB to HSV color space.
*[[RGBToDecimal]] » This function convert RGB to Decimal color.
*[[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.
*[[string.insert]] » This function inserts a string within another string at a given position.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[tocolor2rgba]] » This function convert tocolor to rgba.
*[[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.

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

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

=====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 ===
*[[math.clamp]] » This function returns the number between range of numbers or it's minimum or maximum.
*[[math.getBezierPoint]] » Get N-th order bezier point.
*[[math.hypot]] » This function returns the Hypotenuse of the triangle given by sides x and y.
*[[math.isPointInPolygon]] » Check if point is inside polygon or not.
*[[math.lerp]] » Get val between two integer.
*[[math.percent]] » This function returns a percentage from two number values.
*[[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.rotVecToEulerAngle]] » Rotation Vector To Euler Angle
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[reMap]] » Re-maps a number from one range to another.
*[[Math.percentProgress|math.percentProgress]] » Returns a percentage progress from two specific values.
*[[math.average]] » This function returns the simple arithmetic mean of multiple numbers.

=== 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.
*[[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.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[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.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[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.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[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.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[getPlayerPreviousAndNextWeapon]] » This function returns the player previous and next weapon.
*[[getPlayersInRange]]» This function make a table of players within certain range.
*[[isPlayerActuallyInVehicle]]» This function checks if a player is actually in a vehicle instead of just in the process of entering.
*[[isPlayerHitByVehicle]]» This function cancels event when a element is hit by a vehicle.
*[[warpToPlayer]]» This function make player warp to another player.

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

=== Sound functions ===
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[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.
*[[getVehicleTurnVelocityCenterOfMass]]» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[isVehicleDoubleExhaust]] » This function checks is exhaust vehicle double.
*[[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.
*[[isVehicleOnFire]] » This function checks if the vehicle is on fire or not.
*[[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.
*[[setVehicleTurnVelocityCenterOfMass]]» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.
*[[setVehicleHandlingFromText]]» This function sets a vehicle's handling from text.
*[[setVehicleWheelModel]]» This function changes the wheel model of the informed vehicle.

=== 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.
*[[isElementObject]] » This function tells you if an element is an object or no.

=== 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.
*[[compact]] » This function create table containing variables and their values.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getSkinNameFromID]] » This function returns the name of the skin from the given id.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCharInString]] » This shared function allows you to check if a char specified is in a string value.
*[[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.
*[[PlotTrajectoryAtTime]] » Calculate projectile/water trajectory.
*[[preprocessor]] » This function allow you to use gcc macros.
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.
*[[svgCreateRoundedRectangle]] » This function creates a rectangle with rounded edges.

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

SetVehicleWheelModel

2023-07-10T16:45:13Z

AirNewSCR:

{{Useful_Function}} __NOTOC__
This function changes the wheel model of the informed vehicle.
==Syntax==
<syntaxhighlight lang="lua">
int setVehicleWheelsModel(element veh, int wheelId)
</syntaxhighlight>

==Required arguments==
* '''veh''': The vehicle you want to change the wheel.
* '''wheelId''': The ID of the new wheel you want.

==Returns==
Returns the ID of the new wheel if successfully changed, otherwise it returns false.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelModel(veh, wheelId)
if veh and isElement(veh) then
if validWheels[tonumber(wheelId)] then
local success = addVehicleUpgrade(veh, tonumber(wheelId))
if success then
return wheelId
end
end
end
return false
end
</syntaxhighlight></section>
'''Author:''' AirNewSCR

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("wset", function(player, _, wheelId)
if wheelId and tonumber(wheelId) then
local veh = getPedOccupiedVehicle(player)
if veh and isElement(veh) then
local result = setVehicleWheelModel(veh, wheelId)
if result then
outputChatBox("Wheel id is now "..result, player, 0, 255, 0)
else
outputChatBox("Error!", player, 255, 0, 0)
end
end
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetVehicleWheelModel

2023-07-10T02:57:07Z

AirNewSCR:

{{Useful_Function}} __NOTOC__
This function changes the wheel model of the informed vehicle.
==Syntax==
<syntaxhighlight lang="lua">
int setVehicleWheelsModel(element veh, int wheelId)
</syntaxhighlight>

==Required arguments==
* '''veh''': The vehicle you want to change the wheel.
* '''wheelId''': The ID of the new wheel you want.

==Returns==
Returns the ID of the new wheel if successfully changed, otherwise it returns false.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelsModel(veh, wheelId)
if veh and isElement(veh) then
if validWheels[tonumber(wheelId)] then
local success = addVehicleUpgrade(veh, tonumber(wheelId))
if success then
return wheelId
end
end
end
return false
end
</syntaxhighlight></section>
'''Author:''' AirNewSCR

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("wset", function(player, _, wheelId)
if wheelId and tonumber(wheelId) then
local veh = getPedOccupiedVehicle(player)
if veh and isElement(veh) then
local result = setVehicleWheelsModel(veh, wheelId)
if result then
outputChatBox("Wheel id is now "..result, player, 0, 255, 0)
else
outputChatBox("Error!", player, 255, 0, 0)
end
end
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetVehicleWheelModel

2023-07-10T02:56:39Z

AirNewSCR:

{{Useful_Function}} __NOTOC__
This function changes the wheel model of the informed vehicle.
==Syntax==
<syntaxhighlight lang="lua">
int setVehicleWheelsModel(element veh, int wheelId)
</syntaxhighlight>

==Required arguments==
* '''veh''': The vehicle you want to change the wheel.
* '''wheelId''': The ID of the new wheel you want.

==Returns==
Returns the ID of the new wheel if successfully changed, otherwise it returns false.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelsModel(veh, wheelId)
if veh and isElement(veh) then
if validWheels[tonumber(wheelId)] then
local success = addVehicleUpgrade(veh, tonumber(wheelId))
if success then
return wheelId
end
end
end
return false
end
</syntaxhighlight></section>
'''Author:''' AirNewSCR

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("wset", function(player, _, wheelId)
if wheelId and tonumber(wheelId) then
local veh = getPedOccupiedVehicle(player)
if veh and isElement(veh) then
local result = setVehicleWheelsModel(veh, wheelId)
if result then
outputChatBox("Wheel id is now 1000", player, 0, 255, 0)
else
outputChatBox("Error!", player, 255, 0, 0)
end
end
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetVehicleWheelModel

2023-07-10T02:55:26Z

AirNewSCR:

{{Useful_Function}} __NOTOC__
This function changes the wheel model of the informed vehicle.
==Syntax==
<syntaxhighlight lang="lua">
int setVehicleWheelsModel(element veh, int wheelId)
</syntaxhighlight>

==Required arguments==
* '''veh''': The vehicle you want to change the wheel.
* '''wheelId''': The ID of the new wheel you want.

==Returns==
Returns the ID of the new wheel if successfully changed, otherwise it returns false.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelsModel(veh, wheelId)
if veh and isElement(veh) then
if validWheels[tonumber(wheelId)] then
local success = addVehicleUpgrade(veh, tonumber(wheelId))
if success then
return wheelId
end
end
end
return false
end
</syntaxhighlight></section>
'''Author:''' AirNewSCR

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("wset", function(player, _, wheelId)
if wheelId and tonumber(wheelId) then
local veh = getPedOccupiedVehicle(player)
if veh and isElement(veh) then
local result = setVehicleWheelsModel(veh, wheelId)
if result then
outputChatBox("Wheel id is now 1000", player, 0, 255, 0)
else
outputChatBox("Error!", player, 255, 0, 0)
end
end
end
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetVehicleWheelModel

2023-07-10T02:38:44Z

AirNewSCR: /* Code */

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
validWheels = {[1025] = true, [1073] = true, [1074] = true, [1075] = true, [1076] = true, [1077] = true, [1078] = true, [1079] = true, [1080] = true, [1081] = true, [1082] = true, [1083] = true, [1084] = true, [1085] = true, [1096] = true, [1097] = true, [1098] = true}

function setVehicleWheelsModel(veh, model)
if veh and isElement(veh) then
if validWheels[tonumber(model)] then
addVehicleUpgrade(veh, tonumber(model))
return true
end
end
return false
end
</syntaxhighlight></section>

GetNearestElement

2023-04-30T19:37:11Z

AirNewSCR: for better processing without using getElementsByType, avoiding a large "for" that can cause server delay.

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

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

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

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(player, type, distance)
local result = false
local dist = nil
if player and isElement(player) then
local elements = getElementsWithinRange(Vector3(getElementPosition(player)), distance, type, getElementInterior(player), getElementDimension(player))
for i = 1, #elements do
local element = elements[i]
if not dist then
result = element
dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
else
local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
if newDist <= dist then
result = element
dist = newDist
end
end
end
end
return result
end
</syntaxhighlight></section>

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

Modified version of [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}