Véhicules et entités

Trouver les véhicules proches du joueur, convertir les ids réseau envoyés par le serveur en entités locales, et lire ou appliquer l’apparence d’un véhicule. Faire apparaître un véhicule se fait uniquement côté serveur (spawnVehicle sur Véhicules) ; une voiture de showroom locale est un PreviewVehicle.

Trouver des véhiculesCopy Anchor Link

nearestVehicleCopy Anchor Link

Le véhicule le plus proche du joueur local dans un rayon donné. Le véhicule dans lequel le joueur est assis passe en premier, sauf avec notOwn. Utilisez filter pour ignorer les véhicules qui ne conviennent pas, de sorte que le coffre derrière lequel se tient le joueur l’emporte sur une voiture plus proche à côté.

Côté : client · Attend : non

nearestVehicle(metres: number, options?: { networked?: boolean; notOwn?: boolean; filter?: (vehicle: number) => boolean }): number

local vehicle = aiLib.nearestVehicle(metres, options) -- 0 s’il n’y en a aucun

ParamètresCopy Anchor Link

OptionsCopy Anchor Link

RetourCopy Anchor Link

number : le handle du véhicule, ou 0 quand aucun n’est dans le rayon metres.

ExempleCopy Anchor Link

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

export async function impound(): Promise<void> {
  const vehicle = nearestVehicle(5, { notOwn: true, filter: (v) => GetPedInVehicleSeat(v, -1) === 0 });
  if (!vehicle) return notify("No empty vehicle near", "error");
  await callAction("mypolice:impound", [NetworkGetNetworkIdFromEntity(vehicle)], { fallback: "IMPOUND_FAILED" });
}

drivenVehicleCopy Anchor Link

Le véhicule que conduit le joueur local (assis sur le siège conducteur).

Côté : client · Attend : non

drivenVehicle(): number | false

Pas d’équivalent Lua : aiLib.cache.seat == -1 and aiLib.cache.vehicle.

RetourCopy Anchor Link

number | false : le handle du véhicule quand le joueur est le conducteur, false à pied ou en tant que passager.

ExempleCopy Anchor Link

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

RegisterCommand(
  "flip",
  () => {
    const vehicle = drivenVehicle();
    if (vehicle === false) return notify("You must drive a vehicle", "error");
    SetVehicleOnGroundProperly(vehicle);
  },
  false,
);

Entités depuis des ids réseauCopy Anchor Link

Le serveur envoie les entités sous forme d’ids réseau. Sur un client, l’entité peut ne pas encore exister (le joueur est loin, ou elle vient d’être créée).

waitForEntityCopy Anchor Link

Attend que l’entité d’un id réseau existe sur ce client et la renvoie.

Côté : client · Attend : oui (Promise en TypeScript, cède la main (yield) du thread en Lua)

waitForEntity(netId: number, timeoutMs?: number): Promise<number>

local entity = aiLib.waitForEntity(netId, timeout) -- à appeler dans un thread

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Promise<number> : le handle de l’entité locale, ou 0 après le délai. Elle n’est jamais rejetée.

ExempleCopy Anchor Link

import { onServerEvent, waitForEntity } from "@aicore-fivem/lib/client";
import { readId } from "@aicore-fivem/lib/shared";

// Le serveur a fait apparaître un véhicule de métier et envoie son id réseau.
onServerEvent(
  "myjob:vehicle",
  { args: ([id]) => { const netId = readId(id); return netId === null ? null : [netId]; } },
  async (netId) => {
    const vehicle = await waitForEntity(netId);
    if (vehicle) SetVehicleFuelLevel(vehicle, 100);
  },
);

entityFromNetIdCopy Anchor Link

L’entité locale d’un id réseau à l’instant, sans attendre. Vérifie éventuellement le type de l’entité.

Côté : client · Attend : non

entityFromNetId(netId: number, type?: 1 | 2 | 3): number

