Multi Theft Auto: Wiki - User contributions [en]

Modern-Library

2025-01-10T18:24:55Z

ClawSuit:

{{Resource page}}
__NOTOC__

== Modern DX Library ==

This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.
{{note|This wiki is always for the latest Modern DX Library version!}}

'''Full Name''': Modern DX Library for User Interface

'''Developer Team''': [[User:ClawSuit|ClawSuit]], [[User:PandFort|PandFort]]

'''Wiki contributor''': [[User:BR4|BR4]]

'''GitHub Repo''': ''https://github.com/clawsuit/dxLibrary''

'''Current Version''': 1.0 Estable

=Features=

[[Image:Demo.PNG|350px|thumb|right| Demo Window]]

'''How does it work?'''
*Modern DX Library is based on [[element]] system, which just likes the cegui system. To make Modern DX Library easier to use and understand, I choose to follow the usage of cegui's.
*Modern DX Library elements are rendered in the event "onClientRender". When "onClientRender" is called, every Modern DX Library elements will be looped and calculated.

'''What's different from cegui?'''
*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.

'''You Should Know'''
*Some of Modern DX Library elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those Modern DX Library elements won't be shown.

=Examples=
'''Demonstration''': https://www.youtube.com/watch?v=qakLp6Znws0

'''Notice'''
*It is recommended to change the resource name to 'dxLibrary'.
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix (''' exports[ "dxLibrary" ]: ''') call in your code, such as

<syntaxhighlight lang="lua">
button = exports[ "dxLibrary" ]:dxButton( 50, 50, 40, 20, "Button Test" )
</syntaxhighlight>

*Here is a feasible way to shorten the name of an exported function:
<syntaxhighlight lang="lua">
dxLib = exports[ "dxLibrary" ] -- shorten the export function prefix

button = dxLib:dxButton( 50, 50, 40, 20, "Button Test" ) -- create a button
</syntaxhighlight>

='''Client Functions'''=
{{DXLIB_FUNCTIONS}}

='''Client Events'''=
{{DXLIB_EVENTS}}

=Last=
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''
[[Category:Resource]]

AddTableChangeHandler

2024-04-13T05:01:36Z

ClawSuit:

{{Useful Function}}
{{Important Note|do not use this function for local variables}}

This function monitors the changes of a table

==Syntax==
<syntaxhighlight lang="lua">bool addTableChangeHandler(string tablename, function func)</syntaxhighlight>

===Arguments===
* '''tablename''': The variable [[table]] name.
* '''func''': The function.

===Returns===
The func returns 5 arguments the tablename, the table, the key, the old value and the new value.

==Code==
<section name="Deprecated version" class="shared" show="false">
<syntaxhighlight lang="lua">
addTableChangeHandler = function(t, f)
local f = f
assert(type(t) == 'table', 'check argument 1 table got '..tostring(t))
assert(type(f) == 'function', 'check argument 2 function got '..tostring(f))

local copy = {}
for k,v in pairs(t) do
copy[k] = v
t[k] = nil
end

local mt = getmetatable(t) or {}

mt.lock = true
mt.copy = copy
mt.__newindex = function(t, k, v)
if not getmetatable(t).lock then
local oldValue = getmetatable(t).copy[k]
getmetatable(t).copy[k] = v
return f(t, k, oldValue, v)
end
end,

setmetatable(t,mt)

for k,v in pairs(copy) do
t[k] = v
end

getmetatable(t).lock = nil
return true

end
</syntaxhighlight>
</section>

<section name="New Version" class="shared" show="true">
<syntaxhighlight lang="lua">
function addTableChangeHandler(tablename, func)

local tablename, func = tablename, func
local parts = {}
local name
local t = _G
local i = 0

for word in tablename:gmatch("[^%.]+") do
i = i + 1
parts[i] = word
end

for i = 1, #parts-1 do
name = not name and parts[i] or name..'.'..parts[i]

if t[parts[i]] then
t = t[parts[i]]
else
return error('The table ["'..name..'"] does not exist' )
end
end

