Multi Theft Auto: Wiki - New pages [en]

ResetDynamicPedShadows

2026-04-17T09:55:33Z

Arran Fortuna:

__NOTOC__
{{Client function}}
This function restores the dynamic ped shadow setting back to the player's original video configuration.

If [[setDynamicPedShadowsEnabled]] was used to override the setting, calling this function will remove that override and reapply the value defined in the player's settings.

This is useful for ensuring that temporary changes made by a resource do not persist after it stops.

==Syntax==
<syntaxhighlight lang="lua">
bool resetDynamicPedShadows ( )
</syntaxhighlight>

===Required Arguments===
*None

===Returns===
Returns ''true'' if the reset was successful, ''false'' otherwise.

===Examples===
<syntaxhighlight lang="lua">
-- Reset dynamic ped shadows to player's settings
resetDynamicPedShadows()
</syntaxhighlight>

===Example: Safe usage in a resource===
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
setDynamicPedShadowsEnabled(false)
end
)

addEventHandler("onClientResourceStop", resourceRoot,
function()
resetDynamicPedShadows()
end
)
</syntaxhighlight>

==See Also==
{{World functions|client}}

SetDynamicPedShadowsEnabled

2026-04-17T09:54:25Z

Arran Fortuna:

__NOTOC__
{{Client function}}
This function allows scripts to override the current dynamic ped shadow setting on the client.

When used, it temporarily overrides the player’s video setting for dynamic ped shadows. To restore the original value based on the player's settings, use [[resetDynamicPedShadows]].

==Syntax==
<syntaxhighlight lang="lua">
bool setDynamicPedShadowsEnabled ( bool enabled )
</syntaxhighlight>

===Required Arguments===
*'''enabled:''' a boolean value specifying whether dynamic ped shadows should be enabled (''true'') or disabled (''false'').

===Returns===
Returns ''true'' if the setting was successfully applied, ''false'' otherwise.

===Examples===
<syntaxhighlight lang="lua">
-- Disable dynamic ped shadows
setDynamicPedShadowsEnabled(false)
</syntaxhighlight>

===Example: Toggle shadows===
<syntaxhighlight lang="lua">
local current = isDynamicPedShadowsEnabled()
setDynamicPedShadowsEnabled(not current)
</syntaxhighlight>

===Example: Disable shadows on resource start and restore on stop===
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
setDynamicPedShadowsEnabled(false)
end
)

addEventHandler("onClientResourceStop", resourceRoot,
function()
resetDynamicPedShadows()
end
)
</syntaxhighlight>

==See Also==
{{Client world functions}}

IsDynamicPedShadowsEnabled

2026-04-17T09:53:02Z

Arran Fortuna:

__NOTOC__
{{Client function}}
This function checks whether dynamic shadows for peds are currently enabled on the client.

The returned value may reflect:
* The player's video settings.
* Any override applied using [[setDynamicPedShadowsEnabled]].

Use [[resetDynamicPedShadows]] to restore the setting back to the player’s original video configuration.

==Syntax==
<syntaxhighlight lang="lua">
bool isDynamicPedShadowsEnabled ( )
</syntaxhighlight>

===Required Arguments===
*None

===Returns===
Returns ''true'' if dynamic ped shadows are enabled, ''false'' otherwise.

===Examples===
<syntaxhighlight lang="lua">
if isDynamicPedShadowsEnabled() then
outputChatBox("Dynamic ped shadows are enabled.")
else
outputChatBox("Dynamic ped shadows are disabled.")
end
</syntaxhighlight>

===Example: Toggle shadows===
<syntaxhighlight lang="lua">
-- Toggle dynamic ped shadows
local current = isDynamicPedShadowsEnabled()
setDynamicPedShadowsEnabled(not current)
</syntaxhighlight>

==See Also==
{{World functions|client}}

IsCursorOnElement

2026-04-05T15:19:18Z

Knower: Created page with "== Client-Side Function: isCursorOnElement == thumb '''Description:''' This function is used in GUI / DX to create interactive buttons or effects in a professional way. It allows you to make elements like buttons, rectangles, or any selectable area responsive to the player's cursor. You can also add many enhancements to make the appearance of the button or element look visually appealing and professional. --- === Function === <syntaxhighlight la..."

== Client-Side Function: isCursorOnElement ==

[[File:MTANeonX.png|thumb]]
'''Description:'''
This function is used in GUI / DX to create interactive buttons or effects in a professional way.
It allows you to make elements like buttons, rectangles, or any selectable area responsive to the player's cursor.
You can also add many enhancements to make the appearance of the button or element look visually appealing and professional.
---

=== Function ===
<syntaxhighlight lang="lua">

function isCursorOnElement( posX, posY, width, height )

if isCursorShowing( ) then

local mouseX, mouseY = getCursorPosition( )

local clientW, clientH = guiGetScreenSize( )

local mouseX, mouseY = mouseX * clientW, mouseY * clientH

if ( mouseX > posX and mouseX < ( posX + width ) and mouseY > posY and mouseY < ( posY + height ) ) then

return true

end

end

return false

end

</syntaxhighlight>

---

=== Example Usage ===
<syntaxhighlight lang="lua">
-- Example: Interactive button on screen

local SelectBut = 1 -- Stores the button selected by player
local x, y, w, h = 100, 100, 150, 50 -- Element position and size

if isCursorOnElement(x, y, w, h) then
-- Cursor is on the element → full alpha
dxDrawImage(x, y, w, h, "img.png", 0, 0, 0, tocolor(255, 254, 254, 255), false)
else
if SelectBut == 1 then
-- Cursor is not on the element but already selected → full alpha
dxDrawImage(x, y, w, h, "img.png", 0, 0, 0, tocolor(255, 254, 254, 255), false)
else
-- Cursor is not on the element and not selected → reduce alpha
dxDrawImage(x, y, w, h, "img.png", 0, 0, 0, tocolor(255, 254, 254, 50), false)
end
end
</syntaxhighlight>

---

===Explanation ===
* '''isCursorOnElement(posX, posY, width, height)''' Function to check cursor position relative to an element

---

=== Notes===
* This function is safe for Client-Side only and will not affect other players.
* GUI/DX Example can be adapted for multiple buttons or GUI elements easily.

IsResourceRunning

2026-04-02T02:03:14Z

Flox: /* Example check isResourceRunning(resName) */

__NOTOC__
{{Shared function}}

==Syntax==
*'''isResourceRunning''' You can insert this code example in your resources.

===Required Arguments===
*'''isResourceRunning:''' The value to check resources

==Example check isResourceRunning(resName)==
<section name="isResourceRunning" class="shared" show="true">
You can insert this code example in your resources.
<syntaxhighlight lang="lua">
function isResourceRunning(resName)
local res = getResourceFromName(resName)
return (res) and (getResourceState(res) == "running")
end

-- Example of inserting into system code:
--[[
if isResourceRunning("admin") then
--code
else
--alert
end

addCommandHandler('pos', function (commandName)
if isResourceRunning("admin") then
local x,y,z = getElementPosition(localPlayer)
outputChatBox( x ..', '.. y ..', '.. z, 255, 255, 255 )
else
outputChatBox("The resource is not running 'admin'.", 255, 0, 0)
end
end )
]]

</syntaxhighlight>
</section>

==See Also==
{{Resource_functions}}

EngineRestreamModel

2026-01-13T18:45:17Z

LamarDev: create engineRestreamModel page

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.7.0|25613|This function re-streams a specific model in the GTA world.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineRestreamModel ( int modelId )
</syntaxhighlight>

===Returns===
Returns ''true'' if the re-stream was successful, ''false'' otherwise.

==Example==
This function can be used after a model (or more) is loaded with [[engineImageLinkDFF]]:
<syntaxhighlight lang="lua">
addEventHandler ("onClientResourceStart", resourceRoot, function ()
engineRestreamModel (445)
end)
</syntaxhighlight>

==See Also==
{{Engine functions}}

EngineRestream

2026-01-13T18:42:23Z

LamarDev: create engineRestream page

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.7.0|25613|This function re-streams a specific group of models in the GTA world.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineRestream ( [ string restreamOption = "world" ] )
</syntaxhighlight>

===Optional Arguments===
*'''restreamOption:''' The specific group of models you want to re-stream. It can be: "world", "vehicles", "peds", "objects"

===Returns===
Returns ''true'' if the re-stream was successful, ''false'' otherwise.

==Example==
This function can be used after a model (or more) is loaded with [[engineImageLinkDFF]]:
<syntaxhighlight lang="lua">
addEventHandler ("onClientResourceStart", resourceRoot, function ()
engineRestream ("vehicles")
end)
</syntaxhighlight>

==See Also==
{{Engine functions}}

RU/Script security

2026-01-08T19:13:07Z

Flox: Created page with "==Внимание к клиентской памяти == Начнем с самых основ: * Вы должны знать, что все, что вы храните на стороне клиента, подвержено риску, в том числе и lua-файлы. Злоумышленники могут получить доступ к любым конфиденциальным (и/или) важным данным, которые хранятся ил..."

==Внимание к клиентской памяти ==

Начнем с самых основ:

* Вы должны знать, что все, что вы храните на стороне клиента, подвержено риску, в том числе и lua-файлы. Злоумышленники могут получить доступ к любым конфиденциальным (и/или) важным данным, которые хранятся или передаются на стороне клиента (ПК игрока).
* Для обеспечения безопасности конфиденциальных данных (и/или) логики Lua используйте серверную часть.
* Обратите внимание, что скрипты, помеченные как '''shared''', также действуют как '''client code''', что означает, что к ним применимо все вышесказанное. Например, определение:

<syntaxhighlight lang="xml">
<script src="script.lua" type="shared"/> 
</syntaxhighlight>

Это то же самое, что делать:

<syntaxhighlight lang="xml">
<script src="script.lua" type="client"/> 
<script src="script.lua" type="server"/> 
</syntaxhighlight>

==Дополнительный уровень защиты ==

