Couches via ai-core

Ces objets ne parlent jamais à un script précis. Ils interrogent ai-core, et ai-core transmet au script que le serveur fait tourner pour cette tâche : ai-death ou un autre script de mort, ai-appearance ou tgiann-clothing, n’importe quel script d’emotes ou de menu radial pris en charge. Votre script continue de fonctionner quand le propriétaire en change. Le fonctionnement des couches est décrit dans Couches et pont.

Quand aucun script de ce type ne tourne, les appels répondent false, null ou la valeur propre au jeu, comme l’indique chaque entrée.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Indique si le joueur local est à terre (mort ou en last stand), quel que soit le script de mort qui tourne. Les scripts de mort gardent en vie un ped à terre pour l’animer, si bien que IsEntityDead seul ne les détecte pas. Une lecture en mémoire après le premier appel.

Côté : client · Attend : non

medical.isDead(): boolean

Pas d’équivalent Lua : appelez exports['ai-core']:IsDead() et écoutez l’événement local ai-core:client:dead (dead).

RetourCopy Anchor Link

boolean : true quand la couche médicale d’ai-core indique que le joueur est à terre, ou que le ped est mort pour le jeu.

ExempleCopy Anchor Link

import { medical, notify } from "@aicore-fivem/lib/client";

RegisterCommand(
  "phone",
  () => {
    if (medical.isDead()) return notify("You cannot use the phone now", "error");
    SetNuiFocus(true, true);
  },
  false,
);

medical.onChangeCopy Anchor Link

Exécute un gestionnaire quand le joueur local tombe à terre ou se relève.

Côté : client · Attend : non

medical.onChange(fn: (dead: boolean) => void): void

Pas d’équivalent Lua : AddEventHandler('ai-core:client:dead', function(dead) end).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

import { medical, Points } from "@aicore-fivem/lib/client";

const points = new Points();
medical.onChange(() => points.refresh()); // les points dont canShow lit medical.isDead()

appearanceCopy Anchor Link

L’apparence des peds via la couche d’apparence d’ai-core, quel que soit le script de vêtements qui tourne.

appearance.applyCopy Anchor Link

Applique une apparence enregistrée à un ped du modèle de cette apparence. Récupérez l’apparence sur le serveur avec appearance.get(charId), créez le ped avec look.model, puis appliquez-la. Sur le ped du joueur lui-même, cela change ses vêtements.

Côté : client · Attend : non

appearance.apply(ped: number, look: CharacterAppearance): boolean

local ok = aiLib.appearance.apply(ped, look)

ParamètresCopy Anchor Link

Le type est CharacterAppearance.

RetourCopy Anchor Link

boolean : false quand le ped a disparu, que le modèle diffère ou qu’aucun script de vêtements ne tourne.

ExempleCopy Anchor Link

import { appearance, LocalPed, triggerServerCallback } from "@aicore-fivem/lib/client";
import type { CharacterAppearance } from "@aicore-fivem/shared";

// Une copie endormie d’un personnage, habillée comme lui.
export async function showSleeper(charId: number): Promise<void> {
  const look = (await triggerServerCallback("mysleep:look", [charId]).catch(() => null)) as CharacterAppearance | null;
  if (!look) return;
  new LocalPed({
    model: look.model,
    coords: { x: 151.2, y: -1004.6, z: 29.4, heading: 90 },
    onSpawn: (ped) => appearance.apply(ped, look),
  });
}

appearance.readCopy Anchor Link

L’apparence qu’un ped porte en ce moment.

Côté : client · Attend : non

appearance.read(ped: number): CharacterAppearance | null

local look = aiLib.appearance.read(ped) -- table ou nil

ParamètresCopy Anchor Link

RetourCopy Anchor Link

CharacterAppearance | null : l’apparence, ou null (nil en Lua) quand le script de vêtements ne peut pas la déterminer ou qu’aucun ne tourne.

ExempleCopy Anchor Link

import { appearance, cache } from "@aicore-fivem/lib/client";

const before = appearance.read(cache.ped); // à remettre plus tard avec appearance.apply

