Multi Theft Auto: Wiki - User contributions [en]

User:JeViCo

2023-03-27T14:19:33Z

JeViCo:

Feel free to ask questions
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:Discord.png |
imageSize = 30px|
title = Discord |
message = JeViCo#5147

}}
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:Github.png |
imageSize = 28px|
title = Github |
message = https://github.com/jevico

}}
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:VK.png |
imageSize = 30px|
title = Вконтакте |
message = https://vk.com/jevico

}}

FormatNumber

2023-03-27T14:18:44Z

JeViCo: Removed incorrect 2nd approach

{{Useful Function}} __NOTOC__
This function formats large numbers by adding commas to it. For example, 100000 becomes 100.000 

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

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

===Optional Arguments===
* '''sep''': A string of the character you want to split

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

==Code==
<section name="Example 1: Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function formatNumber(number, sep)
assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
local money = number
for i = 1, tostring(money):len()/3 do
money = string.gsub(money, "^(-?%d+)(%d%d%d)", "%1"..sep.."%2")
end
return money
end
</syntaxhighlight>
</section>

==Example==

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

</section>

==See Also==
{{Useful_Functions}}

User talk:JeViCo

2022-11-16T10:00:52Z

JeViCo: Created page with "Wiki-related only discussions below"

Wiki-related only discussions below

User:JeViCo

2022-11-16T09:59:44Z

JeViCo: vk.com added

Feel free ask questions
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:Discord.png |
imageSize = 30px|
title = Discord |
message = JeViCo#5147

}}
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:Github.png |
imageSize = 28px|
title = Github |
message = https://github.com/jevico

}}
{{MessageBox|
bordercolorhex = 98fb98 |
image = File:VK.png |
imageSize = 30px|
title = Вконтакте |
message = https://vk.com/jevico

}}

User:JeViCo

2022-11-16T09:45:31Z

JeViCo: Space removed

User:JeViCo

2022-11-16T09:45:18Z

JeViCo: Basic info added

File:Discord.png

2022-11-16T09:37:03Z

JeViCo: JeViCo uploaded a new version of File:Discord.png

== Summary ==
Official discord logo

File:Discord.png

2022-11-16T09:34:56Z

JeViCo: Official discord logo

== Summary ==
Official discord logo

BindKey

2022-11-16T09:19:16Z

JeViCo: Note added about non working escape button

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function or command, which will be called when the key is pressed.

{{Note|Using escape key will always return false. Use [[onClientKey]] event instead.}}