Чтобы ''немного усложнить'' задачу для тех, у кого плохие намерения по отношению к вашему серверу, вы можете использовать атрибут cache (и/или [https://luac.mtasa.com / Lua compile (также известный как Luac) с дополнительной настройкой запутывания на уровне ''3''] - [https://wiki.multitheftauto.com/wiki/Lua_compilation_API API]), доступный в [https://wiki.multitheftauto.com/wiki/Meta.xml meta.xml ], а также о настройке встроенного AC в MTA путем переключения SD (Специальные средства обнаружения), смотрите: [https://wiki.multitheftauto.com/wiki/Anti-cheat_guide Руководство по борьбе с читерством].

<syntaxhighlight lang="xml">
<script src="shared.lua" type="shared" cache="false"/> 
<script src="client.lua" type="client" cache="false"/> 
</syntaxhighlight>

* ''Для некоторых'' ''немного сложнее'', ''но не невозможно'', получить клиентский код, но при этом он отлично справляется с тем, что удерживает ''большинство'' пользователей от проверки ваших lua-файлов - тех, кто ищет возможные логические ошибки (баги) или отсутствующие / некорректные проверки на основе безопасности.
* Может использоваться как для ''клиентских (client)'', так и для ''общих (shared)'' скриптов (не влияет на Lua на стороне сервера).
* Не удаляет файлы Lua, которые были загружены ранее.

==Обнаружение бэкдоров и читерских программ и борьба с ними==
'''Для обеспечения минимального ущерба (или его отсутствия) от Lua-скриптов:'''
* Поддерживайте свой сервер в актуальном состоянии, вы можете [https://nightly.multitheftauto.com/ загружать последние сборки сервера с сайта MTA:SA nightly.] Информацию о конкретных сборках можно [https://buildinfo.multitheftauto.com/ найти здесь.]
* Поддерживайте свои ресурсы в актуальном состоянии, вы можете \ [https://github.com/multitheftauto/mtasa-resources загружать последние (по умолчанию) ресурсы из репозитория GitHub.] Они часто содержат последние исправления для системы безопасности, что может привести к тому, что ваш сервер будет защищен от атак или нет.
* Убедитесь в правильной настройке [https://wiki.multitheftauto.com/wiki/Access%20Control%20List ACL (Список контроля доступа)], который будет блокировать использование ресурсами определенных потенциально опасных функций.
* Нулевое доверие с предоставлением прав администратора для ресурсов (включая карты), поступающих из неизвестных источников.
* Перед запуском любого ресурса, которому вы не доверяете, проанализируйте его:
** [https://wiki.multitheftauto.com/wiki/Meta.xml meta.xml] на предмет возможных скрытых скриптов, скрывающихся под другими расширениями файлов.
** Это исходный код, на предмет вредоносной логики.
* Не запускайте и не продолжайте использовать скомпилированные ресурсы (скрипты), в легитимности которых вы не уверены.

'''Чтобы обеспечить минимальный ущерб при подключении мошенника к вашему серверу:'''
* При создании скриптов помните, что никогда не следует доверять данным, поступающим от клиента.
* При проверке скриптов на предмет возможных дыр в системе безопасности. Обратите внимание на любые данные, поступающие от клиента, которым вы доверяете.
* Могут быть отправлены любые данные, следовательно, серверные скрипты, которые взаимодействуют с клиентом, получая данные, отправленные игроками, должны проверить их перед дальнейшим использованием в последующих частях кода. В основном, это будет сделано либо с помощью [[setElementData]], либо с помощью [[triggerServerEvent]].
* Вам не следует полагаться только на игрока [https://wiki.multitheftauto.com/wiki/Serial серийный номер ], когда речь заходит о выполнении важных операций (авторегистрация/действия администратора). '''Не гарантируется, что серийные номера будут уникальными или не поддающимися подделке'''. Вот почему вам следует "оставить это позади" системы учетных записей, как '''важный фактор аутентификации''' (например, '''логин и пароль''').
* Логика на стороне сервера '''не может быть обойдена''' или '''изменена''' (если только сервер не взломан или если в коде есть ошибка, но это совсем другой сценарий) - "используйте это в своих интересах". В большинстве случаев вы сможете выполнить проверку безопасности без участия клиента.
* Используя концепцию ""'“, все параметры, включая источник, могут быть подделаны, и им не следует доверять. Глобальной переменной client можно доверять.”""" - дает вам надежную гарантию того, что игрок, на которого вы ссылаетесь (через ""client"") ""на самом деле""тот, кто действительно вызвал событие"". Такой подход защитит вас от ситуаций, когда мошенник может вызывать и обрабатывать, например, события администратора (например, кикнуть/забанить игрока), передавая фактический администратор ("'2-й"' аргумент в "'[[triggerServerEvent]]"'), или запускать события для других целей. игроки (как будто это они их вызвали, но на самом деле это было принудительно сделано читером) - как следствие использования неправильной переменной. Чтобы убедиться, что вы полностью поняли это, взгляните на примеры ниже:

<syntaxhighlight lang="lua">
--[[
НИКОГДА НЕ ДЕЛАЙТЕ ЭТОГО - ЭТО СОВЕРШЕННО НЕПРАВИЛЬНО И НЕБЕЗОПАСНО
ПРОБЛЕМА: ИСПОЛЬЗУЯ "source" В hasObjectPermissionTo, ВЫ ОСТАВЛЯЕТЕ ДВЕРЬ ОТКРЫТОЙ ДЛЯ МОШЕННИКОВ
]]

function onServerWrongAdminEvent(playerToBan)
if (not client) then -- "client" указывает на игрока, который инициировал событие, и должен использоваться в качестве меры безопасности (чтобы предотвратить подделку игрока).
return false -- если эта переменная в данный момент не существует (по неизвестной причине, или это сервер инициировал это событие), остановите выполнение кода
end

local defaultPermission = false -- не разрешайте действие по умолчанию, смотрите (defaultPermission): https://wiki.multitheftauto.com/wiki/HasObjectPermissionTo
local canAdminBanPlayer = hasObjectPermissionTo(source, "function.banPlayer", defaultPermission) -- уязвимость кроется именно здесь...

if (not canAdminBanPlayer) then -- если у игрока нет прав доступа
return false -- не делайте этого
end

local validElement = isElement(playerToBan) -- проверяет, является ли аргумент, переданный от клиента, элементом

if (not validElement) then -- it is not
return false -- остановить обработку кода
end

local elementType = getElementType(playerToBan) -- это элемент, поэтому укажите его тип
local playerType = (elementType == "player") -- убедитесь, что это игрок

if (not playerType) then -- it's not a player
return false - остановись здесь
end

-- banPlayer(...) -- do what needs to be done
end
addEvent("onServerWrongAdminEvent", true)
addEventHandler("onServerWrongAdminEvent", root, onServerWrongAdminEvent)

--[[
onServerCorrectAdminEvent ПОЛНОСТЬЮ ЗАЩИЩЕН, КАК И ДОЛЖНО БЫТЬ
ЗДЕСЬ НЕТ ПРОБЛЕМ: МЫ ИСПОЛЬЗОВАЛИ "клиент" В hasObjectPermissionTo, ЧТО ПОЗВОЛЯЕТ ЗАЩИТИТЬ ЕГО ОТ ПОДДЕЛКИ ИГРОКОМ, ВЫЗВАВШИМ СОБЫТИЕ
]]

function onServerCorrectAdminEvent(playerToBan)
if (not client) then -- 'client' points to the player who triggered the event, and should be used as security measure (in order to prevent player faking)
return false -- if this variable doesn't exists at the moment (for unknown reason, or it was the server who triggered this event), stop code execution
end

local defaultPermission = false -- do not allow action by default, see (defaultPermission): https://wiki.multitheftauto.com/wiki/HasObjectPermissionTo
local canAdminBanPlayer = hasObjectPermissionTo(client, "function.banPlayer", defaultPermission) -- is player allowed to do that?

if (not canAdminBanPlayer) then -- if player doesn't have permissions
return false -- don't do it
end

local validElement = isElement(playerToBan) -- check whether argument passed from client is an element

if (not validElement) then -- it is not
return false -- stop code processing
end

local elementType = getElementType(playerToBan) -- it's an element, so get it's type
local playerType = (elementType == "player") -- make sure that it's a player

if (not playerType) then -- it's not a player
return false -- stop here
end

-- banPlayer(...) -- do what needs to be done
end
addEvent("onServerCorrectAdminEvent", true)
addEventHandler("onServerCorrectAdminEvent", root, onServerCorrectAdminEvent)
</syntaxhighlight>

==Защита данных setElementData==

* Вам следует воздержаться от использования [[element data]] везде, его следует использовать только тогда, когда это действительно необходимо. Рекомендуется заменить его на [[triggerClientEvent]].
* Если вы все еще настаиваете на его использовании, рекомендуется установить для '''4-го''' аргумента в [[setElementData]] значение '''false''' (отключив синхронизацию для этих определенных данных) и использовать режим подписчика - [[addElementDataSubscriber]], как по соображениям безопасности, так и по соображениям производительности, описанным в [https://wiki.multitheftauto.com/wiki/Script_security#Securing_triggerServerEvent разделе "события".]
{{Важное примечание|Отключение синхронизации, однако, не обеспечивает полной защиты ключа данных. По умолчанию он по-прежнему уязвим, но в этом случае вы не оставляете его на виду. Использование [[getAllElementData]] или копание в оперативной памяти не выявит его, поскольку оно не будет синхронизировано с клиентом в первую очередь. Следовательно, его также необходимо добавить в античит.}}
* Все параметры, включая '''source''', могут быть подделаны, и им не следует доверять.
* Глобальной переменной '''client''' можно доверять.

<section name="Server" class="server" show="true">
Пример защиты данных базового элемента от обмана.
<syntaxhighlight lang="lua">
local function reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue) -- вспомогательная функция для логирования и отката изменений
local logClient = inspect(clientElement) -- подробный вид игрока, который инициировал синхронизацию данных элемента
local logSerial = getPlayerSerial(clientElement) or "N/A" -- серийник клиента, или "N/A", если по какой-то причине это невозможно
local logSource = tostring(sourceElement) -- элемент, который получил данные
local logOldValue = tostring(oldValue) -- старое значение
local logNewValue = tostring(newValue) -- новое значение
local logText = -- заполняем наш отчет данными
"=======================================\n"..
"Detected element data abnormality:\n"..
"Client: "..logClient.."\n"..
"Client serial: "..logSerial.."\n"..
"Source: "..logSource.."\n"..
"Data key: "..dataKey.."\n"..
"Old data value: "..logOldValue.."\n"..
"New data value: "..logNewValue.."\n"..
"======================================="

local logVisibleTo = root -- указываем, кто увидит этот лог в консоли, в данном случае каждый игрок, подключенный к серверу
local hadData = (oldValue ~= nil) -- проверяем, был ли у элемента такой данные раньше

if (hadData) then -- если у элемента ранее были такие данные
setElementData(sourceElement, dataKey, oldValue, true) -- откатываем изменения, это вызовет событие onElementDataChange, но не пройдет (остановится) на первом условии - потому что сервер (не клиент) принудительно изменил данные
else
removeElementData(sourceElement, dataKey) -- полностью удаляем его
end

outputConsole(logText, logVisibleTo) -- выводим это в консоль

return true -- все успешно
end

function onElementDataChangeBasicAC(dataKey, oldValue, newValue) -- сердце нашего античита, которое выполняет все магические меры безопасности
if (not client) then -- проверяем, идут ли данные от клиента
return false -- если нет, не идем дальше
end

local checkSpecialThing = (dataKey == "special_thing") -- сравниваем, совпадает ли dataKey с "special_thing"
local checkFlagWaving = (dataKey == "flag_waving") -- сравниваем, совпадает ли dataKey с "flag_waving"

if (checkSpecialThing) then -- если совпадает, проводим проверки безопасности
local invalidElement = (client ~= source) -- проверяем, отличается ли исходный элемент от игрока, изменившего данные

if (invalidElement) then -- если так и есть
reportAndRevertDataChange(client, source, dataKey, oldValue, newValue) -- откатываем изменение данных, потому что "special_thing" может быть установлен только для самого игрока
end
end

if (checkFlagWaving) then -- если совпадает, проводим проверки безопасности
local playerVehicle = getPedOccupiedVehicle(client) -- получаем текущий транспорт игрока
local invalidVehicle = (playerVehicle ~= source) -- проверяем, отличается ли исходный элемент от транспорта игрока

if (invalidVehicle) then -- если так и есть
reportAndRevertDataChange(client, source, dataKey, oldValue, newValue) -- откатываем изменение данных, потому что "flag_waving" может быть установлен только для собственного транспорта игрока
end
end
end
addEventHandler("onElementDataChange", root, onElementDataChangeBasicAC)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
Пример расширенной защиты данных element от обмана.
<syntaxhighlight lang="lua">
--[[
Для максимальной безопасности установите punishPlayerOnDetect, punishmentBan, allowOnlyProtectedKeys в true (как настроено по умолчанию)
Если включен allowOnlyProtectedKeys, не забудьте добавить каждый ключ элемент данных на стороне клиента в таблицу protectedKeys - иначе возникнут ложные срабатывания

Структура таблицы античита (handleDataChange) и её параметры:

["keyName"] = { -- имя ключа, который будет защищен
onlyForPlayerHimself = true, -- включение этого (true) гарантирует, что этот ключ данных элемента может быть установлен только игроком, который его синхронизировал (игнорирует onlyForOwnPlayerVeh и allowForElements), используйте false/nil для отключения
onlyForOwnPlayerVeh = false, -- включение этого (true) гарантирует, что этот ключ данных элемента может быть установлен только на текущем транспорте игрока, который его синхронизировал (игнорирует allowForElements), используйте false/nil для отключения
allowForElements = { -- ограничить этот ключ для определенных типов элементов, установите false/nil или оставьте пустым, чтобы не проверять это (полный список типов элементов: https://wiki.multitheftauto.com/wiki/GetElementsByType)
["player"] = true,
["ped"] = true,
["vehicle"] = true,
["object"] = true,
},
allowedDataTypes = { -- ограничить этот ключ для определенных типов значений, установите false/nil или оставьте пустым, чтобы не проверять это
["string"] = true,
["number"] = true,
["table"] = true,
["boolean"] = true,
["nil"] = true,
},
allowedStringLength = {1, 32}, -- если значение является строкой, то её длина должна быть в пределах (мин-макс), установите false/nil, чтобы не проверять длину строки - учтите, что allowedDataTypes должен содержать ["string"] = true
allowedTableLength = {1, 64}, -- если значение является таблицей, то её длина должна быть в пределах (мин-макс), установите false/nil, чтобы не проверять длину таблицы - учтите, что allowedDataTypes должен содержать ["table"] = true
allowedNumberRange = {1, 128}, -- если значение является числом, то оно должно быть в пределах (мин-макс), установите false/nil, чтобы не проверять диапазон чисел - учтите, что allowedDataTypes должен содержать ["number"] = true
}
]]

local punishPlayerOnDetect = true -- должен ли игрок быть наказан при обнаружении (убедитесь, что ресурс, запускающий этот код, имеет права администратора)
local punishmentBan = true -- актуально только если punishPlayerOnDetect установлен в true; используйте true для бана или false для кика
local punishmentReason = "Altering element data" -- актуально только если punishPlayerOnDetect установлен в true; причина, которая будет показана наказанному игроку
local punishedBy = "Console" -- актуально только если punishPlayerOnDetect установлен в true; кто ответственен за наказание, также показывается наказанному игроку
local banByIP = false -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; бан по IP в настоящее время не рекомендуется (...)
local banByUsername = false -- имя пользователя сообщества - устаревшая вещь, поэтому установлено в false и должно оставаться таким
local banBySerial = true -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; (...) если есть серийный номер игрока, который можно использовать вместо этого
local banTime = 0 -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; время в секундах, 0 навсегда
local allowOnlyProtectedKeys = true -- запрещать (удалять с помощью removeElementData) любые данные элементов, кроме тех, что указаны в таблице protectedKeys; на случай, если кто-то захочет завалить сервер мусорными ключами, которые будут храниться в памяти до перезапуска сервера или ручного удаления - setElementData(source, key, nil) не удалит их; необходимо использовать removeElementData
local debugLevel = 4 -- этот уровень отладки позволяет скрыть префикс INFO: и использовать пользовательские цвета
local debugR = 255 -- сообщение отладки - красный цвет
local debugG = 127 -- сообщение отладки - зеленый цвет
local debugB = 0 -- сообщение отладки - синий цвет
local protectedKeys = {
["vehicleNumber"] = { -- мы хотим, чтобы vehicleNumber устанавливался только на транспорте, с четкими числами в диапазоне 1-100
allowForElements = {
["vehicle"] = true,
},
allowedDataTypes = {
["number"] = true,
},
allowedNumberRange = {1, 100},
},
["personalVehData"] = { -- мы хотим иметь возможность устанавливать personalVehData только на текущем транспорте, также это должна быть строка длиной от 1 до 24
onlyForOwnPlayerVeh = true,
allowedDataTypes = {
["string"] = true,
},
allowedStringLength = {1, 24},
},
-- выполнять проверки безопасности для ключей, хранящихся в этой таблице, удобным способом
}

local function reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- вспомогательная функция для логирования и отката изменений
local logClient = inspect(clientElement) -- подробный вид игрока, который инициировал синхронизацию данных элемента
local logSerial = getPlayerSerial(clientElement) or "N/A" -- серийник клиента, или "N/A", если по какой-то причине это невозможно
local logSource = inspect(sourceElement) -- подробный вид элемента, который получил данные
local logOldValue = inspect(oldValue) -- подробный вид старого значения
local logNewValue = inspect(newValue) -- подробный вид нового значения
local logText = -- заполняем наш отчет данными
"*\n"..
"Detected element data abnormality:\n"..
"Client: "..logClient.."\n"..
"Client serial: "..logSerial.."\n"..
"Source: "..logSource.."\n"..
"Data key: "..dataKey.."\n"..
"Old data value: "..logOldValue.."\n"..
"New data value: "..logNewValue.."\n"..
"Fail reason: "..failReason.."\n"..
"*"

outputDebugString(logText, debugLevel, debugR, debugG, debugB) -- выводим это в отладку

if (forceRemove) then -- мы вообще не хотим, чтобы этот ключ данных элемента существовал
removeElementData(sourceElement, dataKey) -- удаляем его

return true -- возвращаем успех и останавливаемся здесь, дальнейшие проверки не нужны
end

setElementData(sourceElement, dataKey, oldValue, true) -- откатываем изменения, это вызовет событие onElementDataChange, но не пройдет (остановится) на первом условии - потому что сервер (не клиент) принудительно изменил данные

return true -- возвращаем успех
end

local function handleDataChange(clientElement, sourceElement, dataKey, oldValue, newValue) -- сердце нашего античита, которое выполняет все магические меры безопасности, возвращает true, если не было изменений от клиента (на основе данных из protectedKeys), иначе false
local protectedKey = protectedKeys[dataKey] -- проверяем, хранится ли измененный ключ в таблице protectedKeys

if (not protectedKey) then -- если его нет

if (allowOnlyProtectedKeys) then -- если мы не хотим мусорные ключи
local failReason = "Key isn't present in protectedKeys" -- причина, показанная в отчете
local forceRemove = true -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

return true -- этот ключ не защищен, пропускаем его
end

local onlyForPlayerHimself = protectedKey.onlyForPlayerHimself -- если у ключа есть блокировка "только для себя"
local onlyForOwnPlayerVeh = protectedKey.onlyForOwnPlayerVeh -- если у ключа есть блокировка "свой транспорт"
local allowForElements = protectedKey.allowForElements -- если у ключа есть проверка типа элемента
local allowedDataTypes = protectedKey.allowedDataTypes -- если у ключа есть проверка разрешенного типа данных

if (onlyForPlayerHimself) then -- если блокировка "только для себя" активна
local matchingElement = (clientElement == sourceElement) -- проверяем, равен ли игрок, установивший данные, элементу, который получил данные

if (not matchingElement) then -- если не совпадает
local failReason = "Can only set on player himself" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

if (onlyForOwnPlayerVeh) then -- если блокировка "свой транспорт" активна
local playerVehicle = getPedOccupiedVehicle(clientElement) -- получить текущий транспорт игрока, который установил данные
local matchingVehicle = (playerVehicle == sourceElement) -- проверяем, совпадает ли он с тем, который получил данные

if (not matchingVehicle) then -- если не совпадает
local failReason = "Can only set on player's own vehicle" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

if (allowForElements) then -- проверяем, является ли оно одним из них
local elementType = getElementType(sourceElement) -- получить тип элемента, данные которого изменились
local matchingElementType = allowForElements[elementType] -- проверяем, разрешено ли это

if (not matchingElementType) then -- это не совпадает
local failReason = "Invalid element type" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

if (allowedDataTypes) then -- если есть разрешенные типы данных
local valueType = type(newValue) -- получить тип данных значения
local matchingType = allowedDataTypes[valueType] -- проверяем, является ли оно одним из разрешенных

if (not matchingType) then -- если нет, тогда
local failReason = "Invalid data type" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local allowedStringLength = protectedKey.allowedStringLength -- если у ключа есть указанная проверка длины строки
local dataString = (valueType == "string") -- убеждаемся, что это строка

if (allowedStringLength and dataString) then -- если мы должны проверить длину строки
local minLength = allowedStringLength[1] -- получить минимальную длину
local maxLength = allowedStringLength[2] -- получить максимальную длину
local stringLength = utf8.len(newValue) -- получить длину строки данных
local matchingLength = (stringLength >= minLength) and (stringLength <= maxLength) -- сравниваем, подходит ли значение в промежуток

if (not matchingLength) then -- если не подходит
local failReason = "Invalid string length (must be between "..minLength.."-"..maxLength..")" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

local allowedTableLength = protectedKey.allowedTableLength -- если у ключа есть проверка длины таблицы
local dataTable = (valueType == "table") -- убеждаемся, что это таблица

if (allowedTableLength and dataTable) then -- если мы должны проверить длину таблицы
local minLength = allowedTableLength[1] -- получить минимальную длину
local maxLength = allowedTableLength[2] -- получить максимальную длину
local minLengthAchieved = false -- переменная, которая проверяет 'была ли достигнута минимальная длина'
local maxLengthExceeded = false -- переменная, которая проверяет 'превысила ли длина разрешенный максимум'
local tableLength = 0 -- сохранить начальную длину таблицы

for _, _ in pairs(newValue) do -- проходим по всей таблице
tableLength = (tableLength + 1) -- добавляем + 1 для каждой записи таблицы
minLengthAchieved = (tableLength >= minLength) -- больше ли длина или по крайней мере такой минимум, который мы требуем
maxLengthExceeded = (tableLength > maxLength) -- превысила ли таблица максимальную длину?

if (maxLengthExceeded) then -- она больше, чем должна быть
break -- прерываем цикл (из-за того, что условие выше выполнено, нет смысла считать дальше и тратить процессор на таблицу, которая потенциально может иметь огромное количество записей)
end
end

local matchingLength = (minLengthAchieved and not maxLengthExceeded) -- проверяем, достигнута ли минимальная длина, и убеждаемся, что она не превышает максимальную

if (not matchingLength) then -- эта таблица не соответствует требованиям
local failReason = "Invalid table length (must be between "..minLength.."-"..maxLength..")" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

local allowedNumberRange = protectedKey.allowedNumberRange -- если у ключа есть проверка разрешенного диапазона чисел
local dataNumber = (valueType == "number") -- убеждаемся, что это число

if (allowedNumberRange and dataNumber) then -- если мы должны проверить диапазон чисел
local minRange = allowedNumberRange[1] -- получить минимальный диапазон чисел
local maxRange = allowedNumberRange[2] -- получить максимальный диапазон чисел
local matchingRange = (newValue >= minRange) and (newValue <= maxRange) -- сравниваем, подходит ли значение в промежуток

if (not matchingRange) then -- если не подходит
local failReason = "Invalid number range (must be between "..minRange.."-"..maxRange..")" -- причина, показанная в отчете
local forceRemove = false -- должен ли ключ быть полностью удален

reportAndRevertDataChange(clientElement, sourceElement, dataKey, oldValue, newValue, failReason, forceRemove) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end
end

return true -- проверки безопасности пройдены, с этим ключом данных всё в порядке
end

function onElementDataChangeAdvancedAC(dataKey, oldValue, newValue) -- это событие использует handleDataChange, код был разделен для лучшей читаемости
if (not client) then -- проверяем, идут ли данные от клиента
return false -- если нет, не продолжаем
end

local approvedChange = handleDataChange(client, source, dataKey, oldValue, newValue) -- запускаем наши проверки безопасности

if (approvedChange) then -- всё круто и хорошо
return false -- нам не нужны дальнейшие действия
end

if (not punishPlayerOnDetect) then -- мы не хотим наказывать игрока по какой-то причине
return false -- так что останавливаемся здесь
end

if (punishmentBan) then -- если это бан
banPlayer(client, banByIP, banByUsername, banBySerial, punishedBy, punishmentReason, banTime) -- удаляем его присутствие с сервера
else -- иначе
kickPlayer(client, punishedBy, punishmentReason) -- просто кикаем игрока с сервера
end
end
addEventHandler("onElementDataChange", root, onElementDataChangeAdvancedAC)
</syntaxhighlight>
</section>

==Защита triggerServerEvent==
* Все параметры, включая "source", могут быть подделаны, и им не следует доверять.
* Глобальной переменной "client" можно доверять.
* "События" в стиле "Admin" должны подтверждать "права доступа" игрока (клиента) либо с помощью [https://wiki.multitheftauto.com/wiki/IsObjectInACLGroup isObjectInACLGroup], либо [https://wiki.multitheftauto.com/wiki/HasObjectPermissionTo hasObjectPermissionTo].
* Не используйте для своего пользовательского события то же имя, что и для событий собственного сервера MTA (которые по умолчанию не запускаются удаленно), например: "onPlayerLogin"; это откроет дверь для манипуляций мошенников.
* Будьте в курсе, каким игрокам отправляется событие через [[triggerClientEvent]]. Как по соображениям безопасности, так и по соображениям производительности, события, подобные admin, должны приниматься только администраторами (чтобы предотвратить доступ к конфиденциальным данным), в то же время вы не должны отправлять каждое событие всем пользователям сервера (например, событие успешного входа в систему, которое скрывает панель входа для определенного игрока). [[triggerClientEvent]] позволяет вам указать получатель события в качестве первого (необязательного) аргумента. По умолчанию используется значение [[root]], что означает, что если вы его не укажете, оно будет отправлено всем, кто подключен к серверу, даже тем, кто все еще загружает серверный кэш (что приводит к "событию, инициированному сервером на стороне клиента, eventName, но событие не добавлено на стороне клиента"). Вы можете передать либо элемент игрока, либо таблицу с получателями:

<syntaxhighlight lang="lua">
local playersToReceiveEvent = {player1, player2, player3} -- каждый PlayerX является элементом игрока

triggerClientEvent(playersToReceiveEvent, ...) -- не забудьте заполнить последнюю часть аргументов
</syntaxhighlight>

----------
<section name="Server" class="server" show="true">
Пример функции защиты от мошенничества, разработанной для событий, используемых для проверки данных как для обычных, так и для административных событий, которые вызываются со стороны клиента.
<syntaxhighlight lang="lua">
--[[
Для максимальной безопасности установите punishPlayerOnDetect, punishmentBan в true (как настроено по умолчанию)

Структура таблицы античита (processServerEventData) и её параметры:

checkACLGroup = { -- проверить, принадлежит ли игрок, вызвавший событие, хотя бы к одной из групп ниже, установите false/nil, чтобы не проверять это
"Admin",
},
checkPermissions = { -- проверить, есть ли у игрока, вызвавшего событие, разрешение хотя бы на одно из нижеперечисленного, установите false/nil, чтобы не проверять это
"function.kickPlayer",
},
checkEventData = {
{
debugData = "source", -- дополнительные данные для отчета, показанные в сообщении отладки
eventData = source, -- данные, которые мы хотим проверить
equalTo = client, -- сравнить, совпадают ли eventData и equalTo
allowedElements = { -- ограничить eventData определенными типами элементов, установите false/nil или оставьте пустым, чтобы не проверять это (полный список типов элементов: https://wiki.multitheftauto.com/wiki/GetElementsByType)
["player"] = true,
["ped"] = true,
["vehicle"] = true,
["object"] = true,
},
allowedDataTypes = { -- ограничить eventData определенными типами значений, установите false/nil или оставьте пустым, чтобы не проверять это
["string"] = true,
["number"] = true,
["table"] = true,
["boolean"] = true,
["nil"] = true,
},
allowedStringLength = {1, 32}, -- если eventData является строкой, то её длина должна быть в пределах (мин-макс), установите false/nil, чтобы не проверять длину строки - учтите, что allowedDataTypes должен содержать ["string"] = true
allowedTableLength = {1, 64}, -- если eventData является таблицей, то её длина должна быть в пределах (мин-макс), установите false/nil, чтобы не проверять длину таблицы - учтите, что allowedDataTypes должен содержать ["table"] = true
allowedNumberRange = {1, 128}, -- если eventData является числом, то оно должно быть в пределах (мин-макс), установите false/nil, чтобы не проверять диапазон чисел - учтите, что allowedDataTypes должен содержать ["number"] = true
},
},
]]

local punishPlayerOnDetect = true -- должен ли игрок быть наказан при обнаружении (убедитесь, что ресурс, запускающий этот код, имеет права администратора)
local punishmentBan = true -- актуально только если punishPlayerOnDetect установлен в true; используйте true для бана или false для кика
local punishmentReason = "Altering server event data" -- актуально только если punishPlayerOnDetect установлен в true; причина, которая будет показана наказанному игроку
local punishedBy = "Console" -- актуально только если punishPlayerOnDetect установлен в true; кто ответственен за наказание, также показывается наказанному игроку
local banByIP = false -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; бан по IP в настоящее время не рекомендуется (...)
local banByUsername = false -- имя пользователя сообщества - устаревшая вещь, поэтому установлено в false и должно оставаться таким
local banBySerial = true -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; (...) если есть серийный номер игрока, который можно использовать вместо этого
local banTime = 0 -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; время в секундах, 0 навсегда
local debugLevel = 4 -- этот уровень отладки позволяет скрыть префикс INFO: и использовать пользовательские цвета
local debugR = 255 -- сообщение отладки - красный цвет
local debugG = 127 -- сообщение отладки - зеленый цвет
local debugB = 0 -- сообщение отладки - синий цвет

function processServerEventData(clientElement, sourceElement, serverEvent, securityChecks) -- сердце нашего античита, которое выполняет все магические меры безопасности, возвращает true, если не было изменений от клиента (на основе данных из securityChecks), иначе false
if (not securityChecks) then -- если мы не передали никаких проверок безопасности
return true -- нечего проверять, даем коду идти дальше
end

if (not clientElement) then -- если переменная client недоступна по какой-то причине (хотя это не должно произойти)
local failReason = "Client variable not present" -- причина, показанная в отчете
local skipPunishment = true -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local checkACLGroup = securityChecks.checkACLGroup -- если есть какие-либо группы ACL для проверки
local checkPermissions = securityChecks.checkPermissions -- если есть какие-либо разрешения для проверки
local checkEventData = securityChecks.checkEventData -- если есть какие-либо проверки данных

if (checkACLGroup) then -- проверим группы ACL игрока
local playerAccount = getPlayerAccount(clientElement) -- получить текущий аккаунт игрока
local guestAccount = isGuestAccount(playerAccount) -- если аккаунт гость (это значит, что игрок не вошел в систему)

if (guestAccount) then -- это так
local failReason = "Can't retrieve player login - guest account" -- причина, показанная в отчете
local skipPunishment = true -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local accountName = getAccountName(playerAccount) -- получить имя текущего аккаунта игрока
local aclString = "user."..accountName -- форматируем это для дальнейшего использования в функции isObjectInACLGroup

for groupID = 1, #checkACLGroup do -- перебираем таблицу заданных групп
local groupName = checkACLGroup[groupID] -- получить имя каждой группы
local aclGroup = aclGetGroup(groupName) -- проверить, существует ли такая группа

if (not aclGroup) then -- не существует
local failReason = "ACL group '"..groupName.."' is missing" -- причина, показанная в отчете
local skipPunishment = true -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local playerInACLGroup = isObjectInACLGroup(aclString, aclGroup) -- проверить, принадлежит ли игрок к группе

if (playerInACLGroup) then -- да, это так
return true -- значит, успех
end
end

local failReason = "Player doesn't belong to any given ACL group" -- причина, показанная в отчете
local skipPunishment = true -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

if (checkPermissions) then -- проверить, есть ли у игрока хотя бы одно желаемое разрешение
local allowedByDefault = false -- есть ли у него доступ по умолчанию

for permissionID = 1, #checkPermissions do -- перебираем все разрешения
local permissionName = checkPermissions[permissionID] -- получить имя разрешения
local hasPermission = hasObjectPermissionTo(clientElement, permissionName, allowedByDefault) -- проверить, разрешено ли игроку выполнять определенное действие

if (hasPermission) then -- если у игрока есть доступ
return true -- одно доступно (и достаточно), сервер не станет проверять остальные (так как return также прерывает цикл)
end
end

local failReason = "Not enough permissions" -- причина, показанная в отчете
local skipPunishment = true -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

if (checkEventData) then -- если есть какие-то данные для проверки

for dataID = 1, #checkEventData do -- перебираем каждые данные
local dataToCheck = checkEventData[dataID] -- получить каждый набор данных
local eventData = dataToCheck.eventData -- это то, что мы будем проверять
local equalTo = dataToCheck.equalTo -- мы хотим сравнить, совпадают ли eventData и equalTo
local allowedElements = dataToCheck.allowedElements -- проверить, является ли это элементом и принадлежит ли к определенным типам элементов
local allowedDataTypes = dataToCheck.allowedDataTypes -- ограничиваем ли мы данные определенным типом?
local debugData = dataToCheck.debugData -- дополнительные вспомогательные данные
local debugText = debugData and " ("..debugData..")" or "" -- если оно присутствует, красиво форматируем

if (equalTo) then -- проверка на равенство существует
local matchingData = (eventData == equalTo) -- сравнить, равны ли эти два значения

if (not matchingData) then -- они не равны
local failReason = "Data isn't equal @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

if (allowedElements) then -- мы проверяем, является ли это элементом и принадлежит ли хотя бы одному из списка
local validElement = isElement(eventData) -- проверить, является ли это фактическим элементом

if (not validElement) then -- это не так
local failReason = "Data isn't element @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local elementType = getElementType(eventData) -- это элемент, поэтому мы хотим узнать его тип
local matchingElementType = allowedElements[elementType] -- проверить, разрешено ли это

if (not matchingElementType) then -- не разрешено
local failReason = "Invalid element type @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

if (allowedDataTypes) then -- проверим разрешенные типы данных
local dataType = type(eventData) -- получить тип данных
local matchingType = allowedDataTypes[dataType] -- проверить, разрешено ли это

if (not matchingType) then -- не разрешено
local failReason = "Invalid data type @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end

local allowedStringLength = dataToCheck.allowedStringLength -- если данные имеют проверку длины строки
local dataString = (dataType == "string") -- убеждаемся, что это строка

if (allowedStringLength and dataString) then -- если мы должны проверить длину строки
local minLength = allowedStringLength[1] -- получить минимальную длину
local maxLength = allowedStringLength[2] -- получить максимальную длину
local stringLength = utf8.len(eventData) -- получить длину строки данных
local matchingLength = (stringLength >= minLength) and (stringLength <= maxLength) -- сравниваем, подходит ли значение в промежуток

if (not matchingLength) then -- если не подходит
local failReason = "Invalid string length (must be between "..minLength.."-"..maxLength..") @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

local allowedTableLength = dataToCheck.allowedTableLength -- если данные имеют проверку длины таблицы
local dataTable = (dataType == "table") -- убеждаемся, что это таблица

if (allowedTableLength and dataTable) then -- если мы должны проверить длину таблицы
local minLength = allowedTableLength[1] -- получить минимальную длину
local maxLength = allowedTableLength[2] -- получить максимальную длину
local minLengthAchieved = false -- переменная, которая проверяет 'была ли достигнута минимальная длина'
local maxLengthExceeded = false -- переменная, которая проверяет 'превысила ли длина разрешенный максимум'
local tableLength = 0 -- сохранить начальную длину таблицы

for _, _ in pairs(eventData) do -- проходим по всей таблице
tableLength = (tableLength + 1) -- добавляем + 1 для каждой записи таблицы
minLengthAchieved = (tableLength >= minLength) -- больше ли длина или по крайней мере такой минимум, который мы требуем
maxLengthExceeded = (tableLength > maxLength) -- превысила ли таблица максимальную длину?

if (maxLengthExceeded) then -- она больше, чем должна быть
break -- прерываем цикл (из-за того, что условие выше выполнено, нет смысла считать дальше и тратить процессор на таблицу, которая потенциально может иметь огромное количество записей)
end
end

local matchingLength = (minLengthAchieved and not maxLengthExceeded) -- проверяем, достигнута ли минимальная длина, и убеждаемся, что она не превышает максимальную

if (not matchingLength) then -- эта таблица не соответствует требованиям
local failReason = "Invalid table length (must be between "..minLength.."-"..maxLength..") @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end

local allowedNumberRange = dataToCheck.allowedNumberRange -- если данные имеют проверку диапазона чисел
local dataNumber = (dataType == "number") -- убеждаемся, что это число

if (allowedNumberRange and dataNumber) then -- если мы должны проверить диапазон чисел
local minRange = allowedNumberRange[1] -- получить минимальный диапазон чисел
local maxRange = allowedNumberRange[2] -- получить максимальный диапазон чисел
local matchingRange = (eventData >= minRange) and (eventData <= maxRange) -- сравниваем, подходит ли значение в промежуток

if (not matchingRange) then -- если не подходит
local failReason = "Invalid number range (must be between "..minRange.."-"..maxRange..") @ argument "..dataID..debugText -- причина, показанная в отчете
local skipPunishment = false -- должен ли сервер пропустить наказание

reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- сообщить о происшествии и обработать (или нет) этого игрока

return false -- вернуть неудачу
end
end
end
end
end

return true -- проверки безопасности пройдены, с этим вызовом события всё в порядке
end

function reportAndHandleEventAbnormality(clientElement, sourceElement, serverEvent, failReason, skipPunishment) -- вспомогательная функция для логирования и обработки инцидентов
local logClient = inspect(clientElement) -- подробный вид игрока, вызвавшего событие
local logSerial = getPlayerSerial(clientElement) or "N/A" -- серийник клиента, или "N/A", если по какой-то причине это невозможно
local logSource = inspect(sourceElement) -- подробный вид исходного элемента
local logText = -- заполняем наш отчет данными
"*\n"..
"Detected event abnormality:\n"..
"Client: "..logClient.."\n"..
"Client serial: "..logSerial.."\n"..
"Source: "..logSource.."\n"..
"Event: "..serverEvent.."\n"..
"Reason: "..failReason.."\n"..
"*"

outputDebugString(logText, debugLevel, debugR, debugG, debugB) -- выводим это в отладку

if (not punishPlayerOnDetect or skipPunishment) then -- мы не хотим наказывать игрока по какой-то причине
return true -- останавливаемся здесь
end

if (punishmentBan) then -- если это бан
banPlayer(clientElement, banByIP, banByUsername, banBySerial, punishedBy, punishmentReason, banTime) -- удаляем его присутствие с сервера
else -- иначе
kickPlayer(clientElement, punishedBy, punishmentReason) -- просто кикаем игрока с сервера
end

return true -- всё готово, сообщаем об успехе
end

function onServerEvent(clientData)
--[[
Предположим, что это серверское событие (функция) вызывается следующим образом:

local dataToPass = 10

triggerServerEvent("onServerEvent", localPlayer, dataToPass)
]]

local shouldProcessServerCode = processServerEventData(
client, -- элемент клиента - ответственный за вызов события
source, -- исходный элемент - переданный в triggerServerEvent (в качестве 2-го аргумента)
eventName, -- имя события - в данном случае 'onServerEvent'
{
checkEventData = { -- мы хотим проверить всё, что приходит от клиента
{
eventData = source, -- первое на проверку, переменная source
equalTo = client, -- мы хотим проверить, совпадает ли это с игроком, вызвавшим событие
debugData = "source", -- вспомогательные данные, которые будут показаны в отчете отладки
},
{
eventData = clientData, -- давайте проверим данные, которые клиент прислал нам
allowedDataTypes = {
["number"] = true, -- мы хотим, чтобы это было только число
},
allowedNumberRange = {1, 100}, -- в диапазоне от 1 до 100
debugData = "clientData", -- если что-то пойдет не так, дадим серверу знать где (это появится в отчете отладки)
},
},
}
)

if (not shouldProcessServerCode) then -- что-то не так, зеленого света для выполнения кода за этим пределом нет
return false -- остановить выполнение кода
end

-- выполняем код как обычно
end
addEvent("onServerEvent", true)
addEventHandler("onServerEvent", root, onServerEvent)

function onServerAdminEvent(playerToBan)
--[[
Предположим, что это серверское событие администратора (функция) вызывается следующим образом:

local playerToBan = getPlayerFromName("playerToBan")

triggerServerEvent("onServerAdminEvent", localPlayer, playerToBan)
]]

local shouldProcessServerCode = processServerEventData(
client, -- элемент клиента - ответственный за вызов события
source, -- исходный элемент - переданный в triggerServerEvent (в качестве 2-го аргумента)
eventName, -- имя события - в данном случае 'onServerAdminEvent'
{
checkACLGroup = { -- нам нужно проверить, принадлежит ли игрок, вызвавший событие, к группам ACL
"Admin", -- в данном случае группа администраторов
},
checkEventData = { -- мы хотим проверить всё, что приходит от клиента
{
eventData = source, -- первое на проверку, переменная source
equalTo = client, -- мы хотим проверить, совпадает ли это с игроком, вызвавшим событие
debugData = "source", -- вспомогательные данные, которые будут показаны в отчете отладки
},
{
eventData = playerToBan, -- давайте проверим данные, которые клиент прислал нам
allowedDataTypes = {
["player"] = true, -- мы хотим, чтобы это был игрок
},
debugData = "playerToBan", -- если что-то пойдет не так, дадим серверу знать где (это появится в отчете отладки)
},
},
}
)

if (not shouldProcessServerCode) then -- что-то не так, зеленого света для выполнения кода за этим пределом нет
return false -- остановить выполнение кода
end

-- выполняем код как обычно
end
addEvent("onServerAdminEvent", true)
addEventHandler("onServerAdminEvent", root, onServerAdminEvent)
</syntaxhighlight>
</section>

==Защита событий, относящихся только к серверу ==
* Очень важно отключить удаленный запуск''' в [https://wiki.multitheftauto.com/wiki/AddEvent addEvent], чтобы предотвратить вызов событий, относящихся только к серверу, со стороны клиента.
* '''События''' в стиле '''Admin''' должны подтверждать '''права доступа''' игрока, либо с помощью [https://wiki.multitheftauto.com/wiki/IsObjectInACLGroup isObjectInACLGroup], либо [https://wiki.multitheftauto.com/wiki/HasObjectPermissionTo hasObjectPermissionTo].

----------
<section name="Server" class="server" show="true">
В этом примере показано, как вы должны создавать события только на стороне сервера.
<syntaxhighlight lang="lua">
function onServerSideOnlyEvent()
-- делаем какие-то вещи на стороне сервера
end
addEvent("onServerSideOnlyEvent", false) -- установите второй аргумент (allowRemoteTriger) в false, чтобы его нельзя было вызвать с клиента
addEventHandler("onServerSideOnlyEvent", root, onServerSideOnlyEvent) -- связываем наше событие с функцией onServerSideOnlyEvent
</syntaxhighlight>
</section>

==Защита снарядов и взрывных устройств ==
Этот раздел (и '''код''' - '''работа продолжается''') - '''используйте на свой страх и риск'''.
----------
<section name="Server" class="server" show="false">
Устройство для отслеживания боеприпасов к снарядам:
<syntaxhighlight lang="lua">
local playerProjectileAmmo = {} -- хранить здесь боезапас оружия игрока
local playerWeaponsToTrack = { -- отслеживать боезапас для определенных типов оружия игрока, в основном тех, которые создают снаряды; [weaponID] = weaponSlot
[16] = 8, -- grenade
[17] = 8, -- teargas
[18] = 8, -- molotov
[35] = 7, -- rocket launcher
[36] = 7, -- rocket launcher (heat-seeking)
[39] = 8, -- satchel charge
}

local function updateProjectileAmmoForPlayer(playerElement)
local validElement = isElement(playerElement)

if (not validElement) then
return false
end

local playerDead = isPedDead(playerElement)

if (playerDead) then
return false
end

for weaponID, weaponSlot in pairs(playerWeaponsToTrack) do
local weaponInSlot = getPedWeapon(playerElement, weaponSlot)
local weaponTotalAmmo = getPedTotalAmmo(playerElement, weaponSlot)
local weaponHasAmmo = (weaponTotalAmmo > 0)
local weaponMatching = (weaponInSlot == weaponID)
local updateWeaponAmmo = (weaponMatching and weaponHasAmmo)

if (updateWeaponAmmo) then
local storedProjectileAmmo = playerProjectileAmmo[playerElement]
local newWeaponAmmo = (updateWeaponAmmo and weaponTotalAmmo or nil)

if (not storedProjectileAmmo) then
playerProjectileAmmo[playerElement] = {}
storedProjectileAmmo = playerProjectileAmmo[playerElement]
end

storedProjectileAmmo[weaponID] = newWeaponAmmo
end
end

return true
end

function hasPlayerProjectileAmmo(playerElement, projectileWeapon)
local validElement = isElement(playerElement)

if (not validElement) then
return false
end

local playerDead = isPedDead(playerElement)

if (playerDead) then
return false
end

local projectileData = playerProjectileAmmo[playerElement]
local projectileAmmo = (projectileData and projectileData[projectileWeapon])

return projectileAmmo
end

function decreasePlayerProjectileAmmo(playerElement, projectileWeapon)
local validElement = isElement(playerElement)

if (not validElement) then
return false
end

local playerDead = isPedDead(playerElement)

if (playerDead) then
return false
end

local playerProjectileData = playerProjectileAmmo[playerElement]

if (not playerProjectileData) then
return false
end

local projectileWeaponAmmo = playerProjectileData[projectileWeapon]
local tempProjectileAmmo = (projectileWeaponAmmo - 1)
local newProjectileAmmo = (tempProjectileAmmo > 0 and tempProjectileAmmo or nil)

playerProjectileData[projectileWeapon] = newProjectileAmmo

return true
end

function onPlayerWeaponSwitchAntiCheat(previousWeaponID, currentWeaponID)
setTimer(updateProjectileAmmoForPlayer, 50, 1, source)
end
addEventHandler("onPlayerWeaponSwitch", root, onPlayerWeaponSwitchAntiCheat)

function onResourceStartAntiCheat()
local playersTable = getElementsByType("player")

for playerID = 1, #playersTable do
local playerElement = playersTable[playerID]

updateProjectileAmmoForPlayer(playerElement)
end
end
addEventHandler("onResourceStart", resourceRoot, onResourceStartAntiCheat)

function onPlayerWastedQuitAntiCheat()
playerProjectileAmmo[source] = nil
end
addEventHandler("onPlayerWasted", root, onPlayerWastedQuitAntiCheat)
addEventHandler("onPlayerQuit", root, onPlayerWastedQuitAntiCheat)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="false">
Манипулятор со снарядом:
<syntaxhighlight lang="lua">
local playerCreatedProjectiles = {} -- хранить количество легитимно созданных снарядов игрока; [playerElement] = {[projectileType] = activeProjectiles}
local projectileTypes = {
[16] = { -- Grenade
projectileAllowed = true,
projectileMaxDistanceFromCreator = 2,
projectileAllowedWeapons = {
[16] = true, -- grenade
},
},
[17] = { -- Teargas
projectileAllowed = true,
projectileMaxDistanceFromCreator = 2,
projectileAllowedWeapons = {
[17] = true, -- teargas
},
},
[18] = { -- Molotov
projectileAllowed = true,
projectileMaxDistanceFromCreator = 2,
projectileAllowedWeapons = {
[18] = true, -- molotov
},
},
[19] = { -- Rocket
projectileAllowed = true,
projectileMaxDistanceFromCreator = 5,
projectileMaxVelocity = 2,
projectileAllowedWeapons = {
[35] = true, -- rocket launcher
},
projectileAllowedVehicles = {
[425] = true, -- hunter
[520] = true, -- hydra
},
},
[20] = { -- Rocket (heat-seeking)
projectileAllowed = true,
projectileMaxDistanceFromCreator = 5,
projectileMaxVelocity = 2,
projectileAllowedWeapons = {
[36] = true, -- rocket launcher (heat-seeking)
},
projectileAllowedVehicles = {
[520] = true, -- hydra
},
},
[21] = { -- Airbomb
projectileAllowed = true,
projectileAllowedVehicles = {
[520] = true, -- hydra
},
},
[39] = { -- Satchel charge
projectileAllowed = true,
projectileMaxDistanceFromCreator = 2,
projectileAllowedWeapons = {
[39] = true, -- satchel charge
},
},
[58] = { -- Hydra flare
projectileAllowed = true,
projectileMaxDistanceFromCreator = 5,
projectileAllowedVehicles = {
[520] = true, -- hydra
},
},
}

local reportAbnormality = true -- сообщать ли о нарушениях в скрипте отладки - по умолчанию
local punishPlayerOnDetect = false -- должен ли игрок быть наказан при обнаружении; true - да, или false, чтобы ничего не делать (убедитесь, что ресурс, запускающий этот код, имеет права администратора)
local punishmentBan = true -- актуально только если punishPlayerOnDetect установлен в true; используйте true для бана или false для кика
local punishmentReason = "Projectile/explosion anti-cheat" -- актуально только если punishPlayerOnDetect установлен в true; причина, которая будет показана наказанному игроку
local punishedBy = "Console" -- актуально только если punishPlayerOnDetect установлен в true; кто ответственен за наказание, также показывается наказанному игроку
local banByIP = false -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; бан по IP в настоящее время не рекомендуется (...)
local banByUsername = false -- имя пользователя сообщества - устаревшая вещь, поэтому установлено в false и должно оставаться таким
local banBySerial = true -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; (...) если есть серийный номер игрока, который можно использовать вместо этого
local banTime = 0 -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; время в секундах, 0 навсегда
local debugMsgLevel = 4 -- этот уровень отладки позволяет скрыть префикс INFO: и использовать пользовательские цвета
local debugMsgR = 255 -- сообщение отладки - красный цвет
local debugMsgG = 127 -- сообщение отладки - зеленый цвет
local debugMsgB = 0 -- сообщение отладки - синий цвет

local function reportProjectileAbnormality(playerElement, projectileType, projectileX, projectileY, projectileZ, projectileForce, projectileTarget, projectileRX, projectileRY, projectileRZ, projectileVX, projectileVY, projectileVZ, detectionCode)
local projectileSyncer = inspect(playerElement)
local projectilePosition = projectileX..", "..projectileY..", "..projectileZ
local projectileZoneName = getZoneName(projectileX, projectileY, projectileZ, false)
local projectileCityName = getZoneName(projectileX, projectileY, projectileZ, true)
local projectileLog =
"* Detected projectile abnormality - "..detectionCode.." *\n"..
"Projectile syncer: "..projectileSyncer.."\n"..
"Projectile type: "..projectileType.."\n"..
"Projectile position: "..projectilePosition.. " ("..projectileZoneName..", "..projectileCityName..")\n"

outputDebugString(projectileLog, debugMsgLevel, debugMsgR, debugMsgG, debugMsgB)

return true
end

local function processProjectileChecks(playerElement, projectileType, projectileX, projectileY, projectileZ, projectileForce, projectileTarget, projectileRX, projectileRY, projectileRZ, projectileVX, projectileVY, projectileVZ)
local projectileData = projectileTypes[projectileType]
local projectileAllowed = projectileData.projectileAllowed

if (not projectileAllowed) then
return false, "Projectile not allowed"
end

local projectileAllowedWeapons = projectileData.projectileAllowedWeapons

if (projectileAllowedWeapons) then
local playerWeapon = getPedWeapon(playerElement)
local allowedWeapon = projectileAllowedWeapons[playerWeapon]

if (not allowedWeapon) then
return false, "Player is not holding correct weapon"
end

local weaponAmmo = hasPlayerProjectileAmmo(playerElement, playerWeapon)
local playerHasAmmo = (weaponAmmo > 0)

if (not playerHasAmmo) then
return false, "Player doesn't have ammo for weapon"
end

decreasePlayerProjectileAmmo(playerElement, playerWeapon)
end

local playerVehicle = getPedOccupiedVehicle(playerElement)

if (playerVehicle) then
local projectileAllowedVehicles = projectileData.projectileAllowedVehicles

if (projectileAllowedVehicles) then
local vehicleModel = getElementModel(playerVehicle)
local allowedVehicle = projectileAllowedVehicles[vehicleModel]

if (not allowedVehicle) then
return false, "Player is not inside allowed vehicles"
end

local vehicleDriver = getVehicleController(playerVehicle)
local playerDriver = (playerElement == vehicleDriver)

if (not playerDriver) then
return false, "Player is not vehicle driver"
end

return true
end

return false, "Player in vehicle"
end

local projectileMaxDistanceFromCreator = projectileData.projectileMaxDistanceFromCreator

if (projectileMaxDistanceFromCreator) then
local playerX, playerY, playerZ = getElementPosition(playerElement)
local distanceToProjectile = getDistanceBetweenPoints3D(playerX, playerY, playerZ, projectileX, projectileY, projectileZ)
local matchingProjectileDistance = (distanceToProjectile <= projectileMaxDistanceFromCreator)

if (not matchingProjectileDistance) then
return false, "Projectile distance mismatch"
end
end

local projectileMaxVelocity = projectileData.projectileMaxVelocity

if (projectileMaxVelocity) then
local projectileVelocity = (projectileVX ^ 2 + projectileVY ^ 2 + projectileVZ ^ 2)
local projectileSpeed = math.sqrt(projectileVelocity)
local matchingProjectileVelocity = (projectileSpeed <= projectileMaxVelocity)

if (not matchingProjectileVelocity) then
return false, "Projectile velocity mismatch"
end
end

return true
end

local function trackPlayerProjectile(playerElement, projectileID)
local validElement = isElement(playerElement)

if (not validElement) then
return false
end

local playerProjectiles = playerCreatedProjectiles[playerElement]

if (not playerProjectiles) then
playerCreatedProjectiles[playerElement] = {}
playerProjectiles = playerCreatedProjectiles[playerElement]
end

local projectilesByType = playerProjectiles[projectileID] or 0
local newProjectilesCount = (projectilesByType + 1)

playerProjectiles[projectileID] = newProjectilesCount

return true
end

local function getProjectileDetectionOverwrittenBehavior(projectileType)
local projectileData = projectileTypes[projectileType]

if (not projectileData) then
return reportAbnormality, punishPlayerOnDetect, punishmentBan
end

local projectileBehaviour = projectileData.projectileOverwriteBehaviour

if (not projectileBehaviour) then
return reportAbnormality, punishPlayerOnDetect, punishmentBan
end

local overwriteReport = projectileBehaviour.reportAbnormality
local overwritePunish = projectileBehaviour.punishPlayerOnDetect
local overwriteBan = projectileBehaviour.punishmentBan

return overwriteReport, overwritePunish, overwriteBan
end

function decreasePlayerProjectiles(playerElement, projectileID)
local validElement = isElement(playerElement)

if (not validElement) then
return false
end

local playerProjectiles = playerCreatedProjectiles[playerElement]

if (not playerProjectiles) then
return false, true
end

local projectilesByType = playerProjectiles[projectileID]

if (not projectilesByType) then
return false, true
end

local tempProjectilesCount = (projectilesByType - 1)
local newProjectilesCount = (tempProjectilesCount > 0 and tempProjectilesCount or nil)

playerProjectiles[projectileID] = newProjectilesCount

return true
end

function onPlayerProjectileCreationAntiCheat(projectileType, projectileX, projectileY, projectileZ, projectileForce, projectileTarget, projectileRX, projectileRY, projectileRZ, projectileVX, projectileVY, projectileVZ)
local approvedProjectile, detectionCode = processProjectileChecks(source, projectileType, projectileX, projectileY, projectileZ, projectileForce, projectileTarget, projectileRX, projectileRY, projectileRZ, projectileVX, projectileVY, projectileVZ)

if (approvedProjectile) then
trackPlayerProjectile(source, projectileType)

return true
end

local reportAbnormality, punishPlayerOnDetect, punishmentBan = getProjectileDetectionOverwrittenBehavior(projectileType)

if (reportAbnormality) then
reportProjectileAbnormality(source, projectileType, projectileX, projectileY, projectileZ, projectileForce, projectileTarget, projectileRX, projectileRY, projectileRZ, projectileVX, projectileVY, projectileVZ, detectionCode)
end

cancelEvent()

if (not punishPlayerOnDetect) then -- мы не хотим наказывать игрока по какой-то причине
return false -- так что останавливаемся здесь
end

if (punishmentBan) then -- если это бан
banPlayer(source, banByIP, banByUsername, banBySerial, punishedBy, punishmentReason, banTime) -- удаляем его присутствие с сервера
else -- иначе
kickPlayer(source, punishedBy, punishmentReason) -- просто кикаем игрока с сервера
end
end
addEventHandler("onPlayerProjectileCreation", root, onPlayerProjectileCreationAntiCheat)

function onPlayerQuitAntiCheat()
playerCreatedProjectiles[source] = nil
end
addEventHandler("onPlayerQuit", root, onPlayerQuitAntiCheat)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="false">
Обработчик взрывов:
<syntaxhighlight lang="lua">
local rocketInstantExplosionDistanceThreshold = 1.55 -- дистанция, ниже которой будет создан только взрыв (а не снаряд ракеты, следовательно, не вызывается onPlayerProjectileCreation); не меняйте это
local explosionTypes = { -- более конкретная информация о взрыве и разрешен ли он
[0] = { -- Grenade
explosionAllowed = true,
explosionAllowedProjectiles = {
[16] = true, -- grenade
},
},
[1] = { -- Molotov
explosionAllowed = true,
explosionAllowedProjectiles = {
[18] = true, -- molotov
},
},
[2] = { -- Rocket
explosionAllowed = true,
explosionAllowedWeapons = {
[35] = true, -- rocket launcher
[36] = true, -- rocket launcher (heat-seeking)
},
explosionAllowedProjectiles = {
[19] = true, -- rocket
[20] = true, -- rocket (heat-seeking)
},
},
[3] = { -- Rocket weak
explosionAllowed = true,
explosionAllowedProjectiles = {
[19] = true, -- rocket
[20] = true, -- rocket (heat-seeking)
},
},
[4] = { -- Car
explosionAllowed = true,
},
[5] = { -- Car quick
explosionAllowed = true,
},
[6] = { -- Boat
explosionAllowed = true,
},
[7] = { -- Heli
explosionAllowed = true,
},
[8] = { -- Mine
explosionAllowed = true,
},
[9] = { -- Object
explosionAllowed = true,
},
[10] = { -- Tank grenade
explosionAllowed = true,
explosionMaxDistanceFromCreator = 80,
explosionAllowedVehicles = {
[432] = true,
}
},
[11] = { -- Small
explosionAllowed = true,
},
[12] = { -- Tiny
explosionAllowed = true,
},
}

local reportAbnormality = true -- сообщать ли о нарушениях в скрипте отладки - по умолчанию
local punishPlayerOnDetect = false -- должен ли игрок быть наказан при обнаружении; true - да, или false, чтобы ничего не делать (убедитесь, что ресурс, запускающий этот код, имеет права администратора)
local punishmentBan = true -- актуально только если punishPlayerOnDetect установлен в true; используйте true для бана или false для кика
local punishmentReason = "Projectile/explosion anti-cheat" -- актуально только если punishPlayerOnDetect установлен в true; причина, которая будет показана наказанному игроку
local punishedBy = "Console" -- актуально только если punishPlayerOnDetect установлен в true; кто ответственен за наказание, также показывается наказанному игроку
local banByIP = false -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; бан по IP в настоящее время не рекомендуется (...)
local banByUsername = false -- имя пользователя сообщества - устаревшая вещь, поэтому установлено в false и должно оставаться таким
local banBySerial = true -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; (...) если есть серийный номер игрока, который можно использовать вместо этого
local banTime = 0 -- актуально только если punishPlayerOnDetect и punishmentBan установлены в true; время в секундах, 0 навсегда
local debugMsgLevel = 4 -- этот уровень отладки позволяет скрыть префикс INFO: и использовать пользовательские цвета
local debugMsgR = 255 -- сообщение отладки - красный цвет
local debugMsgG = 127 -- сообщение отладки - зеленый цвет
local debugMsgB = 0 -- сообщение отладки - синий цвет

local function reportExplosionAbnormality(playerElement, explosionType, explosionX, explosionY, explosionZ, detectionCode)
local explosionSyncer = inspect(playerElement)
local explosionType = explosionType
local explosionPosition = explosionX..", "..explosionY..", "..explosionZ
local explosionZoneName = getZoneName(explosionX, explosionY, explosionZ, false)
local explosionCityName = getZoneName(explosionX, explosionY, explosionZ, true)
local explosionLog =
"* Detected explosion abnormality - "..detectionCode.." *\n"..
"Explosion syncer: "..explosionSyncer.."\n"..
"Explosion type: "..explosionType.."\n"..
"Explosion position: "..explosionPosition.. " ("..explosionZoneName..", "..explosionCityName..")\n"

outputDebugString(explosionLog, debugMsgLevel, debugMsgR, debugMsgG, debugMsgB)

return true
end

local function processExplosionChecks(playerElement, explosionType, explosionX, explosionY, explosionZ)
local explosionData = explosionTypes[explosionType]
local explosionAllowed = explosionData.explosionAllowed

if (not explosionAllowed) then
return false, "Explosion type not allowed"
end

local rocketExplosion = (explosionType == 2)

if (rocketExplosion) then
local playerX, playerY, playerZ = getElementPosition(playerElement)
local distanceToExplosion = getDistanceBetweenPoints3D(playerX, playerY, playerZ, explosionX, explosionY, explosionZ)
local instantExplosion = (distanceToExplosion < rocketInstantExplosionDistanceThreshold)

if (instantExplosion) then
local explosionAllowedWeapons = explosionData.explosionAllowedWeapons
local playerWeapon = getPedWeapon(playerElement)
local allowedWeapon = explosionAllowedWeapons[playerWeapon]

if (not allowedWeapon) then
return false, "Player is not holding rocket launcher"
end

local weaponAmmo = hasPlayerProjectileAmmo(playerElement, playerWeapon)
local playerHasAmmo = (weaponAmmo > 0)

if (not playerHasAmmo) then
return false, "Player doesn't have ammo for rocket launcher"
end

decreasePlayerProjectileAmmo(playerElement, playerWeapon)

return true
end
end

local explosionAllowedProjectiles = explosionData.explosionAllowedProjectiles

if (explosionAllowedProjectiles) then

for projectileID, _ in pairs(explosionAllowedProjectiles) do
local atleastOneProjectile = decreasePlayerProjectiles(playerElement, projectileID)

if (atleastOneProjectile) then
return true
end
end

return false, "Explosion created without respective projectile"
end

local explosionAllowedVehicles = explosionData.explosionAllowedVehicles

if (explosionAllowedVehicles) then
local playerVehicle = getPedOccupiedVehicle(playerElement)

if (not playerVehicle) then
return false, "Player is not in vehicle"
end

local vehicleModel = getElementModel(playerVehicle)
local allowedVehicle = explosionAllowedVehicles[vehicleModel]

if (not allowedVehicle) then
return false, "Player is inside not allowed vehicles"
end

local vehicleDriver = getVehicleController(playerVehicle)
local playerDriver = (playerElement == vehicleDriver)

if (not playerDriver) then
return false, "Player is not vehicle driver"
end
end

local explosionMaxDistanceFromCreator = explosionData.explosionMaxDistanceFromCreator

if (explosionMaxDistanceFromCreator) then
local playerX, playerY, playerZ = getElementPosition(playerElement)
local distanceToExplosion = getDistanceBetweenPoints3D(playerX, playerY, playerZ, explosionX, explosionY, explosionZ)
local matchingExplosionDistance = (distanceToExplosion < explosionMaxDistanceFromCreator)

if (not matchingExplosionDistance) then
return false, "Explosion distance mismatch"
end
end

return true
end

local function getExplosionDetectionOverwrittenBehavior(explosionType)
local explosionData = explosionTypes[explosionType]

if (not explosionData) then
return reportAbnormality, punishPlayerOnDetect, punishmentBan
end

local explosionBehaviour = explosionData.explosionOverwriteBehaviour

if (not explosionBehaviour) then
return reportAbnormality, punishPlayerOnDetect, punishmentBan
end

local overwriteReport = explosionBehaviour.reportAbnormality
local overwritePunish = explosionBehaviour.punishPlayerOnDetect
local overwriteBan = explosionBehaviour.punishmentBan

return overwriteReport, overwritePunish, overwriteBan
end

function onExplosionAntiCheat(explosionX, explosionY, explosionZ, explosionType)
local serverSyncExplosion = (source == root)

if (serverSyncExplosion) then
return true
end

local approvedExplosion, detectionCode = processExplosionChecks(source, explosionType, explosionX, explosionY, explosionZ)

if (approvedExplosion) then
return true
end

local reportAbnormality, punishPlayerOnDetect, punishmentBan = getExplosionDetectionOverwrittenBehavior(explosionType)

if (reportAbnormality) then
reportExplosionAbnormality(source, explosionType, explosionX, explosionY, explosionZ, detectionCode)
end

cancelEvent()

if (not punishPlayerOnDetect) then -- мы не хотим наказывать игрока по какой-то причине
return false -- так что останавливаемся здесь
end

if (punishmentBan) then -- если это бан
banPlayer(source, banByIP, banByUsername, banBySerial, punishedBy, punishmentReason, banTime) -- удаляем его присутствие с сервера
else -- иначе
kickPlayer(source, punishedBy, punishmentReason) -- просто кикаем игрока с сервера
end
end
addEventHandler("onExplosion", root, onExplosionAntiCheat)
</syntaxhighlight>
</section>

==Обработка незарегистрированных событий==
Смотрите: [[onPlayerTriggerInvalidEvent]]

==Обработка нежелательных событий==
Смотрите: [[onPlayerTriggerEventThreshold]]

__NOTOC__
__NOEDITSECTION__
[[ru:Script security]]
[[en:Script security]]

RU/Forks

2026-01-02T20:15:14Z

Flox: Created page with "__NOTOC__ {{Note|Information on this page does not apply to the official builds of MTA.}} Multi Theft Auto - Это программное обеспечение с открытым исходным кодом, доступное бесплатно на [https://github.com/multitheftauto/mtasa-blue GitHub multitheftauto/mtasa-blue]. Любой может создать форк проекта, если будет соблюдать условия нашей лиценз..."

__NOTOC__ {{Note|Information on this page does not apply to the official builds of MTA.}}

Multi Theft Auto - Это программное обеспечение с открытым исходным кодом, доступное бесплатно на [https://github.com/multitheftauto/mtasa-blue GitHub multitheftauto/mtasa-blue].
Любой может создать форк проекта, если будет соблюдать условия нашей лицензии — Стандартной общественной лицензии GNU версии 3.

Вы можете ознакомиться с пояснениями к GNU GPL v3 здесь: [https://choosealicense.com/licenses/gpl-3.0/ choosealicense.com] и [https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3) tldrlegal.com]. Приоритет [https://github.com/multitheftauto/mtasa-blue/blob/master/LICENSE license] отдается нашей лицензии, но обычно это означает, что вы должны:

* указать существенные изменения, внесенные в программное обеспечение
* раскрыть исходный код
* поделиться своим кодом под той же лицензией
* включить оригинальное уведомление об авторских правах

Если вы работаете над форком, мы просим вас указать ссылку на вашу домашнюю страницу и указать, где мы можем найти исходный код. Это позволяет нам быть в курсе событий, связанных с проектами, и даже вносить улучшения для подавляющего большинства игроков в MTA. Указывать имя в Discord не обязательно, но если вы обратитесь за помощью в разработке на наш GitHub, форум или в Discord, это поможет нам понять, из какого вы проекта и соблюдаете ли вы условия лицензии.

== Forks and anti-cheat==

(from https://wiki.multitheftauto.com/wiki/Anti-cheat_support_for_custom_builds)

=== '''// UPDATE (December 2022)''' ===
Теперь вы также можете использовать «полный античит для форков». Для получения дополнительной информации прочтите эту статью: '''[[Forks Full AC]]'''<br><br>

.. But otherwise

Пользовательские сборки MTA и форки столкнутся с некоторыми проблемами, связанными с античитом (AC). Из-за того, что многие форки и пользовательские сборки работают не так, как ожидает модуль античита, мы были вынуждены удалить множество расширенных средств обнаружения и защиты от античита, чтобы создать и предоставить отдельный модуль (тот, что с https://mirror-cdn.multitheftauto.com/bdata/netc.dll), который, проще говоря, является гораздо более слабым античитом, чем «настоящий» MTA. Таким образом, если вы не примете меры, ваш форк-проект может (и будет) легко заражён мошенниками. Этого можно избежать с помощью [[Forks Full AC]] (нажмите, чтобы прочитать статью). Но в стандартном сценарии вам поможет информация, представленная ниже.

Компоненты античита и неткода (netc.dll, net.dll, FairplayKD.sys), в отличие от самого MTA, имеют закрытый исходный код, поэтому без дополнительной информации вам будет сложно справиться с трудностями.

AC, как правило, не поддерживается в форках и в будущем может быть полностью исключён. Это означает, что вы, как правило, ''не можете'' полагаться на античит MTA в своём форке. '''Мы настоятельно рекомендуем вам написать и внедрить собственный античит.'''

Если вы не можете написать свой собственный AC, вот несколько шагов, которые помогут вам максимально эффективно использовать наш (не поддерживаемый) AC:

* Всегда используйте версию наших сетевых модулей (например, [https://mirror-cdn.multitheftauto.com/bdata/netc.dll netc.dll] и [https://mirror-cdn.multitheftauto.com/bdata/net.dll net.dll]), которая соответствует нашему коммиту в основной ветке, на которой основан ваш форк
** Если говорить конкретно, вы можете использовать последнюю версию модуля, совместимую с битовым потоком
** Вы можете загрузить эти модули, выполнив команду https://github.com/multitheftauto/mtasa-blue/blob/master/win-build.bat
* Никогда не блокируйте трафик MTA (клиент и сервер взаимодействуют с официальными серверами MTAHQ) в своём проекте
'''* Обязательно используйте тип сборки «нестабильный», а не «пользовательский», иначе 15 % функций AC для «bdata forks netc» снизятся до 1 %. Подробную информацию и правильную конфигурацию см. в документации по типу сборки по адресу [https://github.com/multitheftauto/mtasa-blue/blob/master/Shared/sdk/version.h mtasa-blue/Shared/sdk/version.h] '''

=== Функции AC отсутствуют в пользовательских сборках ===
* Не обнаруживаются изменения в разделе кода gta_sa
* Не обнаруживаются изменения в некоторых переменных gta_sa
* Не обнаруживаются изменения в памяти
* Не обнаруживаются различные методы внедрения Lua
* SetElementData не защищён от внешних изменений с помощью хаков
* Гораздо меньше эвристических методов защиты от читов и внутренних средств защиты
* Не гарантируется постоянное обновление всех исправленных методов и уязвимостей, на основе которых можно писать читы (иногда они выбираются случайным образом; это одна из причин, по которой рекомендуется обновлять netc.dll до последней доступной версии). Это самая большая (и самая важная) часть оригинального античита.
* Модули MTA не проверяются на предмет модификаций или удалённого перехвата/манипулирования
* и многое другое

Как правило, лучше всего работают системы обнаружения на основе сигнатур. Никаких эвристических методов, исправленных методов и исправленных уязвимостей. Системы обнаружения на основе сигнатур — самые слабые, и основная античит-система решает реальную проблему, а не полагается на сигнатуры. Обратите внимание, что в некоторых форках (например, в российской «MTA Province») античит-система MTA поддерживается ещё хуже, чем в большинстве других форков. Это связано с тем, что разработчики форков имеют возможность полностью блокировать или прерывать коммуникационный трафик клиента > MTAHQ (на что мы в значительной степени полагаемся, чтобы помочь форкам противодействовать мошенничеству, поскольку большинство обычных функций AC недоступны), или выполнять и изменять другие действия, которые с технической точки зрения приведут к тому, что функции AC не будут работать. работайте по назначению или немедленно выйдите из строя. Если вы не хотите, чтобы ваш форк был заражен читерами так же сильно, как "провинция MTA" и как они ее называют, "их клоны" (из провинции).. в дополнение к тому, что вы установили тип сборки «custom», тогда как он должен быть «unstable». Теперь, надеюсь, вы знаете, на что следует обратить внимание как разработчику форка. Кроме того, было бы неплохо, если бы это сообщение дошло до разработчиков форков с большим количеством читеров, таких как Province.

Кроме того, команда по борьбе с мошенничеством в MTA выполняет дополнительную работу вручную, чтобы пресекать мошенничество на форках, например, время от времени блокируя читеров из известных форков с помощью слишком простых методов обнаружения, прилагая все усилия (без каких-либо гарантий). Это всего лишь любезность со стороны MTA, которую мы проявляем, когда нам этого хочется, или, может быть, когда вы обращаетесь к нам... и на это нельзя полагаться.
<br />
Известно, что вышеупомянутые волны банов приводят к банам по причинам, которые выглядят одинаково и известны читерам как «БАН: RPBOX / NEXTRP / PROVINCE CHEAT» (в зависимости от названий форков, затронутых определенным читом). Поэтому, пожалуйста, не направляйте этих пользователей в MTA для обжалования банов.

[[Category:Development]]

SetVehicleDirtEnabled

2026-01-01T18:09:25Z

IManGaaX:

{{Useful Function}} __NOTOC__
<lowercasetitle>setVehicleDirtEnabled</lowercasetitle>
This function toggles a dirt removal [[shader]] effect on the specified [[vehicle]].

[[Image:SetVehicleDirtEnabled-false.png|thumb|320px|right|[[Image:SetVehicleDirtEnabled-true.png|320px|right]]]]

{{Note|This function applies or removes a custom [[shader]] that removes dirt [[texture]] from the [[vehicle]]'s surface. It also handles [[shader]] cleanup automatically when the [[vehicle]] is destroyed.}}

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleDirtEnabled( element theVehicle, boolean enabledState )</syntaxhighlight>

===Required Arguments===
* '''theVehicle''': the vehicle element on which to toggle the dirt effect.
* '''enabledState''': set to false to remove dirt, true to show default dirt.

===Returns===
* '''true''' if the operation was successful (shader applied or removed, or already in the requested state).
* '''false''' if the operation failed (shader creation failure).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local enabledVehicles = {}

local shaderCode = [[texture removeDirtyTexture;
technique TexReplace {
pass P0 {
Texture[0] = removeDirtyTexture;
}
}]]

function isVehicleDirtEnabled(theVehicle)
assert(isElement(theVehicle) and getElementType(theVehicle) == "vehicle", "Bad argument @ 'isVehicleDirtEnabled' [Expected vehicle element at argument 1, got "..(isElement(theVehicle) and getElementType(theVehicle) or type(theVehicle)).."]")

if isElement(enabledVehicles[theVehicle]) then
return false
end

return true
end

function setVehicleDirtEnabled(theVehicle, enabledState)
assert(isElement(theVehicle) and getElementType(theVehicle) == "vehicle", "Bad argument @ 'setVehicleDirtEnabled' [Expected vehicle element at argument 1, got "..(isElement(theVehicle) and getElementType(theVehicle) or type(theVehicle)).."]")
assert(type(enabledState) == "boolean", "Bad argument @ 'setVehicleDirtEnabled' [Expected boolean at argument 2, got "..(type(enabledState)).."]")

if not enabledState then
if not isElement(enabledVehicles[theVehicle]) then
enabledVehicles[theVehicle] = dxCreateShader(shaderCode, 0, 100, false, "vehicle")
if isElement(enabledVehicles[theVehicle]) then
engineApplyShaderToWorldTexture(enabledVehicles[theVehicle], "vehiclegrunge256", theVehicle)
else
return false
end
end
else
if isElement(enabledVehicles[theVehicle]) then
engineRemoveShaderFromWorldTexture(enabledVehicles[theVehicle], "vehiclegrunge256", theVehicle)
destroyElement(enabledVehicles[theVehicle])
enabledVehicles[theVehicle] = nil
end
end

return true
end

addEventHandler("onClientElementDestroy", root, function()
if getElementType(source) == "vehicle" then
setVehicleDirtEnabled(source, true)
end
end)
</syntaxhighlight>
</section>

'''Author:''' [[User:IManGaaX|Youssef Maged (iManGaaX)]]

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--// Disable dirt on the localPlayer's vehicle
local theVeh = getPedOccupiedVehicle(localPlayer)
if theVeh then
setVehicleDirtEnabled(theVeh, false)
end

--// Show the dirt on a vehicle after 5 seconds
setTimer(function()
if theVeh then
setVehicleDirtEnabled(theVeh, true)
end
end, 5000, 1)

--// Also u can use 'isVehicleDirtEnabled' to check.
</syntaxhighlight>
</section>

==See Also==

{{Useful_Functions}}

IsPostFXEnabled

2025-12-03T11:08:22Z

O22:

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6|23644 |
Checks whether a specific PostFX effect is currently enabled.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isPostFXEnabled ( string fxType )
</syntaxhighlight>

===Required arguments===
*'''fxType''': An string of the PostFX. Possible values are:
**'''Gamma'''
**'''Brightness'''
**'''Contrast'''
**'''Saturation'''

===Returns===
Returns '''true''' if the selected type is enabled, otherwise '''false'''

==Example==
This example gets whether the gamma PostFX is enabled and displays it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("isGammaEnabled",
function()
local isEnabled = isPostFXEnabled("Gamma")
outputChatBox("Your gamma mode is: "..(isEnabled and "Enabled" or "Disabled"))
end, false, false
)
</syntaxhighlight>

==See Also==
{{Client_PostFX_functions}}

GetPostFXValue

2025-12-03T11:06:32Z

O22: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0161|1.6|23644| Gets the current float value of the selected PostFX type. }} ==Syntax== <syntaxhighlight lang="lua"> float getPostFXValue ( string fxType ) </syntaxhighlight> ===Required arguments=== *'''fxType''': An string of the PostFX. Possible values are: **'''Gamma''' **'''Brightness''' **'''Contrast''' **'''Saturation''' ===Returns=== Returns the current value of the specified PostFX parameter. ==Example== T..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6|23644|
Gets the current float value of the selected PostFX type.
}}

==Syntax==
<syntaxhighlight lang="lua">
float getPostFXValue ( string fxType )
</syntaxhighlight>

===Required arguments===
*'''fxType''': An string of the PostFX. Possible values are:
**'''Gamma'''
**'''Brightness'''
**'''Contrast'''
**'''Saturation'''

===Returns===
Returns the current value of the specified PostFX parameter.

==Example==
This example gets the current gamma PostFX value and display it in the chat.
<syntaxhighlight lang="lua">
addCommandHandler("getGammaValue",
function()
local gammaValue = getPostFXValue("Gamma")
outputChatBox("Your gamma value is: "..tostring(gammaValue))
end, false, false
)
</syntaxhighlight>

==See Also==
{{Client_PostFX_functions}}

GetPostFXMode

2025-12-03T11:05:40Z

O22: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0161|1.6|23644| Gets the current mode of PostFX. }} ==Syntax== <syntaxhighlight lang="lua"> int getPostFXMode ( ) </syntaxhighlight> ===Returns=== An integer for the current PostFX mode: * 0: Disabled * 1: Enabled in fullscreen mode * 2: Enabled in windowed/borderless mode ==Example== This example gets the current PostFX mode and displays it in the chat. <syntaxhighlight lang="lua"> local modes = { [0] = "Disabl..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6|23644|
Gets the current mode of PostFX.
}}

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

===Returns===
An integer for the current PostFX mode:
* 0: Disabled
* 1: Enabled in fullscreen mode
* 2: Enabled in windowed/borderless mode

==Example==
This example gets the current PostFX mode and displays it in the chat.
<syntaxhighlight lang="lua">
local modes = {
[0] = "Disabled",
[1] = "Enabled in fullscreen mode",
[2] = "Enabled in windowed/borderless mode"
}

addCommandHandler("getMyMode",
function()
local currentMode = getPostFXMode()
outputChatBox("Your PostFX mode is: "..modes[currentMode])
end, false, false
)
</syntaxhighlight>

==See Also==
{{Client_PostFX_functions}}

IsPlayerNameRandomized

2025-12-01T19:04:39Z

O22: Created page with "{{Useful Function}} __NOTOC__ Checks whether the given player name looks like an automatically-generated random nickname. ==Syntax== <syntaxhighlight lang="lua">bool isPlayerNameRandomized ( string name )</syntaxhighlight> ===Required Arguments=== * '''name''': The player name to check. ===Returns=== Returns '''true''' if the given name is an auto-generated random nickname, or '''false''' otherwise. ==Code== <section name="Shared" class="both" show="true"> <syntaxhig..."

{{Useful Function}}
__NOTOC__
Checks whether the given player name looks like an automatically-generated random nickname.

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerNameRandomized ( string name )</syntaxhighlight>

===Required Arguments===
* '''name''': The player name to check.

===Returns===
Returns '''true''' if the given name is an auto-generated random nickname, or '''false''' otherwise.

==Code==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local firstName, secondName = {
"Aback", "Abaft", "Abandoned", "Abashed", "Aberrant", "Abhorrent", "Abiding", "Abject", "Ablaze", "Able", "Abnormal",
"Aboard", "Aboriginal", "Abortive", "Abounding", "Abrasive", "Abrupt", "Absent", "Absorbed", "Absorbing", "Abstracted", "Absurd",
"Abundant", "Abusive", "Acceptable", "Accessible", "Accidental", "Accurate", "Acid", "Acidic", "Acoustic", "Acrid", "Actually",
"Adhoc", "Adamant", "Adaptable", "Addicted", "Adhesive", "Adjoining", "Adorable", "Afraid", "Aggressive", "Agonizing", "Agreeable",
"Ahead", "Ajar", "Alcoholic", "Alert", "Alike", "Alive", "Alleged", "Alluring", "Aloof", "Amazing", "Ambiguous",
"Ambitious", "Amuck", "Amused", "Amusing", "Ancient", "Angry", "Animated", "Annoyed", "Annoying", "Anxious", "Apathetic",
"Aquatic", "Aromatic", "Arrogant", "Ashamed", "Aspiring", "Assorted", "Attractive", "Auspicious", "Automatic", "Available", "Average",
"Awake", "Aware", "Awesome", "Awful", "Axiomatic", "Bad", "Barbarous", "Bashful", "Bawdy", "Beautiful", "Befitting",
"Beneficial", "Bent", "Berserk", "Best", "Better", "Bewildered", "Big", "Billowy", "Bite-sized", "Bitter", "Bizarre",
"Black", "Bloody", "Blue", "Blue-eyed", "Blushing", "Boiling", "Boorish", "Bored", "Boring", "Bouncy", "Boundless",
"Brainy", "Brash", "Brave", "Brawny", "Breakable", "Breezy", "Brief", "Bright", "Broad", "Broken", "Brown",
"Bumpy", "Burly", "Bustling", "Busy", "Cagey", "Callous", "Calm", "Capable", "Capricious", "Careful", "Careless",
"Caring", "Cautious", "Ceaseless", "Certain", "Changeable", "Charming", "Cheap", "Cheerful", "Chemical", "Chief", "Childlike",
"Chilly", "Chivalrous", "Chubby", "Chunky", "Clammy", "Classy", "Clean", "Clear", "Clever", "Cloistered", "Cloudy",
"Closed", "Clumsy", "Cluttered", "Coherent", "Cold", "Colorful", "Colossal", "Combative", "Common", "Complete", "Complex",
"Concerned", "Condemned", "Confused", "Conscious", "Cooing", "Cool", "Courageous", "Cowardly", "Crabby", "Craven", "Crazy",
"Creepy", "Crooked", "Crowded", "Cruel", "Cuddly", "Cultured", "Cumbersome", "Curious", "Curly", "Curved", "Curvy",
"Cut", "Cute", "Cynical", "Daffy", "Daily", "Damaged", "Damaging", "Damp", "Dangerous", "Dapper", "Dark",
"Dashing", "Dazzling", "Dead", "Deadpan", "Deafening", "Dear", "Debonair", "Decisive", "Decorous", "Deep", "Deeply",
"Defeated", "Defective", "Defiant", "Delicate", "Delicious", "Delightful", "Demonic", "Delirious", "Dependent", "Depressed", "Deranged",
"Deserted", "Detailed", "Determined", "Devilish", "Didactic", "Different", "Difficult", "Diligent", "Direful", "Dirty", "Disastrous",
"Discreet", "Disgusted", "Disgusting", "Distinct", "Disturbed", "Divergent", "Dizzy", "Doubtful", "Drab", "Draconian", "Dramatic",
"Dreary", "Drunk", "Dry", "Dull", "Dusty", "Dynamic", "Eager", "Early", "Earthy", "Easy", "Eatable",
"Economic", "Educated", "Efficient", "Eight", "Elastic", "Elated", "Elderly", "Electric", "Elegant", "Elfin", "Elite",
"Eminent", "Empty", "Enchanted", "Enchanting", "Endurable", "Energetic", "Enormous", "Envious", "Equable", "Equal", "Erect",
"Erratic", "Ethereal", "Evanescent", "Evasive", "Even", "Excellent", "Excited", "Exciting", "Exclusive", "Exotic", "Expensive",
"Exuberant", "Exultant", "Fabulous", "Faded", "Faint", "Fair", "Faithful", "Fallacious", "False", "Familiar", "Famous",
"Fanatical", "Fancy", "Fantastic", "Far", "Far-flung", "Fascinated", "Fast", "Fat", "Faulty", "Fearful", "Fearless",
"Feeble", "Feigned", "Female", "Fertile", "Festive", "Few", "Fierce", "Filthy", "Fine", "Finicky", "First",
"Five", "Fixed", "Flagrant", "Flaky", "Flashy", "Flat", "Flawless", "Flimsy", "Flippant", "Flowery", "Fluffy",
"Fluttering", "Foamy", "Foolish", "Foregoing", "Forgetful", "Fortunate", "Four", "Frail", "Fragile", "Frantic", "Free",
"Freezing", "Frequent", "Fresh", "Fretful", "Friendly", "Frightened", "Full", "Fumbling", "Functional", "Funny", "Furry",
"Furtive", "Future", "Futuristic", "Fuzzy", "Gabby", "Gainful", "Gamy", "Gaping", "Garrulous", "Gaudy", "General",
"Gentle", "Giant", "Giddy", "Gifted", "Gigantic", "Glamorous", "Gleaming", "Glib", "Glistening", "Glorious", "Glossy",
"Godly", "Good", "Goofy", "Gorgeous", "Graceful", "Grandiose", "Grateful", "Gratis", "Gray", "Greasy", "Great",
"Greedy", "Green", "Grey", "Grieving", "Groovy", "Grotesque", "Grouchy", "Grubby", "Gruesome", "Grumpy", "Guarded",
"Guiltless", "Gullible", "Gusty", "Guttural", "Habitual", "Half", "Hallowed", "Halting", "Handsome", "Handsomely", "Handy",
"Hanging", "Hapless", "Happy", "Hard", "Harmonious", "Harsh", "Hateful", "Heady", "Healthy", "Heavenly", "Heavy",
"Hellish", "Helpful", "Helpless", "Hesitant", "Hideous", "High", "Hilarious", "Hissing", "Historical", "Holistic", "Hollow",
"Homeless", "Homely", "Honorable", "Horrible", "Hospitable", "Hot", "Huge", "Hulking", "Humdrum", "Humorous", "Hungry",
"Hurried", "Hurt", "Hushed", "Husky", "Hypnotic", "Hysterical", "Icky", "Icy", "Idiotic", "Ignorant", "Ill",
"Illegal", "Ill-fated", "Imaginary", "Immense", "Imminent", "Impartial", "Imperfect", "Impolite", "Important", "Imported", "Impossible",
"Incredible", "Infamous", "Innate", "Innocent", "Insidious", "Internal", "Invincible", "Irate", "Irritating", "Itchy", "Jaded",
"Jagged", "Jazzy", "Jealous", "Jittery", "Jobless", "Jolly", "Joyous", "Judicious", "Juicy", "Jumbled", "Jumpy",
"Juvenile", "Kaput", "Keen", "Kind", "Kindly", "Knotty", "Knowing", "Known", "Labored", "Lacking", "Lame",
"Lamentable", "Languid", "Large", "Last", "Late", "Laughable", "Lavish", "Lazy", "Lean", "Learned", "Left",
"Legal", "Lethal", "Level", "Lewd", "Light", "Like", "Likeable", "Limping", "Literate", "Little", "Lively",
"Living", "Lonely", "Long", "Longing", "Long-term", "Loose", "Lopsided", "Loud", "Loutish", "Lovely", "Loving",
"Low", "Lowly", "Lucky", "Ludicrous", "Lumpy", "Lush", "Luxuriant", "Lying", "Lyrical", "Macabre", "Macho",
"Maddening", "Madly", "Magenta", "Magical", "Majestic", "Makeshift", "Male", "Malicious", "Mammoth", "Maniacal", "Many",
"Marked", "Massive", "Married", "Marvelous", "Material", "Mature", "Mean", "Measly", "Meaty", "Medical", "Meek",
"Mellow", "Melodic", "Melted", "Merciful", "Mere", "Messy", "Mighty", "Military", "Milky", "Mindless", "Miniature",
"Minor", "Miscreant", "Misty", "Mixed", "Moaning", "Modern", "Moldy", "Momentous", "Motionless", "Muddled", "Mundane",
"Murky", "Mushy", "Mute", "Mysterious", "Naive", "Nappy", "Narrow", "Nasty", "Natural", "Naughty", "Nauseating",
"Near", "Neat", "Nebulous", "Necessary", "Needless", "Needy", "Neighborly", "Nervous", "New", "Next", "Nice",
"Nifty", "Nimble", "Nine", "Nippy", "Noiseless", "Noisy", "Nonchalant", "Nonstop", "Normal", "Nostalgic", "Nosy",
"Noxious", "Null", "Numberless", "Numerous", "Nutritious", "Nutty", "Oafish", "Obedient", "Obeisant", "Obese", "Obnoxious",
"Obscene", "Obsequious", "Observant", "Obsolete", "Obtainable", "Oceanic", "Odd", "Offbeat", "Old", "Omniscient", "One",
"Onerous", "Open", "Opposite", "Optimal", "Orange", "Ordinary", "Organic", "Ossified", "Outgoing", "Outrageous", "Oval",
"Overjoyed", "Overrated", "Overt", "Painful", "Pale", "Paltry", "Panicky", "Panoramic", "Parallel", "Parched", "Past",
"Pastoral", "Pathetic", "Peaceful", "Penitent", "Perfect", "Periodic", "Perpetual", "Petite", "Phobic", "Physical", "Picayune",
"Pink", "Piquant", "Placid", "Plain", "Plant", "Plastic", "Plausible", "Pleasant", "Plucky", "Pointless", "Poised",
"Polite", "Political", "Poor", "Possessive", "Possible", "Powerful", "Precious", "Premium", "Present", "Pretty", "Previous",
"Pricey", "Prickly", "Private", "Probable", "Productive", "Profuse", "Protective", "Proud", "Psychotic", "Public", "Puffy",
"Pumped", "Puny", "Purple", "Purring", "Pushy", "Puzzled", "Puzzling", "Quack", "Quaint", "Quick", "Quickest",
"Quiet", "Quirky", "Quixotic", "Quizzical", "Rabid", "Racial", "Ragged", "Rainy", "Rampant", "Rapid", "Rare",
"Raspy", "Ratty", "Ready", "Real", "Rebel", "Receptive", "Recondite", "Red", "Redundant", "Reflective", "Regular",
"Relieved", "Remarkable", "Repulsive", "Resolute", "Resonant", "Rhetorical", "Rich", "Right", "Righteous", "Rightful", "Rigid",
"Ripe", "Ritzy", "Roasted", "Robust", "Romantic", "Roomy", "Rotten", "Rough", "Round", "Royal", "Ruddy",
"Rude", "Rural", "Rustic", "Ruthless", "Sable", "Sad", "Safe", "Salty", "Same", "Sassy", "Satisfying",
"Savory", "Scandalous", "Scarce", "Scared", "Scary", "Scattered", "Scientific", "Scrawny", "Screeching", "Second", "Secret",
"Secretive", "Sedate", "Seemly", "Selective", "Selfish", "Separate", "Serious", "Shaggy", "Shaky", "Shallow", "Sharp",
"Shiny", "Shivering", "Shocking", "Short", "Shrill", "Shut", "Shy", "Sick", "Silent", "Silky", "Silly",
"Simple", "Simplistic", "Sincere", "Six", "Skillful", "Skinny", "Sleepy", "Slim", "Slimy", "Slippery", "Sloppy",
"Slow", "Small", "Smart", "Smelly", "Smiling", "Smoggy", "Smooth", "Sneaky", "Snobbish", "Snotty", "Soft",
"Soggy", "Solid", "Somber", "Sordid", "Sore", "Sour", "Sparkling", "Special", "Spicy", "Spiffy", "Spiky",
"Spiritual", "Spiteful", "Splendid", "Spooky", "Spotless", "Spotted", "Spotty", "Spurious", "Squalid", "Square", "Squealing",
"Squeamish", "Staking", "Stale", "Standing", "Statuesque", "Steadfast", "Steady", "Stealthy", "Steep", "Sticky", "Stiff",
"Stingy", "Stormy", "Straight", "Strange", "Striped", "Strong", "Stupendous", "Stupid", "Sturdy", "Subdued", "Subsequent",
"Successful", "Succinct", "Sudden", "Sulky", "Super", "Superb", "Supreme", "Swanky", "Sweet", "Sweltering", "Swift",
"Synonymous", "Taboo", "Tacit", "Tacky", "Talented", "Tall", "Tame", "Tan", "Tangible", "Tangy", "Tart",
"Tasteful", "Tasteless", "Tasty", "Tawdry", "Tearful", "Tedious", "Teeny", "Teeny-tiny", "Telling", "Temporary", "Ten",
"Tender", "Tense", "Tenuous", "Terrible", "Terrific", "Tested", "Testy", "Thankful", "Thick", "Thin", "Thinkable",
"Third", "Thirsty", "Thoughtful", "Three", "Thundering", "Tidy", "Tight", "Tiny", "Tired", "Tiresome", "Toothsome",
"Torpid", "Tough", "Towering", "Tranquil", "Trashy", "Tremendous", "Tricky", "Trite", "Troubled", "Truculent", "True",
"Truthful", "Two", "Typical", "Ubiquitous", "Ugliest", "Ugly", "Ultra", "Unable", "Unadvised", "Unarmed", "Unbecoming",
"Unbiased", "Uncovered", "Understood", "Unequal", "Unequaled", "Uneven", "Unhealthy", "Unique", "Unkempt", "Unknown", "Unnatural",
"Unruly", "Unsightly", "Unsuitable", "Untidy", "Unused", "Unusual", "Unwieldy", "Unwritten", "Upbeat", "Uppity", "Upset",
"Uptight", "Used", "Useful", "Useless", "Utopian", "Utter", "Uttermost", "Vacuous", "Vagabond", "Vague", "Valuable",
"Various", "Vast", "Vengeful", "Venomous", "Verdant", "Versed", "Victorious", "Vigorous", "Violent", "Violet", "Vivacious",
"Voiceless", "Volatile", "Voracious", "Vulgar", "Wacky", "Waggish", "Waiting", "Wakeful", "Wandering", "Wanting", "Warlike",
"Warm", "Wary", "Wasteful", "Watery", "Weak", "Wealthy", "Weary", "Well-made", "Well-off", "Well-to-do", "Wet",
"Whimsical", "Whispering", "White", "Whole", "Wholesale", "Wicked", "Wide", "Wide-eyed", "Wiggly", "Wild", "Willing",
"Windy", "Wiry", "Wise", "Wistful", "Witty", "Woebegone", "Womanly", "Wonderful", "Wooden", "Woozy", "Workable",
"Worried", "Worthless", "Wrathful", "Wretched", "Wrong", "Wry",
}, {
"Aardvark", "Buffalo", "Alligator", "Ant", "Anteater", "Antelope", "Ape", "Armadillo", "Donkey", "Baboon", "Badger",
"Barracuda", "Bat", "Bear", "Beaver", "Bee", "Bison", "Boar", "Bush", "Butterfly", "Camel", "Calf",
"Cat", "Kitten", "Cattle", "Chamois", "Cheetah", "Chicken", "Chick", "Chimpanzee", "Infant", "Empress", "Troop",
"Cobra", "Cockroach", "Cormorant", "Cougar", "Coyote", "Crab", "Crane", "Crocodile", "Crow", "Deer", "Dog",
"Dogfish", "Dolphin", "Dove", "Dragonfly", "Duck", "Dugong", "Eagle", "Eaglet", "Echidna", "Eel", "Eland",
"Elephant", "Elk", "Falcon", "Ferret", "Finch", "Fly", "Fox", "Frog", "Gaur", "Gazelle", "Gerbil",
"Giant", "Giraffe", "Gnu", "Goat", "Goose", "Gorilla", "Guanaco", "Guinea", "Guineapig", "Gull", "Hamster",
"Hare", "Hawk", "Hedgehog", "Heron", "Hornet", "Horse", "Human", "Hyena", "Iguana", "Jackal", "Jaguar",
"Jellyfish", "Kangaroo", "Koala", "Komodo", "Kouprey", "Kudu", "Lark", "Lemur", "Leopard", "Lion", "Llama",
"Loris", "Louse", "Lobster", "Lyrebird", "Magpie", "Mallard", "Manatee", "Meerkat", "Mink", "Mole", "Monkey",
"Moose", "Mouse", "Mosquito", "Mule", "Okapi", "Oryx", "Ostrich", "Otter", "Owl", "Ox", "Oyster",
"Panther", "Partridge", "Peafowl", "Pelican", "Penguin", "Pig", "Pigeon", "Pony", "Porcupine", "Quelea", "Rabbit",
"Bunny", "Raccoon", "Rail", "Ram", "Rat", "Raven", "Reindeer", "Rhino", "Salamander", "Sealion", "Seal",
"Seahorse", "Seastar", "Shark", "Sheep", "Shrew", "Skunk", "Snail", "Snake", "Spider", "Squid", "Squirrel",
"Stinkbug", "Swan", "Tapir", "Tarsier", "Tiger", "Toad", "Turkey", "Turtle", "Vicuna", "Walrus", "Wasp",
"Weasel", "Whale", "Wolf", "Worm", "Yak", "Zebra", "Hat", "Cap", "Beret", "Astrakhan", "Beanie",
"Hardhat", "Pillbox", "Monkeycap", "Operahat", "Bonnet", "Bowler", "Coonskin", "Fedora", "Derby", "Montero", "Cowboyhat",
"Sombrero", "Yarmulke", "Skullcap", "Tam", "Sunbonnet", "Toque", "Tophat", "Babushka", "Balaclava", "Turban", "Diadem",
"Earmuffs", "Visor", "Scarf", "Veil", "Warbonnet", "Pithhelmet", "Hood", "Miter", "Butter", "Icecream", "Cakebatter",
"Coffee", "Tea", "Soda", "Beer", "Wine", "Cappuccino", "Jell-o", "Nougats", "Lambchops", "Steaks", "Chowder",
"Fishsoup", "Spaghetti", "Sushi", "Fondue", "Crabslegs", "Shrimp", "Onions", "Bratwurst", "Kielbasa", "Hotdog", "Hamburger",
"Herbs", "Grains", "Legumes", "Zampone", "Casserole", "Beans", "Seeds", "Stew", "Cereal", "Polenta", "Pudding",
"Pasta", "Macaroni", "Ravioli", "Wafer", "Crackers", "Cookies", "Sandwich", "Gyro", "Wrap", "Omelet", "Popcorn",
"Walnuts", "Nuts", "Almonds", "Pizza", "Mousse", "Brulee", "Cakes", "Pancake", "Waffles", "Toast", "Candy",
"Pie", "Senator", "Governor", "Councilman", "Detective", "Sleuth", "Musician", "Maestro", "Conductor", "Composer", "Singer",
"Architect", "Physician", "Manager", "Usher", "Painter", "Model", "Designer", "Guest", "Attorney", "Lawyer", "Judge",
"Mayor", "Therapist", "Teacher", "Principal", "Professor", "Orator", "Man", "Woman", "Teen", "Child", "Mother",
"Father", "Sister", "Brother", "Uncle", "Aunt", "Son", "Daughter", "In-laws", "Boy", "Girl", "Nurse",
"Sibling", "Settler", "Pioneer", "Waiter", "Hostess", "Host", "Cashier", "Attendant", "Publisher", "Witch", "Warlock",
"Ghost", "Knight", "Prince", "Princess", "Maiden", "Godmother", "Fairy", "Petal", "Sepal", "Stamen", "Pineboughs",
"Bud", "Branch", "Blossom", "Fruit", "Bloom", "Tree", "Maple", "Elm", "Oak", "Palm", "Baobab",
"Mangrove", "Cyprus", "Pine", "Dogwood", "Alder", "Flowers", "Rose", "Tulip", "Cyclamen", "Lily", "Carnations",
"Wisteria", "Flytrap", "Hoe", "Weeds", "Plants", "Canes", "Palms", "Apple", "Lemon", "Orange", "Grapefruit",
"Tangerine", "Peach", "Tomato", "Banana", "Vegetables", "Artichokes", "Leeks", "Lettuce", "Eggplants", "Zucchini", "Squash",
"Pumpkin", "Cabbage", "Pepper", "Onion", "Garlic", "Poison", "Venom", "Fire", "Ship", "Ferryboat", "Oceanliner",
"Oars", "Sails", "Dinghy", "Yacht", "Canoe", "Catamaran", "Gondola", "Boat", "Battleship", "Clipper", "Dhow",
"Flatboat", "Houseboat", "Galleon", "Frigate", "Hydrofoil", "Junk", "Ketch", "Yawl", "Submarine", "Schooner", "Scow",
"Flatbed", "Suv", "Van", "Caboose", "Train", "Bullet", "Metro", "Subway", "Cart", "Taxi", "Car",
"Racingcar", "Buggy", "Dunebuggy", "Dragster", "Motorcycle", "Gokart", "Limo", "Stretch", "Wagon", "Trolley", "Tram",
"Bus", "Parachute", "Tractor", "Trailer", "Golfkart", "Jeep", "Bigrig", "Bulldozer", "Dumptruck", "Towtruck", "Engine",
"Fireengine", "Policecar", "Tank", "Locomotive", "Ocean", "Oasis", "Sea", "Lake", "Saltlake", "Seafoam", "Waves",
"Bubbles", "Current", "Waterbasin", "Bridge", "Harbor", "Pond", "Wharf", "Pier", "Dock", "Port", "Shore",
"Beach", "Sandbar", "Coast", "River", "Brook", "Rivulet", "Puddle", "Waterfall", "Cascades", "Canal", "Channel",
"Stream", "Creek", "Marsh", "Bog", "Swamp", "Bayou", "Estuary", "Whirlpool", "Eddy", "Geyser", "Well",
"Monsoon", "Hurricane", "Typhoon", "Air", "Snow", "Rain", "Sleet", "Storm", "Hail", "Blizzard", "Wind",
"Breeze", "Gale", "Whirlwind", "Maelstrom", "Duststorm", "Cloudburst", "Tornado", "Twister", "Clouds", "Fog", "Peasoup",
"Floods", "Flashflood", "Acidrain", "Tremors", "Lightning", "Avalanche", "Eclipse", "Alpenglow", "Tsunami", "Waterspout", "Smog",
"Aneroid", "Barometer", "Radiosonde", "Station", "Map", "Chalice", "Bijou", "Candelabra", "Menorah", "Curio", "Figurine",
"Music-box", "Objetd'art", "Trinket", "Trims", "Windchimes", "Birdcage", "Birdbath", "Cans", "Urn", "Bucket", "Arrow",
"Bow", "Sword", "Dart", "Epee", "Dagger", "Hatchet", "Pickax", "Dolls", "Broom", "Mop", "Pail",
"Squeegee", "Caddy", "Telephone", "Pipe", "Paints", "Brushes", "Easel", "Canvas", "Trunk", "Hook", "Gun",
"Glue", "Tissue", "Toilet", "Kleenex", "Papertowel", "Ropes", "Rubber", "Coil", "Toys", "Dogleash", "Balloon",
"Vases", "Planters", "Pen", "Pad", "Typewriter", "Computer", "Laptop", "Netbook", "Stylus", "Pencil", "Desk",
"Backpack", "Shoerack", "Notebook", "Vellum", "Chalk", "Badge", "Saddle", "Spurs", "Paper", "Rollbook", "Guestbook",
"Pot", "Plate", "Dishes", "Fork", "Spoons", "Knives", "Knife", "Samovar", "Sky", "Forest", "Heaven",
"Hell", "Earth", "Sun", "Star", "Planet", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus",
"Neptune", "Ceres", "Pluto", "Haumea", "Makemake", "Eris", "Outerspace", "Town", "Village", "City", "Country",
"Farm", "Suburb", "Roads", "Streets", "Blocks", "Zoo", "Park", "Museum", "Cemetery", "Tunnels", "Caves",
"Churches", "Temples", "Mall", "Dresser", "Armoire", "Chiffonier", "Credenza", "Console", "Bookcase", "Buffet", "Armchair",
"Recliner", "Easychair", "Bench", "Banquette", "Chair", "Couch", "Davenport", "Sofa", "Ottoman", "Deckchair", "Loveseat",
"Highseat", "Divan", "Inglenook", "Pew", "Throne", "Sectional", "Stool", "Pottychair", "Workbench", "Nighttable", "Bed",
"Daybed", "Bassinet", "Crib", "Cradle", "Cot", "Futon", "Hammock", "Tatamimat", "Waterbed", "Trundlebed", "Hassock",
"Hatrack", "Stepstool", "Footrest", "Footstool", "Tripod", "Mirror", "Nightlight", "Torchiere", "Sunlamp", "Spotlight", "Ceilingfan",
"Cupboard", "Cardtable", "Hutch", "Locker", "Wetbar", "Vanity", "Rack", "Hopechest", "Sculpture", "Painting", "Eye",
"Pupil", "Iris", "Retina", "Eyeball", "Eyelids", "Eyelashes", "Eyebrows", "Lap", "Waist", "Belly", "Tummy",
"Rearend", "Crotch", "Abdomen", "Beard", "Mustache", "Sideburns", "Fingernail", "Hand", "Forearm", "Arm", "Knuckles",
"Thumb", "Wrist", "Elbow", "Leg", "Toes", "Knee", "Ankle", "Shin", "Thigh", "Hip", "Breast",
"Chest", "Torso", "Tongue", "Lips", "Gums", "Mouth", "Teeth", "Bones", "Spine", "Throat", "Lungs",
"Kidneys", "Intestines", "Colon", "Spleen", "Glands", "Blood", "Head", "Skull", "Brain", "Muscle", "Hair",
"Xylophone", "Clavier", "Virginal", "Lute", "Drum", "Frenchhorn", "Piano", "Violin", "Cello", "Guitar", "Flute",
"Tuba", "Harp", "Mariachi", "Orchestra", "Oboe", "Bassoon", "Woodwinds", "Brass", "Viola", "Kettledrum", "Peyotedrum",
"Tambourine", "Tambour", "Saxophone", "Marimba", "Maracas", "Shofar", "Cymbals", "Kazoo", "Dulcimer", "Accordion", "Lyre",
"Fiddle", "Banjo", "Balalaika", "Sitar", "Ukulele", "Zither", "Bagpipes", "Piccolo", "Clarinet", "Cornet", "Panpipe",
"Tuningfork", "Metronome", "Castanets", "Woofer", "Sniper", "Marksman", "Cleaner", "Pyro", "Attacker", "Mechanic", "Janitor",
"Scrubber", "Garbageman", "Technician", "Ninja", "Medic", "Spy", "Assassin", "Gunman", "Triggerman", "Butcher", "Killer",
"Dodger", "Booger", "Engineer", "Doctor", "Surgeon", "Fighter", "Shooter", "Gunner", "Soldier", "Officer", "Veteran",
"Scout", "Mercenary", "Commando", "Cadet", "Guard", "Warrior", "Trooper", "Gambler", "Specialist", "Shaper", "Finisher",
"Gladiator", "Boxer", "Wrestler", "Warlord", "Rival", "Armory", "Agent", "Rebel", "Brawler", "Bruiser", "Bully",
"Champion", "Hero", "Battler", "Combatant", "Fencer", "Swordsman", "Expert", "Gangster", "Gangsta", "Bandit", "Hoodlum",
"Mobster", "Robber", "Thief", "Burglar", "Pirate", "Thug", "Hitman", "Hitperson", "Dealer", "Desperado", "Criminal",
"Crook", "Hijacker", "Carjacker", "Villain", "Convict", "Fugitive", "Mug", "Outlaw", "Ruffian", "Cutthroat", "Devil",
"Murderer", "Psycho", "Punk", "ASBO", "Offender", "Drifter", "Rioter", "Goon", "Roughneck", "Brute", "Hacker",
"Cabbie", "Wheeler", "Driver", "Rider", "Cyclist", "Cowboy", "Operative", "Carrier", "Transporter", "Trucker", "Wheelman",
"Vampire", "Parasite", "Tramp", "Bum", "Hobo", "Hitchhiker", "Deadbeat", "Acrobat",
}

function isPlayerNameRandomized(name)
if type(name) ~= "string" then
return false
end

local prefix, num = name:match("^(.-)(%d+)$")
if not prefix or not num then
return false
end

if not tonumber(num) or tonumber(num) < 0 or tonumber(num) > 100 then
return false
end

for _, first in ipairs(firstName) do
if prefix:sub(1, #first) == first then
local rest = prefix:sub(#first + 1)

for _, second in ipairs(secondName) do
if rest == second then
return true
end
end
end
end

return false
end
</syntaxhighlight>
</section>

==Example==
The example shows how to use function.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onPlayerConnect", root,
function(playerNick)
if isPlayerNameRandomized(playerNick) then
cancelEvent(true, "Newbie players are not allowed!")
end
end
)
</syntaxhighlight>
</section>

<br>
Author: [https://wiki.multitheftauto.com/wiki/User:O22 omar-o22]
<br>
Idea from: [https://github.com/multitheftauto/mtasa-blue/issues/2103 Issue#2103]
==See Also==
{{Useful_Functions}}

PT-BR/OnPlayerLogin

2025-10-23T01:31:50Z

Lettify:

__NOTOC__
{{PT-BR/Server event}}
Este evento é acionado quando um jogador se conecta em sua conta dentro do jogo.

==Parâmetros==
<syntaxhighlight lang="lua">
account thePreviousAccount, account theCurrentAccount
</syntaxhighlight>

*'''thePreviousAccount''': A [[account|conta]] que o jogador se conectou anteriormente.
*'''theCurrentAccount''': A [[account|conta]] que o jogador se conectou agora.

==Source==
O [[event system#Event source|source]] deste evento é o [[Elemento/Player|elemento jogador]] que se conectou em sua conta.

==Efeito do cancelamento==
Se este evento é [[cancelEvent|cancelado]], o jogador não se conectará em sua conta.

==Exemplo==
Este exemplo apenas exibe ao console do jogador que um jogador que estava conectado em uma conta, se conectou em outra:
<syntaxhighlight lang="lua">
addEventHandler("onPlayerLogin", root,
function()
outputChatBox(getPlayerName(source).." has logged in!", root)
end
)
</syntaxhighlight>
Este exemplo permite apenas que seriais inseridos manualmente consigam acessar as determinadas contas.
<syntaxhighlight lang="lua">
Firewall =
{
-- [ 'accountName' ] = 'playerSerial',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if Serial and Serial ~= getPlayerSerial ( source ) then
outputChatBox( "Sorry, you're not allowed to access this account.", source)
cancelEvent( true )
end
end
)
</syntaxhighlight>

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

[[ru:onPlayerLogin]]
[[pt-br:onPlayerLogin]]

Astrath:createTab

2025-10-22T20:23:32Z

Sybellex:

= DxTab:new =

{{Client function}}
{{FuncDef|element DxTab:new ( element parent, string text, table color, table hoverColor, table activeColor, table tabColor )}}

'''Description:'''
Creates a new tab element inside a `DxTabPanel`. Tabs are linked to a panel and their positions are automatically managed according to the panel layout. Only usable with a valid `DxTabPanel` parent.

'''Parameters:'''
* parent (element) – A `DxTabPanel` element where this tab will be attached (required).
* text (string) – The text to display on the tab (optional, default: 'tab').
* color (table / tocolor) – The main color of the tab (optional, defaults to parent's color).
* hoverColor (table / tocolor) – Color when hovering (optional, defaults to parent's hoverColor).
* activeColor (table / tocolor) – Color when tab is active (optional, defaults to parent's activeColor).
* tabColor (table / tocolor) – Base color for inactive tabs (optional, defaults to parent's tabColor).

'''Returns:'''
: Returns the newly created `DxTab` element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the tab and removes it from the parent panel.
|-
| Ath:setVisible(boolean) || Shows or hides the tab and triggers reordering in the panel.
|-
| Ath:setEnabled(boolean) || Enables or disables the tab.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effects for this tab.
|-
| Ath:setColor(r, g, b, a, type) || Sets the tab's color. Type can be 'mainColor', 'hoverColor', 'tabColor', 'activeColor'.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Crear un tab panel
local tabPanel = DxTabPanel:new(100, 100, 400, 300)
tabPanel:setVisible(true)

-- Agregar tabs
local tab1 = DxTab:new(tabPanel, "Tab 1")
local tab2 = DxTab:new(tabPanel, "Tab 2", tocolor(200,0,0,255))

-- Establecer tab seleccionado
tabPanel:setSelected(tab1)

</syntaxhighlight>

'''See also:'''
* [[DxTabPanel:new]] – The panel container required for tabs
* [[onClientRender]] – Event used to draw DX elements each frame
* [[adjustAlpha]] – Function used internally to adjust tab opacity

Astrath:createTabPanel

2025-10-22T20:19:50Z

Sybellex: Created page with "= DxTabPanel:new = {{Client function}} {{FuncDef|element DxTabPanel:new ( float posX, float posY, float width, float height, element parent, boolean relative, table color, table tabColor, table activeColor, table hoverColor, string font, float fontsize, string style, string tabStyle )}} '''Description:''' Creates a new tab panel DX element. A tab panel can hold multiple tabs and manage their selection and hover states. Automatically adjusts child tab positions and size..."

= DxTabPanel:new =

{{Client function}}
{{FuncDef|element DxTabPanel:new ( float posX, float posY, float width, float height, element parent, boolean relative, table color, table tabColor, table activeColor, table hoverColor, string font, float fontsize, string style, string tabStyle )}}

'''Description:'''
Creates a new tab panel DX element. A tab panel can hold multiple tabs and manage their selection and hover states. Automatically adjusts child tab positions and sizes.

'''Parameters:'''
* posX, posY (float) – Position of the tab panel on screen.
* width, height (float) – Dimensions of the tab panel.
* parent (element) – Parent DX element to attach this panel to (optional).
* relative (boolean) – Position relative to parent (optional).
* color (table / tocolor) – Main background color of the panel (optional, default: dark grey).
* tabColor (table / tocolor) – Default color for tabs (optional).
* activeColor (table / tocolor) – Color for the active tab (optional).
* hoverColor (table / tocolor) – Hover color for tabs (optional).
* font (string) – Font used for tab text (optional, default: "default-bold").
* fontsize (float) – Font size for tab text (optional, default: 1).
* style (string) – DX style used for the panel (optional).
* tabStyle (string) – DX style used for tabs (optional).

'''Returns:'''
: Returns the newly created DxTabPanel element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the tab panel and all child tabs and elements.
|-
| Ath:setVisible(boolean) || Shows or hides the tab panel.
|-
| Ath:setEnabled(boolean) || Enables or disables the tab panel for interaction.
|-
| Ath:addTab(text) || Adds a new tab with the given text to the panel.
|-
| Ath:getSelected() || Returns the currently selected tab element.
|-
| Ath:setSelected(tabElement) || Sets a specific tab as selected.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect for tabs.
|-
| Ath:setColor(r, g, b, a, type) || Sets colors for the panel or tabs. Type can be 'mainColor', 'hoverColor', 'tabColor', 'activeColor'.
|}

'''Example:'''
<syntaxhighlight lang="lua">
local tabPanel = DxTabPanel:new(100, 100, 400, 300)
tabPanel:setVisible(true)
tabPanel:addTab("Tab 1")
tabPanel:addTab("Tab 2")
tabPanel:draw()
</syntaxhighlight>

'''See also:'''
* [[DxTab:new]] – Page for individual tab elements
* [[DxWindow:new]] – For window parent reference
* [[onClientRender]] – Event to render DX elements

Astrath:createShape

2025-10-22T20:17:10Z

Sybellex: Created page with "= DxShape:new = {{Client function}} {{FuncDef|element DxShape:new ( float posX, float posY, float width, float height, element parent, boolean relative, table color )}} '''Description:''' Creates a new DX-based shape element. Shapes can have custom colors, hover effects, and rounded corners. Each shape instance is automatically registered in the DX library. '''Parameters:''' * posX, posY (float) – Position on screen. * width, height (float) – Size of the shape. *..."

= DxShape:new =

{{Client function}}
{{FuncDef|element DxShape:new ( float posX, float posY, float width, float height, element parent, boolean relative, table color )}}

'''Description:'''
Creates a new DX-based shape element. Shapes can have custom colors, hover effects, and rounded corners. Each shape instance is automatically registered in the DX library.

'''Parameters:'''
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the shape.
* parent (element) – Parent DX element to attach this shape to (optional).
* relative (boolean) – Position relative to parent (optional).
* color (table / tocolor) – Main color of the shape (optional, default: grey).

'''Returns:'''
: Returns the newly created DxShape element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the shape and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the shape.
|-
| Ath:setEnabled(boolean) || Enables or disables the shape for interaction.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets main or hover color of the shape.
|}

'''Example:'''
<syntaxhighlight lang="lua">
local myShape = DxShape:new(100, 100, 200, 150)
myShape:setVisible(true)
myShape:setHoverable(true)
myShape:setColor(150, 150, 150, 255, "mainColor")
myShape:draw()
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxLabel:new]] – Page for label element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createRadio

2025-10-22T20:15:27Z

Sybellex: Created page with "= DxRadio:new = {{Client function}} {{FuncDef|element DxRadio:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string key, string font, float fontsize )}} '''Description:''' Creates a new DX-based radio button element. Radio buttons are single-select controls grouped by a key, allowing only one selection per group. Each radio instance is automatically registered in the DX library. '''Parameters:''' * text (string)..."

= DxRadio:new =

{{Client function}}
{{FuncDef|element DxRadio:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string key, string font, float fontsize )}}

'''Description:'''
Creates a new DX-based radio button element. Radio buttons are single-select controls grouped by a key, allowing only one selection per group. Each radio instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – Label text for the radio button (optional, default: "radiobutton").
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the radio button.
* parent (element) – Parent DX element to attach this radio button to (optional).
* relative (boolean) – Position relative to parent (optional).
* key (string) – Group key to identify radio button group (optional, default: "Default").
* font (string) – Font used for text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).

'''Returns:'''
: Returns the newly created DxRadio element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the radio element and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the radio button.
|-
| Ath:setEnabled(boolean) || Enables or disables the radio button for interaction.
|-
| Ath:setSelected() || Selects this radio button and deselects others in the same group.
|-
| Ath:getSelected() || Returns whether this radio button is selected.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets main, hover, or selected color of the radio button.
|}

'''Example:'''
<syntaxhighlight lang="lua">
local myRadio = DxRadio:new("Option 1", 100, 100, 150, 30)

myRadio:setVisible(true)
myRadio:setHoverable(true)
myRadio:setColor(200, 200, 200, 200, "mainColor")
myRadio:setColor(30, 30, 30, 255, "selectColor")
myRadio:setSelected()
myRadio:draw()
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxLabel:new]] – Page for label element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createMemo

2025-10-22T20:14:10Z

Sybellex: Created page with "= DxMemo:new = {{Client function}} {{FuncDef|element DxMemo:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize )}} '''Description:''' Creates a new DX-based memo element. Memos are multi-line text boxes that support scrolling, cursor positioning, text input, custom fonts, colors, and read-only mode. Each memo instance is automatically registered in the DX library. '''Parameters:''' * text..."

= DxMemo:new =

{{Client function}}
{{FuncDef|element DxMemo:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize )}}

'''Description:'''
Creates a new DX-based memo element. Memos are multi-line text boxes that support scrolling, cursor positioning, text input, custom fonts, colors, and read-only mode. Each memo instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – Initial text content for the memo (optional).
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the memo.
* parent (element) – Parent DX element to attach this memo to (optional).
* relative (boolean) – Position relative to parent (optional).
* font (string) – Font used for the text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).

'''Returns:'''
: Returns the newly created DxMemo element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the memo element and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the memo.
|-
| Ath:setEnabled(boolean) || Enables or disables the memo for interaction.
|-
| Ath:setText(string) || Sets the memo text.
|-
| Ath:getText() || Returns the current memo text.
|-
| Ath:clear() || Clears all text and resets the cursor.
|-
| Ath:setReadOnly(boolean) || Enables or disables read-only mode.
|-
| Ath:getReadOnly() || Returns whether the memo is read-only.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main or hover background color.
|}

'''Example:'''
<syntaxhighlight lang="lua">
local myMemo = DxMemo:new("Hello World", 100, 100, 300, 200)

myMemo:setVisible(true)
myMemo:setReadOnly(false)
myMemo:setHoverable(true)
myMemo:setColor(255, 255, 255, 255, "mainColor")
myMemo:setText("Welcome to MTA DX Memo")
myMemo:draw()
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxLabel:new]] – Page for label element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createLabel

2025-10-22T20:12:06Z

Sybellex: Created page with "= DxLabel:new = {{Client function}} {{FuncDef|element DxLabel:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string horizontalAlign, string verticalAlign )}} '''Description:''' Creates a new DX-based label element. Labels display text, support parent-relative positioning, custom fonts, colors, alignment, and optional hover effects. Each label instance is automatically registered in th..."

= DxLabel:new =

{{Client function}}
{{FuncDef|element DxLabel:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string horizontalAlign, string verticalAlign )}}

'''Description:'''
Creates a new DX-based label element. Labels display text, support parent-relative positioning, custom fonts, colors, alignment, and optional hover effects. Each label instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – Text to display in the label.
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the label.
* parent (element) – Parent DX element to attach this label to (optional).
* relative (boolean) – Position relative to parent (optional).
* font (string) – Font used for the text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).
* horizontalAlign (string) – Horizontal alignment ("left", "center", "right", optional, default: "center").
* verticalAlign (string) – Vertical alignment ("top", "center", "bottom", optional, default: "center").

