RU/Server Scripting Functions

From Multi Theft Auto: Wiki
Revision as of 13:01, 11 April 2021 by EOFIK (talk | contribs) (Обновление информации)
Jump to navigation Jump to search

Contributors: Did you create a page but it's not on this list? Confused? Read: Adding Pages to Categories and Templates

На этой странице располагается список всех серверных функций скриптинга, которые когда-либо были внедрены и теперь являются встроенными. Чтобы запросить новую функцию или событие, напишите об этом в наш GitHub хранилище.

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

Отправляйтесь на страницу с модулями, если хотите получить список доступных невстроенных серверных функций и модулей.

Если вам захочется узнать о других функциях, посетите страницу с полезными функциями.

Клиентские функции скриптинга можно найти здесь.

Функции аккаунта

Серверные функции

  • addAccount - регистрирует аккаунт
  • copyAccountData - копирует данные аккаунта в другой
  • getAccount - получает аккаунт указанного пользователя
  • getAccountByID - получает аккаунт с указанным ID
  • getAccountData - получает указанные данные аккаунта
  • getAccountID - получает ID указанного аккаунта
  • getAccountIP - получает IP указанного аккаунта
  • getAccountName - получает имя аккаунта
  • getAccountPlayer - получает активного пользователя аккаунта
  • getAccountSerial - получает серийный номер аккаунта
  • getAccounts - получает все зарегистрированные аккаунты
  • getAccountsByData - получает аккаунты с указанными сохранёнными данными
  • getAccountsByIP - получает аккаунт с указанным IP
  • getAccountsBySerial - получает все аккаунты с указанным серийным номером
  • getAllAccountData - получает все данные аккаунта
  • getPlayerAccount - получает аккаунт указанного игрока
  • isGuestAccount - проверяет, является ли аккаунт гостевым
  • logIn - авторизует игрока под указанный аккаунт
  • logOut - выходит из аккаунта указанного игрока
  • removeAccount - удаляет аккаунт
  • setAccountData - сохраняет данные в аккаунте
  • setAccountName - устанавливает имя аккаунту
  • setAccountPassword - устанавливает пароль аккаунта


ACL-функции

Серверные функции

  • aclCreate - создаёт запись ACL
  • aclCreateGroup - создаёт группу ACL
  • aclDestroy - уничтожает запись ACL
  • aclDestroyGroup - уничтожает группу ACL
  • aclGet - возвращает запись ACL с указанным именем
  • aclGetGroup - возвращает группу ACL с указанным именем
  • aclGetName - возвращает имя указанной записи ACL
  • aclGetRight - проверяет, установлен ли доступ для указанного права в ACL
  • aclGroupAddACL - добавляет указанный ACL в указанную группу ACL
  • aclGroupAddObject - добавляет указанный объект в указанную группу ACL
  • aclGroupGetName - возвращает имя указанной ACL группы
  • aclGroupList - возвращает все группы ACL
  • aclGroupListACL - возвращает все ACL из указанной группы ACL
  • aclGroupListObjects - возвращает все объекты их указанной группы ACL
  • aclGroupRemoveACL - удаляет указанный ACL из группы ACL
  • aclGroupRemoveObject - удаляет указанный объект из указанной группы ACL
  • aclList - возвращает список всех ACL из XML-файла ACL
  • aclListRights - возвращает таблицу всех прав, которыми обладает указанный ACL
  • aclReload - перезагружает ACL и группы ACL из XML-файла ACL
  • aclRemoveRight - удаляет указанное право из указанного ACL
  • aclSave - немедленно сохраняет XML-файл ACL
  • aclSetRight - изменяет указанное право для указанного ACL
  • hasObjectPermissionTo - проверяет, имеет ли указанный объект доступ для выполнения указанного действия
  • isObjectInACLGroup - проверяет, входит ли указанный объект в указанную группу


Функции администратора