Pas d’équivalent Lua : NetworkDoesEntityExistWithNetworkId(netId) and NetToEnt(netId) or 0.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

number : le handle de l’entité, ou 0 quand elle n’est pas sur ce client ou n’est pas du type type.

ExempleCopy Anchor Link

import { entityFromNetId, EntityState, stateBoolean } from "@aicore-fivem/lib/client";

const sirens = new EntityState("sirensMuted", stateBoolean);

sirens.onChange((netId, muted) => {
  const vehicle = entityFromNetId(netId, 2);
  if (vehicle) SetVehicleHasMutedSirens(vehicle, muted === true);
});

Apparence du véhiculeCopy Anchor Link

getVehiclePropsCopy Anchor Link

Lit toutes les propriétés d’un véhicule que ce client peut voir : plaque, couleurs, mods, extras, néons, dégâts. Stockez le résultat pour remettre plus tard la même apparence.

Côté : client · Attend : non

getVehicleProps(vehicle: number): VehicleProps

Pas d’équivalent Lua.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

VehicleProps : v (version de format 1), model, plate (sans espaces superflus), plateIndex, colors, extraColors, customPrimary, customSecondary (RGB ou null), wheelType, windowTint, livery, mods (par type de mod 0-49 ; les mods à bascule 17-22 valent 1 ou 0), xenonColor, neon (quatre booléens), neonColor, tyreSmoke, extras (par id d’extra), dirt, engineHealth, bodyHealth.

ExempleCopy Anchor Link

import { callAction, drivenVehicle, getVehicleProps } from "@aicore-fivem/lib/client";

export async function saveLook(): Promise<void> {
  const vehicle = drivenVehicle();
  if (vehicle === false) return;
  await callAction("mygarage:saveProps", [NetworkGetNetworkIdFromEntity(vehicle), getVehicleProps(vehicle)], { fallback: "SAVE_FAILED" });
}

setVehiclePropsCopy Anchor Link

Applique des propriétés stockées à un véhicule. Ne fonctionne que sur un véhicule que ce client contrôle ; les autres joueurs reçoivent l’apparence par le réseau.

Côté : client · Attend : non

setVehicleProps(vehicle: number, props: VehicleProps): void

Pas d’équivalent Lua.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

import { onServerEvent, setVehicleProps, waitForEntity } from "@aicore-fivem/lib/client";
import { readId, toVehicleProps } from "@aicore-fivem/lib/shared";

onServerEvent(
  "mygarage:look",
  {
    args: ([id, raw]) => {
      const netId = readId(id);
      const props = toVehicleProps(raw);
      return netId === null || props === null ? null : [netId, props];
    },
  },
  async (netId, props) => {
    const vehicle = await waitForEntity(netId);
    if (vehicle && NetworkHasControlOfEntity(vehicle)) setVehicleProps(vehicle, props);
  },
);

setVehicleSetupCopy Anchor Link

Applique une configuration d’apparition à un véhicule tout juste créé : performances au maximum, couleurs, livrée, teinte des vitres, saleté, moteur allumé. Ne fonctionne que sur un véhicule que ce client contrôle.

Côté : client · Attend : non

setVehicleSetup(vehicle: number, setup: VehicleSetup): void

Pas d’équivalent Lua.

ParamètresCopy Anchor Link

VehicleSetupCopy Anchor Link

Le type est VehicleSetup.

RetourCopy Anchor Link

void.

ExempleCopy Anchor Link

import { PreviewVehicle, setVehicleSetup } from "@aicore-fivem/lib/client";

const preview = new PreviewVehicle();

export function showMaxed(model: string): Promise<number> {
  return preview.show(model, { x: -44.4, y: -1097.1, z: 26.4, heading: 120 }, (vehicle) =>
    setVehicleSetup(vehicle, { maxed: true, primary: [20, 200, 120], windowTint: 1 }),
  );
}