RU/Server Scripting Functions: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Replaced content with "<center> <font face="Verdana" size="5" color="#800"><b> Эта страница находится на стадии beta-тестирования </b></font> <hr> <font f...")
(Undo revision 58795 by XBullet (talk))
Line 1: Line 1:
<center>
<pageclass class="server"></pageclass>
<font face="Verdana" size="5" color="#800"><b>
На этой странице располагается список всех серверных функций скриптинга, которые когда-либо были внедрены и теперь являются встроенными. Чтобы запросить новую функцию или событие, напишите об этом [[Requested Functions and Events|сюда]] или на https://bugs.mtasa.com.
Эта страница находится на стадии beta-тестирования
 
</b></font>
Обратите внимание, что функции скриптинга также можно расширить благодаря подгрузке динамических модулей с ними. Они предоставляют новый функционал, как утилитарные функции. Эти функции скриптинга не являются встроенными и требуют подгрузки модуля для того, чтобы с ними можно было работать.
<hr>
 
<font face="Verdana" size="3" color="#000">
Отправляйтесь на страницу с [[RU/Modules|модулями]], если хотите получить список доступных невстроенных серверных функций и модулей.
Вы можете <b>[http://yadi.sk/d/mjvTNlGO3akkzs скачать offline версию MTA Wiki (редакция от 2 Сентября 2018)]</b>
 
</font>
Если вам захочется узнать о других функциях, посетите [[RU/Useful_Functions|страницу с полезными функциями]].
</center>
 
Клиентские функции скриптинга можно найти [[RU/Client Scripting Functions|здесь]].
 
__TOC__
 
==Функции аккаунта==
{{RU/Account_functions}}
 
==ACL-функции==
{{RU/ACL_functions}}
 
==Функции администратора==
{{RU/Admin_functions}}
 
==Функции звука==
{{RU/Audio_functions}}
 
==Функции объявления==
{{RU/Announce_functions}}
 
==Функции метки на радаре==
{{RU/Blip_functions}}
 
==Функции камеры==
{{RU/Camera functions}}
 
==Функции тела и одежды==
{{RU/Clothes and body functions}}
 
==Функции коллизии==
{{RU/Collision shape functions}}
 
==Функции курсора==
{{RU/Cursor_functions}}
 
==Функции элемента==
{{RU/Element functions}}
 
==Функции события==
{{RU/Event_functions}}
 
==Функции взрыва==
{{RU/Explosion_functions}}
 
==Файловые функции==
{{RU/File_functions}}
 
==HTTP-функции==
{{RU/HTTP_functions}}
 
==Функции ввода==
{{RU/Input_functions}}
 
==Функции карты==
{{RU/Map_functions}}
 
==Функции маркера==
{{RU/Marker functions}}
 
==Функции матрицы==
{{RU/Shared_matrix_functions}}
 
==Функции модуля==
{{RU/Module functions}}
 
==Функции объекта==
{{RU/Object functions}}
 
==Функции NPC==
{{RU/Ped_functions}}
 
==Функции пикапа==
{{RU/Pickup functions}}
 
==Функции игрока==
{{RU/Player functions}}
 
==Функции снаряда==
{{RU/Projectile_functions}}
 
==Функции территории радара==
{{RU/Radar area functions}}
 
==Функции ресурса==
{{RU/Resource functions}}
 
==Функции сервера==
{{RU/Server functions}}
 
==Функции настройки реестра==
{{RU/Settings registry functions}}
 
==SQL-функции==
{{RU/SQL_functions}}
 
==Функции команды==
{{RU/Team functions}}
 
==Функции текста==
{{RU/Text functions}}
 
==Утилитарные функции==
{{RU/Utility functions}}
 
==Функции UTF-8==
{{RU/UTF8 functions}}
 
==Функции транспорта==
{{RU/Vehicle functions}}
 
==Функции воды==
{{RU/Water functions}}
 
==Функции оружия==
{{RU/Weapon functions}}
 
==Функции мира==
{{RU/World functions}}
 
==XML-функции==
{{RU/XML functions}}
 
[[ar:Server Scripting Functions]]
[[de:Server-Seitige Scripting Funktionen]]
[[en:Server Scripting Functions]]
[[es:Funciones_del_Server]]
[[pl:Server Scripting Functions]]
[[pt-br:Funções de Scripting do Servidor]]
[[tr:Server Scripting Functions]]

Revision as of 00:56, 2 September 2018

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

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

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

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

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

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

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

  • 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 файл из памяти