Серверные функции

  • addBan — блокирует доступ по серийному номеру, IP адресу и / или нику
  • banPlayer — блокирует указанного игрока по серийному номеру, IP адресу и / или нику
  • getBanAdmin — возвращает ник администратора, ответственного за указанную блокировку
  • getBanIP — возвращает заблокированный IP адрес для указанной блокировки
  • getBanNick — возвращает ник заблокированного игрока для указанной блокировки
  • getBanReason — возвращает причину выдачи для указанной блокировки
  • getBans — возвращает таблицу выданных блокировок
  • getBanSerial — возвращает заблокированный серийный номер для указанной блокировки
  • getBanTime — возвращает время в секундах, прошедшее от 1.01.1970 до момента выдачи указанной блокировки
  • getBanUsername — возвращает ник заблокированного игрока для указанной блокировки (устарела)
  • getUnbanTime — возвращает время в секундах, прошедшее от 1.01.1970 до момента снятия указанной блокировки
  • isBan — проверка значение на соответствие типу ban
  • kickPlayer — исключает указанного игрока из игры
  • setBanAdmin — изменяет никнейм ответственного за блокировку администратора
  • setBanNick — изменяет никнейм игрока для указанной блокировки
  • setBanReason — изменяет причину указанной блокировки
  • setUnbanTime — изменяет время разблокировки для указанного игрока
  • removeBan — удаляет указанную блокировку
  • reloadBans — обновление данных о выданных блокировках из файла banlist.xml


Функции звука

  • playSoundFrontEnd - воспроизводит внешний звук для указанного игрока

Функции объявления

  • getGameType — возвращает название игрового режима, установленного на сервере
  • getMapName — возвращает название карты
  • getRuleValue — возвращает правило, установленное на сервере, по ключу
  • removeRuleValue — удаляет правило, установленное на сервере, по ключу
  • setGameType — устанавливает название игрового режима
  • setMapName — устанавливает название карты
  • setRuleValue — добавляет правило по ключу

Функции метки на радаре

  • createBlip — создает блип (иконку) на радаре игрока
  • createBlipAttachedTo — создает блип (иконку) на радаре игрока с привязкой к определенному элементу
  • getBlipColor — возвращает цвет созданного блипа
  • getBlipIcon — возвращает номер иконки созданного блипа
  • getBlipSize — возвращает размер созданного блипа
  • setBlipColor — устанавливает цвет созданного блипа
  • setBlipIcon — устанавливает иконку созданного блипа
  • setBlipSize — устанавливает размер созданного блипа
  • getBlipOrdering — возвращает позицию созданного блипа по координате Z
  • setBlipOrdering — устанавливает позицию созданного блипа по координате Z
  • getBlipVisibleDistance — возвращает дальность видимости для созданного блипа
  • setBlipVisibleDistance — устанавливает дальность видимости для созданного блипа


Функции камеры

  • fadeCamera — заливает экран цветом или отменяет этот эффект
  • getCameraInterior — возвращает номер интерьера, в котором установлена камера
  • getCameraMatrix — возвращает позицию камеры
  • getCameraTarget — возвращает элемент, за которым закреплена камера
  • setCameraInterior — устанавливает номер интерьера для созданной камеры
  • setCameraMatrix — устанавливает позицию камеры
  • setCameraTarget — закрепляет камеру за определенным элементом

Функции тела и одежды

  • getBodyPartName — возвращает название части тела по указанному ID
  • getClothesByTypeIndex — возвращает название текстуры и модели одежды по указанным типу и индексу
  • getClothesTypeName — возвращает название типа одежды по указанному индексу
  • getTypeIndexFromClothes — возвращает тип и индекс одежды по указанным названию текстуры и названию модели

Функции коллизии

  • addColPolygonPoint — добавляет новую вершину к существующей форме коллизии
  • createColPolygon — создает форму коллизии
  • createColCircle — создает форму коллизии в виде окружности
  • createColCuboid — создает форму коллизии в виде прямоугольного параллелепипеда
  • createColRectangle — создает форму коллизии в виде прямоугольника
  • createColSphere — создает форму коллизии в виде сферы
  • createColTube — создает форму коллизии в виде цилиндра
ДОБАВЛЕНО/ОБНОВЛЕНО В ВЕРСИИ 1.5.9 r20807:
  • getColPolygonHeight — возвращает начальные и конечные координаты по Z формы коллизии
  • getColPolygonPoints — возвращает координаты (X, Y) вершин формы коллизии
  • getColPolygonPointPosition — возвращает координаты (X, Y) вершины формы коллизии по указанному индексу
  • getColShapeType — возвращает тип формы коллизии
  • getColShapeRadius — возвращает радиус формы коллизии
  • getColShapeSize — возвращает размер формы коллизии
  • getElementColShape — возвращает форму коллизии, созданной с помощью пикапа или маркера
  • getElementsWithinColShape — возвращает элементы, находящихся в зоне формы коллизии
  • isElementWithinColShape — проверяет нахождение элемента в зоне формы коллизии
  • isInsideColShape — проверяет нахождение указанной точки в зоне формы коллизии
  • removeColPolygonPoint — удаляет вершины формы коллизии по указанному индексу