==Syntax==
<section name="Server - Syntax 1" class="server" show="true">
<syntaxhighlight lang="lua">bool bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( player keyPresser, string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''keyPresser:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Server - Syntax 2" class="server" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bool bindKey ( player thePlayer, string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
===Optional Arguments===
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

<section name="Client - Syntax 1" class="client" show="true">
<syntaxhighlight lang="lua">bool bindKey ( string key, string keyState, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released

*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Client - Syntax 2" class="client" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bool bindKey ( string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function. You may not pass functions.

===Returns===
Returns ''true'' if the key was bound, ''false'' otherwise.

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( player, key, keyState )
outputChatBox ( getPlayerName ( player) .. " " .. (keyState == "down" and "pressed" or "released") .. " the " .. key .. " key!" )
end

function bindTheKeys ( player, commandName )
bindKey ( player, "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( player, "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( player, "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
outputChatBox( "You " .. (keyState == "down" and "pressed" or "let go of") .. " the " .. key .. " key!" )
end

function bindTheKeys ( commandName )
bindKey( "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey( "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey( "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example says how cool is the MTA:SA is if players wants to move.
<syntaxhighlight lang="lua">
function fanFunction()
bindKey (source,"forwards","down",
function(player,key,state)
outputChatBox (getPlayerName (player) .. "#FFFF00 thinks MTA:SA is so cool.",root,255,255,0,true)
end
)
end
addEventHandler ("onPlayerLogin",root,fanFunction)
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}
[[pt-br:bindKey]]

Compiling MTASA

2021-03-15T12:10:30Z

JeViCo: fixed broken link (DirectX SDK)

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Auto client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2019 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2019]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these two items]]:
## ''Desktop development with C++''
## ''C++ MFC for latest v142 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download''' 
[http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549 Microsoft DirectX SDK (August 2009)] 

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h''' 
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib''' 
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error''' 
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)] 

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository. 
We recommend cloning the repository in your Git client because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Compile in Visual Studio with '''Debug''' configuration (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software. 
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can go to ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software. 
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build. 
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio. 
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise, your
breakpoints will not work for anything besides the MTA Launcher project. 
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio. 
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on the coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

FormatNumber

2020-07-05T09:01:05Z

JeViCo: Changed comma to dot in the description. Small algorithm description added

{{Useful Function}} __NOTOC__
This function formats large numbers by adding commas to it. For example, 100000 becomes 100.000 

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

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

===Optional Arguments===
* '''sep''': A string of the character you want to split

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

==Code==
Made by JeViCo. Uses double string reverse & patterns to paste separator
<syntaxhighlight lang="lua">
function formatNumber(number, sep)
assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
return tostring(number):reverse():gsub("%d%d%d","%1%"..(sep and #sep>0 and sep or ".")):reverse()
end
</syntaxhighlight>

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

==See Also==
{{Useful_Functions}}

FormatNumber

2020-06-26T12:00:45Z

JeViCo: Better algorithm

{{Useful Function}} __NOTOC__
This function formats large numbers by adding commas to it. For example, 100000 becomes 100,000 

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

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

===Optional Arguments===
* '''sep''': A string of the character you want to split

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

==Code==
<syntaxhighlight lang="lua">
function formatNumber(number, sep)
assert(type(tonumber(number))=="number", "Bad argument @'formatNumber' [Expected number at argument 1 got "..type(number).."]")
assert(not sep or type(sep)=="string", "Bad argument @'formatNumber' [Expected string at argument 2 got "..type(sep).."]")
return tostring(number):reverse():gsub("%d%d%d","%1%"..(sep and #sep>0 and sep or ".")):reverse()
end
</syntaxhighlight>

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

==See Also==
{{Useful_Functions}}

SmoothMoveCamera

2020-02-11T18:48:13Z

JeViCo: misspelled word 'periodic'

{{Useful Function}}
<lowercasetitle/>
__NOTOC__

This function allows you to create a cinematic-camera-flight, which moves from a specific position to a specific position.

==Syntax==
<syntaxhighlight lang="lua">bool smoothMoveCamera ( float x1, float y1, float z1, float x1t, float y1t, float z1t, float x2, float y2, float z2, float x2t, float y2t, float z2t, int time )</syntaxhighlight>

* '''x1, y1, z1''': The camera's start position.
* '''x1t, y1t, z1t''': The camera's start look at.
* '''x2, y2, z2''': The camera's end position.
* '''x2t, y2t, z2t''': The camera's end look at.
* '''time''': The speed of the camera's movement.

==Code==
This version returns false if a smoothMoveCamera is in progress:
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0
sm.object1,sm.object2 = nil,nil

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local function camRender()
if (sm.moov == 1) then
local x1,y1,z1 = getElementPosition(sm.object1)
local x2,y2,z2 = getElementPosition(sm.object2)
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientPreRender",root,camRender)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1)then return false end
sm.object1 = createObject(1337,x1,y1,z1)
sm.object2 = createObject(1337,x1t,y1t,z1t)
setElementCollisionsEnabled (sm.object1,false)
setElementCollisionsEnabled (sm.object2,false)
setElementAlpha(sm.object1,0)
setElementAlpha(sm.object2,0)
setObjectScale(sm.object1,0.01)
setObjectScale(sm.object2,0.01)
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")
sm.moov = 1
setTimer(removeCamHandler,time,1)
setTimer(destroyElement,time,1,sm.object1)
setTimer(destroyElement,time,1,sm.object2)
addEventHandler("onClientPreRender",root,camRender)
return true
end
</syntaxhighlight>
</section>
Author: Noneatme(Me) [Fixed by ADCX and Motar2k~, does not give errors now]

This Version allows cancellation of current smoothMoveCamera progress and doing another one.
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0
sm.object1,sm.object2 = nil,nil

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local function camRender()
if (sm.moov == 1) then
local x1,y1,z1 = getElementPosition(sm.object1)
local x2,y2,z2 = getElementPosition(sm.object2)
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientPreRender",root,camRender)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1)then
destroyElement(sm.object1)
destroyElement(sm.object2)
killTimer(timer1)
killTimer(timer2)
killTimer(timer3)
removeEventHandler("onClientPreRender",root,camRender)
end
sm.object1 = createObject(1337,x1,y1,z1)
sm.object2 = createObject(1337,x1t,y1t,z1t)
setElementCollisionsEnabled (sm.object1,false)
setElementCollisionsEnabled (sm.object2,false)
setElementAlpha(sm.object1,0)
setElementAlpha(sm.object2,0)
setObjectScale(sm.object1,0.01)
setObjectScale(sm.object2,0.01)
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")
sm.moov = 1
timer1 = setTimer(removeCamHandler,time,1)
timer2 = setTimer(destroyElement,time,1,sm.object1)
timer3 = setTimer(destroyElement,time,1,sm.object2)
addEventHandler("onClientPreRender",root,camRender)
return true
end
</syntaxhighlight>
</section>

Made by JeViCo. Same function as previous one except it's using interpolateBetween function. Also this version may fix little periodic flickering which happen in previous examples.
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local start
local animTime
local tempPos = {{},{}}
local tempPos2 = {{},{}}

local function camRender()
local now = getTickCount()
if (sm.moov == 1) then
local x1, y1, z1 = interpolateBetween(tempPos[1][1], tempPos[1][2], tempPos[1][3], tempPos2[1][1], tempPos2[1][2], tempPos2[1][3], (now-start)/animTime, "InOutQuad")
local x2,y2,z2 = interpolateBetween(tempPos[2][1], tempPos[2][2], tempPos[2][3], tempPos2[2][1], tempPos2[2][2], tempPos2[2][3], (now-start)/animTime, "InOutQuad")
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientRender",root,camRender)
fadeCamera(true)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1) then
killTimer(timer1)
killTimer(timer2)
removeEventHandler("onClientRender",root,camRender)
fadeCamera(true)
end
fadeCamera(true)
sm.moov = 1
timer1 = setTimer(removeCamHandler,time,1)
timer2 = setTimer(fadeCamera, time-1000, 1, false) --
start = getTickCount()
animTime = time
tempPos[1] = {x1,y1,z1}
tempPos[2] = {x1t,y1t,z1t}
tempPos2[1] = {x2,y2,z2}
tempPos2[2] = {x2t,y2t,z2t}
addEventHandler("onClientRender",root,camRender)
return true
end
</syntaxhighlight>
</section>
==See Also==
{{Useful_Functions}}

SetElementCollisionsEnabled

2020-01-20T16:27:34Z

JeViCo:

{{Server client function}}
__NOTOC__
This function can disable or enable an element's collisions. An element without collisions does not interact with the physical environment and remains static.

{{Note|Vehicles that are collisionless and have a driver will cause bugs.}}
{{Note|Enabling a players collisions when they're inside a vehicle will cause bugs.}}
{{Note|Disabling a peds collisions will cause some problems, such as it being unable to move or wrong rotation after creation.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollisionsEnabled ( element theElement, bool enabled )
</syntaxhighlight>
{{OOP||[[element]]:setCollisionsEnabled|collisions|getElementCollisionsEnabled}}

===Required Arguments===
*'''theElement:''' The element you wish to set the collisions of
*'''enabled:''' A boolean to indicate whether collisions are enabled (''true'') or disabled (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
This example disables collisions for all vehicles within a certain radius of a player:
<syntaxhighlight lang="lua">
function disableVehicleCollisionsNearPlayer(thePlayer, maxDistance)
local playerX, playerY, playerZ = getElementPosition(thePlayer)
local vehicles = getElementsByType("vehicle")
for k,v in ipairs(vehicles) do
local vehicleX, vehicleY, vehicleZ = getElementPosition(v)
-- get the distance between the player and the vehicle:
local distance = getDistanceBetweenPoints3D(vehicleX, vehicleY, vehicleZ, playerX, playerY, playerZ)
if (distance <= maxDistance) then
-- disable collisions for the vehicle
setElementCollisionsEnabled(v, false)
end
end
end
</syntaxhighlight>

==See Also==
{{Client element functions}}

SmoothMoveCamera

2020-01-10T18:03:10Z

JeViCo: added example (using interpolateBetween). Grammar & syntax check needed (variable count reduce ?)

{{Useful Function}}
<lowercasetitle/>
__NOTOC__

This function allows you to create a cinematic-camera-flight, which moves from a specific position to a specific position.

==Syntax==
<syntaxhighlight lang="lua">bool smoothMoveCamera ( float x1, float y1, float z1, float x1t, float y1t, float z1t, float x2, float y2, float z2, float x2t, float y2t, float z2t, int time )</syntaxhighlight>

* '''x1, y1, z1''': The camera's start position.
* '''x1t, y1t, z1t''': The camera's start look at.
* '''x2, y2, z2''': The camera's end position.
* '''x2t, y2t, z2t''': The camera's end look at.
* '''time''': The speed of the camera's movement.

==Code==
This version returns false if a smoothMoveCamera is in progress:
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0
sm.object1,sm.object2 = nil,nil

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local function camRender()
if (sm.moov == 1) then
local x1,y1,z1 = getElementPosition(sm.object1)
local x2,y2,z2 = getElementPosition(sm.object2)
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientPreRender",root,camRender)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1)then return false end
sm.object1 = createObject(1337,x1,y1,z1)
sm.object2 = createObject(1337,x1t,y1t,z1t)
setElementCollisionsEnabled (sm.object1,false)
setElementCollisionsEnabled (sm.object2,false)
setElementAlpha(sm.object1,0)
setElementAlpha(sm.object2,0)
setObjectScale(sm.object1,0.01)
setObjectScale(sm.object2,0.01)
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")
sm.moov = 1
setTimer(removeCamHandler,time,1)
setTimer(destroyElement,time,1,sm.object1)
setTimer(destroyElement,time,1,sm.object2)
addEventHandler("onClientPreRender",root,camRender)
return true
end
</syntaxhighlight>
</section>
Author: Noneatme(Me) [Fixed by ADCX and Motar2k~, does not give errors now]

This Version allows cancellation of current smoothMoveCamera progress and doing another one.
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0
sm.object1,sm.object2 = nil,nil

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local function camRender()
if (sm.moov == 1) then
local x1,y1,z1 = getElementPosition(sm.object1)
local x2,y2,z2 = getElementPosition(sm.object2)
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientPreRender",root,camRender)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1)then
destroyElement(sm.object1)
destroyElement(sm.object2)
killTimer(timer1)
killTimer(timer2)
killTimer(timer3)
removeEventHandler("onClientPreRender",root,camRender)
end
sm.object1 = createObject(1337,x1,y1,z1)
sm.object2 = createObject(1337,x1t,y1t,z1t)
setElementCollisionsEnabled (sm.object1,false)
setElementCollisionsEnabled (sm.object2,false)
setElementAlpha(sm.object1,0)
setElementAlpha(sm.object2,0)
setObjectScale(sm.object1,0.01)
setObjectScale(sm.object2,0.01)
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")
sm.moov = 1
timer1 = setTimer(removeCamHandler,time,1)
timer2 = setTimer(destroyElement,time,1,sm.object1)
timer3 = setTimer(destroyElement,time,1,sm.object2)
addEventHandler("onClientPreRender",root,camRender)
return true
end
</syntaxhighlight>
</section>

Made by JeViCo. Same function as previous one except it's using interpolateBetween function. Also this version may fix little preiodic flickering which happen in previous examples.
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
local sm = {}
sm.moov = 0

local function removeCamHandler()
if(sm.moov == 1)then
sm.moov = 0
end
end

local start
local animTime
local tempPos = {{},{}}
local tempPos2 = {{},{}}

local function camRender()
local now = getTickCount()
if (sm.moov == 1) then
local x1, y1, z1 = interpolateBetween(tempPos[1][1], tempPos[1][2], tempPos[1][3], tempPos2[1][1], tempPos2[1][2], tempPos2[1][3], (now-start)/animTime, "InOutQuad")
local x2,y2,z2 = interpolateBetween(tempPos[2][1], tempPos[2][2], tempPos[2][3], tempPos2[2][1], tempPos2[2][2], tempPos2[2][3], (now-start)/animTime, "InOutQuad")
setCameraMatrix(x1,y1,z1,x2,y2,z2)
else
removeEventHandler("onClientRender",root,camRender)
fadeCamera(true)
end
end

function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)
if(sm.moov == 1) then
killTimer(timer1)
killTimer(timer2)
removeEventHandler("onClientRender",root,camRender)
fadeCamera(true)
end
fadeCamera(true)
sm.moov = 1
timer1 = setTimer(removeCamHandler,time,1)
timer2 = setTimer(fadeCamera, time-1000, 1, false) --
start = getTickCount()
animTime = time
tempPos[1] = {x1,y1,z1}
tempPos[2] = {x1t,y1t,z1t}
tempPos2[1] = {x2,y2,z2}
tempPos2[2] = {x2t,y2t,z2t}
addEventHandler("onClientRender",root,camRender)
return true
end
</syntaxhighlight>
</section>
==See Also==
{{Useful_Functions}}

Table.empty

2019-12-15T07:45:11Z

JeViCo: updated code (check needed)

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check is empty table or not.
==Syntax==
<syntaxhighlight lang="lua">boolean table.empty( table a )</syntaxhighlight>

===Required Arguments===
* '''a''': The table for check.

===Returns===
Returns the true if table is empty or false in otherwise.

<section name="Code" class="both" show="true">
<syntaxhighlight lang="lua">
function table.empty(a)
for _, _ in pairs(a) do
return false
end
return true
end
</syntaxhighlight>
</section>

<section name="Example" class="both" show="true">
<syntaxhighlight lang="lua">
print( 'empty = ' .. tostring( table.empty( { [0] = 1 } ) ) ) -- false
print( 'empty = ' .. tostring( table.empty( { [10] = 10, [2] = 2 } ) ) ) -- false
print( 'empty = ' .. tostring( table.empty( { } ) ) ) -- true
</syntaxhighlight>
</section>

Author: Kenix & Renkon

==See Also==
{{Useful_Functions}}

AddEventHandler

2019-11-11T16:30:49Z

JeViCo: revert last edit (wrong)

__NOTOC__
{{Server client function}}
{{Important Note|Do '''NOT''' use the same name for your handler function as the event name, as this can lead to confusion if multiple handler functions are used}}
This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.

Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:
*'''source''': the element that triggered the event
*'''this''': the element that the event handler is attached to
*'''sourceResource''': the resource that triggered the event
*'''sourceResourceRoot''': the root element of the resource that triggered the event
*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.
{{New_feature|3|1.0|
*'''eventName''': the name of the event which triggered the handler function.
}}

It is important to remember that events pass up and down the [[element tree]]. An event triggered on the root element is triggered on every element in the tree. An event triggered on any other element is triggered on its ancestors (its parent element and its parent's parent etc) and its children, grandchildren and great-grandchildren. You can use the ''getPropagated'' argument to specify if you wish your handler to receive events that have propagated up or down the tree.

The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.
{{Note|See [[Script security]] for tips on preventing cheaters when using events and element data}}
{{Note|See [[Event_Source_Element|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}
==Syntax==
<syntaxhighlight lang="lua">
bool addEventHandler ( string eventName, element attachedTo, function handlerFunction [, bool getPropagated = true, string priority = "normal" ] )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the [[event]] you want to attach the handler function to.
*'''attachedTo:''' The [[element]] you wish to attach the handler to. The handler will only be called when the event it is attached to is triggered for this element, or one of its children. Often, this can be the root element (meaning the handler will be called when the event is triggered for ''any'' element).
*'''handlerFunction:''' The handler function you wish to call when the event is triggered. This function will be passed all of the event's parameters as arguments, but it isn't required that it takes all of them.

===Optional Arguments===
*'''getPropagated:''' A boolean representing whether the handler will be triggered if the event was propagated down or up the [[element tree]] (starting from the source), and not triggered directly on attachedTo (that is, handlers attached with this argument set to ''false'' will only be triggered if ''source == this'').
{{New_feature|3.0131|1.3.1|
*'''priority :''' A string representing the trigger order priority relative to other event handlers of the same name. Possible values are:
**'''"high"'''
**'''"normal"'''
**'''"low"'''
''It is also possible to add finer priority control by appending a positive or negative number to the priority string. For example (in priority order for reference): "high+4" "high" "high-1" "normal-6" "normal-7" "low+1" "low" "low-1"''
{{Important Note|Anything bound to a specific element will be run before other handlers that are bound to something higher in the element tree (like root) This means that "high+10" bound to root '''won't''' trigger before "normal" bound directly to an element.}}
}}

