AI Core
Справочник APILib: клиент

Lib: клиент

@aicore8/lib/client и клиентская сторона aiLib: что это такое, как загружать их в TypeScript и Lua, и все тематические страницы.

Клиентская lib это набор помощников, которые каждый клиентский скрипт ai-* использует вместо того, чтобы писать нативы вручную: связь с сервером, локальный игрок, точки взаимодействия, зоны, педы и блипы, общий интерфейс (уведомления, полоса прогресса, меню, мини-игры), клавиши и слои, которые через ai-core достигают того HUD, скрипта смерти, одежды или эмоций, который запущен на сервере.

TypeScript

Импортируйте из @aicore8/lib/client в файлах под resource/client/. Помощники, которые работают на любой стороне (отказы, функции чтения ввода, математика, RecordObjects, ServerClock), берутся из @aicore8/lib/shared.

resource/client/index.ts
import { Points, notify, progress, cache } from "@aicore8/lib/client";
import { RecordObjects, ServerClock } from "@aicore8/lib/shared";

Каждый ресурс, созданный из шаблона ai-core, уже зависит от этого пакета ("@aicore8/lib": "workspace:*" в package.json); сборка упаковывает его в dist/client.js.

Lua

Ресурсы на Lua получают те же помощники в глобальной таблице aiLib из ресурса ai-lib. Добавьте две строки в свой fxmanifest.lua:

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

Затем вызывайте aiLib.<name> в любом клиентском файле. Каждый модуль загружается при первом использовании и выполняется внутри вашего ресурса, поэтому созданные вами точки, клавиши и колбэки принадлежат вашему ресурсу и исчезают, когда он останавливается. Классы создаются через .new(), а их методы вызываются через двоеточие: local points = aiLib.Points.new(), затем points:add(...).

client.lua
local t = aiLib.locale()

RegisterCommand('hello', function()
    aiLib.notify(t('HELLO'), 'success')
end, false)

Функции Lua с пометкой Ждёт (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, загрузчики request*, pedHeadshot) приостанавливают код, пока не придёт ответ. Они работают только внутри потока. Обработчики команд и сетевых событий уже выполняются в потоке; в любом другом месте (onPressed точки, клавиша, колбэк меню) оберните вызов в CreateThread(function() ... end).

Не у каждого помощника TypeScript есть Lua-аналог. В каждой записи сказано, если его нет. В Lua отсутствуют: fromServer, isActionOk, replyError, onCache (в Lua есть cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, помощники свойств транспорта, ScriptCamera, TickLoop (используйте aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects и проверки членства (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Темы

Связь с сервером

triggerServerCallback, onServerEvent, onServerCallback, callAction, чтение ActionResult.

Локальный игрок

cache и onCache, player (координаты, телепорт, анимации), затемнения, playerPed, nearestPlayer.

Точки взаимодействия

Points: add, addModel, addVehicle, все опции, prompt или target, refresh, точки из записей панели.

Зоны

Zones: области с колбэками входа и выхода, формы сферы, цилиндра и полигона.

Педы, блипы и пропы

LocalPed, Blips, createBlip, attachProp, PreviewVehicle, player.holdAnim.

Общий интерфейс

notify, progress, menu, input, подсказки, skillCheck, lockpick, itemPicker.

Экраны и управление

NuiScreen, hud, keyHints, controls.

Клавиши

Keybind: переназначаемая клавиша, клавишу по умолчанию которой может изменить админ-панель.

Слои через ai-core

medical, appearance, gestures, seatbelt, fuel, mdt, radial, world, inventory.

Транспорт и сущности

nearestVehicle, drivenVehicle, waitForEntity, entityFromNetId, свойства транспорта.

Замеры и загрузка

raycast, groundZ, locationName, vehicleLabel, waypoint, pedHeadshot, onShot, requestModel и похожие.

Камера и время

ScriptCamera, TickLoop, AreaFollower, ServerClock.

Членство и данные игрока

hasJob, inGang, onDutyIn, allows, onMembershipChange, getPlayerData, onPlayerData.

Помощники, общие с сервером

Клиентская точка входа также реэкспортирует помощники /fivem, поэтому их можно импортировать и из @aicore8/lib/client. Они описаны один раз на странице 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, экспортируемые из клиентской точки входа, это клиентские версии только для чтения: get(id) и onChange(handler), без set. Серверные версии описаны на странице State bags.

Экспорты, которые ваш скрипт никогда не вызывает

ZoneEngine (проверка зон за Zones), ModelScanner и readModelScanDef (сканирование моделей за Points.addModel) экспортируются для ai-lib, который запускает их для каждого ресурса. Используйте вместо них Zones и Points.

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