'''Returns:'''
: Returns the newly created DxLabel element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the label element and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the label.
|-
| Ath:setEnabled(boolean) || Enables or disables the label for interaction.
|-
| Ath:setText(string) || Sets the label text.
|-
| Ath:getText() || Returns the current label text.
|-
| Ath:setFont(string) || Changes the label font.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main or hover text color.
|-
| Ath:setHorizontalAlign(string) || Sets horizontal alignment of the text.
|-
| Ath:setVerticalAlign(string) || Sets vertical alignment of the text.
|}

'''Example:'''
<syntaxhighlight lang="lua">
local myLabel = DxLabel:new("Hello World", 100, 100, 200, 50)

myLabel:setVisible(true)
myLabel:setHoverable(true)
myLabel:setText("Welcome")
myLabel:setColor(255, 200, 0, 255, "mainColor")
myLabel:setHorizontalAlign("center")
myLabel:setVerticalAlign("center")
myLabel:draw()
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxButton:new]] – Page for button element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createImage

2025-10-22T19:59:06Z

Sybellex:

= DxImage:new =

{{Client function}}
{{FuncDef|element DxImage:new ( string path, float posX, float posY, float width, float height, element parent, boolean relative )}}

'''Description:'''
Creates a new DX-based image element. Images can be attached to parent elements, support transparency, custom styles, and optional parent-relative positioning. Each image instance is automatically registered in the DX library.

