События и состояние
Как ai-core сообщает другим скриптам, что что-то изменилось - локальные события, сетевые события, state bag - и как их слушать в TypeScript и Lua.
ai-core сообщает другим скриптам, когда что-то меняется: загрузился персонаж, переместились деньги, сменилась работа, игрок упал, HUD скрылся. Ваш скрипт слушает, а не спрашивает снова и снова. В этом разделе перечислены все события и общие значения состояния, которые используют другие ресурсы.
Три вида
| Вид | Что это | Как слушать |
|---|---|---|
| Локальное событие | Отправляется на одной стороне (сервер или один клиент) для всех ресурсов на этой стороне. Никогда не пересекает сеть. Большинство событий ai-core локальные. | TS: on(name, handler). Lua: AddEventHandler(name, handler). |
| Сетевое событие | Отправляется с сервера на клиент одного игрока (или наоборот). | TS-клиент: onServerEvent(name, ...) из библиотеки. Lua-клиент: aiLib.onServerEvent(name, handler). |
| State bag | Значение, хранящееся в GlobalState, у игрока или у сущности. Читать его могут все; записывает только ресурс-владелец. | GlobalKey, PlayerState, EntityState, GlobalGroup из библиотеки или GlobalState[...], Player(src).state[...], Entity(e).state[...] в Lua. |
Страницы
| Страница | Что |
|---|---|
| Серверные события | Персонаж загружен, появился, выгружен; деньги, работы, дежурство, банды, метаданные; использован предмет; игрок умер; определения работ и банд; изменился инвентарь. |
| Клиентские события | Локальный персонаж загружен или выгружен, состояние «лежит», кэшированные значения, видимость HUD, синхронизация мира, подсказки клавиш, ремень безопасности. |
| Сетевые события | Канал данных игрока, который может слушать клиент, и собственный трафик ai-core, который нельзя вызывать. |
| События интерфейса ai-lib | Ответы меню, диалогов ввода, подсказок и полосы прогресса для скриптов, которые сами вызывают экспорты ai-lib. |
| State bag | PLAYER_BAGS, VEHICLE_BAGS и все ключи GlobalState, которые пишет ai-core. |
| События моста фреймворков | События ESX, QB / Qbox и vRP, которые ai-core отправляет для скриптов, написанных под эти фреймворки, и события фреймворков, на которые он отвечает. |
Имена берутся из констант
В TypeScript никогда не набирайте имя события вручную. Это константы в @aicore8/shared:
| Константа | События |
|---|---|
CORE | Серверные и клиентские события ai-core (CORE.playerLoadedEvent, CORE.clientDeadEvent...) и ключи GlobalState (CORE.pvpStateKey...). |
KEY_HINTS | KEY_HINTS.changedEvent. |
MENU_EVENTS, LIB_UI | Ответы интерфейса ai-lib. |
VEHICLES_EVENTS | Поток владельцев ai-vehicles. |
VRP | VRP.configEvent. |
PLAYER_BAGS, VEHICLE_BAGS, INVENTORY_STATE_KEY, APPEARANCE_STATE_KEY, dutyCountKey(job)... | Ключи state bag. |
В Lua констант нет: используйте строку, указанную рядом с каждым событием.
Первый обработчик
import { CORE, type CharacterInfo } from "@aicore8/shared";
on(CORE.playerLoadedEvent, (src: number, character: CharacterInfo) => {
console.log(`${character.firstname} ${character.lastname} joined as ${src}`);
});Для всей жизни персонажа на сервере (загружен, выгружен, а также персонажи, которые уже в мире, когда ваш ресурс перезапускается) используйте onCharacter({ loaded, unloaded }) из библиотеки (aiLib.onCharacter в Lua) вместо двух событий вручную. Ресурс, который стартует поздно, пропускает события, отправленные до его старта; onCharacter воспроизводит этих персонажей за вас.
Локальные события ai-core локальны намеренно. Никогда не делайте RegisterNetEvent (или onNet) для их имён: это позволит клиенту любого игрока отправить поддельный ai-core:moneyChanged или ai-core:playerLoaded в ваш обработчик. Простой AddEventHandler / on слышит только события, отправленные на той же стороне.
Уведомления
Как карточки уведомлений ai-lib попадают в сторонний интерфейс уведомлений через ai-core, и единственный экспорт, который за этим стоит.
Серверные события
Все серверные локальные события, которые отправляет ai-core - персонажи, деньги, работы, дежурство, банды, метаданные, определения, предметы, смерти - с аргументами и обработчиками на TypeScript и Lua.