AI Core
Справочник API

Обзор API

Как вызвать AI Core из другого скрипта - экспорты, события и библиотека, на TypeScript и Lua.

Всё, что может вызвать другой скрипт: экспорты ai-core, события, которые он отправляет, и вспомогательные функции @aicore8/lib (собственные экспорты каждого скрипта ai-* описаны на его странице в разделе «Скрипты»). Каждая сигнатура на этих страницах взята из исходников (@aicore8/shared exports.ts, JSDoc библиотеки, вызовы экспортов в каждом скрипте).

Выберите правильный путь

Вы пишетеИспользуйте
Скрипт ai-* или любой ресурс на TypeScript@aicore8/lib: inventory, vehicleKeys, online, medical... Библиотека сама вызывает ai-core.
Ресурс на LuaaiLib из ai-lib (shared_script '@ai-lib/init.lua') или экспорты ai-core напрямую.
Скрипт для ESX / QB / Qbox / vRPНичего нового: мост отвечает на собственный API фреймворка. См. Слои и мост.

Предметы, ключи от транспорта, оповещения, телефон, погода, тюрьма, одежда и смерти всегда идут через ai-core, а не через экспорты конкретного скрипта: ai-core передаёт вызов тому скрипту, который сервер использует для этой задачи.

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

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

// Один типизированный хэндл на ресурс, в начале файла.
const core = resourceExport("ai-core");

const cash = core.GetMoney(source, "cash");
local cash = exports['ai-core']:GetMoney(source, 'cash')
  • Типы: resourceExport берёт их из CitizenExports в @aicore8/shared. Ресурс, который может быть не запущен, использует optionalExport("x") (null, пока он остановлен).
  • Имена: каждый экспорт отвечает и с изменённым регистром первой буквы (GetMoney и getMoney).
  • Экспорты синхронные и возвращают небольшие значения. Если значению нужно время (сохранённая внешность), экспорт принимает callback: promise не пересекает границу ресурса.
  • Горячие пути следят за событиями ai-core, а не вызывают экспорты в цикле (так работает зеркало online в библиотеке).

Страницы

СтраницаЧто там найти
Серверные экспорты ai-coreВсе серверные экспорты ai-core, по странице на тему: персонажи, деньги, работы и банды, предметы, ключи, медицина, телефон, диспетчер, тюрьма, мир, банк, счета, логи, админ-панель.
Клиентские экспорты ai-coreВсе клиентские экспорты: данные игрока, HUD, подсказки клавиш, синхронизация мира, предметы, радиальное меню, жесты, внешность, ремень безопасности.
События и состояниеВсе события ai-core с их аргументами, state bag и события ESX / QB / Qbox / vRP, которые отправляет мост.
Библиотека: сервер@aicore8/lib/server и серверная часть aiLib.
Библиотека: клиент@aicore8/lib/client и клиентская часть aiLib.
Библиотека: shared и fivem@aicore8/lib/shared и /fivem: экспорты, планирование, state bag, чтение ввода, текст и числа.
Библиотека для LuaКак ресурс на Lua использует aiLib, и функции, которые есть только в Lua.
ТипыВсе общие типы из сигнатур (Vec3, ActionResult, InventoryRef...), поле за полем.
Страницы скриптовСобственные экспорты и события каждого скрипта ai-* описаны на его странице Developer (например, ai-inventory, включая API ox_inventory и qb-inventory, на которые он отвечает).

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