ДОБАВЛЕНО/ОБНОВЛЕНО В ВЕРСИИ 1.5.9 r20807:
  • setColPolygonHeight — изменяет начальные и конечные координаты по Z формы коллизии
  • setColPolygonPointPosition — изменяет координаты точки формы коллизии по указанному индексу
  • setColShapeRadius — изменяет радиус формы коллизии
  • setColShapeSize — изменяет размер формы коллизии


Функции курсора

Функции элемента

Серверные функции

Клиентские функции


Общие функции


Функции события

Серверные функции

  • getCancelReason - получает причину отмены события
  • triggerClientEvent - позволяет вызвать срабатывание события, предварительно созданного на клиенте
  • triggerLatentClientEvent - аналог triggerClientEvent, но скорость передачи может быть ограничена

Клиентские функции

  • triggerLatentServerEvent - аналог triggerServerEvent, но скорость передачи может быть ограничена
  • triggerServerEvent - позволяет вызвать срабатывание события, предварительно созданного на сервере

Общие функции

  • addEvent - позволяет зарегистрировать своё собственное событие
  • addEventHandler - прикрепляет к событию обработчик
  • cancelEvent - останавливает автоматическую внутреннюю обработку события
  • cancelLatentEvent - останавливает автоматическую внутреннюю обработку скрытого события
  • getEventHandlers - получает прикреплённые функции из события и присоединённый элемент из текущего lua-скрипта
  • getLatentEventHandles - получает текущие скрытые события в очереди
  • getLatentEventStatus - получает состояние одного скрытого события в очереди
  • removeEventHandler - открепляет от события обработчик
  • triggerEvent - вызывает срабатывание указанного события для указанного элемента в дереве элементов
  • wasEventCancelled - проверяет, было ли отменено последнее завершённое событие


Функции взрыва


Файловые функции


HTTP-функции

Эти функции могут использоваться только из lua-блоков в HTML-страницах, размещённых на сервере


Функции ввода


Функции карты

Функции маркера

Функции матрицы

Функции модуля


Функции объекта


Функции вывода


Функции NPC


Функции пикапа


Функции игрока


Функции снаряда


Функции территории радара

Функции ресурса

Серверные функции

  • addResourceConfig - добавляет новый пустой файл конфигурации к существующему ресурсу
  • addResourceMap - добавляет новый пустой файл карты к существующему ресурсу
  • callRemote - вызывает функции, которые были экспортированы с HTTP-доступом другими серверами MTA
  • copyResource - копирует указанный ресурс с новым именем
  • createResource - создаёт новый пустой ресурс
  • deleteResource - удаляет ресурс из памяти MTA и перемещает его в каталог /resources-cache/trash/
  • getResourceACLRequests - возвращает раздел запроса ACL из файла meta.xml данного ресурса
  • getResourceInfo - возвращает значение любого атрибута в теге информации о ресурсе
  • getResourceLastStartTime - возвращает последнее время и дату запуска ресурса
  • getResourceLoadFailureReason - возвращает причину, по которой не удалось запустить ресурс
  • getResourceLoadTime - возвращает дату и время последней загрузки ресурса на сервер
  • getResourceMapRootElement - возвращает корневой элемент определённой карты в указанном ресурсе
  • getResourceOrganizationalPath - возвращает путь к файлу организации ресурса
  • getResources - возвращает таблицу всех ресурсов, существующих на сервере
  • isResourceArchived - проверяет, заархивирован ли ресурс в данный момент (запускается из ZIP-файла)
  • isResourceProtected - проверяет, защищён ли ресурс в настоящее время, как определено в mtaserver.conf
  • refreshResources - находит новые ресурсы и проверяет наличие изменений в текущих
  • renameResource - переименовывает ресурс
  • removeResourceFile - удаляет файл из ресурса
  • restartResource - перезапускает работающий ресурс
  • setResourceInfo - устанавливает значение любого атрибута в теге информации о ресурсе
  • startResource - запускает ресурс либо постоянно, либо как зависимость от текущего ресурса
  • stopResource - останавливает работающий ресурс
  • updateResourceACLRequest - изменяет доступ для одного запроса ACL к данному ресурсу

