Multi Theft Auto: Wiki - User contributions [en]

Resource:Custom edit

2024-07-15T15:32:19Z

Shuffle:

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: Shuffle

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float width, float height, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
*'''block space:''' If it is true, user cant enter space (for example - login edit).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

This function return count of character in edit
<syntaxhighlight lang="lua">
bool editGetLength(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which want to check.
====Returns====
Returns count if successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you typing in edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who typing.

==Example==
This example shows how to use "onCustomEditType"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditType",root,function(edit)
if edit==variable_of_edit then
print("You typed in "..edit)
end
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

FormatDate

2024-06-07T23:47:51Z

Shuffle:

{{Useful Function}}
__NOTOC__
This function formats a date according to the given format string.

==Syntax==
<syntaxhighlight lang="lua">string formatDate( string theFormat, [ string escaper = "'", int timestamp = GetTimestamp() ] )</syntaxhighlight>

===Required Arguments===
* '''theFormat''': Format string that determines how the date should be formatted. It provides the following wildcards:
** d: day (01-31)
** h: hour (00-23)
** i: minute (00-59)
** m: month (01-12)
** s: second (00-59)
** w: shortened day of the week (Su-Mo)
** W: day of the week (Sunday-Monday)
** y: shortened year (e.g. 09)
** Y: year (e.g. 2009)

===Optional Arguments===
{{OptionalArg}}
* '''escaper''': Escape character that determines the beginning or end of a non-format-area, where the wildcards aren't replaced with their corresponding value. Note that the escapers get lost.
* '''timestamp''': Timestamp of the date that should be formatted.

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

==Code==
{{RequiredFunctions|Check}}
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
local gWeekDays = { "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" }
function formatDate(format, escaper, timestamp)
check("formatDate", "string", format, "format", {"nil","string"}, escaper, "escaper", {"nil","string"}, timestamp, "timestamp")

escaper = (escaper or "'"):sub(1, 1)
local time = getRealTime(timestamp)
local formattedDate = ""
local escaped = false

time.year = time.year + 1900
time.month = time.month + 1

local datetime = { d = ("%02d"):format(time.monthday), h = ("%02d"):format(time.hour), i = ("%02d"):format(time.minute), m = ("%02d"):format(time.month), s = ("%02d"):format(time.second), w = gWeekDays[time.weekday+1]:sub(1, 2), W = gWeekDays[time.weekday+1], y = tostring(time.year):sub(-2), Y = time.year }

for char in format:gmatch(".") do
if (char == escaper) then escaped = not escaped
else formattedDate = formattedDate..(not escaped and datetime[char] or char) end
end

return formattedDate
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example outputs the actual date to a joining player.
<syntaxhighlight lang="lua">
-- get the root element
local _root = getRootElement()
-- define the onPlayerJoin handler function
function OnPlayerJoin()
-- output the formatted date
outputChatBox(formatDate("'You joined our server on' m/d/Y at h:i."))
end
-- add the event handler
addEventHandler("onPlayerJoin", _root, OnPlayerJoin)
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}

FormatDate

2024-06-07T23:46:44Z

Shuffle:

FormatDate

2024-06-07T23:46:21Z

Shuffle:

Resource:Custom edit

2022-03-29T22:14:11Z

Shuffle:

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float width, float height, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
*'''block space:''' If it is true, user cant enter space (for example - login edit).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

This function return count of character in edit
<syntaxhighlight lang="lua">
bool editGetLength(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which want to check.
====Returns====
Returns count if successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you typing in edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who typing.

==Example==
This example shows how to use "onCustomEditType"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditType",root,function(edit)
if edit==variable_of_edit then
print("You typed in "..edit)
end
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

Resource:Custom edit

2022-03-29T22:12:06Z

Shuffle:

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float width, float height, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
*'''block space:''' If it is true, user cant enter space (for example - login edit).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you typing in edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who typing.

==Example==
This example shows how to use "onCustomEditType"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditType",root,function(edit)
if edit==variable_of_edit then
print("You typed in "..edit)
end
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

Resource:Custom edit

2021-08-26T08:21:52Z

Shuffle:

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float width, float height, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you typing in edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who typing.

==Example==
This example shows how to use "onCustomEditType"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditType",root,function(edit)
if edit==variable_of_edit then
print("You typed in "..edit)
end
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

Resource:Custom edit

2021-07-28T18:59:40Z

Shuffle:

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Functions/Events" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float z, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who blur edit.

==Example==
This example shows how to use "onCustomEditLeave"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditLeave",root,function(edit)
print("You leave edit "..edit)
end)
</syntaxhighlight>