local last = parts[#parts]
if not t[last] then return error('The table ["'..(name..'.'..last)..'"] does not exist') end

local old = t[last]
t[last] = setmetatable({}, {
__index = old,
__newindex = function(self, key, value)
local oldValue = rawget(old, key)
rawset(old, key, value)
if func then
func(tablename, old, key, oldValue, value)
end
end,
})
return t[last]
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
Config = {}
Config.player = {}

addCommandHandler('smoney',
function()
Config.player.money = math.random(999)
end
)

addTableChangeHandler('Config.player',
function(name, table, key, old, new)
print(('tablename: %s | key: %s | Old: %s | New: %s'):format(tostring(name), tostring(key), tostring(old), tostring(new)))
end
)

Config.player.money = 1
Config.player.money = 50
</syntaxhighlight>

''Author'': ClawSuit

==See Also==
{{Useful_Functions}}

AddTableChangeHandler

2024-04-12T03:20:18Z

ClawSuit:

{{Useful Function}}
{{Important Note|do not use this function for local variables}}

This function monitors the changes of a table

==Syntax==
<syntaxhighlight lang="lua">bool addTableChangeHandler(string tablename, function func)</syntaxhighlight>

===Arguments===
* '''tablename''': The variable [[table]] name.
* '''func''': The function.

===Returns===
The func returns 5 arguments the tablename, the table, the key, the old value and the new value.

==Code==
<section name="Deprecated version" class="shared" show="false">
<syntaxhighlight lang="lua">
addTableChangeHandler = function(t, f)
local f = f
assert(type(t) == 'table', 'check argument 1 table got '..tostring(t))
assert(type(f) == 'function', 'check argument 2 function got '..tostring(f))

local copy = {}
for k,v in pairs(t) do
copy[k] = v
t[k] = nil
end

local mt = getmetatable(t) or {}

mt.lock = true
mt.copy = copy
mt.__newindex = function(t, k, v)
if not getmetatable(t).lock then
local oldValue = getmetatable(t).copy[k]
getmetatable(t).copy[k] = v
return f(t, k, oldValue, v)
end
end,

setmetatable(t,mt)

for k,v in pairs(copy) do
t[k] = v
end

getmetatable(t).lock = nil
return true

end
</syntaxhighlight>
</section>

<section name="New Version" class="shared" show="true">
<syntaxhighlight lang="lua">
function addTableChangeHandler(tablename, func)

local tablename, func = tablename, func
local parts = {}
local name
local t = _G
local i = 0

for word in tablename:gmatch("[^%.]+") do
i = i + 1
parts[i] = word
end

for i = 1, #parts-1 do
name = not name and parts[i] or name..'.'..parts[i]

if t[parts[i]] then
t = t[parts[i]]
else
return error('The table ["'..name..'"] does not exist' )
end
end

local last = parts[#parts]
if not t[last] then return error('The table ["'..(name..'.'..last)..'"] does not exist') end

local old = t[last]
t[last] = setmetatable({}, {
__index = old,
__newindex = function(self, key, value)
local oldValue = rawget(old, key)
rawset(old, key, value)
if func then
func(tablename, old, key, oldValue, value)
end
end,
})
return t[last]
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
Config = {}
Config.player = {}

addCommandHandler('smoney',
function()
Config.player.money = math.random(999)
end
)

addChangeHandler('Config.player',
function(name, table, key, old, new)
print(('tablename: %s | key: %s | Old: %s | New: %s'):format(tostring(name), tostring(key), tostring(old), tostring(new)))
end
)

Config.player.money = 1
Config.player.money = 50
</syntaxhighlight>

''Author'': ClawSuit

==See Also==
{{Useful_Functions}}

AddTableChangeHandler

2024-04-12T03:19:30Z

ClawSuit:

{{Useful Function}}
{{Important Note|do not use this function for local variables}}

This function monitors the changes of a table

==Syntax==
<syntaxhighlight lang="lua">bool addTableChangeHandler(string tablename, function func)</syntaxhighlight>

===Arguments===
* '''tablename''': The variable [[table]] name.
* '''func''': The function.

===Returns===
The func returns 5 arguments the tablename, the table, the key, the old value and the new value.

==Code==
<section name="Deprecated version" class="shared" show="false">
<syntaxhighlight lang="lua">
addTableChangeHandler = function(t, f)
local f = f
assert(type(t) == 'table', 'check argument 1 table got '..tostring(t))
assert(type(f) == 'function', 'check argument 2 function got '..tostring(f))

local copy = {}
for k,v in pairs(t) do
copy[k] = v
t[k] = nil
end

local mt = getmetatable(t) or {}

mt.lock = true
mt.copy = copy
mt.__newindex = function(t, k, v)
if not getmetatable(t).lock then
local oldValue = getmetatable(t).copy[k]
getmetatable(t).copy[k] = v
return f(t, k, oldValue, v)
end
end,

setmetatable(t,mt)

for k,v in pairs(copy) do
t[k] = v
end

getmetatable(t).lock = nil
return true

end
</syntaxhighlight>
</section>

<section name="New Version" class="shared" show="true">
<syntaxhighlight lang="lua">
function addTableChangeHandler(tablename, func)

local tablename, func = tablename, func
local parts = {}
local name
local t = _G
local i = 0

for word in tablename:gmatch("[^%.]+") do
i = i + 1
parts[i] = word
end

for i = 1, #parts-1 do
name = not name and parts[i] or name..'.'..parts[i]

if t[parts[i]] then
t = t[parts[i]]
else
return error('The table ["'..name..'"] does not exist' )
end
end

local last = parts[#parts]
if not t[last] then return error('The table ["'..(name..'.'..last)..'"] does not exist') end

local old = t[last]
t[last] = setmetatable({}, {
__index = old,
__newindex = function(self, key, value)
local oldValue = rawget(old, key)
rawset(old, key, value)
if func then
func(tablename, old, key, oldValue, value)
end
end,
})
return t[last]
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
Config = {}
Config.player = {}

addCommandHandler('smoney',
function()
Config.player.money = math.random(999)
end
)

addChangeHandler('Config.player',
function(name, table, key, old, new)
print(('tablename: %s | key: %s | Old: %s | New: %s'):format(tostring(name), tostring(key), tostring(old), tostring(new)))
end
)

Config.player.money = 1
Config.player.money = 50
</syntaxhighlight>

''Author'': ClawSuit

==See Also==
{{Useful_Functions}}

AddTableChangeHandler

2024-04-12T03:18:51Z

ClawSuit:

{{Useful Function}}
{{Important Note|do not use this function for local variables}}

This function monitors the changes of a table

==Syntax==
<syntaxhighlight lang="lua">bool addTableChangeHandler(string tablename, function func)</syntaxhighlight>

===Arguments===
* '''tablename''': The [[table]].
* '''func''': The function.

===Returns===
The func returns 5 arguments the tablename, the table, the key, the old value and the new value.

==Code==
<section name="Deprecated version" class="shared" show="false">
<syntaxhighlight lang="lua">
addTableChangeHandler = function(t, f)
local f = f
assert(type(t) == 'table', 'check argument 1 table got '..tostring(t))
assert(type(f) == 'function', 'check argument 2 function got '..tostring(f))

local copy = {}
for k,v in pairs(t) do
copy[k] = v
t[k] = nil
end

local mt = getmetatable(t) or {}

mt.lock = true
mt.copy = copy
mt.__newindex = function(t, k, v)
if not getmetatable(t).lock then
local oldValue = getmetatable(t).copy[k]
getmetatable(t).copy[k] = v
return f(t, k, oldValue, v)
end
end,

setmetatable(t,mt)

for k,v in pairs(copy) do
t[k] = v
end

getmetatable(t).lock = nil
return true

end
</syntaxhighlight>
</section>

<section name="New Version" class="shared" show="true">
<syntaxhighlight lang="lua">
function addTableChangeHandler(tablename, func)

local tablename, func = tablename, func
local parts = {}
local name
local t = _G
local i = 0

for word in tablename:gmatch("[^%.]+") do
i = i + 1
parts[i] = word
end

for i = 1, #parts-1 do
name = not name and parts[i] or name..'.'..parts[i]

if t[parts[i]] then
t = t[parts[i]]
else
return error('The table ["'..name..'"] does not exist' )
end
end

local last = parts[#parts]
if not t[last] then return error('The table ["'..(name..'.'..last)..'"] does not exist') end

local old = t[last]
t[last] = setmetatable({}, {
__index = old,
__newindex = function(self, key, value)
local oldValue = rawget(old, key)
rawset(old, key, value)
if func then
func(tablename, old, key, oldValue, value)
end
end,
})
return t[last]
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
Config = {}
Config.player = {}

addCommandHandler('smoney',
function()
Config.player.money = math.random(999)
end
)

addChangeHandler('Config.player',
function(name, table, key, old, new)
print(('tablename: %s | key: %s | Old: %s | New: %s'):format(tostring(name), tostring(key), tostring(old), tostring(new)))
end
)

Config.player.money = 1
Config.player.money = 50
</syntaxhighlight>

''Author'': ClawSuit

==See Also==
{{Useful_Functions}}

AddTableChangeHandler

2024-04-12T03:17:59Z

ClawSuit:

{{Useful Function}}
{{Important Note|do not use this function for local variables}}

This function monitors the changes of a table

==Syntax==
<syntaxhighlight lang="lua">bool addTableChangeHandler(string tablename, function func)</syntaxhighlight>

===Arguments===
* '''tablename''': The [[table]].
* '''func''': The function.

===Returns===
The func returns 5 arguments the tablename, the table, the key, the old value and the new value.

==Code==
<section name="Deprecated version" class="shared" show="false">
<syntaxhighlight lang="lua">
addTableChangeHandler = function(t, f)
local f = f
assert(type(t) == 'table', 'check argument 1 table got '..tostring(t))
assert(type(f) == 'function', 'check argument 2 function got '..tostring(f))

local copy = {}
for k,v in pairs(t) do
copy[k] = v
t[k] = nil
end

local mt = getmetatable(t) or {}

mt.lock = true
mt.copy = copy
mt.__newindex = function(t, k, v)
if not getmetatable(t).lock then
local oldValue = getmetatable(t).copy[k]
getmetatable(t).copy[k] = v
return f(t, k, oldValue, v)
end
end,

setmetatable(t,mt)

for k,v in pairs(copy) do
t[k] = v
end

getmetatable(t).lock = nil
return true

end
</syntaxhighlight>
</section>

<section name="New Version" class="shared" show="true">
<syntaxhighlight lang="lua">
function addChangeHandler(tablename, func)

local tablename, func = tablename, func
local parts = {}
local name
local t = _G
local i = 0

for word in tablename:gmatch("[^%.]+") do
i = i + 1
parts[i] = word
end

for i = 1, #parts-1 do
name = not name and parts[i] or name..'.'..parts[i]

if t[parts[i]] then
t = t[parts[i]]
else
return error('The table ["'..name..'"] does not exist' )
end
end

local last = parts[#parts]
if not t[last] then return error('The table ["'..(name..'.'..last)..'"] does not exist') end

local old = t[last]
t[last] = setmetatable({}, {
__index = old,
__newindex = function(self, key, value)
local oldValue = rawget(old, key)
rawset(old, key, value)
if func then
func(tablename, old, key, oldValue, value)
end
end,
})
return t[last]
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
Config = {}
Config.player = {}

addCommandHandler('smoney',
function()
Config.player.money = math.random(999)
end
)

addChangeHandler('Config.player',
function(name, table, key, old, new)
print(('tablename: %s | key: %s | Old: %s | New: %s'):format(tostring(name), tostring(key), tostring(old), tostring(new)))
end
)

Config.player.money = 1
Config.player.money = 50
</syntaxhighlight>

''Author'': ClawSuit

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2023-11-01T03:19:45Z

ClawSuit: /* Drawing functions */

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

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

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

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

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawEditbox]] » This function draws a edit box across the screen - rendered for one frame. This should be used in conjunction with '''onClientRender''' in order to display continuously.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombo]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxFade]] » This function fade-in or fade-out any dxDraw by gradually changing its alpha value.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

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

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getElementZoneFullName]] » This function allows you to retrieve the zone full name of a element.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInAir]] » This function checks if an element is in air or not.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]] » This function checks if an element is moving.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[isElementWithinAColShape]] » This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[getPositionInFrontOfElement]] » This function returns position in provided distance away from element, including element's rotation.

