Multi Theft Auto: Wiki - User contributions [en]

GuiCreateButton

2025-11-26T09:06:08Z

Tails: /* Example */

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.
==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.

===Optional Arguments===
{{OptionalArg}}
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an [[element]] of the created [[Element/GUI/Button|button]] if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
-- Create a simple button
local myButton = guiCreateButton(0.30, 0.15, 0.05, 0.03, "Click me", true)

-- Attach a click event to the button to change its text
addEventHandler("onClientGUIClick", myButton, function()
guiSetText(myButton, "Clicked!")
end)
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Custom chat input
local myButton = guiCreateButton(0.30, 0.20, 0.05, 0.03, "Send", true)
local myInput = guiCreateEdit(0.36, 0.20, 0.13, 0.03, "", true)

addEventHandler("onClientGUIClick", myButton, function()
local myText = guiGetText(myInput, "") -- Grab the input value
if myText ~= "" then -- Make sure the input not empty
outputChatBox(myText)
guiSetText(myInput, "") -- Clear the input
end
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]
{{GUI_events}}

GuiCreateButton

2025-11-26T09:05:36Z

Tails: /* Example */

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.
==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.

===Optional Arguments===
{{OptionalArg}}
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an [[element]] of the created [[Element/GUI/Button|button]] if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
-- Create a simple button
local myButton = guiCreateButton(0.30, 0.15, 0.05, 0.03, "Click me", true)

-- Attach a click event to the button to change its text
addEventHandler("onClientGUIClick", myButton, function()
guiSetText(myButton, "Clicked!")
end)
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Custom chat input
local myButton = guiCreateButton(0.30, 0.20, 0.05, 0.03, "Click me", true)
local myInput = guiCreateEdit(0.36, 0.20, 0.13, 0.03, "", true)

addEventHandler("onClientGUIClick", myButton, function()
local myText = guiGetText(myInput, "") -- Grab the input value
if myText ~= "" then -- Make sure the input not empty
outputChatBox(myText)
guiSetText(myInput, "") -- Clear the input
end
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]
{{GUI_events}}

GuiCreateButton

2025-11-26T09:04:37Z

Tails: /* Example */

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.
==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.

===Optional Arguments===
{{OptionalArg}}
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an [[element]] of the created [[Element/GUI/Button|button]] if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
-- Create a simple button
local myButton = guiCreateButton(0.30, 0.15, 0.05, 0.03, "Click me", true)

-- Attach a click event to the button to change its text
addEventHandler("onClientGUIClick", myButton, function()
guiSetText(myButton, "Clicked!")
end)
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Chat example
local myButton = guiCreateButton(0.30, 0.20, 0.05, 0.03, "Click me", true)
local myInput = guiCreateEdit(0.36, 0.20, 0.13, 0.03, "", true)

addEventHandler("onClientGUIClick", myButton, function()
local myText = guiGetText(myInput, "") -- Grab the input value
if myText ~= "" then -- Make sure the input not empty
outputChatBox(myText)
guiSetText(myInput, "") -- Clear the input
end
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]
{{GUI_events}}

OnClientRender

2025-03-28T14:04:55Z

Tails:

__NOTOC__
{{Client event}}
This event is triggered every time GTA renders a new frame. It is required for the DirectX drawing functions, and also useful for other clientside operations that have to be applied repeatedly with very short time differences between them.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way. This will be a little bit laggy. If you want the camera to follow something (eg. player or vehicle) then use [[onClientPreRender]] instead.
<syntaxhighlight lang="lua">
function updateCamera()
local x, y, z = getElementPosition(localPlayer)
setCameraMatrix(x, y, z + 50, x, y, z)
end
addEventHandler("onClientRender", root, updateCamera)
</syntaxhighlight>

==Warning==
This event and [[onClientPreRender]] will trigger whatever function it is attached to with every frame. Depending on the server's maximum FPS and what your computer might handle - you might end up triggering the function 30-60 times '''per second'''.

As a result, this event may cause severe lag and/or even crashes if not used cautiously.

==See Also==
===[[Game_Processing_Order|Game Processing Order]]===
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

DxDrawLine

2025-03-28T14:00:11Z

Tails: /* Example */

__NOTOC__
{{Client function}}
This function draws a 2D line across the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawLine ( int startX, int startY, int endX, int endY, int color [, float width = 1.0, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
* '''startX:''' An integer representing the '''absolute''' start X position of the line, represented by pixels on the screen.
* '''startY:''' An integer representing the '''absolute''' start Y position of the line, represented by pixels on the screen.
* '''endX:''' An integer representing the '''absolute''' end X position of the line, represented by pixels on the screen.
* '''endY:''' An integer representing the '''absolute''' end Y position of the line, represented by pixels on the screen.
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

==Optional Arguments==
{{OptionalArg}}
* '''width:''' The width/thickness of the line
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Example==
This example draws an 'X' across the screen.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize()
local lineColor = tocolor(255, 0, 0)
function drawLinesAcrossScreen()
dxDrawLine(0, 0, screenWidth, screenHeight, lineColor)
dxDrawLine(screenWidth, 0, 0, screenHeight, lineColor)
end
addEventHandler("onClientRender", root, drawLinesAcrossScreen)
</syntaxhighlight>

This example draws a couple of circles
<syntaxhighlight lang="lua">
function drawCircle(x,y, radius, color)
local numPoints = math.floor(math.pow(radius, 0.4) * 5) -- Calculate number of points to make it look good
local step = math.pi * 2 / numPoints
local sx,sy
for p=0,numPoints do
local ex = math.cos(p * step) * radius
local ey = math.sin(p * step) * radius
if sx then
dxDrawLine(x+sx, y+sy, x+ex, y+ey, color)
end
sx,sy = ex,ey
end
end

addEventHandler("onClientRender", root, function()
drawCircle(350, 350, 10, tocolor(255,0,255))
drawCircle(350, 350, 50, tocolor(255,0,255))
end)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxDrawLine]]

AddCommandHandler

2024-01-29T01:59:07Z

Tails:

__NOTOC__
{{Server client function}}
{{Important Note|Do '''NOT''' use the same name for your handler function as the command name, as this can lead to confusion if multiple handler functions are used. Use a name that describes your handler's purpose more specifically.}}
This function will attach a scripting function (handler) to a console command, so that whenever a player or administrator uses the command the function is called.

Multiple command handlers can be attached to a single command, and they will be called in the order that the handlers were attached. Equally, multiple commands can be handled by a single function, and the ''commandName'' parameter used to decide the course of action.

For users, a command is in the format:

''commandName'' ''argument1'' ''argument2''

This can be triggered from the player's console or directly from the chat box by prefixing the message with a forward slash (''/''). For server side handlers, the server admin is also able to trigger these directly from the server's console in the same way as they are triggered from a player's console.
{{Note|You can't use "check", "list", "test" and "help" as a command name.}}

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters as you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
*'''restricted:''' Specify whether or not this command should be restricted by default. Use this on commands that should be inaccessible to everyone as default except special users specified in the ACL (Access Control List). This is to make sure admin commands such as ie. 'punish' won't be available to everyone if a server administrator forgets masking it in ACL. Make sure to add the command to your ACL under the proper group for it to be usefull (i.e <right name="command.killEveryone" access="true"></right>). This argument defaults to false if nothing is specified.
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )
</syntaxhighlight>

===Required Arguments===
*'''commandName:''' This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
*'''handlerFunction:''' This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take commandName parameter, followed by as many parameters as you expect after your command (see below). These are all optional.
===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' Specifies if the command handler will ignore the case for this command name.
}}
</section>

====Handler function parameters====
These are the parameters for the handler function that is called when the command is used.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>

* '''playerSource:''' The player who triggered the command or the [[Element/Console|server console]]. If not triggered by a player (e.g. by admin) or server console, this will be ''false''.
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Server Example 2''' below.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>
* '''commandName:''' The name of the command triggered. This is useful if multiple commands go through one function.
* '''arg1, arg2, ...:''' Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain [[nil]]. You can deal with a variable number of arguments using the vararg expression, as shown in '''Server Example 2''' below.
</section>

