AI Core
Справочник APIAI Core: серверные экспорты

Серверные экспорты

Как вызывать серверные экспорты ai-core из Lua и TypeScript, и список всех групп экспортов.

ai-core - это ресурс фреймворка. Другие ресурсы спрашивают у него персонажа игрока, деньги, работы и предметы и поручают ему задачи вроде «выдай этому игроку ключ» или «отправь полицейское оповещение». Они делают это через экспорты: функции, которые ai-core делает доступными для вызова из любого другого ресурса на сервере.

На этих страницах перечислены все серверные экспорты, которые регистрирует ai-core, сгруппированные по темам. Каждая запись показывает, что делает экспорт, его точную сигнатуру, каждый параметр, что он возвращает в каждом случае, и рабочий пример на TypeScript и Lua.

Вызов экспорта

Экспорт вызывается по имени ресурса, которому он принадлежит (ai-core), и имени экспорта.

import { resourceExport } from "@aicore8/lib/server";

// Один типизированный хэндл на файл, в начале. Здесь это безопасно: FiveM ищет каждый
// экспорт при первом использовании и забывает его, когда ai-core перезапускается.
const core = resourceExport("ai-core");

export function cashOf(source: number): number {
  return core.GetMoney(source, "cash") ?? 0;
}

Что нужно знать перед началом:

  • Типы TypeScript. resourceExport("ai-core") типизирован по AiCoreServerExports из @aicore8/shared, поэтому редактор знает каждое имя, параметр и тип возврата. Никогда не пишите resourceExport("ai-core").GetMoney(...) внутри функции: держите один хэндл в начале файла.
  • В Lua используется двоеточие. Пишите exports['ai-core']:GetMoney(source, 'cash'), а не через точку. Ответ null приходит в Lua как nil, массив как список Lua (первый индекс 1), объект как таблица.
  • Два написания. Каждый экспорт отвечает и с изменённым регистром первой буквы: GetMoney и getMoney - одна и та же функция.
  • Экспорты никогда не ждут. Каждый экспорт сразу отвечает небольшим значением. Когда ответу нужна база данных (сохранённая внешность, список счетов), экспорт принимает callback done вместо возврата Promise, потому что Promise не может перейти из одного ресурса в другой.
  • Не в горячих путях. Вызов экспорта копирует аргументы и ответ. Не вызывайте экспорты каждый кадр или для каждого игрока в цикле. Для «кто на дежурстве», имени персонажа или работ многих игроков используйте зеркало online из библиотеки, которое следит за событиями ai-core (Библиотека: сервер).
  • ai-core должен запуститься первым. Укажите dependency 'ai-core' в своём fxmanifest.lua (ресурс ai-* перечисляет его в fxDependencies в package.json), чтобы ваш ресурс стартовал после ai-core.
  • source - это серверный id игрока. Это число, которое FiveM даёт подключённому игроку. Id персонажа (charId) - другое число: id строки персонажа в базе данных.

Библиотека или экспорт?

У большинства экспортов есть обёртка в @aicore8/lib/server (и у многих в aiLib для Lua). Обёртка вызывает тот же экспорт, поэтому поведение идентично; она лишь читается приятнее (inventory.addItem(source, "water") вместо core.AddItem(source, "water")) и превращает callback в Promise там, где это безопасно. Каждая запись называет свою обёртку в строке Библиотека. Используйте что нравится; ресурс на Lua без ai-lib вызывает экспорт напрямую.

Примеры на этих страницах

Примеры - это полные серверные файлы. Примеры на TypeScript используют addCommand и onClientCallback из библиотеки; примеры на Lua используют aiLib.addCommand и aiLib.onClientCallback из ai-lib, которым нужны эти строки в вашем fxmanifest.lua:

fxmanifest.lua
shared_script '@ai-lib/init.lua'
dependency 'ai-lib'
dependency 'ai-core'

Ожидающие вызовы Lua (aiLib.progressFor, Wait) работают только внутри потока; обработчики команд и callback уже выполняются в нём.

Типы

Типы, которые встречаются на нескольких страницах (CharacterInfo, InventoryRef, DispatchAlert...), описаны один раз со всеми полями на странице Типы, и на неё ссылается каждая запись, которая их использует.

Группы экспортов

Персонажи и игроки

Данные игрока, персонажи, поиск по серверному id, смена персонажа, офлайн-позиции, игроки в зоне видимости.

Сохранённые персонажи

Любой персонаж, загруженный или нет: найти, прочитать, его деньги, работы, банды, метаданные, имя, время игры, сохранить, удалить.

Деньги и счета

Балансы, добавление и списание денег, счета работ и банд, переводы, типы счетов.

Работы и банды

Членство, дежурство, ранги, число на дежурстве, прайм-тайм, определения работ и банд.

Метаданные и настройки

Метаданные персонажа, брендинг сервера, устаревшие скрипты.

Предметы

Добавление, изъятие, подсчёт и проверка предметов, тайники, магазины скриптов, используемые предметы, определения предметов.

Ключи от транспорта

Выдача, изъятие и проверка ключей от транспорта через тот скрипт ключей, который работает.

Топливо

Чтение и установка топлива транспорта через тот скрипт топлива, который работает.

Дверные замки

Запирание, отпирание и чтение дверей через тот скрипт замков, который работает.

Гаражи

Штрафстоянка, парковка, открытие меню гаража, список транспорта игрока в гаражах.

Медицина

Реанимация, лечение и проверка, лежит ли игрок.

EMS

Сколько медиков свободно, сигналы бедствия.

Внешность

Сохранённая внешность персонажа из того скрипта одежды, который работает.

Телефон

Номера телефонов, письма, SMS и уведомления телефона.

Диспетчер

Полицейские и рабочие оповещения через ту систему оповещений, которая работает.

MDT

Штрафы, ордера, аресты и записи о заключении в полицейском MDT.

Тюрьма

Заключение, освобождение и оставшийся срок.

Банк

Открытие экрана банка, баланс организации работы.

Счета

Отправка счетов, список и оплата открытых счетов игрока.

Стресс и потребности

Добавление или снятие стресса, восполнение голода и жажды.

Время и погода

Погода, игровое время, блэкаут и замороженное время.

Routing bucket

Взять и вернуть свободный routing bucket для отдельного мира.

Логи

Отправка логов в Discord, Fivemanage, FiveM Stats и консоль.

Проверки подключения

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

Админ-панель и команды

Регистрация панели, вкладка Commands, справочные списки, внешние экраны настроек.

Мост vRP

Экспорты, которые использует встроенный мост vRP в ai-core.

Связанные страницы

На этой странице