AI Core
Справочник APIКлиентские экспорты ai-core

Клиентские экспорты ai-core

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

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

Большинство этих экспортов - слои: ai-core не выполняет работу сам, а передаёт вызов тому скрипту, который сервер использует для этой задачи (инвентарь, скрипт одежды, радиальное меню, меню эмоций, скрипт смерти, MDT). Ваш скрипт вызывает одно имя и продолжает работать, когда владелец сервера заменяет один из этих скриптов другим.

Перед началом

  • Каждый клиентский экспорт синхронный: он отвечает сразу и никогда не ждёт. Ничто на этих страницах не возвращает Promise, и ничему не нужен поток в Lua. Единственный экспорт, ответу которого нужно время (OpenItemPicker), отвечает через событие.
  • Вызывайте их только из клиентского кода. У сервера свой список: серверные экспорты ai-core.
  • ai-core должен быть запущен. Ресурс, который может работать без ai-core, использует optionalExport("ai-core") в TypeScript (он равен null, пока ai-core остановлен).
  • Каждый экспорт отвечает и с изменённым регистром первой буквы: GetPlayerData и getPlayerData - одна и та же функция.
  • То, что ресурс добавляет через эти экспорты (причины скрытия HUD, подсказки клавиш, пункты радиального меню, паузы синхронизации мира), принадлежит этому ресурсу. ai-core удаляет всё это, когда ресурс останавливается, поэтому сбой или перезапуск никогда не оставляет скрытый HUD или мёртвый пункт меню.

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

resource/client/index.ts
import { resourceExport } from "@aicore8/lib/client";

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

RegisterCommand(
  "myjob",
  () => {
    const data = core.GetPlayerData();
    console.log(data ? `job: ${data.job.job}` : "no character loaded");
  },
  false,
);

Используйте функцию библиотеки, если она есть

У большинства экспортов есть вспомогательная функция в @aicore8/lib/client и такая же функция в aiLib для ресурсов на Lua (shared_script '@ai-lib/init.lua'). Эти функции вызывают экспорт за вас, проверяют ответ и добавляют обработчик изменений, если он существует. Предпочитайте их; вызывайте экспорт напрямую, только когда не можете использовать библиотеку.

ЭкспортБиблиотека TypeScriptLua aiLibСтраница
GetPlayerData, IsPlayerLoaded, GetDefinitionsgetPlayerData, onPlayerDataaiLib.playerData.get, aiLib.playerData.onChangeИгрок
HideHud, ShowHud, IsHudVisiblehud.hide, hud.show, hud.visible, hud.onChangeaiLib.hud.hide, aiLib.hud.show, aiLib.hud.visibleHUD
OpenHudSettings, HasHudSettingsнетнетHUD
ShowKeyHint, HideKeyHintkeyHints.show, keyHints.hideaiLib.keyHints.show, aiLib.keyHints.hideПривязки и подсказки клавиш
GetKeybindKey, GetKeyHints, OpenKeyboardнетнетПривязки и подсказки клавиш
PauseWorldSync, ResumeWorldSyncworld.pauseSync, world.resumeSyncaiLib.world.pauseSync, aiLib.world.resumeSyncСинхронизация погоды и времени
OpenInventory, HasItem, GetCurrentWeaponinventory.openInventory, inventory.hasItem, inventory.currentWeaponaiLib.inventory.* (те же имена)Предметы
OpenItemPickeritemPickeraiLib.itemPickerПредметы
AddRadialItem, RemoveRadialItem, RefreshRadialradial.add, radial.remove, radial.refreshaiLib.radial.* (те же имена)Радиальное меню
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvidergestures.*aiLib.gestures.*Жесты и эмоции
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkinappearance.apply, read, openMenu, wearOutfit, reloadSkinaiLib.appearance.* (те же имена)Внешность
IsDeadmedical.isDead, medical.onChangeнет (вызывайте экспорт)Медицина
GetSeatbelt, GetSeatbeltProviderseatbelt.isOn, seatbelt.provider, seatbelt.onChangeaiLib.seatbelt.* (те же имена)Ремень безопасности
OpenMdtmdt.openaiLib.mdt.openMDT
ExternalNotifyнет (используется ai-lib)нетУведомления

Не вызывайте экспорты каждый кадр

Экспорты пересекают границу ресурса, а это дороже, чем вызов локальной функции. Прочитайте значение один раз, а затем следите за событием, которое сообщает об изменении. Каждая страница называет это событие; все они собраны в События и состояние.

Меню, диалоги ввода, уведомления, подсказки, полоса прогресса и мини-игры принадлежат ai-lib, а не ai-core. Используйте notify, menu, input, progress и skillCheck из библиотеки (или те же имена в aiLib).

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