appearance.openMenuCopy Anchor Link

Ouvre pour le joueur la boutique de vêtements, le barbier ou les tenues enregistrées du script de vêtements.

Côté : client · Attend : non

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParamètresCopy Anchor Link

Le type est ClothingMenu.

RetourCopy Anchor Link

boolean : false quand le script de vêtements n’a pas ce menu ou qu’aucun ne tourne.

ExempleCopy Anchor Link

import { appearance, Points } from "@aicore-fivem/lib/client";

const points = new Points();
points.add("barber", {
  coords: { x: -814.3, y: -183.8, z: 37.6 },
  label: "Barber",
  onPressed: () => appearance.openMenu("barber"),
});

appearance.wearOutfitCopy Anchor Link

Fait porter au joueur une tenue de métier (un uniforme) jusqu’à reloadSkin. Elle n’est pas enregistrée : une reconnexion ou reloadSkin rend au joueur ses propres vêtements. Seules les pièces listées changent.

Côté : client · Attend : non

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParamètresCopy Anchor Link

Les types sont JobOutfit et OutfitPiece.

RetourCopy Anchor Link

boolean : false quand ce n’est pas possible (aucun script de vêtements, un modèle qu’il ne prend pas en charge).

ExempleCopy Anchor Link

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

appearance.wearOutfit({
  components: [
    { id: 11, collection: "", index: 55, texture: 0 },
    { id: 4, collection: "", index: 35, texture: 0 },
  ],
  props: [{ id: 0, collection: "", index: -1, texture: 0 }],
});

appearance.reloadSkinCopy Anchor Link

Remet au joueur son apparence enregistrée (retire une tenue de métier).

Côté : client · Attend : non

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

RetourCopy Anchor Link

boolean : false sans script de vêtements.

ExempleCopy Anchor Link

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

RegisterCommand("offduty", () => appearance.reloadSkin(), false);

gesturesCopy Anchor Link

Mains en l’air, pointer du doigt et emotes du script d’emotes qui tourne, via ai-core.

gestures.isHandsUpCopy Anchor Link

Indique si le joueur local a les mains en l’air.

Côté : client · Attend : non

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

RetourCopy Anchor Link

boolean : true tant que les mains sont en l’air dans le script d’emotes en cours.

ExempleCopy Anchor Link

import { gestures, onServerCallback } from "@aicore-fivem/lib/client";

// Avant un braquage, le serveur demande si la victime s’est rendue.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Indique si le joueur local pointe du doigt.

Côté : client · Attend : non

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

RetourCopy Anchor Link

boolean : true tant qu’il pointe du doigt.

ExempleCopy Anchor Link

if (gestures.isPointing()) return; // ne pas lancer une emote par-dessus le pointage

gestures.providerCopy Anchor Link

Le script d’emotes qui répond pour les mains en l’air et le pointage.

Côté : client · Attend : non

gestures.provider(): string | null

local name = aiLib.gestures.provider()

RetourCopy Anchor Link

string | null : son nom de ressource, ou null (nil) quand aucun ne tourne.

ExempleCopy Anchor Link

console.log(`hands up from ${gestures.provider() ?? "nothing"}`);

gestures.playEmoteCopy Anchor Link

Joue une emote par son nom de commande (ce que les joueurs tapent après e) dans le script d’emotes en cours.

Côté : client · Attend : non

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

boolean : false sans script d’emotes.

ExempleCopy Anchor Link

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

RegisterCommand("hi", () => gestures.playEmote("wave"), false);

gestures.cancelEmoteCopy Anchor Link

Arrête l’emote que joue le joueur (menotté, mis à terre).

Côté : client · Attend : non

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

RetourCopy Anchor Link

boolean : false sans script d’emotes.

ExempleCopy Anchor Link

onServerEvent("mypolice:cuffed", () => gestures.cancelEmote());

gestures.emoteProviderCopy Anchor Link

Le script d’emotes qui joue les emotes (il peut différer de celui qui répond pour les mains en l’air).

Côté : client · Attend : non

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

RetourCopy Anchor Link

