Capas a través de ai-core

Estos objetos nunca hablan con un script concreto. Preguntan a ai-core, y ai-core reenvía al script que use el servidor para esa tarea: ai-death u otro script de muerte, ai-appearance o tgiann-clothing, cualquier script de emotes o de menú radial compatible. Tu script sigue funcionando cuando el dueño cambia uno. Cómo funcionan las capas está en Capas y el puente.

Cuando no hay ningún script de ese tipo en marcha, las llamadas responden false, null o el propio valor del juego, como indica cada entrada.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Si el jugador local está derribado (muerto o en last stand), en el script de muerte que funcione. Los scripts de muerte mantienen vivo un ped derribado para animarlo, así que IsEntityDead por sí solo no los detecta. Una lectura en memoria después de la primera llamada.

Lado: Cliente · Espera: no

medical.isDead(): boolean

Sin equivalente en Lua: llama a exports['ai-core']:IsDead() y escucha el evento local ai-core:client:dead (dead).

DevuelveCopy Anchor Link

boolean: true cuando la capa médica de ai-core dice que el jugador está derribado, o el ped está muerto para el juego.

EjemploCopy 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

Ejecuta un handler cuando el jugador local cae derribado o se levanta.

Lado: Cliente · Espera: no

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

Sin equivalente en Lua: AddEventHandler('ai-core:client:dead', function(dead) end).

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

void.

EjemploCopy Anchor Link

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

const points = new Points();
medical.onChange(() => points.refresh()); // puntos cuyo canShow lee medical.isDead()

appearanceCopy Anchor Link

El aspecto de los peds a través de la capa de apariencia de ai-core, sea cual sea el script de ropa que funcione.

appearance.applyCopy Anchor Link

Pone un aspecto guardado en un ped del modelo de ese aspecto. Obtén el aspecto en el servidor con appearance.get(charId), crea el ped con look.model y luego aplícalo. En el propio ped del jugador cambia su ropa.

Lado: Cliente · Espera: no

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

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

ParámetrosCopy Anchor Link

El tipo es CharacterAppearance.

DevuelveCopy Anchor Link

boolean: false cuando el ped ya no existe, el modelo es distinto o no hay script de ropa en marcha.

EjemploCopy Anchor Link

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

// Una copia dormida de un personaje, vestida como él.
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

El aspecto que lleva ahora un ped.

Lado: Cliente · Espera: no

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

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

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

CharacterAppearance | null: el aspecto, o null (nil en Lua) cuando el script de ropa no puede saberlo o no hay ninguno en marcha.

EjemploCopy Anchor Link

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

const before = appearance.read(cache.ped); // vuelve a ponerlo más tarde con appearance.apply

appearance.openMenuCopy Anchor Link

Abre la tienda de ropa, la barbería o los conjuntos guardados del script de ropa para el jugador.

Lado: Cliente · Espera: no

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParámetrosCopy Anchor Link

El tipo es ClothingMenu.

DevuelveCopy Anchor Link

boolean: false cuando el script de ropa no tiene ese menú o no hay ninguno en marcha.

EjemploCopy 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

Pone al jugador un conjunto de trabajo (un uniforme) hasta reloadSkin. No se guarda: una reconexión o reloadSkin devuelve al jugador su propia ropa. Solo cambian las piezas de la lista.

Lado: Cliente · Espera: no

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParámetrosCopy Anchor Link

Los tipos son JobOutfit y OutfitPiece.

DevuelveCopy Anchor Link

boolean: false cuando no puede (sin script de ropa, un modelo que no admite).

EjemploCopy 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

Vuelve a poner el aspecto guardado del jugador (le quita un conjunto de trabajo).

Lado: Cliente · Espera: no

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

DevuelveCopy Anchor Link

boolean: false sin script de ropa.

EjemploCopy Anchor Link

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

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

gesturesCopy Anchor Link

Manos arriba, señalar y emotes del script de emotes que funcione, a través de ai-core.

gestures.isHandsUpCopy Anchor Link

Si el jugador local tiene las manos arriba.

Lado: Cliente · Espera: no

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

DevuelveCopy Anchor Link

boolean: true mientras tiene las manos arriba en el script de emotes en marcha.

EjemploCopy Anchor Link

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

// El servidor pregunta antes de un robo si la víctima se rindió.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Si el jugador local está señalando.

Lado: Cliente · Espera: no

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

DevuelveCopy Anchor Link

boolean: true mientras señala.

EjemploCopy Anchor Link

if (gestures.isPointing()) return; // no empieces un emote encima de señalar

gestures.providerCopy Anchor Link

El script de emotes que responde a manos arriba y señalar.

Lado: Cliente · Espera: no

gestures.provider(): string | null

local name = aiLib.gestures.provider()

DevuelveCopy Anchor Link

string | null: el nombre de su recurso, o null (nil) cuando no hay ninguno en marcha.

EjemploCopy Anchor Link

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

gestures.playEmoteCopy Anchor Link

Reproduce un emote por su nombre de comando (lo que escriben los jugadores después de e) en el script de emotes en marcha.

Lado: Cliente · Espera: no

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

boolean: false sin script de emotes.

EjemploCopy Anchor Link

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

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

gestures.cancelEmoteCopy Anchor Link

Detiene el emote que reproduce el jugador (esposado, derribado).

Lado: Cliente · Espera: no

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

DevuelveCopy Anchor Link