===Returns===
Returns ''true'' if the command handler was added successfully, ''false'' otherwise.

==Examples==
<section name="Server" class="server" show="true">
'''Example 1:''' This example defines a command handler for the command ''createmarker''. This will create a red marker at the position of the player player who uses it.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command
function consoleCreateMarker ( playerSource, commandName )
-- If a player triggered it (rather than the admin) then
if ( playerSource ) then
-- Get that player's position
local x, y, z = getElementPosition ( playerSource )
-- Create a size 2, red checkpoint marker at their position
createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
-- Output it in his chat box
outputChatBox ( "You got a red marker", playerSource )
end
end
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
addCommandHandler ( "createmarker", consoleCreateMarker )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="hide">
'''Example 2:''' This example makes use of Lua's vararg expression to implement a ''check_parameters'' command to count the number of parameters passed, merge them all into a single string and output it. This is also shows you how you can use table.concat to merge all the passed arguments. This is particularly useful when you want to read in a sentence of text passed from the user.
<syntaxhighlight lang="lua">
-- Define our function that will handle this command (which can accept a variable number of arguments after commandName)
function consoleCheckParameters ( playerSource, commandName, ... )
-- If a player, not an admin, triggered it,
if playerSource then
local arg = {...}
-- Get the number of arguments in the arg table (arg table is the same as: {...})
local parameterCount = #arg
-- Output it to the player's chatbox
outputChatBox ( "Number of parameters: " .. parameterCount, playerSource )
-- Join them together in a single comma-separated string
local stringWithAllParameters = table.concat( arg, ", " )
-- Output this parameter list to the player's chatbox
outputChatBox ( "Parameters passed: " .. stringWithAllParameters, playerSource )
end
end
-- Attach the 'consoleCheckParameters' function to the "check_parameters" command
addCommandHandler ( "check_parameters", consoleCheckParameters )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="hide">
'''Example 3:''' This example shows using a single function to handle multiple command handlers. This isn't advised for general usage, as it makes code harder to understand, but where multiple command handlers share some logic, it can be a useful way of reducing duplicated code. Generally, it would be preferable to put this shared logic in a separate function instead, as this gives you more control over the flow.

<syntaxhighlight lang="lua">
-- make the function
function moneyCmd(player, commandName, amount)
if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
if commandName == "givemoney" then
amount = tonumber(amount)
if amount then
givePlayerMoney(player, amount)
else
outputChatBox("[usage] /givemoney [amount]", player)
end
else if commandName == "takemoney" then
amount = tonumber(amount)
if amount then
takePlayerMoney(player, amount)
else
outputChatBox("[usage] /takemoney [amount]", player)
end
end
else
outputChatBox("You aren't able to use this command", player)
end
end

addCommandHandler("givemoney", moneyCmd);
addCommandHandler("takemoney", moneyCmd);
</syntaxhighlight>
</section>

<section name="Client" class="client" show="false">
'''Example 1:''' This example warps the local player to a random nearby location (useful for when a player gets stuck somewhere).

<syntaxhighlight lang="lua">function escapeMe ( commandName )
local x, y, z = getElementPosition ( localPlayer ) --Get player's position
setElementPosition ( localPlayer, x+(math.random(-10,10)), y+(math.random(-10,10)), z+(math.random(1,15)) ) --Move a player randomly to a nearby location. X is current x + a number between -10, 10 and so on.
end
addCommandHandler ( "escape", escapeMe ) --When player types "/escape" in chatbox or "escape" in console
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

[[ar:addCommandHandler]]
[[en:addCommandHandler]]
[[hu:addCommandHandler]]
[[pt-br:AddCommandHandler]]

GuiGridListGetColumnCount

2022-12-22T18:05:39Z

Tails: /* Example */

{{Client function}}
__NOTOC__
This allows you to get the count of existing columns in a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListGetColumnCount ( element gridList )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getColumnCount|columnCount}}

===Required Arguments===
*'''gridList:''' The grid list you want to add a column to

===Returns===
Returns an integer with the amount of columns in the gridlist, false otherwise.

<syntaxhighlight lang="lua">
-- create the grid list
local list = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
-- add three columns to the grid list
guiGridListAddColumn(list, "Column 1", 0.33)
guiGridListAddColumn(list, "Column 2", 0.33)
guiGridListAddColumn(list, "Column 3", 0.33)

-- display the number of columns in the grid list in the debug or server console (/debugscript 3)
print("Number of columns: " .. guiGridListGetColumnCount(list))
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiGridListClear

2022-12-22T17:47:52Z

Tails: /* Example */

{{Client function}}
__NOTOC__
This function clears all the data from a grid list.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListClear ( element gridList )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:clear}}

===Required Arguments===
*'''gridList:''' The grid list element to be cleared

===Returns===
Returns ''true'' if the grid list element is valid and has been cleared successfully, ''false'' otherwise.

==Example==
This creates a player list and then clears it when a button is clicked:
<syntaxhighlight lang="lua">
-- create the grid list
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "#", 0.15)
guiGridListAddColumn(playerList, "Player", 0.75)

-- fill the grid list with player names
for index, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, index, getPlayerName(player))
end

-- create a button to clear the grid list
local clearButton = guiCreateButton(0.80, 0.30, 0.15, 0.05, "Clear list", true)

-- when the button is clicked, clear the grid list
addEventHandler("onClientGUIClick", clearButton, function()
guiGridListClear(playerList)
end)
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiGridListClear

2022-12-22T17:47:32Z

Tails: /* Example */

{{Client function}}
__NOTOC__
This function clears all the data from a grid list.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListClear ( element gridList )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:clear}}

===Required Arguments===
*'''gridList:''' The grid list element to be cleared

===Returns===
Returns ''true'' if the grid list element is valid and has been cleared successfully, ''false'' otherwise.

==Example==
Example 1: This creates a player list and then clears it when a button is clicked:
<syntaxhighlight lang="lua">
-- create the grid list
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "#", 0.15)
guiGridListAddColumn(playerList, "Player", 0.75)

-- fill the grid list with player names
for index, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, index, getPlayerName(player))
end

-- create a button to clear the grid list
local clearButton = guiCreateButton(0.80, 0.30, 0.15, 0.05, "Clear list", true)

-- when the button is clicked, clear the grid list
addEventHandler("onClientGUIClick", clearButton, function()
guiGridListClear(playerList)
end)
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

Installing and Running MTASA Server on GNU Linux

2022-01-23T21:35:56Z

Tails: removed spacing in front of shell script (copy paste caused script to not load)

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

DxCreateFont

2020-01-28T23:45:26Z

Tails: update example

