https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=AncienTMulti Theft Auto: Wiki - User contributions [en]2026-05-18T02:02:34ZUser contributionsMediaWiki 1.39.3https://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=78751Resource:DGS2024-01-03T18:29:37Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''Github Repo''': https://github.com/thisdp/dgs<br />
<br />
'''Resource Download''': [https://github.com/thisdp/dgs/releases/latest/download/dgs.zip dgs.zip]<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.522<br />
<br />
'''Update Log''': [https://github.com/thisdp/dgs/releases/tag/3.522 Changes and Updates Log]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: Auto every month) By '''motar2k''']<br />
<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make everything easy to use and understand, DGS has almost the same usage as CEGUI.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=76190DxCreateShader2023-02-08T23:18:07Z<p>AncienT: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every existing PC.<br />
{{Note|It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.}}<br />
<br />
{{Deprecated items|3.0159|1.5.8|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,ped,vehicle,object,other,all" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
|20688}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.8|20688|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [ [, table macros = {} ], float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,ped,vehicle,object,other,all" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|3.0157|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
{{Updated feature/item|1.5.9|1.5.8|20688|<br />
This example creates a basic shader using macros to change shader's behaviour:<br />
<syntaxhighlight lang="lua"><br />
local shaderRawStr = [[<br />
texture MACRO_TEX_NAME;<br />
<br />
technique simple<br />
{<br />
pass P0<br />
{<br />
//-- Set up texture stage 0<br />
Texture[0] = MACRO_TEX_NAME;<br />
ColorOp[0] = SelectArg1;<br />
#ifdef MACRO_FIRST_ARG<br />
ColorArg1[0] = Texture;<br />
#else<br />
ColorArg1[0] = Diffuse;<br />
#endif<br />
AlphaOp[0] = SelectArg1;<br />
AlphaArg1[0] = Texture;<br />
<br />
//-- Disable texture stage 1<br />
ColorOp[1] = Disable;<br />
AlphaOp[1] = Disable;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler( "onClientResourceStart", resourceRoot,<br />
function ( )<br />
local shader, tech = dxCreateShader( shaderRawStr, { MACRO_TEX_NAME = "Tex0", MACRO_FIRST_ARG = true } )<br />
if not shader or tech ~= "simple" then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end <br />
<br />
local texture = dxCreateTexture( "test.png" )<br />
if not texture then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end<br />
<br />
dxSetShaderValue( shader, "Tex0", texture )<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
dxDrawImage( 0, 0, 500, 500, shader )<br />
end<br />
, false )<br />
end<br />
, false )<br />
</syntaxhighlight><br />
You can also pass macros in key-value pairs when the order is important.<br />
}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
{{ChangelogItem|1.5.8-9.20688|Added option to use macros}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76182Resource:DGS2023-02-06T18:52:15Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: 06/02/2023) By '''motar2k''']<br />
<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76181Resource:DGS2023-02-06T18:22:57Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: 05/02/2023) By '''motar2k''']<br />
<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76180Resource:DGS2023-02-06T00:45:59Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
*3. [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: 05/02/2023) By '''motar2k''']<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76179Resource:DGS2023-02-06T00:44:44Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
*3. [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets Last Update: 05/02/2023 By '''motar2k''']<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76178Resource:DGS2023-02-06T00:40:05Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
*3. [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets By '''motar2k''']<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Resource:DGS&diff=76177Resource:DGS2023-02-06T00:39:43Z<p>AncienT: </p>
<hr />
<div><pageclass class="resource" subcaption="Resource"></pageclass><br />
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]<br />
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.<br />
<br />
<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span><br />
<br />
<div style="padding:10px; border-radius:2px;font-size:14px;"><br />
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)<br />
<br />
'''Developer Team''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]], KronoS Lettify, [𝐓𝐅] 𝓣𝓗𝓔 𝓕𝓘𝓧𝓔𝓡<br />
<br />
'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span><br />
<br />
'''GitHub Source''': https://github.com/thisdp/dgs/tree/master<br />
<br />
'''Server Discord''': https://discord.gg/QEs8q6W<br />
<br />
'''Current Version''': 3.520<br />
<br />
'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]<br />
<br />
<br />
'''Auto Completion & Syntax Highlight'''<br />
<br />
Official:<br />
<br />
Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).<br />
*'''g2d -crawl npp/sublime/vscode'''<br />
<br />
Or you can use the following link to download completed files instead of crawling by yourself.<br />
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]<br />
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]<br />
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode]<br />
<br />
3rd Party Auto Completion:<br />
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']<br />
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]<br />
*3. [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VS Code Snippets By '''motar2k''']<br />
</div><br />
<br />
=Features=<br />
<br />
[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]<br />
<br />
[[Image:DGSS.png|400px|thumb|right|]] <br />
<br />
<br />
'''How does it work?'''<br />
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.<br />
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.<br />
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.<br />
<br />
<br />
'''What's different from cegui?'''<br />
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.<br />
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].<br />
<br />
<br />
'''Update System'''<br />
*It have an update system that can inform you of keeping your DGS latest.<br />
*When a newer version has been released, it will detecte the version changing periodically and then notice you.<br />
*Execute command "'''updatedgs'''" to check the least version and update your DGS.<br />
*Also, you can check the version of DGS by inputting the command "dgsver" <br />
<br />
<br />
'''You Should Know'''<br />
*This project was started from 2014.<br />
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.<br />
<br />
<br />
[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]] <br />
<br />
'''Examples scripts'''<br />
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)<br />
*2. Also File test.lua its have more Examples You can See it .<br />
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI<br />
<br />
<br />
'''Debug'''<br />
* You can enter the debug mode by executing the command "'''debugdgs'''".<br />
* "'''debugdgs'''": Simple debug mode. For basic information.<br />
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border<br />
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.<br />
<br />
<br />
'''Notice'''<br />
*It is recommended to change the resource name to 'dgs'.<br />
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as<br />
<syntaxhighlight lang="lua"><br />
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)<br />
</syntaxhighlight><br />
*Here is a feasible way to shorten the name of an exported function:<br />
<syntaxhighlight lang="lua"><br />
DGS = exports.dgs --shorten the export function prefix<br />
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportFunction())()-- load functions<br />
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label<br />
</syntaxhighlight><br />
'''Object Oriented Programming'''<br />
<syntaxhighlight lang="lua"><br />
loadstring(exports.dgs:dgsImportOOPClass(true))()-- load OOP class<br />
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop<br />
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window<br />
label.text = "DGS OOP Test" --set text<br />
</syntaxhighlight><br />
<br />
'''Special thanks to the following for their help (Respect the contributors)''':<br />
* Axel, Senpai, ZoNe<br />
* DiGiTal, #Dv^, maksam07<br />
* Scorpyo, Kingleonide, Bullet(.el3tar)<br />
* Allerek, Deihim007, OmarSwaitti(HankVoight)<br />
* FlyingFork, Lettify, Ahmed Ly<br />
* ᴛᴇᴍᴏɪꜱ, Shady1<br />
<br />
='''DGS Tips'''=<br />
*[[DGS Events and GUI Events]]<br />
*[[DGS Functions and GUI Functions]]<br />
*[[DGS Grid List]]<br />
*[[DGS OOP Class]]<br />
*[[DGS Custom Plugin]]<br />
*[[DGS Style System]]<br />
*[[G2D|DGS GUI To DGS]]<br />
<br />
='''DGS Element Properties'''=<br />
{{DGSPROPERTIES}}<br />
<br />
='''Client Functions'''=<br />
{{DGSFUNCTIONS}}<br />
<br />
=Client Events=<br />
{{DGSEVENTS}}<br />
<br />
=Last=<br />
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''<br />
[[Category:Resource]]<br />
<br />
[[ar:Resource:Dgs]]<br />
[[ZH-CN:Resource:Dgs]]<br />
[[PL:Resource:Dgs]]<br />
[[TR:Resource:Dgs]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73111SetElementBonePosition2021-12-07T07:08:18Z<p>AncienT: Syntax updated</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int bone, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''bone:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
[[File:CJ with long neck.png|thumb|alt=CJ with long neck|Example preview]]<br />
This example shows a surprised CJ with a long neck<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73110SetElementBonePosition2021-12-07T07:06:04Z<p>AncienT: New example</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
[[File:CJ with long neck.png|thumb|alt=CJ with long neck|Example preview]]<br />
This example shows a surprised CJ with a long neck<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73109SetElementBonePosition2021-12-07T07:05:30Z<p>AncienT: Undo revision 73108 by AncienT (talk)</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
This example shows a surprised CJ with a long neck<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73108SetElementBonePosition2021-12-07T06:59:35Z<p>AncienT: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
[[File:CJ with long neck.png|thumb|alt=CJ with long neck|Example preview]]<br />
This example shows a surprised CJ with a long neck<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=File:CJ_with_long_neck.png&diff=73107File:CJ with long neck.png2021-12-07T06:57:23Z<p>AncienT: </p>
<hr />
<div>deformed CJ made with the functions of setElementBonePosition</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73106SetElementBonePosition2021-12-07T06:54:04Z<p>AncienT: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
This example shows a surprised CJ with a long neck<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73105SetElementBonePosition2021-12-07T06:50:25Z<p>AncienT: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
Este ejemplo muestra a un CJ sorprendido<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler("onClientPedsProcessed", root, updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SetElementBonePosition&diff=73104SetElementBonePosition2021-12-07T06:49:10Z<p>AncienT: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Added feature/item|1.5.9|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}<br />
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}<br />
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setElementBonePosition ( element theElement, int boneId, float x, float y, float z )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''theElement:''' the [[Element|element]] to set the bone position on.<br />
*'''boneId:''' the ID of the bone to set the position of. See [[Bone IDs]].<br />
*'''x:''' The X coordinate of the destination.<br />
*'''y:''' The Y coordinate of the destination.<br />
*'''z:''' The Z coordinate of the destination.<br />
<br />
===Returns===<br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example==<br />
This example is a command where the player should input the bone ID and the XYZ coordinates to set one of his bones' position:<br />
<syntaxhighlight lang="lua"><br />
local bones = {<br />
[4] = Vector3(0, 0, 0.15),<br />
[5] = Vector3(0, 0, 0.15),<br />
[6] = Vector3(0, 0, 0.13),<br />
[7] = Vector3(0, 0, 0.13),<br />
[8] = Vector3(0, 0, 0.1),<br />
}<br />
function updatePed()<br />
for bone,v in pairs(bones) do<br />
local pos = localPlayer:getBonePosition(bone)+v<br />
setElementBonePosition(localPlayer, bone, pos)<br />
end<br />
end<br />
addEventHandler ("onClientPedsProcessed", getRootElement(), updatePed)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.8-9.20704|}}<br />
<br />
==See Also==<br />
{{Client_element_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=64886IsValueInTable2020-01-11T03:12:50Z<p>AncienT: </p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table and ID of row to value in table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SmoothMoveCamera&diff=63361SmoothMoveCamera2019-07-21T05:43:10Z<p>AncienT: </p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle/><br />
__NOTOC__<br />
<br />
This function allows you to create a cinematic-camera-flight, which moves from a specific position to a specific position.<br />
<br />
==Syntax==<br />
<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><br />
<br />
* '''x1, y1, z1''': The camera's start position.<br />
* '''x1t, y1t, z1t''': The camera's start look at.<br />
* '''x2, y2, z2''': The camera's end position.<br />
* '''x2t, y2t, z2t''': The camera's end look at.<br />
* '''time''': The speed of the camera's movement.<br />
<br />
==Code==<br />
This version returns false if a smoothMoveCamera is in progress:<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then return false end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementCollisionsEnabled (sm.object1,false) <br />
setElementCollisionsEnabled (sm.object2,false) <br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
setTimer(removeCamHandler,time,1)<br />
setTimer(destroyElement,time,1,sm.object1)<br />
setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
Author: Noneatme(Me) [Fixed by ADCX and Motar2k~, does not give errors now]<br />
<br />
This Version allows cancellation of current smoothMoveCamera progress and doing another one.<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then<br />
destroyElement(sm.object1)<br />
destroyElement(sm.object2)<br />
killTimer(timer1)<br />
killTimer(timer2)<br />
killTimer(timer3)<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementCollisionsEnabled (sm.object1,false) <br />
setElementCollisionsEnabled (sm.object2,false) <br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
timer1 = setTimer(removeCamHandler,time,1)<br />
timer2 = setTimer(destroyElement,time,1,sm.object1)<br />
timer3 = setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=ExecuteSQLQuery&diff=62832ExecuteSQLQuery2019-05-27T05:27:53Z<p>AncienT: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Server function}}<br />
<br />
This function executes an arbitrary SQL query and returns the result rows if there are any. It allows parameter binding for security (SQL injection is rendered impossible).<br />
<br />
'''NOTE: This function only acts upon registry.db. Use [[dbQuery]] to query a custom SQL database.'''<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
table executeSQLQuery ( string query [, var param1 [, var param2 ... ] ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''query:''' An SQL query. Positions where parameter values will be inserted are marked with a "?".<br />
<br />
===Optional Arguments===<br />
*'''paramX:''' A variable number of parameters. These must be strings or numbers - it is important to make sure they are of the correct type. Also, the number of parameters passed must be equal to the number of "?" characters in the query string.<br />
String parameters are automatically escaped by adding a backslash (\) before ' and \ characters.<br />
<br />
===Returns===<br />
Returns a table with the result of the query if it was a SELECT query, or ''false'' if otherwise. In case of a SELECT query the result table may be empty (if there are no result rows). The table is of the form:<br />
<br />
<syntaxhighlight lang="lua"><br />
{<br />
{ colname1=value1, colname2=value2, ... },<br />
{ colname1=value3, colname2=value4, ... },<br />
...<br />
}<br />
</syntaxhighlight><br />
A subsequent table represents the next row.<br />
<br />
==Example==<br />
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.<br />
<br />
Example equivalents for executeSQLCreateTable:<br />
<syntaxhighlight lang="lua"><br />
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")<br />
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")<br />
</syntaxhighlight><br />
<br />
Example equivalents for executeSQLDelete:<br />
<syntaxhighlight lang="lua"><br />
playerName = getPlayerName(thePlayer)<br />
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)<br />
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)<br />
</syntaxhighlight><br />
<br />
Example equivalents for executeSQLDropTable:<br />
<syntaxhighlight lang="lua"><br />
executeSQLQuery("DROP TABLE players" )<br />
executeSQLQuery("DROP TABLE `players`" )<br />
</syntaxhighlight><br />
<br />
Example equivalents for executeSQLSelect:<br />
<syntaxhighlight lang="lua"><br />
playerName = getPlayerName(thePlayer)<br />
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )<br />
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )<br />
</syntaxhighlight><br />
<br />
Example equivalents for executeSQLInsert:<br />
<syntaxhighlight lang="lua"><br />
playerName = getPlayerName(thePlayer)<br />
colorName = "Blue"<br />
soundName = "sound.mp3"<br />
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )<br />
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )<br />
</syntaxhighlight><br />
<br />
Example equivalents for executeSQLUpdate:<br />
<syntaxhighlight lang="lua"><br />
playerName = getPlayerName(thePlayer)<br />
colorName = "Blue"<br />
soundName = "sound.mp3"<br />
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )<br />
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )<br />
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )<br />
</syntaxhighlight><br />
<br />
<br />
This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.<br />
<br />
<syntaxhighlight lang="lua"><br />
function listPlayersWithMoreMoneyThan(thePlayer, command, amount)<br />
local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))<br />
outputConsole("Players with more money than " .. amount .. ":", thePlayer)<br />
for i, playerdata in ipairs(players) do<br />
outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)<br />
end<br />
end<br />
<br />
addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)<br />
</syntaxhighlight><br />
<br />
<br />
This example shows the amount of money a certain registered player has.<br />
<br />
<syntaxhighlight lang="lua"><br />
function showPlayerMoney(thePlayer, command, playerName)<br />
local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)<br />
if(#result == 0) then<br />
outputConsole("No player named " .. playerName .. " is registered.", thePlayer)<br />
else<br />
outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)<br />
end<br />
end<br />
addCommandHandler("playermoney", showPlayerMoney)<br />
</syntaxhighlight><br />
<br />
Notice the lack of single quotes around the "?" in this example, even though it represents a string. executeSQLQuery will see that the playerName variable is a string and take care of the correct execution of the query by itself.<br />
<br />
The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.<br />
<br />
==See Also==<br />
{{Registry_functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Vehicle_IDs&diff=62741Vehicle IDs2019-05-21T03:23:51Z<p>AncienT: /* Heavy & Utility trucks */</p>
<hr />
<div>==Introduction==<br />
This is a list of GTA:SA's vehicle ID numbers, as listed in the vehicles.ide file. These vehicle ID numbers are used for several vehicle scripting functions.<br />
<br />
====Lua table of all the valid vehicle IDs listed on this page====<br />
<syntaxhighlight lang="lua">vehicleIds = {400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415,<br />
416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433,<br />
434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451,<br />
452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469,<br />
470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487,<br />
488, 489, 490, 491, 492, 493, 494, 495, 496, 497, 498, 499, 500, 501, 502, 503, 504, 505,<br />
506, 507, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523,<br />
524, 525, 526, 527, 528, 529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541,<br />
542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559,<br />
560, 561, 562, 563, 564, 565, 566, 567, 568, 569, 570, 571, 572, 573, 574, 575, 576, 577,<br />
578, 579, 580, 581, 582, 583, 584, 585, 586, 587, 588, 589, 590, 591, 592, 593, 594, 595,<br />
596, 597, 598, 599, 600, 601, 602, 603, 604, 605, 606, 607, 608, 609, 610, 611<br />
}</syntaxhighlight><br />
<br />
====Lua table of vehicles that are not lockable====<br />
<syntaxhighlight lang="lua">nonLockableVehicles = {<br />
594, 606, 607, 611, 584, 608, 435, 450, 591, 539, 441, 464, 501, 465, 564, 472, 473, 493, 595, 484, 430, 453, 452, 446, 454, 581, 509, 481,<br />
462, 521, 463, 510, 522, 461, 448, 468, 586, 425, 520<br />
}</syntaxhighlight><br />
<br />
====Lua table of vehicles without number plates====<br />
<syntaxhighlight lang="lua">noNumberPlates = {<br />
592, 553, 577, 488, 511, 497, 548, 563, 512, 476, 593, 447, 425, 519, 520, 460, 417, 469, 487, 513, 509, 481, 510, 472, 473, 493, 595, 484,<br />
430, 453, 452, 446, 454<br />
}</syntaxhighlight><br />
<br />
====Lua table of vehicles that support up to three different colors====<br />
<syntaxhighlight lang="lua">maxColorVehicles = {<br />
483, 524, 446<br />
}</syntaxhighlight><br />
<br />
==Aircrafts==<br />
{|<br />
|- style="vertical-align: top;"<br />
| style="padding-right: 50px;" |<br />
<br />
===Airplanes===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Andromada || 592 || align="center" | [[Image:Androm.png]]<br />
|-<br />
| AT-400 || 577 || align="center" | [[Image:At400.png]]<br />
|-<br />
| Beagle || 511 || align="center" | [[Image:Beagle.png]]<br />
|-<br />
| Cropduster || 512 || align="center" | [[Image:Cropdust.png]]<br />
|-<br />
| Dodo || 593 || align="center" | [[Image:Dodo.png]]<br />
|-<br />
| Hydra || 520 || align="center" | [[Image:Hydra.png]]<br />
|-<br />
| Nevada || 553 || align="center" | [[Image:Nevada.png]]<br />
|-<br />
| Rustler || 476 || align="center" | [[Image:Rustler.png]]<br />
|-<br />
| Shamal || 519 || align="center" | [[Image:Shamal.png]]<br />
|-<br />
| Skimmer || 460 || align="center" | [[Image:Skimmer.png]]<br />
|-<br />
| Stuntplane || 513 || align="center" | [[Image:Stunt.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Helicopters===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Cargobob || 548 || align="center" | [[Image:Cargobob.png]]<br />
|-<br />
| Hunter || 425 || align="center" | [[Image:Hunter.png]]<br />
|-<br />
| Leviathan || 417 || align="center" | [[Image:Leviathn.png]]<br />
|-<br />
| Maverick || 487 || align="center" | [[Image:Maverick.png]]<br />
|-<br />
| News Chopper || 488 || align="center" | [[Image:Newschop.png]]<br />
|-<br />
| Police Maverick || 497 || align="center" | [[Image:Polmav.png]]<br />
|-<br />
| Raindance || 563 || align="center" | [[Image:Raindanc.png]]<br />
|-<br />
| Seasparrow || 447 || align="center" | [[Image:Seaspar.png]]<br />
|-<br />
| Sparrow || 469 || align="center" | [[Image:Sparrow.png]]<br />
|}<br />
<br />
|}<br />
<br />
==Boats==<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Coastguard || 472 || align="center" | [[Image:Coastg.png]]<br />
|-<br />
| Dinghy || 473 || align="center" | [[Image:Dinghy.png]]<br />
|-<br />
| Jetmax || 493 || align="center" | [[Image:Jetmax.png]]<br />
|-<br />
| Launch || 595 || align="center" | [[Image:Launch.png]]<br />
|-<br />
| Marquis || 484 || align="center" | [[Image:Marquis.png]]<br />
|-<br />
| Predator || 430 || align="center" | [[Image:Predator.png]]<br />
|-<br />
| Reefer || 453 || align="center" | [[Image:Reefer.png]]<br />
|-<br />
| Speeder || 452 || align="center" | [[Image:Speeder.png]]<br />
|-<br />
| Squalo || 446 || align="center" | [[Image:Squalo.png]]<br />
|-<br />
| Tropic || 454 || align="center" | [[Image:Tropic.png]]<br />
|}<br />
<br />
==Land vehicles==<br />
{|<br />
|- style="vertical-align: top;"<br />
| style="padding-right: 50px;" |<br />
<br />
===Bikes===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| BF-400 || 581 || align="center" | [[Image:Bf400.png]]<br />
|-<br />
| Bike || 509 || align="center" | [[Image:Bike.png]]<br />
|-<br />
| BMX || 481 || align="center" | [[Image:Bmx.png]]<br />
|-<br />
| Faggio || 462 || align="center" | [[Image:Faggio.png]]<br />
|-<br />
| FCR-900 || 521 || align="center" | [[Image:Fcr900.png]]<br />
|-<br />
| Freeway || 463 || align="center" | [[Image:Freeway.png]]<br />
|-<br />
| Mountain Bike || 510 || align="center" | [[Image:Mtbike.png]]<br />
|-<br />
| NRG-500 || 522 || align="center" | [[Image:Nrg500.png]]<br />
|-<br />
| PCJ-600 || 461 || align="center" | [[Image:Pcj600.png]]<br />
|-<br />
| Pizza Boy || 448 || align="center" | [[Image:Pizzaboy.png]]<br />
|-<br />
| Sanchez || 468 || align="center" | [[Image:Sanchez.png]]<br />
|-<br />
| Wayfarer || 586 || align="center" | [[Image:Wayfarer.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===2-Door & Compact cars===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Alpha || 602 || align="center" | [[Image:Alpha.png]]<br />
|-<br />
| Blista Compact || 496 || align="center" | [[Image:Blistac.png]]<br />
|-<br />
| Bravura || 401 || align="center" | [[Image:Bravura.png]]<br />
|-<br />
| Buccaneer || 518 || align="center" | [[Image:Buccanee.png]]<br />
|-<br />
| Cadrona || 527 || align="center" | [[Image:Cadrona.png]]<br />
|-<br />
| Club || 589 || align="center" | [[Image:Club.png]]<br />
|-<br />
| Esperanto || 419 || align="center" | [[Image:Esperant.png]]<br />
|-<br />
| Euros || 587 || align="center" | [[Image:Euros.png]]<br />
|-<br />
| Feltzer || 533 || align="center" | [[Image:Feltzer.png]]<br />
|-<br />
| Fortune || 526 || align="center" | [[Image:Fortune.png]]<br />
|-<br />
| Hermes || 474 || align="center" | [[Image:Hermes.png]]<br />
|-<br />
| Hustler || 545 || align="center" | [[Image:Hustler.png]]<br />
|-<br />
| Majestic || 517 || align="center" | [[Image:Majestic.png]]<br />
|-<br />
| Manana || 410 || align="center" | [[Image:Manana.png]]<br />
|-<br />
| Picador || 600 || align="center" | [[Image:Picador.png]]<br />
|-<br />
| Previon || 436 || align="center" | [[Image:Previon.png]]<br />
|-<br />
| Stallion || 439 || align="center" | [[Image:Stallion.png]]<br />
|-<br />
| Tampa || 549 || align="center" | [[Image:Tampa.png]]<br />
|-<br />
| Virgo || 491 || align="center" | [[Image:Virgo.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
=== 4-Door & Luxury cars===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Admiral || 445 || align="center" | [[Image:Admiral.png]]<br />
|-<br />
| Damaged Glendale || 604 || align="center" | [[Image:Glenshit.png]]<br />
|-<br />
| Elegant || 507 || align="center" | [[Image:Elegant.png]]<br />
|-<br />
| Emperor || 585 || align="center" | [[Image:Emperor.png]]<br />
|-<br />
| Glendale || 466 || align="center" | [[Image:Glendale.png]]<br />
|-<br />
| Greenwood || 492 || align="center" | [[Image:Greenwoo.png]]<br />
|-<br />
| Intruder || 546 || align="center" | [[Image:Intruder.png]]<br />
|-<br />
| Merit || 551 || align="center" | [[Image:Merit.png]]<br />
|-<br />
| Nebula || 516 || align="center" | [[Image:Nebula.png]]<br />
|-<br />
| Oceanic || 467 || align="center" | [[Image:Oceanic.png]]<br />
|-<br />
| Premier || 426 || align="center" | [[Image:Premier.png]]<br />
|-<br />
| Primo || 547 || align="center" | [[Image:Primo.png]]<br />
|-<br />
| Sentinel || 405 || align="center" | [[Image:Sentinel.png]]<br />
|-<br />
| Stafford || 580 || align="center" | [[Image:Stafford.png]]<br />
|-<br />
| Stretch || 409 || align="center" | [[Image:Stretch.png]]<br />
|-<br />
| Sunrise || 550 || align="center" | [[Image:Sunrise.png]]<br />
|-<br />
| Tahoma || 566 || align="center" | [[Image:Tahoma.png]]<br />
|-<br />
| Vincent || 540 || align="center" | [[Image:Vincent.png]]<br />
|-<br />
| Washington || 421 || align="center" | [[Image:Washing.png]]<br />
|-<br />
| Willard || 529 || align="center" | [[Image:Willard.png]]<br />
|}<br />
<br />
|}<br />
{|<br />
|- style="vertical-align: top;"<br />
| style="padding-right: 50px;" |<br />
<br />
===Civil service===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Baggage || 485 || align="center" | [[Image:Baggage.png]]<br />
|-<br />
| Bus || 431 || align="center" | [[Image:Bus.png]]<br />
|-<br />
| Cabbie || 438 || align="center" | [[Image:Cabbie.png]]<br />
|-<br />
| Coach || 437 || align="center" | [[Image:Coach.png]]<br />
|-<br />
| Sweeper || 574 || align="center" | [[Image:Sweeper.png]]<br />
|-<br />
| Taxi || 420 || align="center" | [[Image:Taxi.png]]<br />
|-<br />
| Towtruck || 525 || align="center" | [[Image:Towtruck.png]]<br />
|-<br />
| Trashmaster || 408 || align="center" | [[Image:Trash.png]]<br />
|-<br />
| Utility Van || 552 || align="center" | [[Image:Utility.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Government vehicles===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Ambulance || 416 || align="center" | [[Image:Ambulan.png]]<br />
|-<br />
| Barracks || 433 || align="center" | [[Image:Barracks.png]]<br />
|-<br />
| Enforcer || 427 || align="center" | [[Image:Enforcer.png]]<br />
|-<br />
| FBI Rancher || 490 || align="center" | [[Image:Fbiranch.png]]<br />
|-<br />
| FBI Truck || 528 || align="center" | [[Image:Fbitruck.png]]<br />
|-<br />
| Fire Truck || 407 || align="center" | [[Image:Firetruk.png]]<br />
|-<br />
| Fire Truck || 544 || align="center" | [[Image:Firela.png]]<br />
|-<br />
| HPV1000 || 523 || align="center" | [[Image:Hpv1000.png]]<br />
|-<br />
| Patriot || 470 || align="center" | [[Image:Patriot.png]]<br />
|-<br />
| Police LS || 596 || align="center" | [[Image:Policels.png]]<br />
|-<br />
| Police LV || 598 || align="center" | [[Image:Policelv.png]]<br />
|-<br />
| Police Ranger || 599 || align="center" | [[Image:Policeru.png]]<br />
|-<br />
| Police SF || 597 || align="center" | [[Image:Policesf.png]]<br />
|-<br />
| Rhino || 432 || align="center" | [[Image:Rhino.png]]<br />
|-<br />
| S.W.A.T. || 601 || align="center" | [[Image:Swatvan.png]]<br />
|-<br />
| Securicar || 428 || align="center" | [[Image:Securica.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Heavy & Utility trucks===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Benson || 499 || align="center" | [[Image:Benson.png]]<br />
|-<br />
| Boxville Mission|| 609 || align="center" | [[Image:Boxburg.png]]<br />
|-<br />
| Boxville || 498 || align="center" | [[Image:Boxville.png]]<br />
|-<br />
| Cement Truck || 524 || align="center" | [[Image:Cement.png]]<br />
|-<br />
| Combine Harvester || 532 || align="center" | [[Image:Combine.png]]<br />
|-<br />
| DFT-30 || 578 || align="center" | [[Image:Dft30.png]]<br />
|-<br />
| Dozer || 486 || align="center" | [[Image:Dozer.png]]<br />
|-<br />
| Dumper || 406 || align="center" | [[Image:Dumper.png]]<br />
|-<br />
| Dune || 573 || align="center" | [[Image:Dune.png]]<br />
|-<br />
| Flatbed || 455 || align="center" | [[Image:Flatbed.png]]<br />
|-<br />
| Hotdog || 588 || align="center" | [[Image:Hotdog.png]]<br />
|-<br />
| Linerunner || 403 || align="center" | [[Image:Linerun.png]]<br />
|-<br />
| Mr. Whoopee || 423 || align="center" | [[Image:Mrwhoop.png]]<br />
|-<br />
| Mule || 414 || align="center" | [[Image:Mule.png]]<br />
|-<br />
| Packer || 443 || align="center" | [[Image:Packer.png]]<br />
|-<br />
| Roadtrain || 515 || align="center" | [[Image:Rdtrain.png]]<br />
|-<br />
| Tanker || 514 || align="center" | [[Image:Tanker.png]]<br />
|-<br />
| Tractor || 531 || align="center" | [[Image:Tractor.png]]<br />
|-<br />
| Yankee || 456 || align="center" | [[Image:Yankee.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Light trucks & Vans===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Berkley's RC Van || 459 || align="center" | [[Image:Topfun.png]]<br />
|-<br />
| Bobcat || 422 || align="center" | [[Image:Bobcat.png]]<br />
|-<br />
| Burrito || 482 || align="center" | [[Image:Burrito.png]]<br />
|-<br />
| Damaged Sadler || 605 || align="center" | [[Image:Sadlshit.png]]<br />
|-<br />
| Forklift || 530 || align="center" | [[Image:Forklift.png]]<br />
|-<br />
| Moonbeam || 418 || align="center" | [[Image:Moonbeam.png]]<br />
|-<br />
| Mower || 572 || align="center" | [[Image:Mower.png]]<br />
|-<br />
| News Van || 582 || align="center" | [[Image:Newsvan.png]]<br />
|-<br />
| Pony || 413 || align="center" | [[Image:Pony.png]]<br />
|-<br />
| Rumpo || 440 || align="center" | [[Image:Rumpo.png]]<br />
|-<br />
| Sadler || 543 || align="center" | [[Image:Sadler.png]]<br />
|-<br />
| Tug || 583 || align="center" | [[Image:Tug.png]]<br />
|-<br />
| Walton || 478 || align="center" | [[Image:Walton.png]]<br />
|-<br />
| Yosemite || 554 || align="center" | [[Image:Yosemite.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===SUVs & Wagons===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Huntley || 579 || align="center" | [[Image:Huntley.png]]<br />
|-<br />
| Landstalker || 400 || align="center" | [[Image:Landstal.png]]<br />
|-<br />
| Perennial || 404 || align="center" | [[Image:Peren.png]]<br />
|-<br />
| Rancher || 489 || align="center" | [[Image:Rancher.png]]<br />
|-<br />
| Rancher || 505 || align="center" | [[Image:Rnchlure.png]]<br />
|-<br />
| Regina || 479 || align="center" | [[Image:Regina.png]]<br />
|-<br />
| Romero || 442 || align="center" | [[Image:Romero.png]]<br />
|-<br />
| Solair || 458 || align="center" | [[Image:Solair.png]]<br />
|}<br />
<br />
|}<br />
{|<br />
|- style="vertical-align: top;"<br />
| style="padding-right: 50px;" |<br />
<br />
===Lowriders===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Blade || 536 || align="center" | [[Image:Blade.png]]<br />
|-<br />
| Broadway || 575 || align="center" | [[Image:Broadway.png]]<br />
|-<br />
| Remington || 534 || align="center" | [[Image:Remingtn.png]]<br />
|-<br />
| Savanna || 567 || align="center" | [[Image:Savanna.png]]<br />
|-<br />
| Slamvan || 535 || align="center" | [[Image:Slamvan.png]]<br />
|-<br />
| Tornado || 576 || align="center" | [[Image:Tornado.png]]<br />
|-<br />
| Voodoo || 412 || align="center" | [[Image:Voodoo.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Muscle cars===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Buffalo || 402 || align="center" | [[Image:Buffalo.png]]<br />
|-<br />
| Clover || 542 || align="center" | [[Image:Clover.png]]<br />
|-<br />
| Phoenix || 603 || align="center" | [[Image:Phoenix.png]]<br />
|-<br />
| Sabre || 475 || align="center" | [[Image:Sabre.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Street racers===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Banshee || 429 || align="center" | [[Image:Banshee.png]]<br />
|-<br />
| Bullet || 541 || align="center" | [[Image:Bullet.png]]<br />
|-<br />
| Cheetah || 415 || align="center" | [[Image:Cheetah.png]]<br />
|-<br />
| Comet || 480 || align="center" | [[Image:Comet.png]]<br />
|-<br />
| Elegy || 562 || align="center" | [[Image:Elegy.png]]<br />
|-<br />
| Flash || 565 || align="center" | [[Image:Flash.png]]<br />
|-<br />
| Hotknife || 434 || align="center" | [[Image:Hotknife.png]]<br />
|-<br />
| Hotring Racer || 494 || align="center" | [[Image:Hotring.png]]<br />
|-<br />
| Hotring Racer 2 || 502 || align="center" | [[Image:Hotrina.png]]<br />
|-<br />
| Hotring Racer 3 || 503 || align="center" | [[Image:Hotrinb.png]]<br />
|-<br />
| Infernus || 411 || align="center" | [[Image:411.png]]<br />
|-<br />
| Jester || 559 || align="center" | [[Image:Jester.png]]<br />
|-<br />
| Stratum || 561 || align="center" | [[Image:Stratum.png]]<br />
|-<br />
| Sultan || 560 || align="center" | [[Image:Sultan.png]]<br />
|-<br />
| Super GT || 506 || align="center" | [[Image:Supergt.png]]<br />
|-<br />
| Turismo || 451 || align="center" | [[Image:Turismo.png]]<br />
|-<br />
| Uranus || 558 || align="center" | [[Image:Uranus.png]]<br />
|-<br />
| Windsor || 555 || align="center" | [[Image:Windsor.png]]<br />
|-<br />
| ZR-350 || 477 || align="center" | [[Image:Zr350.png]]<br />
|}<br />
<br />
|}<br />
{|<br />
|- style="vertical-align: top;"<br />
| style="padding-right: 50px;" |<br />
<br />
===RC Vehicles===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| RC Bandit || 441 || align="center" | [[Image:Rcbandit.png]]<br />
|-<br />
| RC Baron || 464 || align="center" | [[Image:Rcbaron.png]]<br />
|-<br />
| RC Cam || 594 || align="center" | [[Image:Rccam.png]]<br />
|-<br />
| RC Goblin || 501 || align="center" | [[Image:Rcgoblin.png]]<br />
|-<br />
| RC Raider || 465 || align="center" | [[Image:Rcraider.png]]<br />
|-<br />
| RC Tiger || 564 || align="center" | [[Image:Rctiger.png]]<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Trailers===<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Baggage Trailer || 606 || align="center" | [[Image:Bagboxa.png]]<br />
|-<br />
| Baggage Trailer || 607 || align="center" | [[Image:Bagboxb.png]]<br />
|-<br />
| Farm Trailer || 610 || align="center" | [[Image:Farmtr1.png]]<br />
|-<br />
| Petrol trailer || 584 || align="center" | [[Image:Petrotr.png]]<br />
|-<br />
| Trailer || 611 || align="center" | [[Image:Utiltr1.png]]<br />
|-<br />
| Trailer || 608 || align="center" | [[Image:Tugstair.png]]<br />
|-<br />
| Trailer 1 || 435 || align="center" | [[Image:Artict1.png]]<br />
|-<br />
| Trailer 2 || 450 || align="center" | [[Image:Artict2.png]]<br />
|-<br />
| Trailer 3 || 591 || align="center" | [[Image:Artict3.png]]<br />
|-<br />
|}<br />
<br />
| style="padding-right: 50px;" |<br />
<br />
===Trains & Railroad cars===<br />
<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Box Freight || 590 || align="center" | [[Image:Freibox.png]]<br />
|-<br />
| Brown Streak || 538 || align="center" | [[Image:Streak.png]]<br />
|-<br />
| Brown Streak Carriage || 570 || align="center" | [[Image:Streakc.png]]<br />
|-<br />
| Flat Freight || 569 || align="center" | [[Image:Freiflat.png]]<br />
|-<br />
| Freight || 537 || align="center" | [[Image:Freight.png]]<br />
|-<br />
| Tram || 449 || align="center" | [[Image:Tram.png]]<br />
|}<br />
<br />
|}<br />
<br />
==Recreational==<br />
{|class="wikitable sortable"<br />
|-<br />
! Name || ID || class="unsortable" | Image<br />
|-<br />
| Bandito || 568 || align="center" | [[Image:Bandito.png]]<br />
|-<br />
| BF Injection || 424 || align="center" | [[Image:Bfinject.png]]<br />
|-<br />
| Bloodring Banger || 504 || align="center" | [[Image:Bloodra.png]]<br />
|-<br />
| Caddy || 457 || align="center" | [[Image:Caddy.png]]<br />
|-<br />
| Camper || 483 || align="center" | [[Image:Camper.png]]<br />
|-<br />
| Journey || 508 || align="center" | [[Image:Journey.png]]<br />
|-<br />
| Kart || 571 || align="center" | [[Image:Kart.png]]<br />
|-<br />
| Mesa || 500 || align="center" | [[Image:Mesa.png]]<br />
|-<br />
| Monster || 444 || align="center" | [[Image:Monster.png]]<br />
|-<br />
| Monster 2 || 556 || align="center" | [[Image:Monstera.png]]<br />
|-<br />
| Monster 3 || 557 || align="center" | [[Image:Monsterb.png]]<br />
|-<br />
| Quadbike || 471 || align="center" | [[Image:Quad.png]]<br />
|-<br />
| Sandking || 495 || align="center" | [[Image:Sandking.png]]<br />
|-<br />
| Vortex || 539 || align="center" | [[Image:Vortex.png]]<br />
|}<br />
<br />
==Vehicle Functions==<br />
{{Vehicle functions}}<br />
<br />
==See Also==<br />
<br />
[[hu:Vehicle IDs]]<br />
[[id|ID Lists]]<br />
[[tr:Araç ID'leri]]<br />
[[it:ID Veicoli]]<br />
[[ru:Vehicle IDs]]<br />
[[de:Fahrzeug IDs]]<br />
<br />
[[Category:ID Lists]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Animate&diff=62722Animate2019-05-20T07:14:19Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle/><br />
__NOTOC__<br />
This function allows you to use interpolateBetween without render event and easily used.<br />
==Syntax==<br />
<syntaxhighlight lang="lua">animation animate(int/float from, int/float to, string/int easing, int duration, function onChange [ , function onEnd ])</syntaxhighlight><br />
<br />
===Required arguments===<br />
<br />
* '''from''': the start value.<br />
* '''to''': the end value.<br />
* '''easing''': the [[Easing|easing function]] to use for the animation or can be used the easing number, e.g. "Linear" = 1, "InQuad" = 2, "OutQuad" = 3, ...<br />
* '''duration''': the duration of animation.<br />
* '''onChange''': the function to call when the animation value is changed.<br />
<br />
===Optional arguments===<br />
* '''onEnd''': the function to call when the animation End.<br />
<br />
===Return===<br />
Returns animation or false if invalid arguments were passed.<br />
<br />
==Code==<br />
<section name="Code" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local anims, builtins = {}, {"Linear", "InQuad", "OutQuad", "InOutQuad", "OutInQuad", "InElastic", "OutElastic", "InOutElastic", "OutInElastic", "InBack", "OutBack", "InOutBack", "OutInBack", "InBounce", "OutBounce", "InOutBounce", "OutInBounce", "SineCurve", "CosineCurve"}<br />
<br />
function table.find(t, v)<br />
for k, a in ipairs(t) do<br />
if a == v then<br />
return k<br />
end<br />
end<br />
return false<br />
end<br />
<br />
function animate(f, t, easing, duration, onChange, onEnd)<br />
assert(type(f) == "number", "Bad argument @ 'animate' [expected number at argument 1, got "..type(f).."]")<br />
assert(type(t) == "number", "Bad argument @ 'animate' [expected number at argument 2, got "..type(t).."]")<br />
assert(type(easing) == "string" or (type(easing) == "number" and (easing >= 1 or easing <= #builtins)), "Bad argument @ 'animate' [Invalid easing at argument 3]")<br />
assert(type(duration) == "number", "Bad argument @ 'animate' [expected function at argument 4, got "..type(duration).."]")<br />
assert(type(onChange) == "function", "Bad argument @ 'animate' [expected function at argument 5, got "..type(onChange).."]")<br />
table.insert(anims, {from = f, to = t, easing = table.find(builtins, easing) and easing or builtins[easing], duration = duration, start = getTickCount( ), onChange = onChange, onEnd = onEnd})<br />
return #anims<br />
end<br />
<br />
function destroyAnimation(a)<br />
if anims[a] then<br />
table.remove(anims, a)<br />
end<br />
end<br />
<br />
addEventHandler("onClientRender", root, function( )<br />
local now = getTickCount( )<br />
for k,v in ipairs(anims) do<br />
v.onChange(interpolateBetween(v.from, 0, 0, v.to, 0, 0, (now - v.start) / v.duration, v.easing))<br />
if now >= v.start+v.duration then<br />
if type(v.onEnd) == "function" then<br />
v.onEnd( )<br />
end<br />
table.remove(anims, k)<br />
end<br />
end<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Example" class="client" show="true"><br />
This example open/close with slide up/down effect.<br />
<syntaxhighlight lang="lua"><br />
--Slide Animation<br />
local sx, sy = guiGetScreenSize( )<br />
local window = guiCreateWindow((sx-300)/2, (sy-400)/2, 300, 400, "Test", false)<br />
guiSetVisible(window, false)<br />
bindKey("f2", "down", function( )<br />
if anim then return end<br />
local v = guiGetVisible(window)<br />
if not v then <br />
guiSetVisible(window, true)<br />
animate(0, 1, 1, 1000, function(alpha)<br />
guiSetAlpha(window,alpha)<br />
end)<br />
end<br />
anim = true<br />
animate(v and 400 or 0, v and 0 or 400, 2, 1250, function(height)<br />
if v and height == 0 then <br />
guiSetVisible(window, false)<br />
anim = false<br />
elseif not v and height == 400 then<br />
anim = false<br />
end<br />
local w, h = guiGetSize(window, false)<br />
guiSetSize(window, w, height, false)<br />
end)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
Author : Mr.Tn6eL<br />
<br />
==See Also==<br />
{{Useful_Functions}}<br />
[[Category:Useful Functions]]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=62366Template:Useful Functions2019-03-18T04:33:32Z<p>AncienT: Undo revision 62353 by Jefte (talk)</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[isValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[isPlayerStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is server admin or staff.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawRing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a ring with dx lines.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Map functions ===<br />
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle functions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62365IsValueInTable2019-03-18T04:32:20Z<p>AncienT: Undo revision 62357 by Jefte (talk)</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table and ID of row to value in table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Exemplo==<br />
<section name="Clientside example" class="client" show="true"><br />
Este exemplo verifica se a palavra escrita não existe na tabela e a adiciona à tabela, caso contrário, um aviso será emitido.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62364IsValueInTable2019-03-18T04:31:45Z<p>AncienT: Undo revision 62354 by Jefte (talk)</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table and ID of row to value in table.<br />
<br />
==Código==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Exemplo==<br />
<section name="Clientside example" class="client" show="true"><br />
Este exemplo verifica se a palavra escrita não existe na tabela e a adiciona à tabela, caso contrário, um aviso será emitido.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SmoothMoveCamera&diff=62311SmoothMoveCamera2019-02-26T08:36:09Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle/><br />
__NOTOC__<br />
<br />
This function allows you to create a cinematic-camera-flight, which moves from a specific position to a specific position.<br />
<br />
==Syntax==<br />
<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><br />
<br />
* '''x1, y1, z1''': The camera's start position.<br />
* '''x1t, y1t, z1t''': The camera's start look at.<br />
* '''x2, y2, z2''': The camera's end position.<br />
* '''x2t, y2t, z2t''': The camera's end look at.<br />
* '''time''': The speed of the camera's movement.<br />
<br />
==Code==<br />
This version returns false if a smoothMoveCamera is in progress:<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then return false end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementCollisionsEnabled (sm.object1,false) <br />
setElementCollisionsEnabled (sm.object2,false) <br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
setTimer(removeCamHandler,time,1)<br />
setTimer(destroyElement,time,1,sm.object1)<br />
setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
Author: Noneatme(Me) [Fixed by ADCX, does not give errors now]<br />
<br />
This Version allows cancellation of current smoothMoveCamera progress and doing another one.<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then<br />
destroyElement(sm.object1)<br />
destroyElement(sm.object2)<br />
killTimer(timer1)<br />
killTimer(timer2)<br />
killTimer(timer3)<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementCollisionsEnabled (sm.object1,false) <br />
setElementCollisionsEnabled (sm.object2,false) <br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
timer1 = setTimer(removeCamHandler,time,1)<br />
timer2 = setTimer(destroyElement,time,1,sm.object1)<br />
timer3 = setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=SmoothMoveCamera&diff=62310SmoothMoveCamera2019-02-26T08:35:25Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
<lowercasetitle/><br />
__NOTOC__<br />
<br />
This function allows you to create a cinematic-camera-flight, which moves from a specific position to a specific position.<br />
<br />
==Syntax==<br />
<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><br />
<br />
* '''x1, y1, z1''': The camera's start position.<br />
* '''x1t, y1t, z1t''': The camera's start look at.<br />
* '''x2, y2, z2''': The camera's end position.<br />
* '''x2t, y2t, z2t''': The camera's end look at.<br />
* '''time''': The speed of the camera's movement.<br />
<br />
==Code==<br />
This version returns false if a smoothMoveCamera is in progress:<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then return false end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementCollisionsEnabled (sm.object1,false) <br />
setElementCollisionsEnabled (sm.object2,false) <br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
setTimer(removeCamHandler,time,1)<br />
setTimer(destroyElement,time,1,sm.object1)<br />
setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
Author: Noneatme(Me) [Fixed by ADCX, does not give errors now]<br />
<br />
This Version allows cancellation of current smoothMoveCamera progress and doing another one.<br />
<section name="Clientside Script" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
local sm = {}<br />
sm.moov = 0<br />
sm.object1,sm.object2 = nil,nil<br />
<br />
local function removeCamHandler()<br />
if(sm.moov == 1)then<br />
sm.moov = 0<br />
end<br />
end<br />
<br />
local function camRender()<br />
if (sm.moov == 1) then<br />
local x1,y1,z1 = getElementPosition(sm.object1)<br />
local x2,y2,z2 = getElementPosition(sm.object2)<br />
setCameraMatrix(x1,y1,z1,x2,y2,z2)<br />
else<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
end<br />
<br />
function smoothMoveCamera(x1,y1,z1,x1t,y1t,z1t,x2,y2,z2,x2t,y2t,z2t,time)<br />
if(sm.moov == 1)then<br />
destroyElement(sm.object1)<br />
destroyElement(sm.object2)<br />
killTimer(timer1)<br />
killTimer(timer2)<br />
killTimer(timer3)<br />
removeEventHandler("onClientPreRender",root,camRender)<br />
end<br />
sm.object1 = createObject(1337,x1,y1,z1)<br />
sm.object2 = createObject(1337,x1t,y1t,z1t)<br />
setElementAlpha(sm.object1,0)<br />
setElementAlpha(sm.object2,0)<br />
setObjectScale(sm.object1,0.01)<br />
setObjectScale(sm.object2,0.01)<br />
moveObject(sm.object1,time,x2,y2,z2,0,0,0,"InOutQuad")<br />
moveObject(sm.object2,time,x2t,y2t,z2t,0,0,0,"InOutQuad")<br />
sm.moov = 1<br />
timer1 = setTimer(removeCamHandler,time,1)<br />
timer2 = setTimer(destroyElement,time,1,sm.object1)<br />
timer3 = setTimer(destroyElement,time,1,sm.object2)<br />
addEventHandler("onClientPreRender",root,camRender)<br />
return true<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=User:AncienT&diff=62114User:AncienT2019-02-02T02:38:18Z<p>AncienT: Created page with "==My user== * [https://community.multitheftauto.com/index.php?p=profile&id=442249 AncienT] ==My resources== *[https://community.multitheftauto.com/index.php?p=resources&s=deta..."</p>
<hr />
<div>==My user==<br />
* [https://community.multitheftauto.com/index.php?p=profile&id=442249 AncienT]<br />
==My resources==<br />
*[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15823 Adavanced_notifications]<br />
*[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15209 PUBG_circle]<br />
*[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15401 PUBG_HUD]</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62004IsValueInTable2019-01-19T03:35:25Z<p>AncienT: /* Returns */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table and ID of row to value in table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62003IsValueInTable2019-01-19T03:35:07Z<p>AncienT: /* Returns */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table and ID to value in table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62002IsValueInTable2019-01-19T03:34:47Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62001IsValueInTable2019-01-19T03:34:37Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true,i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=62000IsValueInTable2019-01-19T03:34:14Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
local checker,id = isValueInTable(greetingTable,value,1)<br />
if not checker then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..')['..#greetingTable..'] added to table.')<br />
else<br />
outputChatBox('('..value..')['..id..'] already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=61999IsValueInTable2019-01-19T03:29:20Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
if not isValueInTable(greetingTable,value,1) then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..') added to table.')<br />
else<br />
outputChatBox('('..value..') already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=61998IsValueInTable2019-01-19T03:29:12Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true, i<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
if not isValueInTable(greetingTable,value,1) then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..') added to table.')<br />
else<br />
outputChatBox('('..value..') already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=IsValueInTable&diff=61984IsValueInTable2019-01-16T01:47:42Z<p>AncienT: Created page with "{{Useful Function}} ==Syntax== <syntaxhighlight lang="lua"> bool isValueInTable ( table theTable, value, int columnID ) </syntaxhighlight> ===Required arguments=== * '''theTa..."</p>
<hr />
<div>{{Useful Function}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool isValueInTable ( table theTable, value, int columnID )<br />
</syntaxhighlight><br />
<br />
===Required arguments===<br />
* '''theTable''': the [[table]] to check if value exist.<br />
* '''value''': the value to check.<br />
* '''columnID''': The column number within the [[table]].<br />
<br />
==Returns==<br />
This function returns a boolean value, true if the value exists in the table, false if the value does not exist in the table.<br />
<br />
==Code==<br />
<section name="Function source" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function isValueInTable(theTable,value,columnID)<br />
assert(theTable, "Bad argument 1 @ isValueInTable (table expected, got " .. type(theTable) .. ")")<br />
local checkIsTable = type(theTable)<br />
assert(checkIsTable == "table", "Invalid value type @ isValueInTable (table expected, got " .. checkIsTable .. ")")<br />
assert(value, "Bad argument 2 @ isValueInTable (value expected, got " .. type(value) .. ")")<br />
assert(columnID, "Bad argument 3 @ isValueInTable (number expected, got " .. type(columnID) .. ")")<br />
local checkIsID = type(columnID)<br />
assert(checkIsID == "number", "Invalid value type @ isValueInTable (number expected, got " ..checkIsID .. ")")<br />
for i,v in ipairs (theTable) do<br />
if v[columnID] == value then<br />
return true<br />
end<br />
end<br />
return false<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Clientside example" class="client" show="true"><br />
This example verifies if the written word does not exist within the table and then adds it to the table, otherwise a warning will be issued.<br />
<syntaxhighlight lang="lua"><br />
local greetingTable = {<br />
{"Hi"},<br />
{"Aloha"},<br />
{"Hello"},<br />
}<br />
<br />
function greetingCheck(CMD,value)<br />
local value = value or nil<br />
if not isValueInTable(greetingTable,value,1) then<br />
table.insert(greetingTable,{value})<br />
outputChatBox('('..value..') added to table.')<br />
else<br />
outputChatBox('('..value..') already exist in the table.')<br />
end<br />
end<br />
addCommandHandler('addgreeting',greetingCheck)<br />
</syntaxhighlight><br />
</section><br />
'''Author: Motar2k~'''<br />
<br />
==See also==<br />
{{Useful_Functions}}</div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61983Template:Useful Functions2019-01-16T01:47:13Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[isValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[isPlayerStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is server admin or staff.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Map functions ===<br />
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle functions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61982Template:Useful Functions2019-01-16T01:46:48Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[isItemInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[isPlayerStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is server admin or staff.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Map functions ===<br />
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle functions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61981Template:Useful Functions2019-01-16T01:46:34Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[isValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[isPlayerStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is server admin or staff.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Map functions ===<br />
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle functions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61966Template:Useful Functions2019-01-15T05:59:11Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[isItemInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle funcions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61955Template:Useful Functions2019-01-15T03:08:37Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
*[[table.exist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle funcions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61954Template:Useful Functions2019-01-15T03:07:48Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle funcions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61953Template:Useful Functions2019-01-15T03:07:35Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
*[[table.exist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle funcions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=61952Template:Useful Functions2019-01-15T03:07:17Z<p>AncienT: /* Table functions */</p>
<hr />
<div>__NOTOC__<br />
=== Table functions ===<br />
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span><br />
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span><br />
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span><br />
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span><br />
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» 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.</span><br />
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span><br />
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span><br />
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span><br />
*[[table.exist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table Editar.</span><br />
<br />
=== ACL functions ===<br />
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span><br />
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span><br />
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span><br />
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span><br />
<br />
=== Account functions ===<br />
*[[removeAccountData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove data from an account.</span><br />
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span><br />
<br />
=== Camera functions ===<br />
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.<br />
<br />
=== Cursor functions ===<br />
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
<br />
=== Drawing functions ===<br />
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span><br />
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span><br />
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span><br />
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span><br />
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span><br />
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span><br />
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span><br />
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span><br />
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span><br />
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span><br />
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span><br />
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span><br />
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span><br />
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span><br />
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span><br />
<br />
=== Effects functions ===<br />
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span><br />
<br />
=== Elements functions === <br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span><br />
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span><br />
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span><br />
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span><br />
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span><br />
<br />
=== Events ===<br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span><br />
<br />
=== Input functions ===<br />
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span><br />
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span><br />
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span><br />
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span><br />
<br />
=== Data functions === <br />
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span><br />
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span><br />
*[[convertNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts and formats large numbers.</span><br />
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span><br />
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span><br />
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span><br />
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span><br />
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span><br />
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span><br />
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span><br />
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span><br />
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span><br />
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span><br />
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span><br />
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.<br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span><br />
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span><br />
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span><br />
*[[isLowerOrUpper]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function checks whether the letter is large or small.</span><br />
<br />
=== GUI functions === <br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span><br />
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span><br />
=====Comboboxes=====<br />
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span><br />
*[[guiComboBoxAddPlayersName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is add players name in combobox .</span><br />
<br />
=====Gridlists=====<br />
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span><br />
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span><br />
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span><br />
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span><br />
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span><br />
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span><br />
<br />
=====Labels=====<br />
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add a effects to the gui-label like (shadow, outline).</span><br />
<br />
=== Marker functions ===<br />
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span><br />
<br />
=== Math functions ===<br />
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span><br />
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span><br />
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span><br />
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span><br />
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span><br />
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span><br />
<br />
=== Ped functions ===<br />
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span><br />
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span><br />
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span><br />
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span><br />
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span><br />
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span><br />
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span><br />
*[[getPlayersInGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all Players In Group .</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span><br />
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span><br />
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span><br />
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span><br />
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span><br />
<br />
=== Player functions ===<br />
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span><br />
<br />
=== Resource functions ===<br />
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files<br />
<br />
=== Sound functions ===<br />
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span><br />
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span><br />
<br />
=== Browser functions ===<br />
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span><br />
<br />
=== Team functions ===<br />
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span><br />
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span><br />
<br />
=== Vehicle funcions === <br />
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span><br />
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span><br />
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span><br />
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span><br />
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span><br />
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span><br />
<br />
=== Weapon functions === <br />
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span><br />
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span><br />
<br />
=== XML functions ===<br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span><br />
<br />
=== Utility ===<br />
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span><br />
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span><br />
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span><br />
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span><br />
*[[isCursorOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether the cursor is in a particular area.</span><br />
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span><br />
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span><br />
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span><br />
*[[thisCommandHandlersExist]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks a string if this exist as command Handlers</span><br />
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span><br />
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span><br />
<br />
<noinclude>[[Category:Useful Functions]]</noinclude></div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61951GetPlayerFromAccountName2019-01-15T01:35:03Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then --Checking that the account exists<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then --Checking that the name of the account matches that of a player<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("Player not found",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("Write the name of the account first",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61950GetPlayerFromAccountName2019-01-15T01:33:42Z<p>AncienT: /* Code */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("Player not found",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("Write the name of the account first",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61949GetPlayerFromAccountName2019-01-15T01:31:34Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("Player not found",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("Write the name of the account first",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61948GetPlayerFromAccountName2019-01-15T01:30:16Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("player not found!",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("type account name firts!",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61947GetPlayerFromAccountName2019-01-15T01:30:07Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("player not found!",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("type account name firts!",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61946GetPlayerFromAccountName2019-01-15T01:29:43Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("player not found!",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("type account name firts!",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienThttps://wiki.multitheftauto.com/index.php?title=GetPlayerFromAccountName&diff=61945GetPlayerFromAccountName2019-01-15T01:28:47Z<p>AncienT: /* Example */</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function get online [[player]] from their account name.<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
player getPlayerFromAccountName ( string accountName )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''accountName''': A string containing account name of a player you want to reference.<br />
<br />
===Returns===<br />
Returns a [[player]] if the account name exists,''false'' if player not found.<br />
<br />
==Code==<br />
<syntaxhighlight lang="lua">function getPlayerFromAccountName(accountname)<br />
if accountname then<br />
for _,account in ipairs(getAccounts()) do<br />
for _,player in ipairs(getElementsByType('player')) do<br />
if getAccountName(account) == accountname then<br />
if getAccountName(getPlayerAccount(player)) == getAccountName(account) then<br />
return player<br />
end<br />
end<br />
end<br />
end<br />
end<br />
return false<br />
end</syntaxhighlight><br />
<br />
==Example==<br />
This example get player name from account name by command<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler ("name",<br />
function (player,_,accountname)<br />
if accountname then<br />
local thePlayer = getPlayerFromAccountName (accountname)<br />
if thePlayer then<br />
outputChatBox (getPlayerName (thePlayer),player,255,255,255,true)<br />
else<br />
outputChatBox ("player not found !",player,255,0,0)<br />
end<br />
else<br />
outputChatBox ("type account name frist !",player,255,255,0)<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br />
'''Author: Motar2k~'''</div>AncienT