Клиентские функции

Общие функции


Функции сервера

Функции настройки реестра

SQL-функции


Функции команды

Функции текста


Утилитарные функции


Функции UTF-8


Функции транспорта




Функции воды

Серверные функции

Клиентские функции

  • isWaterDrawnLast - определяет, рисуется ли вода последней в порядке рендеринга
  • setWaterDrawnLast - изменяет порядок рендеринга воды

Общие функции

  • createWater - создаёт область воды
  • getWaterColor - возвращает цвет воды мира GTA
  • getWaterVertexPosition - возвращает мировую позицию вершины (т.е. угла) водной области
  • getWaveHeight - возвращает текущую высоту волны
  • resetWaterColor - сбрасывает цвет воды мира GTA по умолчанию
  • resetWaterLevel - сбрасывает уровень воды в мире GTA до уровня по умолчанию
  • setWaterColor - меняет цвет воды в мире GTA
  • setWaterLevel - устанавливает высоту части или всей воды в игровом мире
  • setWaterVertexPosition - устанавливает мировое положение угловой точки воды
  • setWaveHeight - устанавливает высоту волны на указанное значение


Функции оружия

Серверные функции

  • giveWeapon - дает указанное оружие игроку или пешеходу
  • takeAllWeapons - удаляет всё оружие с указанного игрока или пешехода
  • takeWeapon - удаляет указанное оружие или боеприпасы с игрока или пешехода
ДО ВЕРСИИ 1.3.1 :
  • takeWeaponAmmo - удаляет определённое кол-во боеприпасов у игрока для указанного оружия
  • giveWeaponAmmo - даёт определённое кол-во боеприпасов игроку для указанного оружия

Клиентские функции

Общие функции

  • getOriginalWeaponProperty - получает исходное свойство указанного типа оружия
  • getPickupWeapon - получает ID оружия из указанного пикапа
  • getSlotFromWeapon - получает слот к которому принадлежит оружие
  • getWeaponIDFromName - получает ID оружия из его названия
  • getWeaponNameFromID - получает название оружия или причину смерти из его ID
  • getWeaponProperty - получает свойство указанного оружия
  • setWeaponAmmo - устанавливает определенное кол-во боеприпасов для указанного оружия
  • setWeaponProperty - устанавливает свойство указанного типа оружия


Функции мира


XML-функции

Серверные функции

Клиентские функции

Общие функции

  • xmlCopyFile - копирует всё содержимое определённого узла в XML-документе в новый файл документа
  • xmlCreateChild - создаёт новый дочерний узел в узле XML
  • xmlCreateFile - создаёт новый XML-документ, который впоследствии можно сохранить в файл с помощью xmlSaveFile
ДО ВЕРСИИ 1.0.0 :
  • xmlCreateSubNode - создаёт подузел для указанного XML узла
  • xmlFindSubNode - возвращает именованный подузел определённого XML узла
  • xmlDestroyNode - удаляет узел XML из дерева узлов XML
  • xmlFindChild - возвращает именованный дочерний узел узла XML
  • xmlLoadFile - загружает XML-файл и возвращает узел, указав конкретный путь к файлу
  • xmlLoadString - создаёт XML узел из строкового ввода
  • xmlNodeGetAttribute - возвращает атрибут узла в файле конфигурации
  • xmlNodeGetAttributes - возвращает все аттрибуты выбранного XML узла
  • xmlNodeGetChildren - возвращает все дочерние элементы определенного XML узла или определенного дочернего узла
  • xmlNodeGetName - возвращает имя тега указанного XML узла
  • xmlNodeGetParent - возвращает родительский узел XML узла
  • xmlNodeGetValue - читает значения тегов в файлах XML
  • xmlNodeSetAttribute - редактирует атрибуты узла в файле конфигурации
  • xmlNodeSetName - задает имя тега указанного XML узла
  • xmlNodeSetValue - присваивает значения тегам в файлах XML
  • xmlSaveFile - сохраняет загруженный файл XML
  • xmlUnloadFile - выгружает XML файл из памяти