ai-radialmenu для разработчиков

Добавление пункта (рекомендуемый способ)Copy Anchor Link

radial.addCopy Anchor Link

Добавляет пункт в колесо или заменяет пункт с тем же id.

Сторона: клиент · Ожидание: нет

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ПараметрыCopy Anchor Link

RadialItemCopy Anchor Link

ВозвращаетCopy Anchor Link

Ничего.

ПримерCopy Anchor Link

import { radial, notify, onPlayerData, getPlayerData } from "@aicore-fivem/lib/client";
import { RADIAL_VEHICLE } from "@aicore-fivem/shared";
import Locale from "common/locale";

// Категория полиции на главном колесе, показывается только на дежурстве.
radial.add({
  id: "police",
  label: Locale("RADIAL_POLICE"),
  icon: "shield-halved",
  canShow: () => getPlayerData("duty") === "police",
  items: [
    { id: "police_cuff", label: Locale("RADIAL_CUFF"), icon: "handcuffs", onPressed: () => emit("myscript:cuffNearest") },
  ],
});

// Пункт внутри встроенной категории транспорта.
radial.add({
  id: "myscript_windows",
  label: Locale("RADIAL_WINDOWS"),
  icon: "car-side",
  parent: RADIAL_VEHICLE,
  keepOpen: true,
  onPressed: () => notify(Locale("WINDOWS_TOGGLED"), "info"),
});

// Дежурство изменилось: заново прочитать каждый canShow открытого колеса.
onPlayerData("duty", () => radial.refresh());

radial.removeCopy Anchor Link

Удаляет один из ваших пунктов по id. Сторона: клиент · Ожидание: нет.

radial.remove(id: string): void

aiLib.radial.remove('myscript_windows')

radial.refreshCopy Anchor Link

Заново читает каждый canShow открытого колеса. Вызывайте после того, как данные, которые читает ваш canShow, изменились, пока колесо может быть открыто. Сторона: клиент · Ожидание: нет.

radial.refresh(): void

aiLib.radial.refresh()

Собственные клиентские экспорты ai-radialmenuCopy Anchor Link

Их вызывает радиальный слой AI Core. Они типизированы как AiRadialClientExports в @aicore-fivem/shared.

Пункты, подменю и состояния пунктов ресурса удаляются, когда этот ресурс останавливается.

API, на которые он отвечаетCopy Anchor Link

ai-radialmenu делает provide для двух других колёс, поэтому имена их экспортов доходят до него:

• qb-radialmenu: AddOption(data, id?) возвращает id, под которым хранится пункт; RemoveOption(id). Поля пункта title, icon (принимается fas fa-x), items, action (функция) или type + event (client, server, command, qbcommand), shouldClose = false оставляет колесо открытым.
• tgiann-radialmenu-target: AddMenuItem(item | items, parentId?), RemoveMenuItem(id, parentId?), ClearMenuItems(), RegisterSubMenu({ id, items }), RefreshMenu(), DisableMenu(state), IsMenuDisabled(), OpenMenu(), CloseMenu(), IsMenuOpen(), HasMenuItem(id), SetMenuItemHidden(id, state), IsMenuItemHidden(id), UpdateMenuItem(id, { label?, icon? }), ResetMenuItem(id). Поля пункта label (текст или { en, tr }, выбирается по convar ai:locale), canInteract(args), onSelect(args), event + type + args, command, export { resource, name, args }, menu, shouldClose, whileDead.

Не поддерживается: GetCurrentMenuId из tgiann-radialmenu-target, его настройки и серверные экспорты, а также его локальные события (menuOpened, itemSelected). На его API target отвечает ai-target.

СобытияCopy Anchor Link

Для других скриптов нет. NUI-сообщения колеса (open, update, close) и колбэки (select, close) внутренние.