----

{{Client event}}
This event trigger when you blur edit

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who focus edit.

==Example==

This example shows how to use "onCustomEditFocus"
<syntaxhighlight lang="lua">
addEventHandler("onCustomEditFocus",root,function(edit)
print("You focus edit "..edit)
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

Resource:Custom edit

2021-07-28T16:37:49Z

Shuffle: Created page with "{{Resource page}} __NOTOC__ This resource allow you to create custom editbox. Download [https://github.com/sirphantasm/custom_edit GitHub]. Resource developed by: sirphant..."

{{Resource page}}
__NOTOC__
This resource allow you to create custom editbox.
Download [https://github.com/sirphantasm/custom_edit GitHub]. 
Resource developed by: sirphantasm

==Exported functions/events==
<section name="Using" class="client" show="true">
By this function you can create new editbox with variable.
<syntaxhighlight lang="lua">
bool createCustomEdit(string default-text, float x, float y, float z, bool postgui, string placeholder, bool masked, filepath font, table activecolor, table fontcolor table backgroundcolor, table caretcolor, bool visible, number length, number fontsize)
</syntaxhighlight>
====Required Arguments====
*'''text:''' Default text to draw in the editbox. Recommended "".
*'''x:''' A float of the 2D screen x position.
*'''y:''' A float of the 2D screen y position.
*'''width:''' A float of the 2D screen y position.
*'''heigth:''' A float of the 2D screen y position.

====Optional arguments====
{{OptionalArg}}
*'''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (default false).
*'''placeHolder:''' A string of the placeholder text of editbox (default false).
*'''masked:''' covering up the text being typed for password text fields (default false).
*'''font:''' Name of font from folder "fonts" (default false, arial).
*'''activeColor:''' Color of line on the bottom when edit is active (default red).
*'''fontColor:''' Color of font (default white).
*'''backgroundColor:''' Color of editbox (default black).
*'''caretColor:''' Color of caret in text field (default white).
*'''visible:''' Visibility of editbox (default true).
*'''length:''' Max length for text field (default 40).
*'''font size:''' Available for DXFont (default scaled to edit size).
====Returns====
Returns ID if element was successfully created, false otherwise.

----

This function change visibility of editbox.
<syntaxhighlight lang="lua">
bool editSetVisible(element theElement, bool state)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change.
*'''state:''' true or false.
====Returns====
Returns true if successfully , false otherwise.

----

This function set mask to password fields
<syntaxhighlight lang="lua">
bool editSetMasked(element theElement, bool mask)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to set mask.
*'''state:''' true of false.
====Returns====
Returns true if editbox will be masked, false otherwise.

----

This function gets text from text field.
<syntaxhighlight lang="lua">
bool editGetText(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element from where you want to get text.
====Returns====
Returns string text if successfully , false otherwise.

----

This function changes text into text field.
<syntaxhighlight lang="lua">
bool editSetText(element theElement, string text)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change text.
*'''text:''' New value.
====Returns====
Returns true if text set successfully, false otherwise.

----

This function changes max length od text field
<syntaxhighlight lang="lua">
bool editMaxLength(element theElement, float length)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change length.
*'''length:''' New value.
====Returns====
Returns true if length set successfully, false otherwise.

----

This function change 2D position on the screen.
<syntaxhighlight lang="lua">
bool editChangePos(element theElement, float x, float y)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change position.
*'''x:''' 2D x position.
*'''y:''' 2D y position.
====Returns====
Returns true if succesfully, false otherwise.

----

This function changes all properties of editbox
<syntaxhighlight lang="lua">
bool editSetProperty(element theElement, string properties, string value)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to change property.
*'''property:''' id,x,y,w,h,postgui,placeholder,masked,font,size,active,activecolor,bgcolor,caret,visible,cursor,maxLength,click,alpha,readOnly.
====Returns====
Returns true if properties set successfully, false otherwise.

----

This function destroy editbox
<syntaxhighlight lang="lua">
bool destroyCustomEdit(element theElement)
</syntaxhighlight>
====Required Arguments====
*'''theElement:''' Element which you want to destroy.
====Returns====
Returns true if destroy successfully, false otherwise.
</section>

==Example==
<section name="Example" class="client" show="true">
This example creates editbox with some accessories.
<syntaxhighlight lang="lua">
local ce=exports.custom_edit

local edit=ce:createCustomEdit("",500,500,300,70,false,"Password",false,"font2",{255,0,0,255},{255,255,255,255},{0,0,0,150},{255,255,255,255},true,false,false)
ce:editSetMasked(edit,true)
ce:editSetProperty(edit,"bgcolor",{255,255,255,255})
ce:editChangePos(edit,700,700)
ce:editMaxLength(edit,50)
</syntaxhighlight>
</section>

SmoothMoveCamera

2021-07-25T19:31:13Z

Shuffle:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</syntaxhighlight>
</section>

==Example==
'Shuffle' shows how to use function.
<syntaxhighlight lang="lua">
addCommandHandler("smooth",function()
smoothMoveCamera(0,0,30,20,10,1,100,100,30,20,10,1,3500)
end)
</syntaxhighlight>
==See Also==
{{Useful_Functions}}

Template:Useful Functions

2021-06-03T16:45:55Z

Shuffle: /* Data functions */

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

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

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

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

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

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

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

=== Element functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.

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

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

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

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

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

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

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

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

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

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

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

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

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

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

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

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

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

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.

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

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

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

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

Template:Useful Functions

2021-06-03T16:37:43Z

Shuffle: /* Data functions */

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

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

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

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

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

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

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

=== Element functions ===
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.

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

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

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

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

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

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

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

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

=== Map functions ===
*[[assignLod]] » This function lets you conveniently generate and apply a LOD model to a mapping object.
*[[getWorldPositionFromMapPosition]] » This function converts an F11 map position to world position.

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

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

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

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

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

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

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

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

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.

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

=== Engine functions ===
*[[engineGetCOLsFromLibrary]] » This function gets the collision data from the col library.
*[[engineLoadIMGContainer]] » This function loads the IMG container.

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

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

ConvertDate

2021-06-03T13:51:36Z

Shuffle: Created page with "{{Useful Function}} __NOTOC__ This function converts time into a different look ==Syntax== <syntaxhighlight lang="lua">bool convertDate( string data, bool convertTime )</synt..."

{{Useful Function}}
__NOTOC__
This function converts time into a different look

==Syntax==
<syntaxhighlight lang="lua">bool convertDate( string data, bool convertTime )</syntaxhighlight>

===Required Arguments===
* '''date''': String of date(YYYY-MM-DD HH:MM:SS).
* '''convertTime''': True/False if the function should also convert the time.

===Returns===
Returns converted date/time.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
months={
[1]="january",
[2]="february",
[3]="march",
[4]="april",
[5]="may",
[6]="june",
[7]="july",
[8]="august",
[9]="september",
[10]="october",
[11]="november",
[12]="december",
}

function convertDate(string,convertTime)
if string then
local format={}
for _,v in ipairs(split(string,"-",""))do
table.insert(format,v)
end
local date=gettok(format[3], 1, string.byte(' ') ).." "..months[tonumber(format[2])].." "..format[1]
if convertTime then
local format={}
for _,v in ipairs(split(string,":",""))do
table.insert(format,v)
end
date=date.." "..gettok(format[1], 2, string.byte(' ') )..":"..format[2]..":"..format[3]
end
return date
end
end
</syntaxhighlight>
</section>

==Example==
The example shows how to use function.
<syntaxhighlight lang="lua">
addCommandHandler("getformattime",function(plr)
local time = getRealTime()
local formattime = string.format("%04d-%02d-%02d %02d:%02d:%02d", time.year + 1900, time.month + 1, time.monthday, time.hour, time.minute, time.second)
local result=convertDate(formattime)
outputChatBox(result,plr)
end)
</syntaxhighlight>
OR
<syntaxhighlight lang="lua">
string="2020-05-01 19:53:02"

addCommandHandler("getformattime",function(plr)
local result=convertDate(string,true)
outputChatBox(result,plr)
end)
</syntaxhighlight>

01 may 2020 19:53:02

 
Author - Shuffle

==See Also==
{{Useful_Functions}}