===Returns===
Returns ''true'' if the event handler was attached successfully. Returns ''false'' if the specified event could not be found or any parameters were invalid.

==Example==
<section name="Server" class="server" show="true">
This serverside example sends a message to everyone in the server when a player spawns.
<syntaxhighlight lang="lua">
-- define our handler function
function onPlayerSpawnHandler ( )
-- get the player's name, source is the player because he was spawned
local playerName = getPlayerName( source )
-- output in the chat box that they've spawned
outputChatBox ( playerName .. " has spawned!" )
end

addEventHandler( "onPlayerSpawn", root, onPlayerSpawnHandler ) -- root is a predefined global variable for getRootElement()
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03795|Added priority argument}}

==See Also==
{{Event_functions}}
[[ru:addEventHandler]]

AddEventHandler

2019-11-11T12:32:58Z

JeViCo: how to avoid problems described in first note

__NOTOC__
{{Server client function}}
{{Important Note|Do '''NOT''' use the same name for your handler function as the event name, as this can lead to confusion if multiple handler functions are used. Use resourceRoot as attachedTo element to define local events}}
This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.

Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:
*'''source''': the element that triggered the event
*'''this''': the element that the event handler is attached to
*'''sourceResource''': the resource that triggered the event
*'''sourceResourceRoot''': the root element of the resource that triggered the event
*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.
{{New_feature|3|1.0|
*'''eventName''': the name of the event which triggered the handler function.
}}