=== Events ===
*[[onClientPlayerTimeChange]] » This code implements an event that is triggered when the player's real time change.
*[[onPlayerZoneChange]] » This code implements an event that is triggered when the player enters a new area on the map.
*[[onServerVehicleSpawn]] » This code implements an event that is triggered when a new vehicle is spawned in the server.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

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

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

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

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

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

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

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

=== Ped functions ===
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedNearbyWall]] » This function checks if player/ped is nearby a objects like buildings or walls.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

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

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

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

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

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

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

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

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.
*[[isElementObject]] » This function tells you if an element is an object or no.

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

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

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

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

Template:Useful Functions

2023-11-01T03:18:12Z

ClawSuit: /* Drawing functions */

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

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

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

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

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

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

=== Drawing functions ===
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawBorderedRectangle]] » This is a function that will create a bordered rectangle.
*[[dxDrawBorderedText]] » This is a function that will create a bordered text.
*[[dxDrawDashedLine]] » This function draws a line with dashes.
*[[dxDrawEditbox]] » This function draws a edit box across the screen - rendered for one frame. This should be used in conjunction with '''onClientRender''' in order to display continuously.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawImageOnElement]] » This function draws an image on any element.
*[[dxDrawLinedRectangle]] » This is a function that will create a rectangle outline with dx lines.
*[[dxDrawLoading]] » This function draws a loading bar on the screen.
*[[dxDrawOctagon3D]] » This function creates a 3D Octagon
*[[dxDrawPolygon]] » This function draws a custom polygon on the screen.
*[[dxDrawProgressBar]] » This function simulates a progress bar drawed using DirectDraw.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxDrawRectangleOnPlayer]] » This function draws a 3D rectangle above the player.
*[[dxDrawRing]] » This function draws a ring with dx lines.
*[[dxDrawRombus]] » This function creates a Rhombus.
*[[dxDrawSprite]] » This function draw a sprite in the 3D world.
*[[dxDrawTextOnElement]] » This function draws a text on any element.
*[[dxDrawTextOnRectangle]] » Esta funcion crea un rectangle con un texto dentro.
*[[dxDrawTriangle]] » This is a function that will create a triangle with dx lines.
*[[dxFade]] » This function fade-in or fade-out any dxDraw by gradually changing its alpha value.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[getScreenStartPositionFromBox]] » This function helps with getting the correct position for your dx-effects.
*[[wordWrap]] » This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.
*[[CreateRectangle3D]] » This is a function that will create a 3d rectangle on the player screen.
*[[DxDrawBordered3DLine]] »This function creates a bordered area with 3D dx lines.

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

=== Element functions ===
*[[autoAttach]] » This function attaches one element into another at the same position and rotation they are.
*[[attachElementToBone]] » This function allows you to attach an element to ped bone accurately using new bone functions.
*[[getElementDirectionCardialPoint]] » This function returns the direction of the element according to the ''wind rose''.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementUsingData]] » This function returns table elements that contains the elements data with the given key and value.
*[[getElementZoneFullName]] » This function allows you to retrieve the zone full name of a element.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getNearestElement]] » This function returns the nearest element (of a specific type) to a player.
*[[isElementInAir]] » This function checks if an element is in air or not.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]] » This function checks if an element is moving.
*[[isElementPlayer]] » This function checks whether the element is a player or not.
*[[isElementWithinAColShape]] » This function checks if an element is within a collision shape element.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[getPositionInFrontOfElement]] » This function returns position in provided distance away from element, including element's rotation.