{{Client function}}
__NOTOC__
{{Note|The size can't be less than 5 or more than 150}}
 
This function creates a [[DX font]] element that can be used in [[dxDrawText]]. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

To see if creation is likely to fail, use [[dxGetStatus]]. (When '''VideoMemoryFreeForMTA''' is zero, failure ''is'' guaranteed.)
=====It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateFont.=====

==Syntax==
<syntaxhighlight lang="lua">
element dxCreateFont ( string filepath[, int size=9, bool bold=false, string quality="proof" ] )
</syntaxhighlight>
{{OOP||[[DX_font|DxFont]]}}
===Required Arguments===
*'''filepath:''' the name of the file containing the font

===Optional Arguments===
*'''size:''' size of the font
*'''bold:''' flag to indicate if the font should be bold
*'''quality:''' the font quality
** "default": not the actual default
** "draft"
** "proof": the default
** "nonantialiased"
** "antialiased"
** "cleartype"
** "cleartype_natural"

===Returns===
Returns a [[DX font]] element if successful, ''false'' if invalid arguments were passed to the function, or there is insufficient resources available.

'''You should always check to see if this function has returned false.'''

==Example==
<syntaxhighlight lang="lua">
local font = dxCreateFont('myfont.ttf', 20, false, 'proof') or 'default' -- fallback to default

addEventHandler('onClientRender', root, function()
dxDrawText('Example Text', 100, 350, 300, 350, tocolor(255, 255, 0), 1, font)
end)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxCreateFont]]

Template:Useful Functions

2020-01-05T05:02:28Z

Tails: /* Vehicle functions */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[warpToPlayer]]» This function make player warp to another player.

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

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

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

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

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

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

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

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

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

Template:Useful Functions

2020-01-05T05:00:46Z

Tails: /* Utility */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.
*[[warpToPlayer]]» This function make player warp to another player.

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

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

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

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

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

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

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

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

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

FindEmptyCarSeat

2020-01-05T05:00:10Z

Tails: Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ This function allows you to find the first empty seat in a vehicle. Returns false if it did not find an empty s..."

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function allows you to find the first empty seat in a vehicle. Returns false if it did not find an empty seat.

==Syntax==
<syntaxhighlight lang="lua">int findEmptyCarSeat( vehicle vehicle )</syntaxhighlight>

===Required Arguments===
* '''vehicle''': a vehicle element

===Returns===
Returns seat number if there is a seat available, ''false'' otherwise.

==Code==
<section name="Client/Server" class="generic" show="true">
<syntaxhighlight lang="lua">
function findEmptyCarSeat(vehicle)
local max = getVehicleMaxPassengers(vehicle)
local pas = getVehicleOccupants(vehicle)
for i=1, max do
if not pas[i] then
return i
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Client/Server" class="both" show="true">
<syntaxhighlight lang="lua">
local vehicle = getPedOccupiedVehicle(localPlayer)
local seat = findEmptyCarSeat(vehicle)
if seat then
warpPedIntoVehicle(vehicle, seat)
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

GuiGridListGetVerticalScrollPosition

2019-09-27T01:54:09Z

Tails: float > integer

{{client function}}
This function is used to get the vertical scroll position from a grid list

==Syntax==
<syntaxhighlight lang="lua">
float guiGridListGetVerticalScrollPosition( element guiGridlist )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getVerticalScrollPosition|verticalScrollPosition|guiGridListSetVerticalScrollPosition}}

===Required Arguments===
*'''guiGridlist''': The grid list you want to get the vertical scroll position from

===Returns===
Returns a integer between 0 and 100 indicating the vertical scroll position, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
This example gets the position of the vertical scroll and outputs it to the chatbox.
<syntaxhighlight lang="lua">
local gridList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true) -- Create the grid list
local column = guiGridListAddColumn(gridList, "New column", 1) -- Create a new column in the grid list

if gridList then -- if the grid list exist then
local postion = guiGridListGetVerticalScrollPosition(gridList) -- get the vertical scroll position
outputChatBox ( "Current position of the vertical scroll:" ..tostring(position).. "%" ) -- output to the chatbox
else
outputChatBox ("Grid list not found!") -- if the grid list was not found
end
</syntaxhighlight>
==See Also==
{{GUI_functions}}
{{GUI_events}}

GuiGridListGetHorizontalScrollPosition

2019-09-27T01:52:55Z

Tails: float > integer

{{client function}}
This function is used to get the horizontal scroll position from a grid list

==Syntax==
<syntaxhighlight lang="lua">
float guiGridListGetHorizontalScrollPosition( element guiGridlist )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getHorizontalScrollPosition|horizontalScrollPosition|guiGridListSetHorizontalScrollPosition}}

===Required Arguments===
*'''guiGridlist''': The grid list you want to get the horizontal scroll position from

===Returns===
Returns a integer between 0 and 100 indicating the horizontal scroll position, or ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
This example gets the position of the horizontal scroll and outputs it to the chatbox.
<syntaxhighlight lang="lua">
local gridList = guiCreateGridList(0.80, 0.10, 0.15, 0.60, true) -- Create the grid list
local column = guiGridListAddColumn(gridList, "New column", 1) -- Create a new column in the grid list

if gridList then -- if the grid list exist then
local postion = guiGridListGetHorizontalScrollPosition(gridList) -- get the horizontal scroll position
outputChatBox ( "Current position of the horizontal scroll:" ..tostring(position).. "%" ) -- output to the chatbox
else
outputChatBox ("Grid list not found!") -- if the grid list was not found
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

GuiScrollPaneGetHorizontalScrollPosition

2019-09-27T01:49:46Z

Tails: /* Returns */