string | null : son nom de ressource, ou null (nil) quand aucun ne tourne.

ExempleCopy Anchor Link

if (gestures.emoteProvider() === null) console.log("no emote script: skipping the emote");

seatbeltCopy Anchor Link

La ceinture de sécurité du joueur local via ai-core, quel que soit le script de ceinture qui tourne.

seatbelt.isOnCopy Anchor Link

Indique si la ceinture est attachée. Demandez-le au besoin, pas à chaque frame.

Côté : client · Attend : non

seatbelt.isOn(): boolean | null

local worn = aiLib.seatbelt.isOn() -- booléen ou nil

RetourCopy Anchor Link

boolean | null : true ou false ; null (nil) quand aucun script de ceinture ne répond.

ExempleCopy Anchor Link

import { cache, notify, onCache, seatbelt } from "@aicore-fivem/lib/client";

onCache("vehicle", (vehicle) => {
  if (vehicle !== false && seatbelt.isOn() === false) notify("Buckle up", "warning");
});

seatbelt.onChangeCopy Anchor Link

Exécute un gestionnaire quand l’état de la ceinture change. Seuls les scripts de ceinture qui signalent les changements le déclenchent.

Côté : client · Attend : non

seatbelt.onChange(fn: (worn: boolean | null) => void): void

aiLib.seatbelt.onChange(function(worn) end)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

seatbelt.onChange((worn) => SendNUIMessage({ action: "belt", data: worn === true }));

seatbelt.providerCopy Anchor Link

Le script de ceinture qui répond.

Côté : client · Attend : non

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

RetourCopy Anchor Link

string | null : son nom de ressource, ou null (nil) quand aucun ne répond.

ExempleCopy Anchor Link

if (seatbelt.provider() === null) console.log("no seat belt script runs");

fuelCopy Anchor Link

fuel.getCopy Anchor Link

Le niveau de carburant d’un véhicule. Le serveur tient un state bag fuel pour chaque véhicule quel que soit le script de carburant qui tourne, c’est donc une lecture en mémoire ; sans ce state bag, c’est le niveau du réservoir du jeu.

Côté : client · Attend : non

fuel.get(vehicle: number): number

Pas d’équivalent Lua : lisez Entity(vehicle).state.fuel. Régler le carburant se fait uniquement côté serveur (fuel.set dans Véhicules).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

number : 0-100.

ExempleCopy Anchor Link

import { cache, every, fuel } from "@aicore-fivem/lib/client";

every(1000, () => {
  if (cache.vehicle !== false) SendNUIMessage({ action: "fuel", data: Math.round(fuel.get(cache.vehicle)) });
});

mdtCopy Anchor Link

mdt.openCopy Anchor Link

Ouvre le MDT de police actif pour le joueur local. Le MDT vérifie lui-même le métier.

Côté : client · Attend : non

mdt.open(): boolean

local ok = aiLib.mdt.open()

RetourCopy Anchor Link

boolean : false quand aucun MDT ne tourne ou qu’il ne peut pas être ouvert depuis l’extérieur.

ExempleCopy Anchor Link

import { mdt, notify } from "@aicore-fivem/lib/client";

RegisterCommand("mdt", () => {
  if (!mdt.open()) notify("No MDT available", "error");
}, false);

radialCopy Anchor Link

Des éléments dans le menu radial qui tourne (ai-radialmenu, ou un autre via la couche radiale d’ai-core). ai-core les conserve lors des redémarrages du menu radial et les retire quand votre ressource s’arrête : ajoutez-les une seule fois au démarrage.

radial.addCopy Anchor Link

Ajoute un élément à la roue, ou remplace l’élément portant le même id.

Côté : client · Attend : non

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParamètresCopy Anchor Link

RadialItemCopy Anchor Link

Le type est RadialItem.

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

import { cache, createLocale, hasJob, radial } from "@aicore-fivem/lib/client";
import { RADIAL_VEHICLE } from "@aicore-fivem/shared";

const Locale = createLocale<typeof import("../../locales/en.json")>();