It is important to remember that events pass up and down the [[element tree]]. An event triggered on the root element is triggered on every element in the tree. An event triggered on any other element is triggered on its ancestors (its parent element and its parent's parent etc) and its children, grandchildren and great-grandchildren. You can use the ''getPropagated'' argument to specify if you wish your handler to receive events that have propagated up or down the tree.

The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.
{{Note|See [[Script security]] for tips on preventing cheaters when using events and element data}}
{{Note|See [[Event_Source_Element|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}
==Syntax==
<syntaxhighlight lang="lua">
bool addEventHandler ( string eventName, element attachedTo, function handlerFunction [, bool getPropagated = true, string priority = "normal" ] )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the [[event]] you want to attach the handler function to.
*'''attachedTo:''' The [[element]] you wish to attach the handler to. The handler will only be called when the event it is attached to is triggered for this element, or one of its children. Often, this can be the root element (meaning the handler will be called when the event is triggered for ''any'' element).
*'''handlerFunction:''' The handler function you wish to call when the event is triggered. This function will be passed all of the event's parameters as arguments, but it isn't required that it takes all of them.

===Optional Arguments===
*'''getPropagated:''' A boolean representing whether the handler will be triggered if the event was propagated down or up the [[element tree]] (starting from the source), and not triggered directly on attachedTo (that is, handlers attached with this argument set to ''false'' will only be triggered if ''source == this'').
{{New_feature|3.0131|1.3.1|
*'''priority :''' A string representing the trigger order priority relative to other event handlers of the same name. Possible values are:
**'''"high"'''
**'''"normal"'''
**'''"low"'''
''It is also possible to add finer priority control by appending a positive or negative number to the priority string. For example (in priority order for reference): "high+4" "high" "high-1" "normal-6" "normal-7" "low+1" "low" "low-1"''
{{Important Note|Anything bound to a specific element will be run before other handlers that are bound to something higher in the element tree (like root) This means that "high+10" bound to root '''won't''' trigger before "normal" bound directly to an element.}}
}}

===Returns===
Returns ''true'' if the event handler was attached successfully. Returns ''false'' if the specified event could not be found or any parameters were invalid.

==Example==
<section name="Server" class="server" show="true">
This serverside example sends a message to everyone in the server when a player spawns.
<syntaxhighlight lang="lua">
-- define our handler function
function onPlayerSpawnHandler ( )
-- get the player's name, source is the player because he was spawned
local playerName = getPlayerName( source )
-- output in the chat box that they've spawned
outputChatBox ( playerName .. " has spawned!" )
end

addEventHandler( "onPlayerSpawn", root, onPlayerSpawnHandler ) -- root is a predefined global variable for getRootElement()
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03795|Added priority argument}}

==See Also==
{{Event_functions}}
[[ru:addEventHandler]]

GetEventHandlers

2019-07-05T10:02:31Z

JeViCo: replaced word 'array' with 'table'

__NOTOC__
{{Server client function}}
{{New feature/item|3.0140|1.4|4973|
This function gets the attached functions from the event and attached element from current lua script.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getEventHandlers ( string eventName, element attachedTo )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event. For example ( "onPlayerWasted" ).
*'''attachedTo:''' The [[element]] attached to.

===Returns===
Returns table with attached functions, empty table otherwise.

===Example===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isEventHandlerAdded( sEventName, pElementAttachedTo, func )
if
type( sEventName ) == 'string' and
isElement( pElementAttachedTo ) and
type( func ) == 'function'
then
local aAttachedFunctions = getEventHandlers( sEventName, pElementAttachedTo )
if type( aAttachedFunctions ) == 'table' and #aAttachedFunctions > 0 then
for i, v in ipairs( aAttachedFunctions ) do
if v == func then
return true
end
end
end
end

return false
end

function onPlayerWasted()
outputChatBox( getPlayerName( source ) .. ' died.' )
end
addEventHandler( 'onPlayerWasted', root, onPlayerWasted )

addCommandHandler( 'removeOnPlayerWastedEvent',
function()
if isEventHandlerAdded( 'onPlayerWasted', root, onPlayerWasted ) then
outputChatBox( 'onPlayerWasted succesfully removed!' )
removeEventHandler( 'onPlayerWasted', root, onPlayerWasted )
end
end
)
</syntaxhighlight>
</section>

==See also==
{{Event functions}}

GetEventHandlers

2019-07-05T10:01:55Z

JeViCo: return result fixed

__NOTOC__
{{Server client function}}
{{New feature/item|3.0140|1.4|4973|
This function gets the attached functions from the event and attached element from current lua script.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getEventHandlers ( string eventName, element attachedTo )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the event. For example ( "onPlayerWasted" ).
*'''attachedTo:''' The [[element]] attached to.

===Returns===
Returns table with attached functions, empty array otherwise.

===Example===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isEventHandlerAdded( sEventName, pElementAttachedTo, func )
if
type( sEventName ) == 'string' and
isElement( pElementAttachedTo ) and
type( func ) == 'function'
then
local aAttachedFunctions = getEventHandlers( sEventName, pElementAttachedTo )
if type( aAttachedFunctions ) == 'table' and #aAttachedFunctions > 0 then
for i, v in ipairs( aAttachedFunctions ) do
if v == func then
return true
end
end
end
end

return false
end

function onPlayerWasted()
outputChatBox( getPlayerName( source ) .. ' died.' )
end
addEventHandler( 'onPlayerWasted', root, onPlayerWasted )

addCommandHandler( 'removeOnPlayerWastedEvent',
function()
if isEventHandlerAdded( 'onPlayerWasted', root, onPlayerWasted ) then
outputChatBox( 'onPlayerWasted succesfully removed!' )
removeEventHandler( 'onPlayerWasted', root, onPlayerWasted )
end
end
)
</syntaxhighlight>
</section>

==See also==
{{Event functions}}

Template:Useful Functions

2019-07-05T09:46:33Z

JeViCo: Undo revision 63173 by JeViCo (talk)

__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.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[isPlayerStaff]] » This function checks if a player is server admin or staff.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

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

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[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.
*[[isFireKey]] » This function checks if a key is the firing key.

=== 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.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.
*[[isLowerOrUpper]] »This function checks whether the letter is large or small.

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

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

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

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

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

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

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

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

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

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

Template:Useful Functions

2019-07-05T09:23:28Z

JeViCo: added file functions section with a new useful function

__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.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[isPlayerStaff]] » This function checks if a player is server admin or staff.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.

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

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[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.
*[[isFireKey]] » This function checks if a key is the firing key.

=== 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.
*[[getDistanceBetweenElements]] » Esta funcion sirve para obtener la distancia entre dos elementos.
*[[isLowerOrUpper]] »This function checks whether the letter is large or small.

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

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

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

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

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

=== Vehicle functions ===
*[[getNearestVehicle]] » This function gets the nearest vehicle to the specified player in a specified distance.
*[[getRandomVehicle]] » This function gets a random vehicle.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehiclesCountByType]] » This function returns the amount of vehicles by the given type as an integer value.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleReversing]] » This function checks if a specified vehicle is moving backwards.
*[[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.

=== File functions ===
*[[fileClear]] » This function allow you to clear file content.

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

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

DxGetTextWidth

2019-03-07T11:15:48Z

JeViCo: Undo revision 62332 by JeViCo (talk)

__NOTOC__
{{Client function}}
This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].

'''NOTE:''' This function is relative to the client's screen resolution.

==Syntax==
<syntaxhighlight lang="lua">
float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.1|6942|{{OOP|This syntax requires you to ignore the font argument above| [[Element/DX font|font]]:getTextWidth}}}}
===Required Arguments===
* '''text:''' A string representing the text for which you wish to retrieve with width for.

==Optional Arguments==
{{OptionalArg}}
* '''scale:''' The size of the text.
* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}
* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