{{client function}}
This function is used to get the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetHorizontalScrollPosition ( element horizontalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[float]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollPaneGetHorizontalScrollPosition

2019-09-27T01:49:10Z

Tails: Undo revision 55032 by LordHenry (talk)

{{client function}}
This function is used to get the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetHorizontalScrollPosition ( element horizontalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[integer]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollPaneGetHorizontalScrollPosition

2019-09-27T01:48:21Z

Tails: /* Returns */

{{client function}}
This function is used to get the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetHorizontalScrollPosition ( element horizontalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[integer]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

GuiScrollPaneGetHorizontalScrollPosition

2019-09-27T01:47:57Z

Tails: /* Returns */

{{client function}}
This function is used to get the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetHorizontalScrollPosition ( element horizontalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[number]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

Scripting Introduction

2019-09-11T10:02:29Z

Tails: added recommended type="server" to script tags

Resources are a key part of MTA. A resource is essentially a folder or zip file that contains a collection of files, plus a meta file that describes to the server how the resource should be loaded and what files it does contain. A resource can be seen as being partly equivalent to a program running in an operating system - it can be started and stopped, and multiple resources can run at once.

Everything that has to do with scripting happens in resources, what a resource does defines if it is a gamemode, a map or anything else. MTA comes with resources that you can optionally use in your gamemodes, such as maplimits to keep playings within a playing area or deathpickups to create weapon pickups.
{{tip|Your first step to begin Lua scripting should be using an Lua editor. This makes scripting much easier. We recommend [https://code.visualstudio.com/ Visual Studio Code], [http://www.sublimetext.com/ Sublime Text], [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] or [http://luaedit.sourceforge.net/ LuaEdit]. There is also an unofficial [[MTASE|MTA Script Editor]] (in work-in-progress state) that you can test out.}}

==Creating a working script==
We will first learn how to make a basic script that lets the player walk around in the city, step by step.
===Where are all the scripts?===
Let's take a look at the script's file structure. Go to your MTA Server folder, and follow the path below:

server/mods/deathmatch/resources/

You will see a lot of .zip files, which are the packaged sample scripts shipped with MTA. Each file is a "resource", and they will all be unzipped and loaded by the server when it starts. To create your own resource, simply make a folder with your preferred name. We'll use "myserver" for this tutorial.

Now you should be under this directory:

server/mods/deathmatch/resources/myserver/

===Identifying your resource===
In order to let the server know what's in the resource, a ''meta.xml'' file must be created to list the resource's content. It must be located in the resource's root directory, which is the "myserver" folder in our case. So create a text file and name it "meta.xml", and open it with notepad.

Enter the following codes in the ''meta.xml'' file:
<syntaxhighlight lang="xml">
<meta>
<info author="YourName" type="gamemode" name="My Server" description="My first MTA server" />
<script src="script.lua" type="server" />
</meta>
</syntaxhighlight>
In the ''<info />'' tag, there's a "type" field which indicates that the resource is a ''gamemode'' instead of a regular include or a ''map'', which will be explained later. A gamemode is what you need to make a stand-alone server.

The ''<script />'' tag indicates the script files contained in the resource, which we will create next.
===Creating a simple script===
Note that in the ''<script />'' tag above, the .lua file is not under another directory. Therefore we'll create the file in the same folder as meta.xml. Now you can copy and paste the following code into script.lua:
<syntaxhighlight lang="lua">
local spawnX, spawnY, spawnZ = 1959.55, -1714.46, 10
function joinHandler()
spawnPlayer(source, spawnX, spawnY, spawnZ)
fadeCamera(source, true)
setCameraTarget(source, source)
outputChatBox("Welcome to My Server", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>
The script will spawn you at the coordinate (x, y, z) specified above, when you join the game. Note that the ''fadeCamera'' function must be used or the screen will be black. Also, in releases after DP2, you need to set the camera target (otherwise all the player will see is blue sky).

The '''source''' variable indicates who triggered the event. Since a player has joined when the code is triggered, you use this variable to look which has joined. So it'll spawn that player instead of everyone or a random person.

If we have a closer look on [[addEventHandler]], you can see 3 things: 'onPlayerJoin', which indicates when it's triggered. getRootElement(), which shows by what/who it can be triggered. (getRootElement() is everything/everyone) And joinHandler, which indicates the function that has to be triggered after the event is triggered. Other details will be explained later in another example, now let's just run the server and try it out!

===Running the script===
To get the server started, simply run the executable under the server/ directory. A list of server stats will be shown first; note the port number, which you'll need when joining the game. Then the server loads all the resources under the mods/deathmatch/resources/ directory, and then "ready to accept connections!"

Before you connect to the server, you must run the gamemode. Type "start myserver" and press Enter. The server will start the gamemode you just created, and will also show any errors and warnings from this point on. Now you can start the MTA client, and "Quick Connect" using the IP address of your server and the port number you saw earlier. If all goes well, after a few seconds your character will be walking on the streets of Los Santos.

Next we'll add a command to your script that players can use to spawn a vehicle beside their position. You may skip it and check out more advanced scripting with the [[Map manager|Map Manager]], which continues this tutorial. Another branch from this tutorial is [[Introduction to Scripting GUI]], you may follow it to see how Graphical User Interface in MTA is drawn and scripted.

==Creating a simple command==
Let's go back to the content of the ''script.lua'' file. As mentioned above, we want to provide a command to create a vehicle beside your current position in the game. Firstly we need to create a function we want to call and a command handler that creates the command the player will be able to enter in the console.

<syntaxhighlight lang="lua">
-- create the function the command handler calls, with the arguments: thePlayer, command, vehicleModel
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- create a vehicle and stuff
end

-- create a command handler
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>
''Note: Function names are clickable in code examples on the wiki and linked to the functions' documentation.''

====About command handlers====
The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.

If you have already experience in scripting, you will know that you call a function like this:
<syntaxhighlight lang="lua">
functionName(argument1, argument2, argument3, ..)
</syntaxhighlight>
<syntaxhighlight lang="lua">
functionName(thePlayer, commandName, argument3, ..)
</syntaxhighlight>
If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.

We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similiar manner, internally.

For example: Someone types "createvehicle 468" ingame in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:
<syntaxhighlight lang="lua">
createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command
</syntaxhighlight>
As we can see, it provides several parameters: the player who called the command, the command he entered and whatever text he had after that, in this case "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).

''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''

====Writing the function====
In order to fill the function we created, we need to think about what we have to do:
* Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)
* Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)
* Spawn the vehicle
* Check if it has been spawned successfully, or output a message

In order to achieve our goals, we have to use several functions. To find function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First we need a function to get the players position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns and usually an example. The syntax shows us what arguments we can or have to submit.

For [[getElementPosition]], the syntax is:
<syntaxhighlight lang="lua">
float, float, float getElementPosition ( element theElement )
</syntaxhighlight>

The three ''float'' in front of the function name are the return type. In this case it means the function returns three floating point numbers. (x, y and z) Within the parentheses, you can see what arguments you have to submit. In this case only the element whose position you want to get, which is the player in our example.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
-- get the position and put it in the x,y,z variables
-- (local means, the variables only exist in the current scope, in this case, the function)
local x,y,z = getElementPosition(thePlayer)
end
</syntaxhighlight>

Next we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
end
</syntaxhighlight>

Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.

We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.

<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
-- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
end
</syntaxhighlight>

Of course this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.

Now we have our complete script:
<syntaxhighlight lang="lua">
function createVehicleForPlayer(thePlayer, command, vehicleModel)
local x,y,z = getElementPosition(thePlayer) -- get the position of the player
x = x + 5 -- add 5 units to the x position
local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)
-- check if the return value was ''false''
if (createdVehicle == false) then
-- if so, output a message to the chatbox, but only to this player.
outputChatBox("Failed to create vehicle.",thePlayer)
end
end
addCommandHandler("createvehicle", createVehicleForPlayer)
</syntaxhighlight>

As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].

==What you need to know==
You already read some things about resources, command handlers and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things, while linking to related pages if possible.
===Clientside and Serverside scripts===
You may have already noticed these or similiar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features, but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still others are better off to be serverside or just don't work clientside.

Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script for example, you would create a ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:
<syntaxhighlight lang="xml">
<script src="client.lua" type="client" />
</syntaxhighlight>
The ''type'' attribute defaults to 'server', so you only need to specify it for clientside scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].

===More complex resources===
The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:

====First example - A utility script====
<syntaxhighlight lang="xml">
/admin_commands
/meta.xml
/commands.lua
/client.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="admin commands" />
<script src="commands.lua" type="server" />
<script src="client.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server
* The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily

This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also wont interfere with the gameplay, unless an admin decides to take some action of course.

====Second example - A gamemode====
<syntaxhighlight lang="xml">
/counterstrike
/meta.xml
/counterstrike.lua
/buymenu.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike remake" type="gamemode" />
<script src="counterstrike.lua" type="server" />
<script src="buymenu.lua" type="client" />
</meta>
</syntaxhighlight>

* The ''counterstrike.lua'' contains similiar to the following features:
** Let players choose their team and spawn them
** Provide them with weapons, targets and instructions (maybe read from a Map, see below)
** Define the game's rules, e.g. when does the round end, what happens when a player dies
** .. and maybe some more
* The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons

This example can be called a gamemode, since it not only intereferes with the gameplay, but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.

This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example for a map is stated in the next example.

====Third example - A Map====
<syntaxhighlight lang="xml">
/cs-airport
/meta.xml
/airport.map
/airport.lua
</syntaxhighlight>
<syntaxhighlight lang="xml">
<meta>
<info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" />
<map src="airport.map" />
<script src="airport.lua" type="server" />
</meta>
</syntaxhighlight>

* The ''airport.map'' in a XML file that provides information about the map to the gamemode, these may include:
** Where the players should spawn, with what weapons, what teams there are
** What the targets are
** Weather, World Time, Timelimit
** Provide vehicles
* The ''airport.lua'' might contain map-specific features, that may include:
** Opening some door/make something explode when something specific happens
** Create or move some custom objects, or manipulate objects that are created through the .map file
** .. anything else map-specific you can think of

As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case the gamemode from the above example.
What may come as a surprise is that there is also a script in the Map resource. Of course this is not necessarily needed in a map, but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.

The ''airport.map'' file might look similiar to this:
<syntaxhighlight lang="xml">
<map mode="deathmatch" version="1.0">
<terrorists>
<spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" />
</terrorists>
<counterterrorists>
<spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" />
</counterterrorists>

<bomb posX="23342.23" posY="" posZ="" />

<vehicle posX="" posY="" posZ="" model="602" />
<vehicle posX="" posY="" posZ="" model="603" />
</map>
</syntaxhighlight>

When a gamemode is started with a map, the map resources is automatically started by the mapmanager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.

===Events===
[[Event|Events]] are the way MTA tells scripts about things that happen. For example when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similiar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].

This example will output a message with the name of the player who died:
<syntaxhighlight lang="lua">
function playerDied(totalAmmo, killer, killerWeapon, bodypart)
outputChatBox(getPlayerName(source).." died!")
end
addEventHandler("onPlayerWasted",getRootElement(),playerDied)
</syntaxhighlight>

Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similiar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea how ''source'' is used.

==Where to go from here==
You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.
{{note|From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts. We also recommend you to use the [[predefined variables list]] to help you with certain tasks and make scripting easier and faster.}}
'''See also:'''
* [[OOP_Introduction|OOP Scripting Introduction]]
* [[Advanced Topics]]
* [[Script_security|Script security]]
* [[Scripting Introduction Urdu]]
[[hu:Bevezetés a scriptelésbe]]
[[es:Introducción a la Programación]]
[[it:Introduzione allo scripting]]
[[nl:Scripting_introductie]]
[[pt-br:Introdução ao Scripting]]
[[ru:Scripting Introduction]]
[[ar:مقدمه_في_البرمجه]]
[[zh-cn:脚本编写介绍]]
[[Category:Tutorials]]

Client Scripting Events

2019-05-20T14:33:43Z

Tails:

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Browser events==
{{CEF_events}}

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==Input events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[hu:Client Scripting Events]]
[[pl:Client Scripting Events]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]
[[fr:Client Scripting Events]]
[[tr:Client Taraflı Eventler]]
[[ar:Client Scripting Events]]

Client Scripting Events

2019-05-20T14:31:48Z

Tails:

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Browser events==
{{CEF_events}}

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==Input events==
{{Input}}
{{GUI}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[hu:Client Scripting Events]]
[[pl:Client Scripting Events]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]
[[fr:Client Scripting Events]]
[[tr:Client Taraflı Eventler]]
[[ar:Client Scripting Events]]

Template:GUI events

2019-05-20T14:31:24Z

Tails: /* GUI events */

===Input===
*[[onClientCharacter]]
*[[onClientClick]]
*[[onClientCursorMove]]
*[[onClientDoubleClick]]
*[[onClientKey]]

===GUI===
*[[onClientGUIAccepted]]
*[[onClientGUIBlur]]
*[[onClientGUIChanged]]
*[[onClientGUIClick]]
*[[onClientGUIComboBoxAccepted]]
*[[onClientGUIDoubleClick]]
*[[onClientGUIFocus]]
*[[onClientGUIMouseDown]]
*[[onClientGUIMouseUp]]
*[[onClientGUIMove]]
*[[onClientGUIScroll]]
*[[onClientGUISize]]
*[[onClientGUITabSwitched]]
*[[onClientMouseEnter]]
*[[onClientMouseLeave]]
*[[onClientMouseMove]]
*[[onClientMouseWheel]]

<noinclude>[[Category:Events templates]]</noinclude>

GetPedControlState

2018-11-13T03:05:28Z

Tails:

__NOTOC__
{{Client function}}
Checks whether a ped or the localplayer has a certain control pressed.

==Syntax==
<syntaxhighlight lang="lua">
bool getPedControlState ( ped thePed, string control )
</syntaxhighlight>
{{OOP||[[Ped]]:getControlState}}

===Required Arguments===
*'''thePed:''' the ped you want to check.
*'''control:''' the control to get the status of. See [[control names]] for a list of valid names.

===Returns===
Returns ''true'' if the ped is pressing the specified control, ''false'' if not or an invalid argument was passed.

===Example===

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local controlTable = {"forwards", "backwards", "left", "right", "jump", "crouch"}

function invisibleOnSpawn()
setElementAlpha (localPlayer, 0)
checkControlState = setTimer(controlState, 50, 0)
end
addEventHandler ("onClientPlayerSpawn", localPlayer, invisibleOnSpawn)

function controlState()
for i,control in ipairs(controlTable) do
local state = getPedControlState(localPlayer, control)
if (state) then
setElementAlpha (localPlayer, 255)
if (isTimer(checkControlState)) then
killTimer(checkControlState)
checkControlState = nil
end
end
end
end
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.11427|Works with the [[getLocalPlayer|local player]] as well. Deprecated [[setControlState]] and [[getControlState]].}}