'''Parameters:'''
* path (string) – Path to the image file. Must exist.
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the image.
* parent (element) – Parent DX element to attach this image to (optional).
* relative (boolean) – Position relative to parent (optional).

'''Returns:'''
: Returns the newly created DxImage element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the image element and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the image.
|-
| Ath:setEnabled(boolean) || Enables or disables the image for interaction.
|-
| Ath:setAlpha(number) || Sets the image transparency (0–255).
|}

'''Example:'''
<syntaxhighlight lang="lua">
local myImage = DxImage:new("images/logo.png", 100, 100, 200, 150)

myImage:setVisible(true)
myImage:setAlpha(200)
myImage:setPath("images/new_logo.png")
myImage:draw()
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxLabel:new]] – Page for label element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createHidden

2025-10-22T19:56:22Z

Sybellex: Created page with "= DxHidden:new = {{Client function}} {{FuncDef|element DxHidden:new ( float posX, float posY, float width, float height, element parent, boolean relative )}} '''Description:''' Creates a hidden DX element. Hidden elements are not drawn and can be used as containers or invisible parents for other DX elements. They can store position and size information and manage child elements. '''Parameters:''' * posX, posY (float) – Position on screen. * width, height (float)..."

= DxHidden:new =

{{Client function}} {{FuncDef|element DxHidden:new ( float posX, float posY, float width, float height, element parent, boolean relative )}}