===Returns===
Returns the float of the width of the text.

==Example==
<section name="Example" class="client" show="true">
This will show you the width of a message in a normal chatbox sent by a player
<syntaxhighlight lang="lua">
function dxwidth(msg)
chatbox = getChatboxLayout()
local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
outputChatBox(tostring(length))
end
addEventHandler("onClientChatMessage",root,dxwidth)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

[[hu:dxGetTextWidth]]

DxGetTextWidth

2019-03-07T11:09:17Z

JeViCo:

__NOTOC__
{{Client function}}
This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using [[dxDrawText]].
{{Note|The returned width will be in logical units which are 1.75 times the actual pixel width.}}

'''NOTE:''' This function is relative to the client's screen resolution.

==Syntax==
<syntaxhighlight lang="lua">
float dxGetTextWidth ( string text, [float scale=1, mixed font="default", bool bColorCoded=false] )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.1|6942|{{OOP|This syntax requires you to ignore the font argument above| [[Element/DX font|font]]:getTextWidth}}}}
===Required Arguments===
* '''text:''' A string representing the text for which you wish to retrieve with width for.

==Optional Arguments==
{{OptionalArg}}
* '''scale:''' The size of the text.
* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}
* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

===Returns===
Returns the float of the width of the text.

==Example==
<section name="Example" class="client" show="true">
This will show you the width of a message in a normal chatbox sent by a player
<syntaxhighlight lang="lua">
function dxwidth(msg)
chatbox = getChatboxLayout()
local length = dxGetTextWidth(msg,chatbox["chat_scale"][1])
outputChatBox(tostring(length))
end
addEventHandler("onClientChatMessage",root,dxwidth)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

[[hu:dxGetTextWidth]]

FetchRemote

2018-12-30T20:03:32Z

JeViCo:

__NOTOC__
{{Server client function}}
This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

