Lib: сервер
@aicore8/lib/server и серверная сторона aiLib: что это такое, как загружать их в TypeScript и Lua, и все тематические страницы.
Серверная lib это набор помощников, которые каждый серверный скрипт ai-* использует вместо того, чтобы снова писать один и тот же код: безопасные ответы клиентам, команды, игроки, предметы, транспорт, деньги, логи и админ-панель. Большинство помощников, которые затрагивают другую систему (инвентарь, ключи, телефон, тюрьма...), работают через ai-core, поэтому ваш скрипт продолжает работать, когда владелец сервера меняет скрипт инвентаря или телефона.
TypeScript
Импортируйте из @aicore8/lib/server в файлах под resource/server/. Помощники, которые работают на любой стороне (отказы, функции чтения ввода, математика), берутся из @aicore8/lib/shared.
import { onClientCallback, inventory, notify } from "@aicore8/lib/server";
import { fail, oneArg, readId } from "@aicore8/lib/shared";Каждый ресурс, созданный из шаблона ai-core, уже зависит от этого пакета ("@aicore8/lib": "workspace:*" в package.json); сборка упаковывает его в dist/server.js.
Lua
Ресурсы на Lua получают те же помощники в глобальной таблице aiLib из ресурса ai-lib. Добавьте две строки в свой fxmanifest.lua:
dependency 'ai-lib'
shared_script '@ai-lib/init.lua'Затем вызывайте aiLib.<name> в любом серверном файле. Каждый модуль загружается при первом использовании и выполняется внутри вашего ресурса, поэтому зарегистрированные вами команды и колбэки принадлежат вашему ресурсу и исчезают, когда он останавливается.
aiLib.addCommand('hello', { help = 'Says hello' }, function(source)
aiLib.notify(source, 'Hello!', 'success')
end)Функции Lua с пометкой Ждёт (progressFor, minigameFor, spawnVehicle, triggerClientCallback, billing.unpaid, appearance.get) приостанавливают код, пока не придёт ответ. Они работают только внутри потока. Обработчики aiLib.onClientCallback и aiLib.onClientEvent уже выполняются в потоке; в любом другом месте оберните вызов в CreateThread(function() ... end).
Не у каждого помощника TypeScript есть Lua-аналог. В каждой записи сказано, если его нет. В Lua отсутствуют: PendingActions, PlayerMap, Cooldowns, KeyedCooldowns, SourceLock, KeyWatchers, помощники для позиций, AreaStream, классы state bag, AdminPanel, DataFile и помощники для базы данных (ресурсы на Lua используют для SQL oxmysql API из ai-mysql).
Темы
Ввод от клиента
onClientCallback, onClientEvent, guard-условия, triggerClientCallback, progressFor, minigameFor, PendingActions.
Команды
addCommand: разобранные аргументы, права, подсказки в чате.
Игроки и персонажи
online, onCharacter, notify, игроки рядом, позиции, PlayerMap, кулдауны, блокировки, ограничения частоты.
Персонажи, загруженные или нет
characters: найдите, прочитайте и измените любого персонажа через ai-core - деньги, работы, банды, метаданные, имя, время игры.
Предметы
inventory: выдать, забрать, посчитать, хранилища, магазины, используемые предметы.
Транспорт
spawnVehicle, vehicleType, vehicleKeys, топливо, гаражи, сущности по сетевым id.
Деньги и банк
money.transfer, banking, billing.
Работы и службы
dispatch, prison, mdt, ems, medical, stress, needs, definitions, isPrimeTime.
Мир
Время и погода, routing buckets, двери, сохранённые персонажи.
Телефон и внешность
номера телефонов, письма, сообщения; сохранённая внешность персонажей.
State bags
EntityState, PlayerState, GlobalKey, GlobalGroup: запись реплицируемых значений.
Логи
aiLog, aiLogChannels: логи через ai-core в Discord, Fivemanage и другие сервисы.
Потоковая передача областей
AreaStream: объекты мира, которые отправляются только игрокам рядом с ними.
Админ-панель
AdminPanel и DataFile: настройки вашего скрипта в панели ai-core.
База данных
createDatabaseTables, WriteQueue.
Помощники, общие с клиентом
Серверная точка входа также реэкспортирует помощники /fivem, поэтому их можно импортировать и из @aicore8/lib/server. Они описаны один раз на странице Lib: общее и fivem:
registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (с типами EveryOptions и Job), stateBoolean, stateNumber, stateString (тип StateParse).
Классы state bag EntityState, PlayerState, GlobalKey и GlobalGroup, экспортируемые из серверной точки входа, это серверные версии: они добавляют set. См. State bags.
Два помощника, которые использует только ai-core
sendPlayerData(source, key, value) и patchPlayerData(source, key, patch) отправляют одно значение данных игрока (AiPlayerData) на клиент этого игрока. Их вызывает ai-core; вашему скрипту они никогда не нужны. Читайте данные игрока на клиенте через getPlayerData (Lib: клиент).
Членство и данные игрока
hasJob, inGang, onDutyIn, allows, onMembershipChange, getPlayerData, onPlayerData и seedPlayerData - персонаж, деньги, работы, дежурство и банды локального игрока в том виде, в каком их присылает ai-core.
Ввод от клиента
Безопасные ответы клиентам: onClientCallback, onClientEvent, guard-условия, triggerClientCallback, полосы прогресса и мини-игры с проверкой на сервере, PendingActions.