boolean: false sin script de emotes.

EjemploCopy Anchor Link

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

gestures.emoteProviderCopy Anchor Link

El script de emotes que reproduce los emotes (puede ser distinto del que responde a manos arriba).

Lado: Cliente · Espera: no

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

DevuelveCopy Anchor Link

string | null: el nombre de su recurso, o null (nil) cuando no hay ninguno en marcha.

EjemploCopy Anchor Link

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

seatbeltCopy Anchor Link

El cinturón de seguridad del jugador local a través de ai-core, sea cual sea el script de cinturón que funcione.

seatbelt.isOnCopy Anchor Link

Si el cinturón está puesto. Pregunta cuando lo necesites, no en cada frame.

Lado: Cliente · Espera: no

seatbelt.isOn(): boolean | null

local worn = aiLib.seatbelt.isOn() -- boolean o nil

DevuelveCopy Anchor Link

boolean | null: true o false; null (nil) cuando no responde ningún script de cinturón.

EjemploCopy 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

Ejecuta un handler cuando cambia el cinturón. Solo lo disparan los scripts de cinturón que informan de los cambios.

Lado: Cliente · Espera: no

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

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

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

void.

EjemploCopy Anchor Link

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

seatbelt.providerCopy Anchor Link

El script de cinturón que responde.

Lado: Cliente · Espera: no

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

DevuelveCopy Anchor Link

string | null: el nombre de su recurso, o null (nil) cuando no responde ninguno.

EjemploCopy Anchor Link

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

fuelCopy Anchor Link

fuel.getCopy Anchor Link

El nivel de combustible de un vehículo. El servidor mantiene un state bag fuel para cada vehículo sea cual sea el script de combustible que funcione, así que es una lectura en memoria; sin ese state bag es el nivel del depósito del juego.

Lado: Cliente · Espera: no

fuel.get(vehicle: number): number

Sin equivalente en Lua: lee Entity(vehicle).state.fuel. Fijar el combustible es solo de servidor (fuel.set en Vehículos).

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

number: 0-100.

EjemploCopy 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

Abre el MDT policial activo para el jugador local. El MDT comprueba el trabajo por sí mismo.

Lado: Cliente · Espera: no

mdt.open(): boolean

local ok = aiLib.mdt.open()

DevuelveCopy Anchor Link

boolean: false cuando no hay MDT en marcha o no se puede abrir desde fuera.

EjemploCopy Anchor Link

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

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

radialCopy Anchor Link

Entradas en el menú radial que funcione (ai-radialmenu, u otro a través de la capa radial de ai-core). ai-core las conserva a través de los reinicios del menú radial y las quita cuando tu recurso se detiene: añádelas una vez al arrancar.

radial.addCopy Anchor Link

Añade una entrada a la rueda, o reemplaza la entrada con el mismo id.

Lado: Cliente · Espera: no

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParámetrosCopy Anchor Link

RadialItemCopy Anchor Link

El tipo es RadialItem.

DevuelveCopy Anchor Link

void.

EjemploCopy 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

Quita una de tus entradas. Un id desconocido no hace nada.

Lado: Cliente · Espera: no

radial.remove(id: string): void

aiLib.radial.remove(id)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

void.

EjemploCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Vuelve a leer cada canShow de una rueda abierta. Llámalo después de que cambie algo que leen mientras la rueda puede estar abierta.

Lado: Cliente · Espera: no

radial.refresh(): void

aiLib.radial.refresh()

DevuelveCopy Anchor Link

void.

EjemploCopy Anchor Link

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

worldCopy Anchor Link

La sincronización de clima y hora del script de clima que funcione, en pausa mientras haya un motivo activo.

world.pauseSyncCopy Anchor Link

Pausa la sincronización de clima y hora por un motivo: dentro de un interior, durante una escena o mientras tu script fija su propio clima.

Lado: Cliente · Espera: no

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

void.

EjemploCopy 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

Quita un motivo de pausa; la sincronización vuelve a funcionar cuando no queda ningún motivo.

Lado: Cliente · Espera: no

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

void. Consulta el ejemplo de world.pauseSync.

inventoryCopy Anchor Link

El inventario del jugador local a través de la capa de inventario de ai-core: responde el inventario que eligió el servidor. Dar y quitar objetos es solo de servidor (Objetos).

inventory.openInventoryCopy Anchor Link

Abre la pantalla del inventario propio del jugador.

Lado: Cliente · Espera: no

inventory.openInventory(): void

aiLib.inventory.openInventory()

DevuelveCopy Anchor Link

void.

EjemploCopy Anchor Link

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

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

inventory.hasItemCopy Anchor Link

Si el jugador tiene al menos count unidades de un objeto. Úsalo en canShow para que el jugador solo vea lo que puede hacer; el servidor lo comprueba de nuevo.

Lado: Cliente · Espera: no

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

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

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

boolean: true cuando el jugador tiene suficientes.

EjemploCopy 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

El objeto de arma en la mano del jugador: su nombre, su etiqueta y su imagen.

Lado: Cliente · Espera: no

inventory.currentWeapon(): HeldWeapon | null

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

DevuelveCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name como WEAPON_PISTOL, image una URL nui:// cuando el inventario tiene una), o null (nil) cuando la mano está vacía.

EjemploCopy Anchor Link

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

// Léelo cuando cambie el arma, nunca en cada frame.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));