'''Description:'''
Creates a hidden DX element. Hidden elements are not drawn and can be used as containers or invisible parents for other DX elements. They can store position and size information and manage child elements.

'''Parameters:'''
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the hidden element.
* parent (element) – Parent DX element to attach this hidden element to (optional).
* relative (boolean) – Position relative to parent (optional).

'''Returns:'''
: Returns the newly created DxHidden element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the hidden element and all its child elements.
|-
| Ath:setVisible(boolean) || Sets the visibility state of the hidden element (mostly for management, as hidden elements are not drawn).
|-
| Ath:setEnabled(boolean) || Enables or disables the element for internal logic or child interaction.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a hidden element at position 100x100 with size 200x200
local hidden = DxHidden:new(100, 100, 200, 200)

-- Set it invisible (default, but can be toggled)
hidden:setVisible(false)

-- Enable it for internal logic
hidden:setEnabled(true)

-- Use as parent for other DX elements
local btn = DxButton:new("Click Me", 10, 10, 100, 40, hidden)
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Example of visible container element
* [[DxButton:new]] – Example of child element

Astrath:createGridList

2025-10-22T19:52:02Z

Sybellex:

= DxEdit:new =
{{Client function}} {{FuncDef|element DxGridlist:new ( float posX, float posY, float width, float height, element parent, boolean relative, table columnSize, string font, float fontSize, table color, table headColor, table hoverColor, table activeColor, table scrollColor, table scrollBGColor )}}