If you are using fetchRemote to connect to a PHP script, you can use ''file_get_contents("php://input")'' to read the '''postData''' sent from this function.
{{Note|Client side function only works with the server the player is connected to unless the domain has been accepted with [[requestBrowserDomains]]}}
{{ Warning| function won't trigger inside another fetchRemote function }}
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, string queueName = "default" ][, int connectionAttempts = 10, int connectTimeout = 10000 ], function callbackFunction, [ string postData = "", bool postIsBinary = false, [ arguments... ] ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''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. A list of possible error values are:
{{Error_codes_for_callRemote_and_fetchRemote}}
<div style="padding-left:19px;">
*'''''arguments...''''' - The arguments that were passed into fetchRemote
</div>

===Optional Arguments===
{{New items|4.0153|1.5.3-9.11270|
*'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
}}
*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 10 seconds. Therefore, the default setting of 10 connection attempts means it will be 100 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 20 seconds''
*'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out
*'''postData:''' A string specifying any data you want to send to the remote HTTP server.
*'''postIsBinary :''' A boolean specifying if the data is text, or binary.
*'''arguments:''' Any arguments you may want to pass to the callback.

{{New items|5.0154|1.5.4-9.11342|
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, table options ], callback callbackFunction[, table callbackArguments ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''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
**'''''responseInfo''''' - A table containing:
***'''''success''''' - A boolean indicating if the request was successful.
***'''''statusCode''''' - An integer status/error code
***'''''headers''''' - A table containing the HTTP response headers
**'''''arguments...''''' - The arguments that were passed into fetchRemote

===Optional Arguments===
*'''options:''' A table containing any request options:
**'''queueName:''' Name of the queue to use. Any name can be used. If not set, the queue name is "default". Requests in the same queue are processed in order, one at a time.
**'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''(Defaults to 10)''
**'''connectTimeout:''' Number of milliseconds each connection attempt will take before timing out. ''(Defaults to 10000)''
**'''postData:''' A string specifying any data you want to send to the remote HTTP server.
**'''postIsBinary :''' A boolean specifying if the data is text, or binary. ''(Defaults to false)''
**'''method:''' A string specifying the request method. ''(Defaults to GET or POST)''
**'''headers:''' A table containing HTTP request headers. ''e.g.{ Pragma="no-cache" }''
**'''maxRedirects:''' An integer limiting the number of HTTP redirections to automatically follow. ''(Defaults to 8)''
**'''username:''' A string specifying the username for protected pages.
**'''password:''' A string specifying the password for protected pages.
{{New items|5.0154|1.5.4-9.11413|
**'''formFields:''' A table containing form items to submit. ''e.g.{ name="bob", email="bob@example.com" }''
}}
*'''arguments:''' A table containing arguments you may want to pass to the callback.
}}

===Returns===
Returns ''true'' if the arguments are correct, ''false'' otherwise.

==Example==
This example shows you how you can fetch an image from a web page, and transfer it to a particular client:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function startImageDownload( playerToReceive )
fetchRemote ( "http://www.example.com/image.jpg", myCallback, "", false, playerToReceive )
end

function myCallback( responseData, errno, playerToReceive )
if errno == 0 then
triggerClientEvent( playerToReceive, "onClientGotImage", resourceRoot, responseData )
end
end
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent( "onClientGotImage", true )
addEventHandler( "onClientGotImage", resourceRoot,
function( pixels )
if myTexture then
destroyElement( myTexture )
end
myTexture = dxCreateTexture( pixels )
end
)

addEventHandler("onClientRender", root,
function()
if myTexture then
local w,h = dxGetMaterialSize( myTexture )
dxDrawImage( 200, 100, w, h, myTexture )
end
end
)
</syntaxhighlight>
</section>
 
{{New items|5.0154|1.5.4-9.11413|
Example sending email via a web service (adopted from examples on https://documentation.mailgun.com/user_manual.html)
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
sendOptions = {
queueName = "My Mailgun queue",
connectionAttempts = 3,
connectTimeout = 5000,
formFields = {
from="Excited User <excited@samples.mailgun.org>",
to="devs@mailgun.net",
subject="Hello",
text="Testing some Mailgun awesomness!",
},
username="api",
password="key-3ax6xnjp29jd6fds4gc373sgvjxteol0",
}
fetchRemote( "https://api.mailgun.net/v3/samples.mailgun.org/messages", sendOptions, mailgunCompleteCallback )

function mailgunCompleteCallback(data, info)
outputDebugString( "mailgunComplete"
.. " success:" .. tostring(info.success)
.. " statusCode:" .. tostring(info.statusCode)
.. " data:" .. tostring(data)
)
end
</syntaxhighlight>
</section>
}}

==Requirements==
{{Requirements|1.3.0-9.03739|1.3.2|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04605|Added connectionAttempts argument}}
{{ChangelogItem|1.3.2|Added client side}}
{{ChangelogItem|1.5.3-9.11270|Added queueName argument}}
{{ChangelogItem|1.5.4-9.11342|Added alternative syntax}}
{{ChangelogItem|1.5.4-9.11413|Added formFields}}

==See Also==
{{Resource_functions}}

FileRead

2018-09-16T06:28:22Z

JeViCo: /* Example */

__NOTOC__
{{Server client function}}

Reads the specified number of bytes from the given file starting at its current read/write position, and returns them as a string.

==Syntax==
<syntaxhighlight lang="lua">
string fileRead ( file theFile, int count )
</syntaxhighlight>
{{OOP||[[file]]:read}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
*'''count:''' The number of bytes you wish to read.

===Returns===
Returns the bytes that were read in a string. Note that this string might not contain as many bytes as you specified if an error occured, i.e. end of file.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
function readFile(path)
local file = fileOpen(path) -- attempt to open the file
if not file then
return false -- stop function on failture
end
local count = fileGetSize(file) -- get file's total size
local data = fileRead(file, count) -- read whole file
fileClose(file) -- close the file once we're done with it
outputConsole(data) -- output code in console
end

addCommandHandler("readfile",function(cmd,fileName) -- add command to test this function
readFile(fileName) -- execute the function
end)
</syntaxhighlight>

[[fileOpen]] sets the read/write position to the beginning of the file.
[[fileGetSize]] gets the total size in bytes of given file.

==See Also==
{{File functions}}

FileRead

2018-09-16T06:26:41Z

JeViCo: /* Example */

__NOTOC__
{{Server client function}}

Reads the specified number of bytes from the given file starting at its current read/write position, and returns them as a string.

==Syntax==
<syntaxhighlight lang="lua">
string fileRead ( file theFile, int count )
</syntaxhighlight>
{{OOP||[[file]]:read}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
*'''count:''' The number of bytes you wish to read.

===Returns===
Returns the bytes that were read in a string. Note that this string might not contain as many bytes as you specified if an error occured, i.e. end of file.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
function readFile(path)
local file = fileOpen(path) -- attempt to open the file
if not file then
return false -- stop function on failture
end
local count = fileGetSize(file) -- get file's total size
local data = fileRead(file, count) -- read whole file
fileClose(file) -- close the file once we're done with it
outputConsole(data) -- output code in console
end

addCommandHandler("readFile",function(cmd,fileName) -- add command to test this function
readFile(fileName) -- execute the function
end)
</syntaxhighlight>

[[fileOpen]] sets the read/write position to the beginning of the file.
[[fileGetSize]] gets the total size in bytes of given file.

==See Also==
{{File functions}}

FileRead

2018-09-16T06:26:10Z

JeViCo: /* Example */

__NOTOC__
{{Server client function}}

Reads the specified number of bytes from the given file starting at its current read/write position, and returns them as a string.

==Syntax==
<syntaxhighlight lang="lua">
string fileRead ( file theFile, int count )
</syntaxhighlight>
{{OOP||[[file]]:read}}

===Required Arguments===
*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
*'''count:''' The number of bytes you wish to read.

===Returns===
Returns the bytes that were read in a string. Note that this string might not contain as many bytes as you specified if an error occured, i.e. end of file.

==Example==
This example opens the file test.txt and outputs its contents to the console.
<syntaxhighlight lang="lua">
function readFile(path)
local file = fileOpen(path) -- attempt to open the file
if not file then
return false -- stop function on failture
end
local count = fileGetSize(file) -- get file's total size
local data = fileRead(file, count) -- read whole file
fileClose(file) -- close the file once we're done with it
outputConsole(data) -- output code in console
end

addCommandHandler("readFile",function(cmd,fileName) -- add command to test this function
readFile(fileName) -- execute the function
end)
</syntaxhighlight>

[[fileOpen]] sets the read/write position to the beginning of the file.
[[fileGetSize]] gets the total size in bytes of given file

==See Also==
{{File functions}}

CreateEffect

2018-09-14T16:38:32Z

JeViCo:

__NOTOC__
{{Client function}}
{{New items|3.0140|1.4|
Creates an [[Element/Effect|effect]] on specified position.
}}
{{Note|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
{{Note|All effects have their own duration.}}
==Syntax==
<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>
{{OOP||[[Effect]]}}

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
{{New feature/item|3.0155|1.5.5||
*'''soundEnabled:''' to enable the sound of the effect.
}}

=== Returns ===
Returns the [[Element/Effect|effect]] element if creation was successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">

--There are 82 effects

local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex <= #effectNames then
createEffect(effectNames[effectIndex], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.06892|Added drawDistance argument}}

== See Also ==
{{Client_Effects_functions}}
[[ru:createEffect]]

CreateEffect

2018-09-14T16:38:15Z

JeViCo:

__NOTOC__
{{Client function}}
{{New items|3.0140|1.4|
Creates an [[Element/Effect|effect]] on specified position.
}}
{{Note|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
{{Note|All effects have their own duration).}}
==Syntax==
<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>
{{OOP||[[Effect]]}}

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
{{New feature/item|3.0155|1.5.5||
*'''soundEnabled:''' to enable the sound of the effect.
}}

=== Returns ===
Returns the [[Element/Effect|effect]] element if creation was successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">

--There are 82 effects

local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex <= #effectNames then
createEffect(effectNames[effectIndex], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.06892|Added drawDistance argument}}

== See Also ==
{{Client_Effects_functions}}
[[ru:createEffect]]

DxCreateRenderTarget

2018-09-14T16:35:57Z

JeViCo:

{{Client function}}
__NOTOC__
This function creates a render target element, which is a special type of [[texture]] that can be drawn on with the dx functions. Successful render target 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.)
{{Tip|Use [[dxSetBlendMode]] to get better quality}}
{{Tip|It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateRenderTarget.}}
{{Note|Render targets are usually cleared when the player minimizes MTA (i.e. alt-tab). See [[onClientRestore]] for details on when to restore any fixed content.}}

==Syntax==
<syntaxhighlight lang="lua">
element dxCreateRenderTarget ( int width, int height [, bool withAlpha = false ] )
</syntaxhighlight>
{{OOP||[[Texture|DxRenderTarget]]}}
===Required Arguments===
*'''width :''' The width of the texture in pixels.
*'''height :''' The height of the texture in pixels.
*'''withAlpha:''' The render target will be created with an alpha channel. 'false' will turn images' alpha channels to black color

===Returns===
Returns a [[texture]] element if successful, ''false'' if the system is unable to create a render target.

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

==Explanation==
What is a rendertarget?
A rendertarget is like a big, white paper(or if you set alpha to true, it will be a transparent paper) that you can draw on,
after you drawn on it, you can draw it as many times as you like, without impacting performance. It could be used for
dashboard, where a few hundred dxDraw* functions are called, so, instead of calling these every frame, you can just
draw it on a render target, and draw the render target, instead of every information one by one.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
myRenderTarget = dxCreateRenderTarget( 80, 100 ) -- Create a render target texture which is 80 x 100 pixels
end
)

addEventHandler( "onClientRender", root,
function()
if myRenderTarget then
dxSetRenderTarget( myRenderTarget ) -- Start drawing on myRenderTarget
dxDrawText ( "Hello", 10, 20 ) -- Draw a message
dxSetRenderTarget() -- Stop drawing on myRenderTarget

dxDrawImage( 50, 50, 100, 100, myRenderTarget ) -- Now use myRenderTarget as a material and draw it lots of times
dxDrawImage( 150, 350, 150, 100, myRenderTarget )
dxDrawImage( 250, 250, 100, 150, myRenderTarget )
dxDrawImage( 350, 30, 150, 150, myRenderTarget )
end
end
)

local myRenderTarget = dxCreateRenderTarget(500, 500, true)

--
-- Function to draw text to our render target with '''modulate_add''' blend mode when the 'r' key is pressed
--
function updateRenderTarget()
dxSetRenderTarget(myRenderTarget, true)
dxSetBlendMode("modulate_add") -- Set 'modulate_add' when drawing stuff on the render target

dxDrawText("Testing "..getTickCount(), 0, 0, 0, 0, tocolor(255, 255, 255, 255), 2, "clear")

dxSetBlendMode("blend") -- Restore default blending
dxSetRenderTarget() -- Restore default render target
end
bindKey("r", "down", updateRenderTarget )

</syntaxhighlight>

==See Also==
{{Drawing_functions}}

DxSetShaderValue

2018-09-14T16:23:48Z

JeViCo:

{{Client function}}
__NOTOC__
This sets a named parameter for a [[shader]] element

{{Important Note|It's enough to set the texture only once if it's a render target}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetShaderValue ( element theShader, string parameterName, mixed value )
</syntaxhighlight>
{{OOP||[[shader]]:setValue}}

===Required Arguments===
*'''theShader:''' The shader element whose parameter is to be changed
*'''parameterName:''' The name of parameter
*'''value:''' The value to set, which can be a [[texture]], a bool, a number or a list of numbers('''max 16 floats(numbers)''')

===Returns===
Returns ''true'' if the shader element's parameter was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
myShader = dxCreateShader( "hello.fx" )
myTexture = dxCreateTexture( "man.png" )
dxSetShaderValue( myShader, "texure0", myTexture ) -- Set a texture
dxSetShaderValue( myShader, "bShowThing", true ) -- Set a bool
dxSetShaderValue( myShader, "speed", 2.4 ) -- Set a float
dxSetShaderValue( myShader, "positionOfCheese", 100, 200, 300 ) -- Set a list of numbers, with max 16 numbers. Btw, this is a float: 3.4
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

Vehicle Components

2018-08-26T09:22:54Z

JeViCo:

'''All components were tested in the vehicle "Sultan"'''
 
*''NOTES:
**''Unknown Component is all that what give "false" when i try move it.''
**''Changing wheel position on Z axis doesn't work.''
 
{|class="wikitable" style="text-align:center; margin: 1em auto 1em auto;"
|-
! width="150" scope="col" style="background:#8f8f8f;"| Component Name
! width="300" scope="col" style="background:#8f8f8f;"| Description
|-
|style="background:#cfcfcf;"|boot_dummy
|style="background:#cfcfcf;"|Trunk door
|-
|style="background:#cfcfcf;"|ug_nitro
|style="background:#cfcfcf;"|Nitro (tuning part)
|-
|style="background:#cfcfcf;"|wheel_rf_dummy
|style="background:#cfcfcf;"|Right Front Wheel
|-
|style="background:#cfcfcf;"|wheel_lf_dummy
|style="background:#cfcfcf;"|Left Front Wheel
|-
|style="background:#cfcfcf;"|wheel_rb_dummy
|style="background:#cfcfcf;"|Right Back Wheel
|-
|style="background:#cfcfcf;"|wheel_lb_dummy
|style="background:#cfcfcf;"|Left Back Wheel
|-
|style="background:#cfcfcf;"|chassis
|style="background:#cfcfcf;"|Chassis
|-
|style="background:#cfcfcf;"|chassis_vlo
|style="background:#cfcfcf;"|Chassis (lod)
|-
|style="background:#cfcfcf;"|ug_roof
|style="background:#cfcfcf;"|Roof
|-
|style="background:#cfcfcf;"|door_rf_dummy
|style="background:#cfcfcf;"|Right Front Door
|-
|style="background:#cfcfcf;"|door_lf_dummy
|style="background:#cfcfcf;"|Left Front Door
|-
|style="background:#cfcfcf;"|door_rb_dummy
|style="background:#cfcfcf;"|Right Back Door
|-
|style="background:#cfcfcf;"|door_lb_dummy
|style="background:#cfcfcf;"|Left Back Door
|-
|style="background:#cfcfcf;"|bonnet_dummy
|style="background:#cfcfcf;"|Hood
|-
|style="background:#cfcfcf;"|ug_wing_right
|style="background:#cfcfcf;"|Right wing (tuning part)
|-
|style="background:#cfcfcf;"|bump_front_dummy
|style="background:#cfcfcf;"|Front bumper
|-
|style="background:#cfcfcf;"|bump_rear_dummy
|style="background:#cfcfcf;"|Back bumper
|-
|style="background:#cfcfcf;"|windscreen_dummy
|style="background:#cfcfcf;"|Windscreen
|-

|style="background:#cfcfcf;"|ug_wing_left
|style="background:#cfcfcf;"|Leftwing (tuning part)
|-
|style="background:#cfcfcf;"|exhaust_ok
|style="background:#cfcfcf;"|Exhausts
|}

==Vehicle functions==
{{Client_vehicle_functions}}

Vehicle Components

2018-08-26T09:19:58Z

JeViCo:

'''All components were tested in the vehicle "Sultan"'''
 
*''NOTES:
**''Unknown Component is all that what give "false" when i try move it.''
**''Changing wheel position on Z axis doesn't work.''
 
{|class="wikitable" style="text-align:center; margin: 1em auto 1em auto;"
|-
! width="150" scope="col" style="background:#8f8f8f;"| Component Name
! width="300" scope="col" style="background:#8f8f8f;"| Description
|-
|style="background:#cfcfcf;"|boot_dummy
|style="background:#cfcfcf;"|Trunk door
|-
|style="background:#cfcfcf;"|ug_nitro
|style="background:#cfcfcf;"|Unknown Component
|-
|style="background:#cfcfcf;"|wheel_rf_dummy
|style="background:#cfcfcf;"|Right Front Wheel
|-
|style="background:#cfcfcf;"|wheel_lf_dummy
|style="background:#cfcfcf;"|Left Front Wheel
|-
|style="background:#cfcfcf;"|wheel_rb_dummy
|style="background:#cfcfcf;"|Right Back Wheel
|-
|style="background:#cfcfcf;"|wheel_lb_dummy
|style="background:#cfcfcf;"|Left Back Wheel
|-
|style="background:#cfcfcf;"|chassis
|style="background:#cfcfcf;"|Chassis
|-
|style="background:#cfcfcf;"|chassis_vlo
|style="background:#cfcfcf;"|Unknown Component
|-
|style="background:#cfcfcf;"|ug_roof
|style="background:#cfcfcf;"|Unknown Component
|-
|style="background:#cfcfcf;"|door_rf_dummy
|style="background:#cfcfcf;"|Right Front Door
|-
|style="background:#cfcfcf;"|door_lf_dummy
|style="background:#cfcfcf;"|Left Front Door
|-
|style="background:#cfcfcf;"|door_rb_dummy
|style="background:#cfcfcf;"|Right Back Door
|-
|style="background:#cfcfcf;"|door_lb_dummy
|style="background:#cfcfcf;"|Left Back Door
|-
|style="background:#cfcfcf;"|bonnet_dummy
|style="background:#cfcfcf;"|Hood
|-
|style="background:#cfcfcf;"|ug_wing_right
|style="background:#cfcfcf;"|Unknown Component
|-
|style="background:#cfcfcf;"|bump_front_dummy
|style="background:#cfcfcf;"|Front bumper
|-
|style="background:#cfcfcf;"|bump_rear_dummy
|style="background:#cfcfcf;"|Back bumper
|-
|style="background:#cfcfcf;"|windscreen_dummy
|style="background:#cfcfcf;"|Windscreen
|-

|style="background:#cfcfcf;"|ug_wing_left
|style="background:#cfcfcf;"|Unknow Component
|-
|style="background:#cfcfcf;"|exhaust_ok
|style="background:#cfcfcf;"|Exhausts
|}

==Vehicle functions==
{{Client_vehicle_functions}}

DxSetShaderValue

2018-08-14T13:10:52Z

JeViCo:

{{Client function}}
__NOTOC__
This sets a named parameter for a [[shader]] element

{{Important Note|It'll be enough to set texture only once if it's a render target}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetShaderValue ( element theShader, string parameterName, mixed value )
</syntaxhighlight>
{{OOP||[[shader]]:setValue}}

===Required Arguments===
*'''theShader:''' The shader element whose parameter is to be changed
*'''parameterName:''' The name of parameter
*'''value:''' The value to set, which can be a [[texture]], a bool, a number or a list of numbers('''max 16 floats(numbers)''')

===Returns===
Returns ''true'' if the shader element's parameter was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
myShader = dxCreateShader( "hello.fx" )
myTexture = dxCreateTexture( "man.png" )
dxSetShaderValue( myShader, "texure0", myTexture ) -- Set a texture
dxSetShaderValue( myShader, "bShowThing", true ) -- Set a bool
dxSetShaderValue( myShader, "speed", 2.4 ) -- Set a float
dxSetShaderValue( myShader, "positionOfCheese", 100, 200, 300 ) -- Set a list of numbers, with max 16 numbers. Btw, this is a float: 3.4
</syntaxhighlight>

==See Also==
{{Drawing_functions}}