==See Also==
{{Client ped functions}}

[[hu:getPedControlState]]

GetPedControlState

2018-11-05T22:31:32Z

Tails:

__NOTOC__
{{Client function}}
Checks whether a ped has a certain control pressed.

==Syntax==
<syntaxhighlight lang="lua">
bool getPedControlState ( ped thePed, string control )
</syntaxhighlight>
{{OOP||[[Ped]]:getControlState}}

===Required Arguments===
*'''thePed:''' the ped you want to check.
*'''control:''' the control to get the status of. See [[control names]] for a list of valid names.

===Returns===
Returns ''true'' if the ped is pressing the specified control, ''false'' if not or an invalid argument was passed.

===Example===

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local controlTable = {"forwards", "backwards", "left", "right", "jump", "crouch"}

function invisibleOnSpawn()
setElementAlpha (localPlayer, 0)
checkControlState = setTimer(controlState, 50, 0)
end
addEventHandler ("onClientPlayerSpawn", localPlayer, invisibleOnSpawn)

function controlState()
for i,control in ipairs(controlTable) do
local state = getPedControlState(localPlayer, control)
if (state) then
setElementAlpha (localPlayer, 255)
if (isTimer(checkControlState)) then
killTimer(checkControlState)
checkControlState = nil
end
end
end
end
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.11427|Works with the [[getLocalPlayer|local player]] as well. Deprecated [[setControlState]] and [[getControlState]].}}

==See Also==
{{Client ped functions}}

[[hu:getPedControlState]]

SetPedControlState

2018-11-05T22:30:52Z

Tails:

__NOTOC__
{{Client function}}
This function makes a [[ped]] or [[player]] press or release a certain control.
{{Note|You can't use enter_exit or enter_passenger on a ped.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedControlState ( ped thePed, string control, bool state )
</syntaxhighlight>
{{OOP||[[Ped]]:setControlState}}

===Required Arguments===
*'''thePed:''' the ped you want to press or release a control.
*'''control:''' the name of the control of which to change the state. See [[control names]] for a list of valid names.
*'''state:''' the new control state. ''true'' means pressed, ''false'' is released.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function newPed()
local x, y, z = getElementPosition(localPlayer)
local ped = createPed(0, x + 1, y, z)
if ped then
setPedControlState(ped, "forwards", true)
end
end
addCommandHandler("ped", newPed)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.11427|Works with the [[getLocalPlayer|local player]] as well. Deprecated [[setControlState]] and [[getControlState]].}}

==See Also==
{{Client ped functions}}

SetPedControlState

2018-11-05T22:30:30Z

Tails:

__NOTOC__
{{Client function}}
This function makes a [[ped]] or [[player]] press or release a certain control.
{{Note|You can't use enter_exit or enter_passenger on a ped.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedControlState ( ped thePed, string control, bool state )
</syntaxhighlight>
{{OOP||[[Player]]:setControlState}}

===Required Arguments===
*'''thePed:''' the ped you want to press or release a control.
*'''control:''' the name of the control of which to change the state. See [[control names]] for a list of valid names.
*'''state:''' the new control state. ''true'' means pressed, ''false'' is released.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function newPed()
local x, y, z = getElementPosition(localPlayer)
local ped = createPed(0, x + 1, y, z)
if ped then
setPedControlState(ped, "forwards", true)
end
end
addCommandHandler("ped", newPed)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.11427|Works with the [[getLocalPlayer|local player]] as well. Deprecated [[setControlState]] and [[getControlState]].}}

==See Also==
{{Client ped functions}}

SetPedControlState

2018-11-05T22:30:11Z

Tails: add oop syntax

__NOTOC__
{{Client function}}
This function makes a [[ped]] or [[player]] press or release a certain control.
{{Note|You can't use enter_exit or enter_passenger on a ped.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedControlState ( ped thePed, string control, bool state )
</syntaxhighlight>
{{OOP||[[Player]]:getControlState}}

===Required Arguments===
*'''thePed:''' the ped you want to press or release a control.
*'''control:''' the name of the control of which to change the state. See [[control names]] for a list of valid names.
*'''state:''' the new control state. ''true'' means pressed, ''false'' is released.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function newPed()
local x, y, z = getElementPosition(localPlayer)
local ped = createPed(0, x + 1, y, z)
if ped then
setPedControlState(ped, "forwards", true)
end
end
addCommandHandler("ped", newPed)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.11427|Works with the [[getLocalPlayer|local player]] as well. Deprecated [[setControlState]] and [[getControlState]].}}

==See Also==
{{Client ped functions}}

GuiGridListAddColumn

2018-11-01T23:50:02Z

Tails: Clean up example

{{Client function}}
__NOTOC__
This function is used to create columns in grid lists.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListAddColumn ( element gridList, string title, float width )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:addColumn}}

===Required Arguments===
*'''gridList:''' The grid list you want to add a column to
*'''title:''' Title of the column
*'''width:''' Column width, relative to the grid list width

===Returns===
Returns the column id if it was created, ''false'' otherwise.

==Example==
This example creates a player list on the right side of the screen and fills it with the currently connected players.
<syntaxhighlight lang="lua">
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "Player", 0.85)

for _, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, getPlayerName(player))
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiGridListGetColumnIDFromTitle

2018-10-24T23:35:47Z

Tails:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function gets a gridlist's column index from the column title. This function is particularly useful when the columns in your gridlist are created programmatically using a pairs loop. Pairs are often used to loop an unordered list and is impossible to guess the order of such a list and it may not always be the same.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListGetColumnIDFromTitle ( element gridlist, string title )
</syntaxhighlight>

==Required Arguments==
* '''gridlist:''' The gridlist you want to get the column index from.
* '''title:''' The title of the column you want to get the index of.

==Code==
<section name='Client' class='generic' show='true'>
<syntaxhighlight lang="lua">
function guiGridListGetColumnIDFromTitle(gridlist, title)
for id=1, guiGridListGetColumnCount(gridlist) do
if guiGridListGetColumnTitle(gridlist, id) == title then
return id
end
end
return false
end
</syntaxhighlight>
</section>

==Returns==
* A column ''id'' of the column matching the title, ''false'' otherwise .

==Example==
* Here's a quick example which grabs the index from the id column and triggers a custom event to delete an account matching that id. (This example is using [[OOP]])

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function deleteAccount()
local row = accountList:getSelectedItem()
if row then
local id = accountList:getItemText(row, guiGridListGetColumnIDFromTitle(accountList, 'id'))
if id then
triggerServerEvent('deleteAccount', resourceRoot, id)
end
end
end

addCommandHandler('del', deleteAccount)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

OnPlayerChat

2018-10-24T21:26:39Z

Tails: removed and updated an example

__NOTOC__
{{Server event}}
This event is triggered when a player chats inside the chatbox.

==Parameters==
<syntaxhighlight lang="lua">
string message, int messageType
</syntaxhighlight>

*'''message''': a [[string]] representing the message typed into the chat.
*'''messageType''': an [[int]] value representing the message type:
**'''0''': normal message
**'''1''': action message (/me)
**'''2''': team message

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who sent the chatbox message.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the game's chat system won't deliver the posts. You may use [[outputChatBox]] to send the messages then.
Cancelling this event also means the chat will not appear in the server console or logs. If you want chat logging, you will have to add a call to [[outputServerLog]] - See the second example.

==Examples==

<section name="Example 1" class="server" show="true">
This example limits receiving of chat messages to a spherical area around the player who sent the message, also blocking action and team text.

<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 --units

-- define a handler that will distribute the message to all nearby players
function sendMessageToNearbyPlayers(message, messageType)
-- we will only send normal chat messages, action and team types will be ignored
if messageType == 0 then
-- get the chatting player's position
local posX1, posY1, posZ1 = getElementPosition(source)

-- loop through all player and check distance
for id, player in ipairs(getElementsByType("player")) do
local posX2, posY2, posZ2 = getElementPosition(player)
if getDistanceBetweenPoints3D(posX1, posY1, posZ1, posX2, posY2, posZ2) <= chatRadius then
outputChatBox(message, nearbyPlayer)
end
end
end
-- block the original message by cancelling this event
cancelEvent()
end
-- attach our new chat handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example implements colored player names in chat.

<syntaxhighlight lang="lua">
--This function is executed when a player joins, it sets the player's name-tag color to a random color.
local function playerJoin()
local red, green, blue = math.random (50, 255), math.random (50, 255), math.random (50, 255)
setPlayerNametagColor(source, red, green, blue)
end
addEventHandler ("onPlayerJoin", root, playerJoin)

--This function is executed when a player says something in chat, it outputs the player's message, with their nick colored to match their name tag color.
local function playerChat(message, messageType)
if messageType == 0 then --Global (main) chat
cancelEvent()
local red, green, blue = getPlayerNametagColor(source)
outputChatBox(getPlayerName(source)..": #FFFFFF"..message, root, red, green, blue, true )
outputServerLog("CHAT: "..getPlayerName(source)..": "..message)--NOTE: Beacuse we cancelled the onPlayerChat event, we need to log chat manually.
end
end
addEventHandler("onPlayerChat", root, playerChat)
</syntaxhighlight>
</section>

<section name="Example 3" class="server" show="true">
This is a script that kills any player that says 'kill'.

<syntaxhighlight lang="lua">
function onChat(message, messageType)
if string.find(message, 'kill') then -- Searches for the string 'kill' in the message sent
killPed ( source, source ) -- Kills that player that typed the string 'kill'
end
end --End of the function
addEventHandler("onPlayerChat", getRootElement(), onChat)
</syntaxhighlight>
</section>

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

[[ru:onPlayerChat]]

GuiGridListAddRow

2018-09-01T22:01:24Z

Tails: Cleaned up example

{{Client function}}
__NOTOC__
Adds a row to a grid list, and optionally add simple text items with your rows. Use [[guiGridListSetItemText]] to add row headers.

{{Deprecated feature|3.0153|1.5.2|
ATTENTION: Without [[guiGridListSetItemText]] there is no row added to the grid.
Look at the example, first you give the row a name with '''[[row =]]''' guiGridListAddRow ( playerList ), and then you use [[guiGridListSetItemText]]. }}

==Syntax==
{{New feature/item|3.0153|1.5.3||
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList [, int/string itemText1, int/string itemText2, ... ] )
</syntaxhighlight>
}}