'''Description:'''
Creates a new DX-based gridlist element. Gridlists display rows and columns of data, support scrolling, hover effects, row selection, and customizable colors and fonts. Each gridlist instance is automatically registered in the DX library.

'''Parameters:'''
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the gridlist.
* parent (element) – Parent DX element to attach this gridlist to (optional).
* relative (boolean) – Position relative to parent (optional).
* columnSize (table / number / 'auto') – Width of columns, can be 'auto' to divide evenly.
* font (string) – Font used for text (optional, default: "default-bold").
* fontSize (float) – Font size multiplier (optional, default: 1).
* color, headColor, hoverColor, activeColor (table / tocolor) – Main, header, hover, and active row colors (optional).
* scrollColor, scrollBGColor (table / tocolor) – Scrollbar colors (optional).

'''Returns:'''
: Returns the newly created DxGridlist element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the gridlist and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the gridlist.
|-
| Ath:setEnabled(boolean) || Enables or disables the gridlist for interaction.
|-
| Ath:addColumn(title, textAlign, columnSize) || Adds a new column with optional alignment and width.
|-
| Ath:addRow(...) || Adds a new row with the given items.
|-
| Ath:clear() || Clears all rows from the gridlist.
|-
| Ath:setColumnTitle(idOrName, newTitle) || Changes the title of a column by ID or name.
|-
| Ath:setItemText(columnID, rowID, text) || Sets the text of a specific cell.
|-
| Ath:getItemText(columnID, rowID) || Returns the text of a specific cell.
|-
| Ath:getColumnCount() || Returns the total number of columns.
|-
| Ath:getRowCount() || Returns the total number of rows.
|-
| Ath:removeColumn(columnID) || Removes a column by its ID.
|-
| Ath:removeRow(rowID) || Removes a row by its ID.
|-
| Ath:getRowText(columnID, rowID) || Returns the text of a cell at a given row and column.
|-
| Ath:getSelectedRowID() || Returns the currently selected row ID.
|-
| Ath:getSelectedRowItem() || Returns all items in the currently selected row.
|-
| Ath:setSelectedRowID(id) || Sets the selected row by ID.
|-
| Ath:addChildDxElement(element) || Adds a child element to the gridlist.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets colors for main, hover, header, active, or scroll elements.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a gridlist at position 200x150 with size 400x300
local myGrid = DxGridlist:new(200, 150, 400, 300)