radial.add({
  id: "myscript:engine",
  label: Locale("ENGINE"),
  icon: "power-off",
  parent: RADIAL_VEHICLE,
  keepOpen: true,
  canShow: () => cache.seat === -1,
  onPressed: () => {
    if (cache.vehicle === false) return;
    SetVehicleEngineOn(cache.vehicle, !GetIsVehicleEngineRunning(cache.vehicle), false, true);
  },
});

radial.add({
  id: "myscript:police",
  label: Locale("POLICE"),
  icon: "shield-halved",
  canShow: () => hasJob(["police"]),
  items: [
    { id: "myscript:cuff", label: Locale("CUFF"), icon: "handcuffs", onPressed: () => emitNet("mypolice:cuff") },
  ],
});

radial.removeCopy Anchor Link

Retire l’un de vos éléments. Un id inconnu ne fait rien.

Côté : client · Attend : non

radial.remove(id: string): void

aiLib.radial.remove(id)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Relit chaque canShow d’une roue ouverte. Appelez-la après qu’une chose qu’ils lisent a changé alors que la roue est peut-être ouverte.

Côté : client · Attend : non

radial.refresh(): void

aiLib.radial.refresh()

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

onMembershipChange(() => radial.refresh());

worldCopy Anchor Link

La synchronisation de la météo et de l’heure du script de météo qui tourne, mise en pause tant qu’une raison est active.

world.pauseSyncCopy Anchor Link

Met en pause la synchronisation de la météo et de l’heure pour une raison : dans un intérieur, pendant une scène, ou pendant que votre script règle sa propre météo.

Côté : client · Attend : non

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

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

export function enterApartment(): void {
  world.pauseSync("apartment");
  NetworkOverrideClockTime(12, 0, 0);
  SetWeatherTypeNowPersist("EXTRASUNNY");
}

export function leaveApartment(): void {
  world.resumeSync("apartment");
}

world.resumeSyncCopy Anchor Link

Retire une raison de pause ; la synchronisation reprend quand il ne reste aucune raison.

Côté : client · Attend : non

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void. Voir l’exemple de world.pauseSync.

inventoryCopy Anchor Link

L’inventaire du joueur local via la couche d’inventaire d’ai-core : l’inventaire choisi par le serveur répond. Donner et retirer des objets se fait uniquement côté serveur (Objets).

inventory.openInventoryCopy Anchor Link

Ouvre l’écran d’inventaire du joueur lui-même.

Côté : client · Attend : non

inventory.openInventory(): void

aiLib.inventory.openInventory()

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

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

RegisterCommand("bag", () => inventory.openInventory(), false);

inventory.hasItemCopy Anchor Link

Indique si le joueur possède au moins count exemplaires d’un objet. Utilisez-la dans canShow pour que le joueur ne voie que ce qu’il peut faire ; le serveur vérifie de nouveau.

Côté : client · Attend : non

inventory.hasItem(item: string, count?: number): boolean

local has = aiLib.inventory.hasItem(item, count)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

boolean : true quand le joueur en a assez.

ExempleCopy Anchor Link

import { inventory, Points } from "@aicore-fivem/lib/client";

const points = new Points();
points.addVehicle("lockpick", {
  label: "Lockpick",
  icon: "unlock",
  canShow: (vehicle) => GetVehicleDoorLockStatus(vehicle) >= 2 && inventory.hasItem("lockpick"),
  onPressed: (vehicle) => emitNet("mykeys:lockpick", NetworkGetNetworkIdFromEntity(vehicle)),
});

inventory.currentWeaponCopy Anchor Link

L’objet arme dans la main du joueur : son nom, son libellé et son image.

Côté : client · Attend : non

inventory.currentWeapon(): HeldWeapon | null

local weapon = aiLib.inventory.currentWeapon() -- table ou nil

RetourCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name comme WEAPON_PISTOL, image une url nui:// quand l’inventaire en a une), ou null (nil) quand la main est vide.

ExempleCopy Anchor Link

import { inventory, onCache } from "@aicore-fivem/lib/client";

// À lire quand l’arme change, jamais à chaque frame.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));