{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:addRow}}

===Required Arguments===
*'''gridList:''' The grid list you want to add a row to

===Optional Arguments===
{{New feature/item|3.0153|1.5.3||
*'''itemText1:''' The text for the first column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
*'''itemText2:''' The text for the second column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
*'''...:''' Item text for any other columns
}}

===Returns===
Returns the row id if it has been created, ''false'' otherwise.

==Example==
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
<syntaxhighlight lang="lua">
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "Player", 0.85)

for _, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, getPlayerName(player))
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiCreateGridList

2018-09-01T21:54:42Z

Tails: Simplified examples

__NOTOC__
{{Client function}}
This function creates a grid list GUI element. These are menu's which are designed in lists and can have multiple columns. A good example of a gridlist element can be found in MTA's settings box, under ''Controls''.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateGridList ( float x, float y, float width, float height, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]}}

===Required Arguments===
[[Image:Gui-gridlist.png|frame|Example GUI gridlist.]]
*'''x:''' A float of the 2D x position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI gridlist on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI gridlist. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI gridlist. This is affected by the ''relative'' argument.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui gridlist is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created gridlist if it was successfully created, false otherwise.

==Example==
'''Example 1:''' This example creates a player list on the right of the screen with 1 column and fills it
<syntaxhighlight lang="lua">
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "Player", 0.85)

for _, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, getPlayerName(player))
end
</syntaxhighlight>

'''Example 2:''' Using [[OOP]] we can write shorter and cleaner code (Requires <oop>true<oop> in the meta file). This creates a player list with 2 columns.
<syntaxhighlight lang="lua">
local list = GuiGridList(0.80, 0.40, 0.15, 0.35, true)
list:addColumn("#", 0.15)
list:addColumn("name", 0.75)

for index, player in ipairs(getElementsByType("player")) do
list:addRow(index, player.name)
end
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

Check

2018-07-17T23:03:41Z

Tails:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

==Syntax==
<syntaxhighlight lang="lua">void check(string pattern, arguments [...])</syntaxhighlight>

===Arguments===
* '''pattern''': a string consisting of the first letter of each datatype passed into the function (see example)
* '''arguments''': arguments to match the pattern

==Code==
<section name="Client/Server" class="generic" show="true">
<syntaxhighlight lang="lua">
function check(pattern, ...)
if type(pattern) ~= 'string' then check('s', pattern) end
local types = {s = "string", n = "number", b = "boolean", f = "function", t = "table", u = "userdata"}
for i=1, #pattern do
local c = pattern:sub(i,i)
local t = #arg > 0 and type(arg[i])
if not t then error('got pattern but missing args') end
if t ~= types[c] then error(("bad argument #%s to '%s' (%s expected, got %s)"):format(i, debug.getinfo(2, "n").name, types[c], tostring(t)), 3) end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Client/Server" class="both" show="true">
<syntaxhighlight lang="lua">
function warpPlayer(player, x, y, z)
check('unnn', player, x, y, z) -- 'unnn' means userdata (player in this case), number, number, number

print("The check passed!")
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

SetTimer

2018-06-23T21:23:26Z

Tails:

__NOTOC__
{{Server client function}}
This function allows you to trigger a function after a number of milliseconds have elapsed. You can call one of your own functions or a built-in function. For example, you could set a timer to spawn a player after a number of seconds have elapsed.

Once a timer has finished repeating, it no longer exists.

'''The minimum accepted interval is 50ms.'''

Multi Theft Auto guarantees that the timer will be triggered after ''at least'' the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future.

==Syntax==
<syntaxhighlight lang="lua">
timer setTimer ( function theFunction, int timeInterval, int timesToExecute, [ var arguments... ] )
</syntaxhighlight>
{{OOP||[[Timer]]}}
===Required Arguments===
*'''theFunction:''' The function you wish the timer to call.
{{Note|The hidden global variable '''sourceTimer''' contains the currently executing timer userdata}}
*'''timeInterval:''' The number of milliseconds that should elapse before the function is called. (the minimum is 50; 1000 milliseconds = 1 second)
*'''timesToExecute:''' The number of times you want the timer to execute, or 0 for infinite repetitions.

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you wish to pass to the function can be listed after the ''timesToExecute'' argument. Note that any tables you want to pass will get cloned, whereas metatables and functions/function references in that passed table will get lost. Also changes you make in the original table before the function gets called won't get transferred.

===Returns===
Returns a [[timer]] pointer if the timer was set successfully, ''false'' if the arguments are invalid or the timer could not be set.

==Examples==
This example will output some text after a small delay.

<syntaxhighlight lang="lua">
-- define function to be called
function delayedChat ( text )
outputChatBox ( "Delayed text: " .. text )
end

-- set a timer so the function is called after 1 second
setTimer ( delayedChat, 1000, 1, "Hello, World!" )
</syntaxhighlight>

1 second after the line above has been executed, the text ''Delayed text: Hello, World!'' will be displayed in the chat box.

This example will nest a whole function within a timer. This is nice for things like setting variables without having to call a function outside of your code block.

<syntaxhighlight lang="lua">
function mainFunction()
outputChatBox ("Instant text!")
setTimer ( function()
outputChatBox ( "5 second delay text!" )
end, 5000, 1 )
end

mainFunction() --call function
</syntaxhighlight>

This example outputs some random text to the chat every 300000 milliseconds (5 minutes).
<syntaxhighlight lang="lua">
setTimer(function()
outputChatBox("Text " .. math.random(1,4))
end, 300000, 0)
</syntaxhighlight>

==See Also==
{{Utility functions}}

Local Scheme Handler

2018-06-19T23:56:30Z

Tails:

__NOTOC__
In many cases it is necessary to access files stored on the local disk from browsers.

{{New feature/item|3.0151|1.5.1|7439|
==Scheme format==
<syntaxhighlight lang="lua">http://mta/resourceName/file.extension</syntaxhighlight>
* '''resourceName''': The resource name, ''local'' is a special name for the current resource
* '''file.extension''': The file path within ''resourceName''

You can use this scheme format for [[loadBrowserURL]] as well as in HTML files e.g. <img> tags.

{{Requirements|1.5.0-9.07439|n/a|}}

==Examples==
===Example 1===
<syntaxhighlight lang="lua">http://mta/myResource/assets/myImage.png</syntaxhighlight>
Refers to the file ''assets/myImage.png'' in a resource named ''myResource''

===Example 2===
<syntaxhighlight lang="lua">http://mta/local/assets/myImage.png</syntaxhighlight>
Refers to the file ''assets/myImage.png'' in the current resource
}}

{{Deprecated_feature|3.0151|1.5.0-7439|
Before build 1.5.0-7439 local files were accessed using the mtalocal:// scheme. This scheme has been deprecated now, but throws a warning and should not be used any longer for this reason.
Nevertheless, it still works for backward compatibility, but should be replaced as soon as possible. '''Don't forget to set min_mta_version though (when using the new scheme).'''
}}

Template:Useful Functions

2018-06-15T00:29:07Z

Tails: /* Gridlists */

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

=== Account functions ===
*[[removeAccountData]] » This function is used to remove data from an account.
*[[setAccountName]] » This function is used to change an existing account's name.

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

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

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

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

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

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

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].

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

=== GUI functions ===
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[guiMoveElement]] » This function moves guiElement by/like using moveObject.
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
*[[guiComboBoxAddPlayersName]] » This function is add players name in combobox .

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

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

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

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

=== 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.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInGroup]] » This function returns all Players In Group .
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.

=== Player functions ===
*[[countPlayersInRange]] » This function returns the number of players that are within a certain range of the specified coordinates.

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

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

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