-- Add columns
myGrid:addColumn("ID", "center", 0.1)
myGrid:addColumn("Name", "left", 0.45)
myGrid:addColumn("Score", "right", 0.45)

-- Add rows
myGrid:addRow(1, "Alice", 95)
myGrid:addRow(2, "Bob", 88)
myGrid:addRow(3, "Charlie", 76)

-- Set selected row
myGrid:setSelectedRowID(2)

-- Change main color
myGrid:setColor(50, 50, 50, 255, "mainColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxButton:new]] – Page for button element reference
* [[DxCombobox:new]] – Page for combobox element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createEditBox

2025-10-22T19:48:22Z

Sybellex: Created page with "= DxEdit:new / Astrath:createEditBox = {{Client function}} {{FuncDef|element DxEdit:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string placeholder )}} '''Description:''' Creates a new DX-based edit box element. Edit boxes allow text input with options for read-only mode, numeric-only input, hover effects, and color customization. Each edit box instance is automatically registered i..."

= DxEdit:new / Astrath:createEditBox =

{{Client function}}
{{FuncDef|element DxEdit:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize, string placeholder )}}

'''Description:'''
Creates a new DX-based edit box element. Edit boxes allow text input with options for read-only mode, numeric-only input, hover effects, and color customization. Each edit box instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – Initial text for the edit box (optional).
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the edit box.
* parent (element) – Parent DX element to attach this edit box to (optional).
* relative (boolean) – Position relative to parent (optional).
* font (string) – Font used for the text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).
* placeholder (string) – Placeholder text when the edit box is empty (optional).

'''Returns:'''
: Returns the newly created DxEdit element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the edit box and all its child elements.
|-
| Ath:clear() || Clears all text and resets the cursor.
|-
| Ath:setVisible(boolean) || Shows or hides the edit box.
|-
| Ath:setEnabled(boolean) || Enables or disables the edit box for interaction.
|-
| Ath:setReadOnly(boolean) || Enables or disables read-only mode.
|-
| Ath:setNumericOnly(boolean) || Enables numeric-only input.
|-
| Ath:getReadOnly() || Returns whether the edit box is in read-only mode.
|-
| Ath:setText(string) || Sets the text of the edit box.
|-
| Ath:getText() || Returns the current text of the edit box.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main background or hover color of the edit box.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create an edit box at position 400x200 with size 200x25
local myEdit = DxEdit:new("", 400, 200, 200, 25)

-- Set placeholder text
myEdit.placeholder = "Enter your name..."

-- Enable numeric only
myEdit:setNumericOnly(true)

-- Show edit box and enable hover
myEdit:setVisible(true)
myEdit:setHoverable(true)

-- Set background color to light grey
myEdit:setColor(200, 200, 200, 255, "mainColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxButton:new]] – Page for button element reference
* [[DxCheckbox:new]] – Page for checkbox element reference
* [[DxCombobox:new]] – Page for combobox element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createComboBox

2025-10-22T19:43:32Z

Sybellex: /* DxCombobox:new / Astrath:createCombobox */

= DxCombobox:new =

{{Client function}}
{{FuncDef|element DxCombobox:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string desc, number maxItems, table color, string font, float fontSize, table scrollColor, table scrollBGColor )}}

'''Description:'''
Creates a new DX-based combobox element. Comboboxes allow selecting from a list of items, support scrolling, hover effects, and color customization. Each combobox instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – The default text displayed on the combobox.
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the combobox.
* parent (element) – Parent DX element to attach this combobox to (optional).
* relative (boolean) – Position relative to parent (optional).
* desc (string) – Default placeholder text when no item is selected (optional).
* maxItems (number) – Maximum number of items displayed at once (optional, default: 10).
* color (table / tocolor) – Base color for bar, button, and body (optional).
* font (string) – Font used for text (optional, default: "default-bold").
* fontSize (float) – Font size multiplier (optional, default: 1).
* scrollColor, scrollBGColor (table / tocolor) – Scrollbar colors (optional).

'''Returns:'''
: Returns the newly created DxCombobox element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the combobox and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the combobox.
|-
| Ath:setEnabled(boolean) || Enables or disables the combobox for interaction.
|-
| Ath:setText(string) || Sets the text displayed on the combobox.
|-
| Ath:addItem(string) || Adds a new item to the combobox list.
|-
| Ath:removeItem(number) || Removes an item from the list by its index.
|-
| Ath:clear() || Removes all items from the combobox.
|-
| Ath:setItemText(number, string) || Updates the text of an item at a given index.
|-
| Ath:getItemText(number) || Returns the text of an item by index.
|-
| Ath:setSelected(number) || Sets the selected item by index.
|-
| Ath:getSelected() || Returns the index of the currently selected item.
|-
| Ath:getItemCount() || Returns the total number of items in the combobox.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the color of bar, button, body, or hover.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a combobox at position 400x200 with size 150x25
local myCombo = DxCombobox:new("Select Item", 400, 200, 150, 25)

-- Add items
myCombo:addItem("Option 1")
myCombo:addItem("Option 2")
myCombo:addItem("Option 3")

-- Show combobox and enable hover
myCombo:setVisible(true)
myCombo:setHoverable(true)

-- Select second item
myCombo:setSelected(2)

-- Change bar color
myCombo:setColor(255, 255, 255, 255, "barColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxButton:new]] – Page for button element reference
* [[DxCheckbox:new]] – Page for checkbox element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createCheckBox

2025-10-22T19:40:13Z

Sybellex: /* DxCheckbox:new / Astrath:createCheckbox */

= DxCheckbox:new =

{{Client function}}
{{FuncDef|element DxCheckbox:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, string font, float fontsize )}}

'''Description:'''
Creates a new DX-based checkbox element. Checkboxes can be attached to parent elements, support hover effects, custom colors, and selection state. Each checkbox instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – The label text of the checkbox. Defaults to "radio".
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the checkbox.
* parent (element) – Parent DX element to attach this checkbox to (optional).
* relative (boolean) – Position relative to parent (optional).
* font (string) – Font used for text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).

'''Returns:'''
: Returns the newly created DxCheckbox element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the checkbox and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the checkbox.
|-
| Ath:setEnabled(boolean) || Enables or disables the checkbox for interaction.
|-
| Ath:isSelected() || Returns whether the checkbox is currently selected.
|-
| Ath:setSelected(boolean) || Sets the checkbox selection state.
|-
| Ath:getSelected() || Returns the current selection state.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main, hover, or select color of the checkbox.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a checkbox at position 300x400 with size 20x20
local myCheckbox = DxCheckbox:new("Accept Terms", 300, 400, 20, 20)

-- Show the checkbox and enable hover effect
myCheckbox:setVisible(true)
myCheckbox:setHoverable(true)

-- Set selection state
myCheckbox:setSelected(true)

-- Change colors
myCheckbox:setColor(255, 255, 255, 255, "mainColor")
myCheckbox:setColor(0, 255, 0, 200, "hoverColor")
myCheckbox:setColor(0, 200, 0, 255, "selectColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxButton:new]] – Page for button element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createButton

2025-10-22T19:33:36Z

Sybellex: /* DxButton:new */

= DxButton:new =

{{Client function}}
{{FuncDef|element DxButton:new ( string text, float posX, float posY, float width, float height, element parent, boolean relative, table color, string font, float fontsize, string description, boolean isIcon, float iconWidth, float iconHeight )}}

'''Description:'''
Creates a new DX-based button element. Buttons can be attached to parent elements, support hover effects, custom colors, icons, fonts, and descriptions. Each button instance is automatically registered in the DX library.

'''Parameters:'''
* text (string) – The button label text. Defaults to "Button".
* posX, posY (float) – Position on screen.
* width, height (float) – Size of the button.
* parent (element) – Parent DX element to attach this button to (optional).
* relative (boolean) – Position relative to parent (optional).
* color (table / tocolor) – Main background color (optional).
* font (string) – Font used for text (optional, default: "default-bold").
* fontsize (float) – Font size multiplier (optional, default: 1).
* description (string) – Optional description text.
* isIcon (boolean) – If true, the button will display an icon instead of text.
* iconWidth, iconHeight (float) – Size of the icon relative to the button (optional).

'''Returns:'''
: Returns the newly created DxButton element.

'''Methods:'''
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the button and all its child elements.
|-
| Ath:setVisible(boolean) || Shows or hides the button.
|-
| Ath:setEnabled(boolean) || Enables or disables the button for interaction.
|-
| Ath:setText(string) || Sets the button text.
|-
| Ath:getText() || Returns the current button text.
|-
| Ath:setDescription(string) || Sets the button description.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main or hover color of the button.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a button at position 200x300 with size 150x50
local myButton = DxButton:new("Click Me", 200, 300, 150, 50)

-- Show the button and enable hover effect
myButton:setVisible(true)
myButton:setHoverable(true)

-- Change text and color
myButton:setText("Press Me")
myButton:setColor(255, 0, 0, 255, "mainColor")
</syntaxhighlight>

'''See also:'''
* [[Astrath]] – Main library page
* [[DxWindow:new]] – Page for window element reference
* [[DxLabel:new]] – Page for label element reference
* [[onClientRender]] – Event used to render DX elements

Astrath:createWindow

2025-10-22T18:49:37Z

Sybellex:

= DxWindow:new=

{{Client function}}
{{FuncDef|element DxWindow:new ( string title, float posX, float posY, float width, float height, table color, element parent, boolean relative, boolean header, float headerSize, table headerColor, string font, float fontsize )}}

'''Description:'''
Creates a new DX-based window element. The window can contain child DX elements, supports customization of colors, fonts, header, and can be attached to a parent element. Each window instance is automatically registered in the DX library for rendering and management.

'''Parameters:'''
* title (string) – The title text displayed on the window. Defaults to "New window" if not provided.
* posX (float) – X position on screen.
* posY (float) – Y position on screen.
* width (float) – Width of the window.
* height (float) – Height of the window.
* color (table / tocolor) – Main background color in RGBA. Optional.
* parent (element) – Parent DX element to attach this window to. Optional.
* relative (boolean) – If true, position will be calculated relative to parent. Optional.
* header (boolean) – If true, the window will display a header. Optional.
* headerSize (float) – Relative size of the header. Defaults to 5% of height.
* headerColor (table / tocolor) – Header color in RGBA. Defaults to tocolor(91, 57, 219, 255).
* font (string) – Font used for title text. Defaults to "default-bold".
* fontsize (float) – Font size multiplier. Defaults to 1.

'''Returns:'''
: Returns the newly created DX window element (DxWindow instance).

== Methods ==
{| class="wikitable" style="width:100%; border:none;"
! Method !! Description
|-
| Ath:destroy() || Destroys the window and all its child elements.
|-
| Ath:setTitle(title) || Sets a new title for the window.
|-
| Ath:setMovable(boolean) || Enables or disables window movement.
|-
| Ath:setVisible(boolean) || Shows or hides the window.
|-
| Ath:setEnabled(boolean) || Enables or disables window for interaction.
|-
| Ath:setHoverable(boolean) || Enables or disables hover effect.
|-
| Ath:setColor(r, g, b, a, type) || Sets the main or hover color of the window.
|}

'''Example:'''
<syntaxhighlight lang="lua">
-- Create a window at position 200x200 with size 300x200
local myWindow = DxWindow:new(
"My Window", 200, 200, 300, 200, tocolor(50, 50, 50, 255), nil, false, true, 0.05, nil, "default-bold", 1
)

-- Show window and enable hover
myWindow:setVisible(true)
myWindow:setHoverable(true)
</syntaxhighlight>

'''See also:'''
* [[DxButton:new]] – For creating buttons inside windows
* [[DxLabel:new]] – For adding text labels
* [[onClientRender]] – Event used to draw DX elements
* [[Astrath]] – Main library page

Astrath

2025-10-15T15:59:02Z

Sybellex:

= Astrath =

''Astrath'' is a DirectX framework for MTA:SA developed by '''Magath'''.
It provides tools to create custom interfaces, animations, and other DX-based visuals.

== Client Functions ==
* [[Astrath:createWindow]] – Creates a new DX-based window element
* [[Astrath:createButton]] – Creates a DX-based button element
* [[Astrath:createCheckBox]] – Creates a DX-based checkbox element
* [[Astrath:createComboBox]] – Creates a DX-based combobox element
* [[Astrath:createEditBox]] – Creates a DX-based editbox element
* [[Astrath:createGridList]] – Creates a DX-based gridlist element
* [[Astrath:createHidden]] – Creates a hidden DX element (used as a parent container)
* [[Astrath:createImage]] – Draws a DX-based image
* [[Astrath:createLabel]] – Creates a DX-based label element
* [[Astrath:createMemo]] – Creates a DX-based multi-line text element
* [[Astrath:createRadio]] – Creates a DX-based radio button element
* [[Astrath:createShape]] – Creates a drawable rectangle element (can be used as parent)
* [[Astrath:createTab]] – Creates a DX-based tab element
* [[Astrath:createTabPanel]] – Creates a container for tabs

== See Also ==
* [[dxDrawImage]]
* [[dxDrawText]]
* [[onClientRender]]

GetClosestPoint

2025-10-13T18:30:05Z

IManGaaX:

{{Useful Function}} __NOTOC__
<lowercasetitle></lowercasetitle>
This function finds the closest point from a given element to a list of points in 2D space.

[[Image:GetClosestPoint2.png|thumb|256px|right|[[Image:GetClosestPoint.png|256px|right]]The difference between code No. 1 and code No. 2. The example in the image and below uses code No. 1.]]

{{Note|The example in the image and below uses code No. 1.}}

==Syntax==
<syntaxhighlight lang="lua">float, float, float getClosestPoint( element theElement, table thePoints )</syntaxhighlight>

===Required Arguments===
* '''theElement''': the element whose position is used as the reference.
* '''thePoints''': a table containing coordinates in the form {x, y, z}.

===Returns===
* Returns three ''float''s indicating the position of the element, ''x'', ''y'' and ''z'' respectively of the closest point.

==Code (1)==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function getClosestPoint(element, points)
local ex, ey, ez = getElementPosition(element)
local closestDist = math.huge
local closestPoint = nil

for _, p in ipairs(points) do
local dx, dy = p[1] - ex, p[2] - ey
local dist = dx*dx + dy*dy

if dist < closestDist then
closestDist = dist
closestPoint = p
end
end

return unpack(closestPoint)
end
</syntaxhighlight>
</section>

==Code (2)==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function getClosestPoint(element, points)
local ex, ey, ez = getElementPosition(element)
local closestDist = math.huge
local closestPoint = nil

for i = 1, #points - 1 do
local x1, y1, z1 = unpack(points[i])
local x2, y2, z2 = unpack(points[i + 1])

local t = ((ex - x1) * (x2 - x1) + (ey - y1) * (y2 - y1)) / ((x2 - x1)^2 + (y2 - y1)^2)
t = math.max(0, math.min(1, t))

local px, py = x1 + t * (x2 - x1), y1 + t * (y2 - y1)
local dist = (ex - px)^2 + (ey - py)^2
if dist < closestDist then
closestDist = dist
closestPoint = {px, py, z1 + t * (z2 - z1)}
end
end

return unpack(closestPoint)
end
</syntaxhighlight>
</section>

'''Author:''' [[User:IManGaaX|Youssef Maged (iManGaaX)]]

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local lanePoints = {
{2469.95850, -1675.36279, 14},
{2489.37866, -1653.80859, 14},
{2508.62891, -1662.11462, 14},
}

local xyz = {getClosestPoint(localPlayer, lanePoints)} --// Code (1), See the images above
outputChatBox("Closest Lane Point: "..table.concat(xyz, ", "))
</syntaxhighlight>
</section>

==See Also==

{{Useful_Functions}}

BR-PT/setElementPosition

2025-09-05T23:59:06Z

Lettify: Lettify moved page BR-PT/setElementPosition to PT-BR/setElementPosition: Wrongly titled during creation

__NOTOC__
{{BR/Funcao compartilhada}}
Esta função define a posição de um elemento para as coordenadas especificadas.
{{BR/Warning|Não use essa função para ''spawnar'' um [[Elemento/Player|jogador]]. Isso vai causar problemas com outras funções, como [[warpPedIntoVehicle]]. Em vez disso, use [[spawnPlayer]].}}

==Sintaxe==
<syntaxhighlight lang="lua">
bool setElementPosition ( element theElement, float x, float y, float z [, bool warp = true ] )
</syntaxhighlight>
{{BR/OOP||[[PT-BR/Elemento|elemento]]:setPosition|position|getElementPosition}}

===Argumentos Necessários===
*'''theElement:''' Um [[PT-BR/Elemento|elemento]] válido para ser movido.
*'''x:''' A coordenada '''X''' de destino.
*'''y:''' A coordenada '''Y''' de destino.
*'''z:''' A coordenada '''Z''' de destino.

===Argumentos Opcionais===
*'''warp:''' teletransporta o jogador, resetando qualquer animação que esteja rodando. Definindo esse argumento com ''false'', a animação permanecerá.

===Retorno===
Retorna ''true'' se foi executado com sucesso, caso contrário retorna ''false''.

==Exemplo==
<section name="Server" class="server" show="true">
Este exemplo permite que os administradores teletransportem 5 jogadores aleatórios para si mesmos
<syntaxhighlight lang="lua">
function randomPlayersToLocation(p)
if not isPlayerStaff(p) then return end

local playersOnline = getElementsByType("player")
local amount = #playersOnline

if amount == 0 then return end

for index = 1,(amount > 5 and 5 or amount) do
local player = playersOnline[index]
setElementPosition(player, getElementPosition(p))
end
end
addCommandHandler("randomtp", randomPlayersToLocation)
addCommandHandler("playershere", randomPlayersToLocation)

-- Utilitário
local staffACLs = {
aclGetGroup("Admin"),
aclGetGroup("Moderator")
}

function isPlayerStaff(p)
if isElement(p) and getElementType(p) == "player" and not isGuestAccount(getPlayerAccount(p)) then
local object = getAccountName(getPlayerAccount(p))

for _, group in ipairs(staffACLs) do
if isObjectInACLGroup("user." .. object, group) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

Se você quiser colocar um veículo ou jogador fora da água ou simular o comportamento de redefinição de posição caso CJ fique muito abaixo do solo, será necessário recuperar uma coordenada recomendada no solo para colocar o elemento. Dê uma olhada [https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198 nesse posto do Fórum do MTA] para os passos na direção certa.

==Problemas==
{{Issues|
{{Issue|539|Alterar a posição do jogador quando ele/ela tiver um jetpack removerá o jetpack e o bug quando a skin for alterada}}
{{Issue|529|Jogador cai da bicicleta quando ela é teletransportada por setElementPosition}}
}}

==Veja também==
{{Element functions}}

[[hu:setElementPosition]]
[[ru:setElementPosition]]

GetColorName

2025-09-05T11:13:36Z

IManGaaX:

{{Useful Function}} __NOTOC__
<lowercasetitle></lowercasetitle>
This function retrieves the nearest color name for a given RGB value using an online API.

{{Note|This function requires an active internet connection and fetches the color name from an external API asynchronously. The result is returned via a callback function.}}

==Syntax==
<syntaxhighlight lang="lua">getColorName( int r, int g, int b, function callback(name) )</syntaxhighlight>

===Required Arguments===
* '''r''': Red component (0-255) of the color.
* '''g''': Green component (0-255) of the color.
* '''b''': Blue component (0-255) of the color.
* '''callback''': A function that will receive the color name as a string.

===Returns===
* Does not return a value directly.
* Calls the 'callback' function with the color name when the API responds.
* Possible callback values:
* 'Error' if the request failed.
* 'Unknown' if the API did not return a valid name.
* Color name string, e.g., 'Dark Orange'.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getColorName(r, g, b, callback)
local url = string.format("https://www.thecolorapi.com/id?rgb=rgb(%d,%d,%d)", r, g, b)
fetchRemote(url, function(data, errno)
if errno == 0 then
local result = fromJSON(data)
if result and result.name and result.name.value then
callback(tostring(result.name.value))
else
callback("Unknown")
end
else
callback("Error")
end
end, "", true)
end
</syntaxhighlight>
</section>

'''Author:''' [[User:IManGaaX|Youssef Maged (iManGaaX)]]

==Examples==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
getColorName(255, 127, 0, function(name)
outputChatBox("Color Name: "..name)
end)
</syntaxhighlight>
<syntaxhighlight lang="lua">
local imangaax = getPlayerFromName("iManGaaX")
local r, g, b = getVehicleColor(getPedOccupiedVehicle(imangaax))
getColorName(r, g, b, function(name)
outputChatBox("Your Vehicle Color Name: "..name, imangaax)
end)
</syntaxhighlight>
<syntaxhighlight lang="lua">
-- If a player owns a vehicle and you want to retrieve detailed information about the vehicle, such as its color name
</syntaxhighlight>
</section>

==See Also==

{{Useful_Functions}}

Table.flatten

2025-09-05T10:12:32Z

IManGaaX:

{{Useful Function}} __NOTOC__
<lowercasetitle></lowercasetitle>
This function converts a nested table into a flattened table with concatenated keys.

{{Note|This function recursively traverses all nested subtables and creates a new table where keys represent the original hierarchy using dot notation.}}

==Syntax==
<syntaxhighlight lang="lua">table table.flatten( table t, [ string prefix = "" ] )</syntaxhighlight>

===Required Arguments===
* '''t''': the nested table to flatten.

===Optional Arguments===
{{OptionalArg}}
* '''prefix''': a string to prepend to all keys (used internally for recursion).

===Returns===
* A new table where all nested keys are flattened using dot notation.

==Code==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function table.flatten(t, prefix)
local flat = {}
prefix = prefix or ""
for k,v in pairs(t) do
local key = prefix .. k
if type(v) == "table" then
local sub = table.flatten(v, key..".")
for sk, sv in pairs(sub) do
flat[sk] = sv
end
else
flat[key] = v
end
end
return flat
end
</syntaxhighlight>
</section>

'''Author:''' [[User:IManGaaX|Youssef Maged (iManGaaX)]]

==Example==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local nestedData = {
player = {
stats = {
hp = 100,
mp = 50
},
level = 5
}
}

local flatData = table.flatten(nestedData)
for k, v in pairs(flatData) do
outputChatBox(k .. " = " .. tostring(v))
end
-- Output:
-- player.stats.hp = 100
-- player.stats.mp = 50
-- player.level = 5
</syntaxhighlight>
</section>

==See Also==

{{Useful_Functions}}

GetServerAveragePing

2025-09-03T00:31:08Z

O22:

{{Useful Function}}
__NOTOC__
This function gets average players ping.

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

===Returns===
Returns the average players ping as integer.
<br>
Returns '''0''' if no players are online.

==Code==
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
function getAveragePing()
local players = getElementsByType("player")
if #players == 0 then
return 0
end

local totalPing = 0
for _, player in ipairs(players) do
totalPing = totalPing + getPlayerPing(player)
end

return math.floor(totalPing / #players)
end
</syntaxhighlight>
</section>

==Example==
The example shows how to use function.
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("avgping", function()
local avg = getAveragePing()
if avg > 0 then
print("Average Ping: " .. avg .. " ms")
else
print("No players online.")
end
end)
</syntaxhighlight>
</section>

<br>
Author: [https://wiki.multitheftauto.com/wiki/User:O22 omar-o22]
==See Also==
{{Useful_Functions}}

DgsGIFGetSize

2025-08-23T22:59:08Z

Lettify: Created page with "__NOTOC__ {{Client function}} Returns the dimensions (width and height) of a GIF element created using dgsCreateGIF. The values correspond to the original size extracted from the GIF file during loading. ==Syntax== <syntaxhighlight lang="lua"> int int dgsGIFGetSize( element gif ) </syntaxhighlight> ===Required Arguments=== *'''gif: ''' The '''dgs-dxgif''' type element you want to get the size of. ===Returns=== Returns two integers corresponding to ''width'' an..."

__NOTOC__
{{Client function}}

Returns the dimensions (width and height) of a GIF element created using [[dgsCreateGIF]]. The values correspond to the original size extracted from the GIF file during loading.

==Syntax==
<syntaxhighlight lang="lua">
int int dgsGIFGetSize( element gif )
</syntaxhighlight>

===Required Arguments===
*'''gif: ''' The '''dgs-dxgif''' type element you want to get the size of.

===Returns===
Returns two integers corresponding to ''width'' and ''height''

==Example==
<syntaxhighlight lang="lua">
-- This script should be executed on the client-side

-- Import the DGS functions to use them from another resource
local DGS = exports.dgs

-- 1. Load the GIF from a file within your resource
local myAnimatedGif = DGS.dgsCreateGIF("files/loading.gif")

-- 2. Check if the GIF was loaded successfully before proceeding
if myAnimatedGif then
-- 3. Use dgsGIFGetSize to get the width and height of the loaded GIF
local width, height = DGS.dgsGIFGetSize(myAnimatedGif)

-- 4. Display the dimensions in the chat to confirm the result
outputChatBox(string.format("The loaded GIF has the dimensions: %d width by %d height.", width, height))

-- 5. Practical example: Create a DGS image in the center of the screen
-- using the 'width' and 'height' we just obtained so the size is perfect.
local screenW, screenH = guiGetScreenSize()
local posX = screenW / 2 - width / 2
local posY = screenH / 2 - height / 2

local gifImage = DGS.dgsCreateImage(posX, posY, width, height, myAnimatedGif, false)

-- Start the GIF's animation
DGS.dgsGIFPlay(myAnimatedGif)
else
-- Inform the user if the GIF was not found or if an error occurred during loading
outputChatBox("Error: Could not load the GIF file.", 255, 0, 0)
end

</syntaxhighlight>

==See Also==
{{DGS_Plugin/Gif}}

DgsCreateGIF

2025-08-23T10:27:29Z

Thisdp:

__NOTOC__
{{Client function}}

This function creates a GIF interface plugin.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateGIF( string pathOrRaw )
</syntaxhighlight>

===Required Arguments===
*'''pathOrRaw: ''' A string representing the path to your GIF file, or the raw GIF data

===Returns===
Returns a dgs-dxgif element (DGS Plugin Type)[ dgs-dxgif (Element Type) ] if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local gif = DGS:dgsCreateGIF("test.gif")
DGS:dgsGIFPlay(gif,1) --Play GIF with Speed 1x
image = DGS:dgsCreateImage(500,500,200,200,gif,false)

</syntaxhighlight>

==See Also==
{{DGS_Plugin/Gif}}

OnPedWeaponReload

2025-08-17T21:15:59Z

-ffs-PLASMA:

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22909|Event has been added.}}

This event is triggered when a ped reloads his weapons.

==Parameters==
<syntaxhighlight lang="lua">
int weapon, int clip, int ammo
</syntaxhighlight>

*'''weapon''': an [[int]] representing the [[weapon]] that has been reloaded.
*'''clip''': an [[int]] representing the [[weapon]] clip size.
*'''ammo''': an [[int]] representing the [[weapon]] ammo.

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that reloaded his weapon.

==Example==
This example outputs a line to the chat box whenever a ped reloads weapons.
<syntaxhighlight lang="lua">
function weaponReload(iWeaponID, iClip, iAmmo)
outputChatBox("A ped reloaded "..getWeaponNameFromID(iWeaponID)..", clip: "..iClip..", ammo: "..iAmmo.."!");
end
addEventHandler("onPedWeaponReload", root, weaponReload);
</syntaxhighlight>

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

AR/getDiscordRichPresenceUserID

2025-08-06T01:39:16Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|ستُعيد الدالة معرف المستخدم بشكل صحيح إذا كان المستخدم قد منح الموافقة مسبقًا ومتصل بتطبيق Rich Presence.}} {{New feature/item|3.0161|1.6.0|22342| تُعيد الدالة معرف مستخدم Discord الخاص بالعميل. }} ==التركيب== <syntaxhighlight lang="lua"> string getDiscordRichPresenceUserID() </syntaxhighlight> ===الق..."

