Événements UI d’ai-lib

ai-lib dessine l’interface joueur partagée : menus, boîtes de saisie, invites, barre de progression, mini-jeux, notifications. Quand le joueur répond, ai-lib déclenche l’un de ces événements locaux client.

La plupart des scripts ne les écoutent jamais. menu, input, itemPicker, skillCheck, lockpick, onPromptPressed et progress de la lib (et les mêmes noms sur aiLib) ouvrent l’interface, attendent la réponse et vous la rendent comme valeur de retour. N’écoutez vous-même que si vous appelez directement les exports d’ai-lib (OpenMenu, OpenInput, OpenMinigame) ou OpenItemPicker d’ai-core.

Chaque réponse transporte la ressource qui a ouvert l’interface et l’id de requête qu’elle a choisi. Vérifiez les deux : chaque ressource du client entend chaque réponse.

ai-lib:client:menuResultCopy Anchor Link

Le joueur a choisi une entrée de menu ou fermé le menu. Le même événement répond au sélecteur d’objets d’ai-core et aux mini-jeux d’ai-lib.

Côté : Client · Constante : MENU_EVENTS.menuResult

ArgumentsCopy Anchor Link

ÉcouteurCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/client";
import { MENU_EVENTS } from "@aicore-fivem/shared";

const ui = resourceExport("ai-lib");
const me = GetCurrentResourceName();
let nextId = 0;
const waiting = new Map<number, (value: unknown) => void>();

on(MENU_EVENTS.menuResult, (resource: string, requestId: number, value: unknown) => {
  if (resource !== me) return;
  waiting.get(requestId)?.(value);
  waiting.delete(requestId);
});

// menu() de la lib fait exactement ceci ; montré ici pour expliquer l’événement.
export function pickColor(): Promise<string | null> {
  const id = ++nextId;
  return new Promise((resolve) => {
    waiting.set(id, (value) => resolve(typeof value === "string" ? value : null));
    ui.OpenMenu(id, {
      title: "Color",
      items: [
        { id: "red", label: "Red" },
        { id: "blue", label: "Blue" },
      ],
    });
  });
}

ai-lib:client:menuHoverCopy Anchor Link

Le pointeur ou le focus clavier est passé sur une entrée de menu. Utilisez-le pour des aperçus (afficher une couleur de véhicule pendant que le joueur la survole). Le menu reste ouvert.

Côté : Client · Constante : MENU_EVENTS.menuHover · Lib : menu(request, { onHover })

ArgumentsCopy Anchor Link

ÉcouteurCopy Anchor Link

import { menu } from "@aicore-fivem/lib/client";

// La lib transmet les survols de son propre menu à onHover.
export async function chooseColor(): Promise<string | null> {
  return menu(
    { title: "Color", items: [{ id: "red", label: "Red" }, { id: "blue", label: "Blue" }] },
    { onHover: (item) => console.log(`previewing ${item}`) },
  );
}

ai-lib:client:menuToggleCopy Anchor Link

Le joueur a basculé une ligne interrupteur (une entrée avec checked). L’interrupteur bascule sur place et le menu reste ouvert.

Côté : Client · Constante : MENU_EVENTS.menuToggle · Lib : menu(request, { onToggle })

ArgumentsCopy Anchor Link

ÉcouteurCopy Anchor Link

import { menu } from "@aicore-fivem/lib/client";

let sounds = true;

export async function openSettings(): Promise<void> {
  await menu(
    { title: "Settings", items: [{ id: "sounds", label: "Sounds", checked: sounds }] },
    { onToggle: (item, checked) => { if (item === "sounds") sounds = checked; } },
  );
}

ai-lib:client:inputResultCopy Anchor Link

Le joueur a confirmé ou fermé une boîte de saisie.

Côté : Client · Constante : MENU_EVENTS.inputResult · Lib : input(request)

ArgumentsCopy Anchor Link

ÉcouteurCopy Anchor Link

import { input } from "@aicore-fivem/lib/client";

// input() de la lib écoute ai-lib:client:inputResult pour vous.
export async function askName(): Promise<string | null> {
  const values = await input({
    title: "Rename",
    confirm: "Save",
    fields: [{ name: "name", label: "Name", type: "text", maxLength: 32 }],
  });
  return values && typeof values.name === "string" ? values.name : null;
}

ai-lib:client:promptPressedCopy Anchor Link

Le joueur a appuyé sur la touche d’interaction pendant qu’une invite était en haut de la liste. Seule la ressource qui a affiché cette invite doit réagir.

Côté : Client · Constante : LIB_UI.promptPressedEvent · Lib : onPromptPressed(handler)

ArgumentsCopy Anchor Link

ÉcouteurCopy Anchor Link

import { onPromptPressed, showPrompt } from "@aicore-fivem/lib/client";

showPrompt("atm", "Use ATM");
// onPromptPressed filtre sur votre ressource pour vous.
onPromptPressed((id) => {
  if (id === "atm") console.log("open the ATM");
});

ai-lib:client:cancelProgressCopy Anchor Link

Le joueur a appuyé sur la touche d’annulation d’ai-lib pendant l’affichage de la barre de progression. progress de la lib avec canCancel: true écoute et termine la barre avec false.

Côté : Client · Constante : LIB_UI.cancelProgressEvent

ArgumentsCopy Anchor Link

Aucun.

ÉcouteurCopy Anchor Link

import { LIB_UI } from "@aicore-fivem/shared";

// Nécessaire seulement si vous lancez vous-même ShowProgress d’ai-lib au lieu de progress() de la lib.
on(LIB_UI.cancelProgressEvent, () => console.log("player cancelled the bar"));

Événements internes d’ai-libCopy Anchor Link

Zones et Points de la lib confient leurs vérifications à ai-lib et reçoivent la réponse par ces événements. Ne les déclenchez pas ; utilisez Zones et Points.