=== Table functions ===
*[[rangeToTable]] » This function converts a string range to a table containing number values.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[Sort_Functions]] » These functions are able to sort your tables by a key.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.removeValue]] » This function removes a specified value from a table.
*[[table.size]] » This function returns the absolute size of a table.

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

=== Vehicle funcions ===
*[[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.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

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

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

=== Utility ===
*[[animate]] » This function allows you to use interpolateBetween without render event and easily used.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isCursorOnElement]] » This function checks whether the cursor is in a particular area.
*[[isMouseInCircle]] » This function checks if a cursor position is in circular area or not.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[thisCommandHandlersExist]] » This method checks a string if this exist as command Handlers
*[[vector3:compare]] » This method checks whether two vectors match, with optional precision.

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

GuiGridListGetColumnIDFromTitle

2018-06-15T00:26:22Z

Tails:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function gets a gridlist's column ID from the column title. This function is particularly useful when the columns in your gridlist are created programmatically using a pairs loop. Pairs are often used to loop an unordered list and is impossible to guess the order of such a list and it may not always be the same.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListGetColumnIDFromTitle ( element gridlist, string title )
</syntaxhighlight>

==Required Arguments==
* '''gridlist:''' The gridlist you want to get the column ID from.
* '''title:''' The title of the column you want to get the ID of.

==Code==
<section name='Client' class='generic' show='true'>
<syntaxhighlight lang="lua">
function guiGridListGetColumnIDFromTitle(gridlist, title)
for id=1, guiGridListGetColumnCount(gridlist) do
if guiGridListGetColumnTitle(gridlist, id) == title then
return id
end
end
return false
end
</syntaxhighlight>
</section>

==Returns==
* A column ''id'' of the column matching the title, ''false'' otherwise .

==Example==
* Here's a quick example which grabs the id from the id column and triggers a custom event to delete an account matching that id. (This example is using [[OOP]])

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function deleteAccount()
local row = accountList:getSelectedItem()
if row then
local id = accountList:getItemText(row, guiGridListGetColumnIDFromTitle(accountList, 'id'))
if id then
triggerServerEvent('deleteAccount', resourceRoot, id)
end
end
end

addCommandHandler('del', deleteAccount)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

GuiGridListGetColumnIDFromTitle

2018-06-15T00:24:05Z

Tails: /* Example */

GuiGridListGetColumnIDFromTitle

2018-06-15T00:22:49Z

Tails: Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ This function gets a gridlist's column ID from the column title. This function is particularly useful when the..."

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function gets a gridlist's column ID from the column title. This function is particularly useful when the columns in your gridlist are created programmatically using a pairs loop. Pairs are often used to loop an unordered list and is impossible to guess the order of such a list and it may not always be the same.

==Syntax==
<syntaxhighlight lang="lua">
int guiGridListGetColumnIDFromTitle ( element gridlist, string title )
</syntaxhighlight>

==Required Arguments==
* '''gridlist:''' The gridlist you want to get the column ID from.
* '''title:''' The title of the column you want to get the ID of.

==Code==
<section name='Client' class='generic' show='true'>
<syntaxhighlight lang="lua">
function guiGridListGetColumnIDFromTitle(gridlist, title)
for id=1, guiGridListGetColumnCount(gridlist) do
if guiGridListGetColumnTitle(gridlist, id) == title then
return id
end
end
return false
end
</syntaxhighlight>
</section>

==Returns==
* A column ''id'' of the column matching the title, ''false'' otherwise .

==Example==
* Here's a quick example which grabs the id from the id column and triggers a custom event to delete an account matching that id. (This example is using [[OOP]])

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local accountList = GuiGridList(10, 68, 406, 369, false)

function deleteAccount()
local row = accountList:getSelectedItem()
if row then
local id = accountList:getItemText(row, guiGridListGetColumnIDFromTitle(accountList, 'id'))
if id then
triggerServerEvent('deleteAccount', resourceRoot, id)
end
end
end

addCommandHandler('del', deleteAccount)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

Check

2018-06-04T22:46:01Z

Tails:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

==Syntax==
<syntaxhighlight lang="lua">void check(string pattern, arguments [...])</syntaxhighlight>

===Arguments===
* '''pattern''': a string consisting of the first letter of each datatype passed into the function (see example)
* '''arguments''': arguments to match the pattern

==Code==
<section name="Client/Server" class="generic" show="true">
<syntaxhighlight lang="lua">
function check(pattern, ...)
if not pattern or type(pattern) ~= 'string' then check('s', pattern) end
local types = {s = "string", n = "number", b = "boolean", f = "function", t = "table", u = "userdata"}
for i=1, #pattern do
local c = pattern:sub(i,i)
local t = arg.n > 0 and type(arg[i])
if not t then error('got pattern but missing args') end
if t ~= types[c] then error("bad argument #"..i.. " to '"..debug.getinfo(2, "n").name.."' ("..types[c].." expected, got "..tostring(t)..")", 3) end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Client/Server" class="both" show="true">
<syntaxhighlight lang="lua">
function warpPlayer(player, x, y, z)
check('unnn', player, x, y, z) -- 'unnn' means userdata (player in this case), number, number, number

print("The check passed!")
end
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

DXX

2018-06-04T15:05:05Z

Tails: Tails moved page Test123 to DXX

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''close'''
**'''change'''
**'''destroy'''
*'''callbackFunction:''' The function that is called when this event occurs.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.
*'''arguments...''' - The arguments that were passed into fetchRemote

===Returns===
This function does not return anything

==Example==
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

DXX

2018-05-27T01:22:38Z

Tails: /* Required Arguments */

DXX

2018-05-27T01:20:34Z

Tails: /* Required Arguments */

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' The function that is called when this event occurs.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.
*'''arguments...''' - The arguments that were passed into fetchRemote

===Returns===
This function does not return anything

==Example==
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

DXX

2018-05-27T01:19:30Z

Tails:

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' The function that is called when this event is triggered.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.
*'''arguments...''' - The arguments that were passed into fetchRemote

===Returns===
This function does not return anything

==Example==
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

DXX

2018-05-27T01:18:25Z

Tails:

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' The function that is called when this event is triggered.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.
*'''arguments...''' - The arguments that were passed into fetchRemote

===Returns===
This function does not return anything

==Example==
<section name="Client" class="generic" show="true">
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

</section>

DXX

2018-05-27T01:16:45Z

Tails:

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' The function that is called when this event is triggered.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.
*'''arguments...''' - The arguments that were passed into fetchRemote

===Returns===
This function does not return anything

<section name="Example" class="generic" show="true">
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

</section>

DXX

2018-05-27T01:14:35Z

Tails: /* Required Arguments */

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' The function that is called when this event is triggered.
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.

*'''arguments...''' - The arguments that were passed into fetchRemote

<section name="Example" class="generic" show="true">
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

</section>

DXX

2018-05-27T01:12:07Z

Tails:

{{Client function}}

{{OOP|Use a dot instead of a colon to access class methods|[[Dxx]].on}}

==Syntax==
<syntaxhighlight lang="lua">
bool Dxx.on(string eventName, function callbackFunction)
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event you want to listen for. Possible values are:
**'''click'''
**'''destroy'''
**'''change'''
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error.

*'''arguments...''' - The arguments that were passed into fetchRemote

<section name="Example" class="generic" show="true">
<syntaxhighlight lang="lua">
local win = Window(700, 400, 1000, 600, "cool window")
local btn = Button(55, 55, 125, 30, "click me")

btn.setParent(win)
btn.on("click", function() btn.value = "clicked" end)
</syntaxhighlight>

</section>