__NOTOC__
{{Client function}}
{{Important Note|ستُعيد الدالة معرف المستخدم بشكل صحيح إذا كان المستخدم قد منح الموافقة مسبقًا ومتصل بتطبيق Rich Presence.}}
{{New feature/item|3.0161|1.6.0|22342|
تُعيد الدالة معرف مستخدم Discord الخاص بالعميل.
}}

==التركيب==
<syntaxhighlight lang="lua">
string getDiscordRichPresenceUserID()
</syntaxhighlight>

===القيم المرجعة===
ستعيد سلسلة فارغة ("") إذا لم يمنح المستخدم الموافقة أو قام بتعطيل خيار تزامن Rich Presence. وإلا، ستعيد المعرف كسلسلة نصية.

==مثال==
يعرض هذا المثال معرف المستخدم الخاص به في الدردشة إذا كان قد منح الإذن بمشاركة البيانات. وإلا، سيظهر له رسالة مناسبة.
<syntaxhighlight lang="lua">
addCommandHandler("getmyuserid",
function ()
if isDiscordRichPresenceConnected() then
local id = getDiscordRichPresenceUserID()
if id == "" then
outputChatBox("لم تسمح بمشاركة بيانات Discord! قم بمنح الإذن في الإعدادات!")
else
outputChatBox("معرف Discord الخاص بك: "..id)
end
end
end
)
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:IsDiscordRichPresenceConnected]]
[[de:isDiscordRichPresenceConnected]]
[[hu:isDiscordRichPresenceConnected]]
[[pl:isDiscordRichPresenceConnected]]
[[ro:isDiscordRichPresenceConnected]]
[[ru:IsDiscordRichPresenceConnected]]
[[PT-BR:IsDiscordRichPresenceConnected]]

AR/setDiscordRichPresenceEndTime

2025-08-06T01:33:46Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22276| تقوم هذه الدالة بتعيين الوقت المتبقي في Discord Rich Presence. }} ==التركيب== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceEndTime(int seconds) </syntaxhighlight> {{OOP||..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22276|
تقوم هذه الدالة بتعيين الوقت المتبقي في Discord Rich Presence.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceEndTime(int seconds)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setEndTime}}

===المعطيات المطلوبة===
*'''seconds''': عدد صحيح يُمثّل عدد الثواني المتبقية. إذا كانت القيمة 0 أو أقل من وقت البدء ([[AR/setDiscordRichPresenceStartTime|setDiscordRichPresenceStartTime]]) فلن يتم عرض المؤقت.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية تغيير مؤقت الوقت المتبقي في تطبيق Discord Rich Presence.
<syntaxhighlight lang="lua">
local app_id = "معرّف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("داخل اللعبة")
setDiscordRichPresenceStartTime(1)
setDiscordRichPresenceEndTime(60) -- دقيقة واحدة متبقية
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

AR/setDiscordRichPresenceStartTime

2025-08-06T01:30:38Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22276| تقوم هذه الدالة بتعيين الوقت المنقضي في Discord Rich Presence. }} ==التركيب== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceStartTime(int seconds) </syntaxhighlight> {{OOP..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22276|
تقوم هذه الدالة بتعيين الوقت المنقضي في Discord Rich Presence.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceStartTime(int seconds)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setStartTime}}

===المعطيات المطلوبة===
*'''seconds''': عدد صحيح يُمثّل عدد الثواني المنقضية. إذا كانت القيمة 0، فلن يتم عرض المؤقت.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية تغيير مؤقت الوقت المنقضي في تطبيق Discord Rich Presence.
<syntaxhighlight lang="lua">
local app_id = "معرّف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("داخل اللعبة")
setDiscordRichPresenceStartTime(1)
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

AR/setDiscordRichPresencePartySize

2025-08-06T01:27:04Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{Note|لكي يتم عرض حجم المجموعة، يجب تعيين الحالة باستخدام setDiscordRichPresenceState}} {{New feature/item|3.0161|1.6.0|22276| تقوم هذه الدالة بتعيين حجم المج..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{Note|لكي يتم عرض حجم المجموعة، يجب تعيين الحالة باستخدام [[AR/setDiscordRichPresenceState|setDiscordRichPresenceState]]}}
{{New feature/item|3.0161|1.6.0|22276|
تقوم هذه الدالة بتعيين حجم المجموعة في Discord Rich Presence.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresencePartySize(int size, int max)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setPartySize}}

===المعطيات المطلوبة===
*'''size''': عدد صحيح يمثل حجم المجموعة الحالي.
*'''max''': عدد صحيح يمثل الحد الأقصى لحجم المجموعة.

'''إذا كانت القيمتان 0، فلن يتم عرض حجم المجموعة.'''

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية تغيير حجم المجموعة (Party Size) في تطبيق Discord Rich Presence.
<syntaxhighlight lang="lua">
local app_id = "معرّف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("داخل اللعبة")
setDiscordRichPresencePartySize(1, 32)
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

AR/setDiscordRichPresenceState

2025-08-06T00:14:56Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| تقوم هذه الدالة بتعيين الحالة لتطبيق Discord Rich Presence. }} ==التركيب== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceState(string state) </syntaxhighlight> {{OOP||Disc..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
تقوم هذه الدالة بتعيين الحالة لتطبيق Discord Rich Presence.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceState(string state)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setState}}

===المعطيات المطلوبة===
*'''state''': سلسلة نصية تحتوي على نص الحالة.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية تعيين الحالة في تطبيق Discord Rich Presence.
<syntaxhighlight lang="lua">
local app_id = "معرّف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceState("في انتظار في الردهة")
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceState]]
[[de:setDiscordRichPresenceState]]
[[hu:setDiscordRichPresenceState]]
[[pl:setDiscordRichPresenceState]]
[[ro:setDiscordRichPresenceState]]
[[ru:SetDiscordRichPresenceState]]
[[PT-BR:SetDiscordRichPresenceState]]

AR/setDiscordRichPresenceSmallAsset

2025-08-06T00:11:02Z

O22: /* Syntax */

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
باستخدام هذه الدالة، يمكنك تعيين صورة الأصل الصغيرة (small asset) للتطبيق.
الحد الأقصى لحجم الصور هو ''1024 x1024''، والحد الأدنى هو ''512 x512''.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceSmallAsset(string assetImage, string text)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setSmallAsset}}

===المعطيات المطلوبة===
*'''assetImage''': سلسلة نصية تحتوي على مفتاح الصورة التي قمت برفعها في قائمة الأصول الخاصة بتطبيقك.
*'''text''': سلسلة نصية تُعرض عندما يقوم أحدهم بتحويم الماوس فوق الصورة الكبيرة في Discord.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
المثال يقوم بتعيين الصورة الكبيرة إلى my_small_logo.
<syntaxhighlight lang="lua">
addCommandHandler("setsmalllogo",
function ()
if isDiscordRichPresenceConnected() then
setDiscordRichPresenceSmallAsset("my_small_logo", "!هذا هو شعاري الصغير")
end
end
)
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceAsset]]
[[de:setDiscordRichPresenceAsset]]
[[hu:setDiscordRichPresenceAsset]]
[[pl:setDiscordRichPresenceAsset]]
[[ro:setDiscordRichPresenceAsset]]
[[ru:SetDiscordRichPresenceAsset]]
[[PT-BR:SetDiscordRichPresenceAsset]]

AR/setDiscordRichPresenceDetails

2025-08-06T00:01:52Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| تقوم هذه الدالة بتعيين نص التفاصيل في Discord Rich Presence. }} ==التركيب== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceDetails(string details) </syntaxhighlight> {{OOP||[..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
تقوم هذه الدالة بتعيين نص التفاصيل في Discord Rich Presence.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceDetails(string details)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setDetails}}

===القيم المطلوبة===
*'''details''': سلسلة نصية تحتوي على نص التفاصيل.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية تغيير الحالة والتفاصيل في تطبيق Discord Rich Presence.
<syntaxhighlight lang="lua">
local app_id = "معرّف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
local name = getPlayerName(localPlayer)
setDiscordRichPresenceState("داخل اللعبة")
setDiscordRichPresenceDetails("حالياً باسم "..name)
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

AR/setDiscordRichPresenceButton

2025-08-05T23:55:28Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| تقوم هذه الدالة بتعيين زر مخصص يمكن من خلاله الوصول إلى موقع ويب على Discord. }} ==التركيب== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceButton(int..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
تقوم هذه الدالة بتعيين زر مخصص يمكن من خلاله الوصول إلى موقع ويب على Discord.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceButton(int index, string text, string url)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setButton}}

===المعطيات المطلوبة===
*'''index''': رقم صحيح (int) يُمثّل ترتيب الزر (القيم الممكنة: 1 أو 2)
*'''text''': سلسلة نصية تحتوي على عنوان الزر
*'''url''': سلسلة نصية تحتوي على رابط الزر (يعمل فقط مع '''https://''' أو '''mtasa://''')

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
يعرض هذا المثال كيفية إنشاء زرين مخصصين في تطبيق Discord Rich Presence الخاص بنا.
<syntaxhighlight lang="lua">
local app_id = "معرف_تطبيقك_الخاص"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceButton(1, "الاتصال بالسيرفر", "mtasa://youraddressip")
setDiscordRichPresenceButton(2, "الصفحة الرئيسية لـ MTA", "https://mtasa.com")
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceButton]]
[[de:setDiscordRichPresenceButton]]
[[hu:setDiscordRichPresenceButton]]
[[pl:setDiscordRichPresenceButton]]
[[ro:setDiscordRichPresenceButton]]
[[ru:SetDiscordRichPresenceButton]]
[[PT-BR:SetDiscordRichPresenceButton]]

AR/setDiscordRichPresenceAsset

2025-08-05T23:50:08Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| باستخدام هذه الدالة يمكنك تعيين صورة الأصل الكبيرة (large image asset) للتطبيق. الحد الأقصى لحجم الصور هو ''1024 x1024''، والحد الأدنى هو..."

__NOTOC__
{{Client function}}
{{Important Note|لاستخدام هذه الدالة، يجب عليك إعداد تطبيقك الخاص باستخدام [[AR/setDiscordApplicationID|setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
باستخدام هذه الدالة يمكنك تعيين صورة الأصل الكبيرة (large image asset) للتطبيق.
الحد الأقصى لحجم الصور هو ''1024 x1024''، والحد الأدنى هو ''512 x512''.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceAsset(string assetImage, string text)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setAsset}}

===المعطيات المطلوبة===
*'''assetImage''': سلسلة نصية تحتوي على مفتاح الصورة التي قمت برفعها في قائمة الأصول الخاصة بتطبيقك.
*'''text''': سلسلة نصية تُعرض عندما يقوم أحدهم بتحويم الماوس فوق الصورة الكبيرة في Discord.

===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' خلاف ذلك.

==مثال==
المثال يقوم بتعيين الصورة الكبيرة إلى my_logo.
<syntaxhighlight lang="lua">
addCommandHandler("setlogo",
function ()
if isDiscordRichPresenceConnected() then
setDiscordRichPresenceAsset("my_logo", "هذا هو شعاري!")
end
end
)
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:SetDiscordRichPresenceAsset]]
[[de:setDiscordRichPresenceAsset]]
[[hu:setDiscordRichPresenceAsset]]
[[pl:setDiscordRichPresenceAsset]]
[[ro:setDiscordRichPresenceAsset]]
[[ru:SetDiscordRichPresenceAsset]]
[[PT-BR:SetDiscordRichPresenceAsset]]

AR/setDiscordApplicationID

2025-08-05T23:44:25Z

O22: Created page with "__NOTOC__ {{Client function}} {{Important Note|لإعادة ضبط معرف التطبيق، يرجى استخدام resetDiscordRichPresenceData}} {{Important Note|لكي تعمل الدالة بشكل صحيح، يجب أن يكون لدى المستخدم إعداد الخصوصية/الحالة مفعل في Discord.}} {{New feature/item|3.0161|1.6.0|22270| تتيح هذه الدالة تعيين تطبيقك الخاص للاست..."

__NOTOC__
{{Client function}}
{{Important Note|لإعادة ضبط معرف التطبيق، يرجى استخدام [[AR/resetDiscordRichPresenceData|resetDiscordRichPresenceData]]}}
{{Important Note|لكي تعمل الدالة بشكل صحيح، يجب أن يكون لدى المستخدم إعداد الخصوصية/الحالة مفعل في Discord.}}
{{New feature/item|3.0161|1.6.0|22270|
تتيح هذه الدالة تعيين تطبيقك الخاص للاستخدام في Rich Presence.
يمكنك إنشاء تطبيقك الخاص '''[https://discord.com/developers/applications هنا]'''
}}

==التركيب==
<syntaxhighlight lang="lua">
bool setDiscordApplicationID(string applicationID)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setApplication}}

===المعطيات المطلوبة===
*'''applicationID''': سلسلة نصية تمثل معرف تطبيق Discord الخاص بك.
===القيم المرجعة===
تعيد الدالة ''true'' إذا نجحت العملية، و ''false'' إذا قام العميل بتعطيل خاصية Rich Presence.

==مثال==
هذا المثال يعرض ما إذا تم إعداد التطبيق بنجاح ويعيّن صورة مخصصة (custom asset).
<syntaxhighlight lang="lua">
local app_id = "معرف_التطبيق_الخاص_بك"
if setDiscordApplicationID(app_id) then
setDiscordRichPresenceAsset("asset_name_from_application")
outputChatBox("رائع، نحن الآن نستخدم تطبيقنا الخاص!")
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:setDiscordApplicationID]]
[[de:setDiscordApplicationID]]
[[hu:setDiscordApplicationID]]
[[pl:setDiscordApplicationID]]
[[ro:setDiscordApplicationID]]
[[ru:SetDiscordApplicationID]]
[[PT-BR:SetDiscordApplicationID]]

AR/resetDiscordRichPresenceData

2025-08-05T23:05:16Z

O22: /* Syntax */

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22270|
تعيد هذه الوظيفة إعدادات Discord Rich Presence إلى الوضع الافتراضي.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool resetDiscordRichPresenceData()
</syntaxhighlight>

===القيم المرجعة===
ترجع الدالة ''true'' إذا نجحت العملية، و ''false'' إذا فشلت.

==مثال==
يعرض هذا المثال كيفية إعادة ضبط Discord Rich Presence بعد استخدام تطبيق مخصص.
<syntaxhighlight lang="lua">
setDiscordApplicationID("you_application_key")
setDiscordRichPresenceAsset("asset_logo", "Name of Asset")
if resetDiscordRichPresenceData() then -- نقوم بإعادة الضبط إلى الوضع الافتراضي باستخدام تطبيق MTA.
outputChatBox("تمت إعادة Discord Rich Presence إلى الوضع الافتراضي.")
end
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:ResetDiscordRichPresenceData]]
[[de:resetDiscordRichPresenceData]]
[[hu:resetDiscordRichPresenceData]]
[[pl:resetDiscordRichPresenceData]]
[[ro:resetDiscordRichPresenceData]]
[[ru:ResetDiscordRichPresenceData]]
[[PT-BR:ResetDiscordRichPresenceData]]

AR/isDiscordRichPresenceConnected

2025-08-05T23:02:08Z

O22:

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22270|
تتحقق الوظيفة مما إذا كان العميل لديه Discord Rich Presence مفعل.
}}

==التركيب==
<syntaxhighlight lang="lua">
bool isDiscordRichPresenceConnected()
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:isConnected}}

===القيم المرجعة===
ترجع الدالة ''true'' إذا كانت خاصية Discord Rich Presence مفعّلة على العميل، و ''false'' إذا كانت غير مفعّلة.

==مثال==
يعرض هذا المثال إذا ما كان العميل قد فعّل خاصية Discord Rich Presence.
<syntaxhighlight lang="lua">
addCommandHandler("checkdiscord",
function ()
if isDiscordRichPresenceConnected() then
outputChatBox("أنت تستخدم Discord Rich Presence، هذا رائع!")
end
end
)
</syntaxhighlight>

==انظر ايضاً==
{{AR/Client_Discord_functions}}

[[en:IsDiscordRichPresenceConnected]]
[[de:isDiscordRichPresenceConnected]]
[[hu:isDiscordRichPresenceConnected]]
[[pl:isDiscordRichPresenceConnected]]
[[ro:isDiscordRichPresenceConnected]]
[[ru:IsDiscordRichPresenceConnected]]
[[PT-BR:IsDiscordRichPresenceConnected]]

ToggleAllVehicleControls

2025-08-05T10:55:36Z

Abolfazl: Created page with "Toggles all vehicle controls for a player based on the provided boolean method (true to enable, false to disable). ==Syntax== <syntaxhighlight lang="lua">toggleAllVehicleControls(player, method)</syntaxhighlight> ===Required Arguments=== *'''player:''' The player whose vehicle controls will be toggled. *'''method:''' A boolean indicating whether to enable (true) or disable (false) the controls. ===Returns=== Returns false if the method is not a b..."

Toggles all vehicle controls for a player based on the provided boolean method (true to enable, false to disable).
==Syntax==
<syntaxhighlight lang="lua">toggleAllVehicleControls(player, method)</syntaxhighlight>

===Required Arguments===
*'''player:''' The [[Player|player]] whose vehicle controls will be toggled.
*'''method:''' A [[Boolean|boolean]] indicating whether to enable (true) or disable (false) the controls.

===Returns===
Returns false if the method is not a boolean value, otherwise it returns true.

==Code==
<section name="Server and Client Side Script" class="both" show="true">
<syntaxhighlight lang="lua">
local vehicleControls = {
"vehicle_fire", "vehicle_secondary_fire", "vehicle_left", "vehicle_right",
"steer_forward", "steer_back", "accelerate", "brake_reverse", "radio_next", "radio_previous", "radio_user_track_skip", "horn", "sub_mission",
"handbrake", "vehicle_look_left", "vehicle_look_right", "vehicle_look_behind", "vehicle_mouse_look", "special_control_left", "special_control_right",
"special_control_down", "special_control_up"
}

function toggleAllVehicleControls(player, method)
if type(method) ~= "boolean" then return false end
for index, control in ipairs(vehicleControls) do
toggleControl(player, control, method)
end
end
</syntaxhighlight>
</section>

==Example 1==
This example toggles player's vehicle controls off when it entered an Andromeda.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onPlayerVehicleEnter", root, function(vehicle)
if getElementModel(vehicle) == 592 then
toggleAllVehicleControls(source, false)
end
end)
</syntaxhighlight>
</section>

'''Author:''' [[User:Abolfazl|Abolfazl]]