=== Events ===
*[[onClientPlayerTimeChange]] » This code implements an event that is triggered when the player's real time change.
*[[onPlayerZoneChange]] » This code implements an event that is triggered when the player enters a new area on the map.
*[[onServerVehicleSpawn]] » This code implements an event that is triggered when a new vehicle is spawned in the server.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.

=== Input functions ===
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[isCommandHandlerAdded]] » This function allows you to check if a command is added or not in the respective resource.

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

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

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

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

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

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

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

=== Ped functions ===
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getGuestPlayers]] » This function gets a players not login or players Guest .
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getPedEyesPosition]] » This function allows you to get peds eyes position.
*[[getPedGender]] » This function allows you to get peds their gender.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPedWeaponSkill]] » This function returns a ped's corresponding weapon skill level name.
*[[getPedHitBone]] » This function gets the approximate number of the bone where the ped is hit.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayersInVehicles]] » This function returns a table of the players insides vehicles from a specified dimension.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
*[[isPedDiving]] » This feature checks that pedestrian is diving in the water.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPedNearbyWall]] » This function checks if player/ped is nearby a objects like buildings or walls.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[setPedAttack]] » This function will make a ped attack a specified target.
*[[setPedFollow]] » This function will make a ped follow a specified target.
*[[getPlayerNameFromID]] » This function will get the player name from the ID element data.

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

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

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

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

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

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

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

=== Object functions ===
*[[getDynamicDoorObjectOpenRatio]] » This function tells you how open a dynamic door is in a range from 0 to 1.
*[[isElementObject]] » This function tells you if an element is an object or no.

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

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

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

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

DxGetLibrary

2023-08-12T17:05:40Z

ClawSuit: Created page with "__NOTOC__ {{Client Function}} Esta funcion extrae los diferentes exports de la libreria en forma de variables para hacer el uso de la libreria mas facil para ello debe de complementarse con '''loadstring'''. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Sintaxis== <syntaxhighlight lang="l..."

__NOTOC__
{{Client Function}}
Esta funcion extrae los diferentes exports de la libreria en forma de variables para hacer el uso de la libreria mas facil para ello debe de complementarse con '''loadstring'''.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">string dxGetLibrary()</syntaxhighlight>

==Ejemplo==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxCheckBox

2023-08-12T16:58:08Z

ClawSuit:

__NOTOC__
{{Client Function}}
[[File:DxWindow.png|300px|thumb|right|Ventana de Pruebas.]]
Esta funcion crea una checkBox basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">element dxCheckBox(int x, int y, string text, [ element parent = nil, bool rounded = nil ] )</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''y''': Un entero que representa la posición Y del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''text''': Una cadena de caracteres(string) que representa el texto que contendra el [https://wiki.multitheftauto.com/wiki/DxCheckBox CheckBox].

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual el [https://wiki.multitheftauto.com/wiki/DxCheckBox CheckBox] se adjunta.
* '''rounded''': Un booleano que representa si el checkBox llevara bordes redondeados.

==Ejemplo==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow( 251, 21, 250, 300, 'Window DEMO', true, true )

--creamos un checkBox
check1 = dxCheckBox(432, 83, 'guardar datos', win)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxListRemoveItem

2023-08-10T00:37:09Z

ClawSuit: Created page with "__NOTOC__ {{Client Function}} Esta funcion elimina un texto o item de una dxList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Sintaxis== <syntaxhighlight lang="lua">bool dxListRemoveItem(element, index int)</syntaxhighlight> ===Argumentos requeridos=== * '''element''': Elemento dxList creado previamente. * '''index''': Un entero que representa la..."

__NOTOC__
{{Client Function}}
Esta funcion elimina un texto o item de una [[dxList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxListRemoveItem(element, index int)</syntaxhighlight>

===Argumentos requeridos===
* '''element''': Elemento [[dxList]] creado previamente.
* '''index''': Un entero que representa la posicion del texto o item en la [[dxList]].

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

--creamos una lista
list = dxList( 312, 347, 250, 203, win )

--agregamos 3 row
for i = 1, 3 do
dxListAddItem(list, 'Row '..i)
end

--borramos el segundo row.
dxListRemoveItem(list, 2)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxListAddItem

2023-08-10T00:35:48Z

ClawSuit:

__NOTOC__
{{Client Function}}
Esta funcion agrega un texto al final de la una [[dxList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxListAddItem(element, item string)</syntaxhighlight>

===Argumentos requeridos===
* '''element''': La [[dxList]] creada.
* '''item''': Un string que representa el texto a agregar.

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

--creamos una lista
list = dxList( 312, 347, 250, 203, win )

--le agregamos un valor a la lista.
dxListAddItem(list, 'Ruedas tipo 1')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxListAddItem

2023-08-10T00:20:16Z

ClawSuit: Created page with "__NOTOC__ {{Client Function}} Esta funcion agrega un texto al final de la una dxList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Sintaxis== <syntaxhighlight lang="lua">bool dxListAddItem(element, item)</syntaxhighlight> ===Argumentos requeridos=== * '''element''': La dxList creada. * '''item''': Un texto(string) que se agregara a la lista. ==Eje..."

__NOTOC__
{{Client Function}}
Esta funcion agrega un texto al final de la una [[dxList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxListAddItem(element, item)</syntaxhighlight>

===Argumentos requeridos===
* '''element''': La [[dxList]] creada.
* '''item''': Un texto(string) que se agregara a la lista.

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

--creamos una lista
list = dxList( 312, 347, 250, 203, win )

--le agregamos un valor a la lista.
dxListAddItem(list, 'Ruedas tipo 1')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxButton

2022-05-21T20:25:16Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función crea un boton basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxButton( int x, int y, int width, int height, string text [, element parent = nil, bool rounded = nil ] )
</syntaxhighlight>

===Required Arguments===
[[Image:DGS_Button.png|thumb|Boton]]
*'''x:''' Un numero de la posición 2D x del botón en la pantalla de un jugador.
*'''y:''' Un numero de la posición 2D y del botón en la pantalla de un jugador.
*'''width:''' Un numero del ancho del botón.
*'''height:''' Un numero de la altura del botón.
*'''text:''' Una cadena del texto que se mostrará como una etiqueta en el botón.

===Optional Arguments===
*'''parent:''' Este es el padre el cual el [https://wiki.multitheftauto.com/wiki/dxButton boton] se adjunta.
*'''rounded:''' Si desea que el botón sea redondeado o no. ( true o false )

==Example==
En este ejemplo se mostrará el mensaje del cuadro de edición en el cuadro de chat.
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

-- crea un boton
button = dxButton( 276, 80, 100, 40, "Anunciar!" )

-- cree un cuadro de edición y lo definimos como "editBox".
editBox = dxEdit( 277, 184, 197, 46, "Escribe tu mensaje aqui!" )

function outputEditBox ()
local text = dxGetText( editBox ) --Obtener el texto del cuadro de edición
outputChatBox ( text, 255, 255, 255 ) --anunciar ese texto
end
addEventHandler ( "onClick", button, outputEditBox )

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxFont

2022-05-21T20:24:28Z

ClawSuit:

__NOTOC__
{{Client Function}}
Esta funcion sirve para crear una fuente que podra ser utilizada por cualquier elemento de [[Modern-Library]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxFont(string path, float size, [ bool bold = nil ] )</syntaxhighlight>

===Argumentos requeridos===
* '''path''': La ruta del archivo tipo fuente. > ''Ruta local de la libreria'' '''"files/font/"'''
* '''size''': Un flotante que representa el tamaño de la fuente.
===Argumentos Opcionales===
* '''bold''': Un booleano que representa si la fuente sera gruesa.
===Fuentes locales===
* '''Basic-Regular.ttf''': Tamaños 10, 11
* '''letterbold.otf''': Tamaños 9, 10
* '''Comforta_regular.ttf''': Tamaños 10, 11, 12, 13
==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una fuente local de la Modern-Library con un tamaño personalizado
dxFont('files/font/letterbold.otf', 13, true)

--creamos una fuente externa de otro script o bien sea del mismo script donde se este llamando a dicha funcion.
dxFont(':varios/font/grove.ttf', 10, false)

win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)
dxSetFont(win, 'letterbold', 13) -- le damos la fuente letterbold a la ventana

bot = dxButton(276, 80, 100, 40, 'Button demo', win, false)
dxSetFont(win, 'grove', 10) -- le damos la fuente grove al boton.

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxSetFont

2022-05-21T20:24:15Z

ClawSuit:

__NOTOC__
{{Client Function}}
Esta funcion sirve para cambiar la fuente de un elemento de la [[Modern-Library]] .

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxSetFont(string fontName, float size)</syntaxhighlight>

===Argumentos requeridos===
* '''fontName''': El nombre de la fuente sin su extension, ''Ejemplo'' en ves de '''''Basic-Regular.ttf''''' colocar '''''Basic-Regular'''''
* '''size''': Un flotante que representa el tamaño de la fuente.
===Fuentes locales===
* '''Basic-Regular.ttf''': Tamaños 10, 11
* '''letterbold.otf''': Tamaños 9, 10
* '''Comforta_regular.ttf''': Tamaños 10, 11, 12, 13

'''NOTA''': ''El tamaño de la fuente en caso de ser una fuente local recuerda ver bien los tamaños y colocar uno existente, en caso de ser una fuente personaliza
recuerda colocar el tamaño que especificaste en'' [[dxFont]]

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una fuente externa de otro script o bien sea del mismo script donde se este llamando a dicha funcion.
dxFont(':varios/font/grove.ttf', 10, false)

win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)
dxSetFont(win, 'Comforta_regular', 12) -- le damos la fuente Comforta_regular a la ventana

bot = dxButton(276, 80, 100, 40, 'Button demo', win, false)
dxSetFont(win, 'grove', 10) -- le damos la fuente grove al boton.

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxWindow

2022-05-21T20:24:00Z

ClawSuit:

__NOTOC__
{{Client Function}}
[[File:DxWindow.png|300px|thumb|right|Ventana de Pruebas.]]
Esta funcion crea una ventana moderna basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">element dxWindow(int x, int y, int w, int h, string title, [ bool closebutton = true, bool rounded = false, float border = false])</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''y''': Un entero que representa la posición Y del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''w''': Un entero que representa el ancho de la ventana.
* '''h''': Un entero que representa la altura de la ventana.
===Argumentos Opcionales===
* '''closebutton''': Un booleano que representa la visibilidad del boton de cerrado, ''false'' para quitar, ''true'' o ''nil'' para visualizar.
* '''rounded''': Un booleano que representa si la ventana llevara bordes redondeados.
* '''border''': Un entero que reprenta el grosor de la linea del borde de la ventana.
==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow( 251, 21, 250, 300, 'Window DEMO', true, true )

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxWindowSetCloseState

2022-05-21T20:23:47Z

ClawSuit:

__NOTOC__
{{Client Function}}
Esta funcion oculta o visualiza el boton de cerrado de una [[dxWindow]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxWindowSetCloseState(element element, bool state)</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxWindow]].
* '''state''': Un booleano (true o false).
==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )
--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

--Le removemos el boton de cerrado mediante la funcion.
dxWindowSetCloseState( win, false )
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxWindowGetCloseState

2022-05-21T20:23:32Z

ClawSuit:

__NOTOC__
{{Client Function}}
Esta funcion obtiene el estado del boton de cerrado de una [[dxWindow]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">bool dxWindowGetCloseState(element element)</syntaxhighlight>

===Argumentos requeridos===
* '''element''': La ventana la cual se obtendra el estado del boton de cerrado.
==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

bindKey('k', 'down',
function()
outputChatBox('El boton de cerrado esta '..(dxWindowGetCloseState( win ) and 'visible' or 'oculto'))
end
)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxButton

2022-05-21T20:23:04Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función crea un boton basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxButton( int x, int y, int width, int height, string text [, element parent = nil, bool rounded = nil ] )
</syntaxhighlight>

===Required Arguments===
[[Image:DGS_Button.png|thumb|Boton]]
*'''x:''' Un numero de la posición 2D x del botón en la pantalla de un jugador.
*'''y:''' Un numero de la posición 2D y del botón en la pantalla de un jugador.
*'''width:''' Un numero del ancho del botón.
*'''height:''' Un numero de la altura del botón.
*'''text:''' Una cadena del texto que se mostrará como una etiqueta en el botón.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' Este es el padre el cual el [https://wiki.multitheftauto.com/wiki/dxButton boton] se adjunta.
*'''rounded:''' Si desea que el botón sea redondeado o no. ( true o false )

==Example==
En este ejemplo se mostrará el mensaje del cuadro de edición en el cuadro de chat.
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

-- crea un boton
button = dxButton( 276, 80, 100, 40, "Anunciar!" )

-- cree un cuadro de edición y lo definimos como "editBox".
editBox = dxEdit( 277, 184, 197, 46, "Escribe tu mensaje aqui!" )

function outputEditBox ()
local text = dxGetText( editBox ) --Obtener el texto del cuadro de edición
outputChatBox ( text, 255, 255, 255 ) --anunciar ese texto
end
addEventHandler ( "onClick", button, outputEditBox )

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxCheckBox

2022-05-21T20:20:29Z

ClawSuit:

__NOTOC__
{{Client Function}}
[[File:DxWindow.png|300px|thumb|right|Ventana de Pruebas.]]
Esta funcion crea una checkBox basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">element dxCheckBox(int x, int y, int w, int h, [ element parent = nil, bool rounded = nil ] )</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''y''': Un entero que representa la posición Y del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''w''': Un entero que representa el ancho de la ventana.
* '''h''': Un entero que representa la altura de la ventana.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual el [https://wiki.multitheftauto.com/wiki/DxCheckBox CheckBox] se adjunta.
* '''rounded''': Un booleano que representa si el checkBox llevara bordes redondeados.

==Ejemplo==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow( 251, 21, 250, 300, 'Window DEMO', true, true )

--creamos un checkBox
check1 = dxCheckBox(432, 83, 32, 32, win)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxCheckBoxSetState

2022-05-21T20:20:14Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función cambia el estado de un [[dxCheckBox]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxCheckBoxSetState( element element, bool bool )
</syntaxhighlight>

===Argumentos requeridos===
*'''element:''' El elemento [[dxCheckBox]].
*'''bool:''' Un booleano (true o false).

==Ejemplo==
En el siguiente ejemplo veremos como al darle click al boton el [[dxCheckBox]] cambia de estado.
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos un dxCheckBox
checkB = dxCheckBox(432, 83, 32, 32)

-- creamos un boton
button = dxButton( 276, 80, 100, 40, "Clickea" )
addEventHandler ( "onClick", button,
function()
dxCheckBoxSetState(checkB, not dxCheckBoxSetState(checkB))
end
)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxCheckBoxGetState

2022-05-21T20:19:59Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para obtener el estado de un [[dxCheckBox]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxCheckBoxSetState( element element )
</syntaxhighlight>

===Argumentos requeridos===
*'''element:''' El elemento [[dxCheckBox]].

==Ejemplo==
En el siguiente ejemplo veremos como al darle click al boton imprime el estado del [[dxCheckBox]].
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos un dxCheckBox
checkB = dxCheckBox(432, 83, 32, 32)

-- creamos un boton
button = dxButton( 276, 80, 100, 40, "Clickea" )
addEventHandler ( "onClick", button,
function()
print(dxCheckBoxSetState(checkB))
end
)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxEdit

2022-05-21T20:19:41Z

ClawSuit:

__NOTOC__
{{Client Function}}
[[File:DxWindow.png|300px|thumb|right|Ventana de Pruebas.]]
Esta funcion crea un cuadro de texto basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">element dxEdit(int x, int y, int w, int h, string text, [ element parent = nil ])</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''y''': Un entero que representa la posición Y del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''w''': Un entero que representa el ancho de la ventana.
* '''h''': Un entero que representa la altura de la ventana.
* '''text''': Una cadena del texto que se mostrará como una etiqueta en la caja de texto.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual el [https://wiki.multitheftauto.com/wiki/dxEdit cuadro de texto] se adjunta.

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)

--creamos una caja de texto
edit1 = dxEdit(277, 184, 197, 46, 'edit demo 1', win, false)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxEditSetMasked

2022-05-21T20:19:15Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para enmascarar el texto de un [[dxEdit]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxEditSetMasked( element element, bool bool )
</syntaxhighlight>
===Argumentos requeridos===
*'''element:''' El elemento [[dxEdit]].
*'''bool:''' Un booleano (true o false).

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una caja de texto
edit = dxEdit(277, 184, 197, 46, 'edit demo 1')
-- enmascaramos el texto
dxEditSetMasked(edit, true)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxEditSetMaxCharacters

2022-05-21T20:18:59Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para colocar un maximo de caracteres que se pueden escribir en un [[dxEdit]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxEditSetMaxCharacters( element element, int quantity )
</syntaxhighlight>

===Argumentos requeridos===
*'''element:''' El elemento [[dxEdit]].
*'''quantity:''' Un entero que representa la cantidad de caracteres.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una caja de texto
edit = dxEdit(277, 184, 197, 46, 'edit demo 1')
-- Le colocamos un maximo de 30 caracteres
dxEditSetMaxCharacters(edit, 30)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridList

2022-05-21T20:18:43Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función crea una lista de cuadrícula basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxGridList( int x, int y, int w, int h, [ element parent = nil] )
</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X de la pantalla.
* '''y''': Un entero que representa la posición Y de la pantalla.
* '''w''': Un entero que representa el ancho del [[dxGridList]].
* '''h''': Un entero que representa la altura del [[dxGridList]].

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxGridList gridlist] se adjunta.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListAddItem

2022-05-21T20:18:24Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para agregar un articulo/ítem a una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListAddItem( element element, columna1, columna2, ... )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''...''': El numero sin fin de artículos/ítems a agregar según la cantidad de columnas.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListRemoveItem

2022-05-21T20:18:04Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para eliminar un articulo/ítem de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListRemoveItem( element element, int index )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''index''': Un entero que representa el índice de la fila a eliminar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000') -- fila 1
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000') -- fila 2

--Eliminamos la fila 1
dxGridListRemoveItem(lista, 1)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListAddColumn

2022-05-21T20:17:42Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para agregar una columna a una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListAddColumn( element element, string name, float size )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''name''': El nombre de la columna.
* '''size''': Un flotante que representa el tamaño de separación entre la columna actual y la siguiente.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListRemoveColumn

2022-05-21T20:17:28Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para remover una columna de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListRemoveColumn( element element, string name )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''name''': El nombre de la columna a eliminar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

--eliminamos la segunda columna
dxGridListRemoveColumn(lista, 'Dueño')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetItemSelected

2022-05-21T20:17:09Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para obtener la fila de articulos/items seleccionada de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
int table dxGridListGetItemSelected( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
===Retorno===
* '''int''': El numero de la fila seleccionada.
* '''table''': Una tabla con todos los articulos/items de la fila seleccionada
==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')

boton = dxButton( 276, 80, 100, 40, 'Clickea')
addEventHandler ( "onClick", boton,
function()
local inx, tab = dxGridListGetItemSelected(lista)
if inx ~= -1 then
print(inspect(tab))
end
end
)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListSetItemSelected

2022-05-21T20:16:46Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para seleccionar una fila de articulos/items de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListSetItemSelected( element element, int index )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''index''': El numero de la fila a seleccionar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')

boton = dxButton( 276, 80, 100, 40, 'Clickea')
addEventHandler ( "onClick", boton,
function()
dxGridListSetItemSelected(lista, math.random(2))
end
)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetScrollHV

2022-05-21T20:16:31Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para extraer el scroll horizontal y vertical de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element element dxGridListGetScrollHV( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos varias filas de items, hay 3 valores en cada sub-tabke porque solamente se crearon 3 columnas ↑
for _, v in ipairs({{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'}}) do
dxGridListAddItem(lista, unpack(v))
end

--extramos las scroll
scrollH, scrollV = dxGridListGetScrollHV(lista)

--Le cambiamos el boton de las scroll a rojo.
dxScrollSetColorButton(scrollH, 255, 0, 0, 255)
dxScrollSetColorButton(scrollV, 255, 0, 0, 255)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxList

2022-05-21T20:15:53Z

ClawSuit:

__NOTOC__
{{Client Function}}
[[File:DxWindow.png|300px|thumb|right|Ventana de Pruebas.]]
Esta funcion crea una lista basada en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Sintaxis==
<syntaxhighlight lang="lua">element dxList(int x, int y, int w, int h, [ element parent = nil ])</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''y''': Un entero que representa la posición Y del origen absoluto de la ventana, representado por píxeles en la pantalla.
* '''w''': Un entero que representa el ancho de la ventana.
* '''h''': Un entero que representa la altura de la ventana.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxList lista] se adjunta.

==Ejemplo de Uso==

<syntaxhighlight lang="lua">
loadstring( exports.dxLibrary:dxGetLibrary( ) )( )

--creamos una ventana
win = dxWindow(251, 21, 250, 300, 'Window DEMO', true, true)
--creamos una lista
list = dxList( 312, 347, 250, 203, win )
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxImage

2022-05-21T20:14:58Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función crea una imagen basada en [[dxCreateTexture]] + dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxImage( int x, int y, int w, int h, string filepath, [ element parent = nil , string textureformat = 'dxt5', mipmaps = true, textureType = 'clamp' ] )
</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X de la pantalla.
* '''y''': Un entero que representa la posición Y de la pantalla.
* '''w''': Un entero que representa el ancho del [[dxImage]].
* '''h''': Un entero que representa la altura del [[dxImage]].
* '''filepath''': La ruta donde se encuentra la imagen.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxImage imagen] se adjunta.
* '''textureformat''': Formatos validos '''''"argb"''''' '''''"dxt1"''''' '''''"dxt3"''''' '''''"dxt5"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''mipmaps''': Un booleano (true o false) ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''textureType''': Formatos validos '''''"wrap"''''' '''''"clamp"''''' '''''"mirror"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlibrary:dxGetLibrary())()
--creamos una imagen
dxImage(561, 92, 116, 92, ":admin/client/images/map.png")
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxImage

2022-05-21T20:14:35Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función crea una imagen basada en [[dxCreateTexture]] + dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxImage( int x, int y, int w, int h, string filepath, [ element parent = nil , string textureformat = 'dxt5', mipmaps = true, textureType = 'clamp' ] )
</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X de la pantalla.
* '''y''': Un entero que representa la posición Y de la pantalla.
* '''w''': Un entero que representa el ancho del [[dxImage]].
* '''h''': Un entero que representa la altura del [[dxImage]].
* '''filepath''': La ruta donde se encuentra la imagen.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxImage imagen] se adjunta.
* '''textureformat''': Formatos validos '''''"argb"''''' '''''"dxt1"''''' '''''"dxt3"''''' '''''"dxt5"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''mipmaps''': Un booleano (true o false) ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''textureType''': Formatos valudos '''''"wrap"''''' '''''"clamp"''''' '''''"mirror"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlibrary:dxGetLibrary())()
--creamos una imagen
dxImage(561, 92, 116, 92, ":admin/client/images/map.png")
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxImage

2022-05-21T20:14:00Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función crea una imagen basada en dxCreateTexture + dxDrawing. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> element dxImage( int x, int y, int w, int h, string filepath, [ element parent = nil , string textureformat = 'dxt5', mipmaps = true, textureType = 'clamp' ] ) </syntaxhig..."

__NOTOC__
{{Client function}}
Esta función crea una imagen basada en [[dxCreateTexture]] + dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxImage( int x, int y, int w, int h, string filepath, [ element parent = nil , string textureformat = 'dxt5', mipmaps = true, textureType = 'clamp' ] )
</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X de la pantalla.
* '''y''': Un entero que representa la posición Y de la pantalla.
* '''w''': Un entero que representa el ancho del [[dxImage]].
* '''h''': Un entero que representa la altura del [[dxImage]].
* '''filepath''': La ruta donde se encuentra la imagen.

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxImage imagen] se adjunta.
* '''textureformat''': Formatos validos '''''"argb"''''' '''''"dxt1"''''' '''''"dxt3"''''' '''''"dxt5"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''mipmaps''': Un booleano (true o false) ; '''''Para mas información véase [[dxCreateTexture]]!'''''
* '''textureType''': '''''"wrap"''''' '''''"clamp"''''' '''''"mirror"''''' ; '''''Para mas información véase [[dxCreateTexture]]!'''''

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlibrary:dxGetLibrary())()
--creamos una imagen
dxImage(561, 92, 116, 92, ":admin/client/images/map.png")
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetScrollHV

2022-05-21T19:06:21Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para extraer el scroll horizontal y vertical de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element element dxGridListGetScrollHV( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos varias filas de items, hay 3 valores en cada sub-tabke porque solamente se crearon 3 columnas ↑
for _, v in ipairs({{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'}}) do
dxGridListAddItem(lista, unpack(v))
end

--extramos las scroll
scrollH, scrollV = dxGridListGetScrollHV(lista)

--Le cambiamos el boton de las scroll a rojo.
dxScrollSetColorButton(scrollH, 255, 0, 0, 255)
dxScrollSetColorButton(scrollV, 255, 0, 0, 255)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetScrollHV

2022-05-21T19:05:51Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para extraer el scroll horizontal y vertical de una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> element element dxGridListGetScrollHV( element element ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. ==Ej..."

__NOTOC__
{{Client function}}
Esta función sirve para extraer el scroll horizontal y vertical de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element element dxGridListGetScrollHV( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos varias filas de items, hay 3 valores en cada sub-tabke porque solamente se crearon 3 columnas ↑
for _, v in ipairs({{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'},{'Infernus', 'Claw', '50000'}, {'Sultan', 'Pand', '500000'}, {'Towtruck', 'Bert', '5000200'}}) do
dxGridListAddItem(lista, unpack(v))
end

-extramos las scroll
scrollH, scrollV = dxGridListGetScrollHV(lista)

--Le cambiamos el boton de las scroll a rojo.
dxScrollSetColorButton(scrollH, 255, 0, 0, 255)
dxScrollSetColorButton(scrollV, 255, 0, 0, 255)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListSetItemSelected

2022-05-21T18:49:51Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para seleccionar una fila de articulos/items de una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> bool dxGridListSetItemSelected( element element, int index ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. *..."

__NOTOC__
{{Client function}}
Esta función sirve para seleccionar una fila de articulos/items de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListSetItemSelected( element element, int index )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''index''': El numero de la fila a seleccionar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')

boton = dxButton( 276, 80, 100, 40, 'Clickea')
addEventHandler ( "onClick", boton,
function()
dxGridListSetItemSelected(lista, math.random(2))
end
)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetItemSelected

2022-05-21T17:17:29Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para obtener la fila de articulos/items seleccionada de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
int table dxGridListGetItemSelected( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
===Retorno===
* '''int''': El numero de la fila seleccionada.
* '''table''': Una tabla con todos los articulos/items de la fila seleccionada
==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')

boton = dxButton( 276, 80, 100, 40, 'Clickea')
addEventHandler ( "onClick", boton,
function()
local inx, tab = dxGridListGetItemSelected(lista)
if inx ~= -1 then
print(inspect(tab))
end
end
)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListGetItemSelected

2022-05-21T17:14:15Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para obtener la fila de articulos/items seleccionada de una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> int table dxGridListGetItemSelected( element element ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList...."

__NOTOC__
{{Client function}}
Esta función sirve para obtener la fila de articulos/items seleccionada de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
int table dxGridListGetItemSelected( element element )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
===Retorno===
* '''int''': Es el numero de la fila seleccionada.
* '''table''': Una tabla con todos los articulos/items de la fila seleccionada
==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')

boton = dxButton( 276, 80, 100, 40, 'Clickea')
addEventHandler ( "onClick", boton,
function()
local inx, tab = dxGridListGetItemSelected(lista)
if inx ~= -1 then
print(inspect(tab))
end
end
)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListRemoveColumn

2022-05-21T07:39:27Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para remover una columna de una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> bool dxGridListRemoveColumn( element element, string name ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. * '''name''': El nombr..."

__NOTOC__
{{Client function}}
Esta función sirve para remover una columna de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListRemoveColumn( element element, string name )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''name''': El nombre de la columna a eliminar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

--eliminamos la segunda columna
dxGridListRemoveColumn(lista, 'Dueño')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListAddColumn

2022-05-21T07:37:31Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para agregar una columna a una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> bool dxGridListAddColumn( element element, string name, float size ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. * '''name''':..."

__NOTOC__
{{Client function}}
Esta función sirve para agregar una columna a una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListAddColumn( element element, string name, float size )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''name''': El nombre de la columna.
* '''size''': Un flotante que representa el tamaño de separación entre la columna actual y la siguiente.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListAddItem

2022-05-21T07:33:55Z

ClawSuit:

__NOTOC__
{{Client function}}
Esta función sirve para agregar un articulo/ítem a una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListAddItem( element element, columna1, columna2, ... )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''...''': El numero sin fin de artículos/ítems a agregar según la cantidad de columnas.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListRemoveItem

2022-05-21T07:33:15Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para eliminar un articulo/ítem de una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> bool dxGridListRemoveItem( element element, int index ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. * '''index''': Un e..."

__NOTOC__
{{Client function}}
Esta función sirve para eliminar un articulo/ítem de una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxGridListRemoveItem( element element, int index )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''index''': Un entero que representa el índice de la fila a eliminar.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000') -- fila 1
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000') -- fila 2

--Eliminamos la fila 1
dxGridListRemoveItem(lista, 1)
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridListAddItem

2022-05-21T07:28:27Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para agregar un articulo/ítem a una dxGridList. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> element dxGridListAddItem( element element, columna1, column2, ... ) </syntaxhighlight> ===Argumentos requeridos=== * '''element''': El elemento dxGridList. * '''......"

__NOTOC__
{{Client function}}
Esta función sirve para agregar un articulo/ítem a una [[dxGridList]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxGridListAddItem( element element, columna1, column2, ... )
</syntaxhighlight>

===Argumentos requeridos===
* '''element''': El elemento [[dxGridList]].
* '''...''': El numero sin fin de artículos/ítems a agregar según la cantidad de columnas.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end

-- Agregamos 2 filas de items, hay 3 valores en cada función porque solamente se crearon 3 columnas ↑
dxGridListAddItem(lista, 'Infernus', 'Claw', '50000')
dxGridListAddItem(lista, 'Sultan', 'Pand', '50000')
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxGridList

2022-05-21T07:20:54Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función crea una lista de cuadrícula basado en dxDrawing. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> element dxGridList( int x, int y, int w, int h, [ element parent = nil] ) </syntaxhighlight> ===Argumentos requeridos=== * '''x''': Un entero que representa la posición X de la..."

__NOTOC__
{{Client function}}
Esta función crea una lista de cuadrícula basado en dxDrawing.

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
element dxGridList( int x, int y, int w, int h, [ element parent = nil] )
</syntaxhighlight>

===Argumentos requeridos===
* '''x''': Un entero que representa la posición X de la pantalla.
* '''y''': Un entero que representa la posición Y de la pantalla.
* '''w''': Un entero que representa el ancho del [[dxGridList]].
* '''h''': Un entero que representa la altura del [[dxGridList]].

===Argumentos Opcionales===
* '''parent''': Este es el padre el cual la [https://wiki.multitheftauto.com/wiki/dxGridList gridlist] se adjunta.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una lista
lista = dxGridList( 588, 349, 351, 120 )

--Agregamos 3 columnas a la lista...
for _, c in ipairs({{'Vehiculo', 2}, {'Dueño', 2}, {'Costo', 3}}) do
dxGridListAddColumn(lista, c[1], c[2])
end
</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}

DxEditSetMaxCharacters

2022-05-21T07:11:38Z

ClawSuit: Created page with "__NOTOC__ {{Client function}} Esta función sirve para colocar un maximo de caracteres que se pueden escribir en un dxEdit. '''''Aviso: Esta es una función exportada por Modern-Library!''''' ==Syntax== <syntaxhighlight lang="lua"> bool dxEditSetMaxCharacters( element element, int quantity ) </syntaxhighlight> ===Argumentos requeridos=== *'''element:''' El elemento dxEdi..."

__NOTOC__
{{Client function}}
Esta función sirve para colocar un maximo de caracteres que se pueden escribir en un [[dxEdit]].

'''''Aviso: Esta es una función exportada por [[Modern-Library]]!'''''
==Syntax==
<syntaxhighlight lang="lua">
bool dxEditSetMaxCharacters( element element, int quantity )
</syntaxhighlight>

===Argumentos requeridos===
*'''element:''' El elemento [[dxEdit]].
*'''quantity:''' Un entero que representa la cantidad de caracteres.

==Ejemplo==
<syntaxhighlight lang="lua">
loadstring(exports.dxlib:dxGetLibrary())()

--creamos una caja de texto
edit = dxEdit(277, 184, 197, 46, 'edit demo 1')
-- Le colocamos un maximo de 30 caracteres
dxEditSetMaxCharacters(edit, 30)

</syntaxhighlight>

==Ver también==
{{DXLIB_FUNCTIONS}}