Camadas pelo ai-core

Estes objetos nunca falam com um script específico. Eles perguntam ao ai-core, e o ai-core encaminha para qualquer script que o servidor roda para aquela tarefa: ai-death ou outro script de morte, ai-appearance ou tgiann-clothing, qualquer script de emotes ou radial suportado. Seu script continua funcionando quando o dono troca um deles. Como as camadas funcionam está em Camadas e a ponte.

Quando nenhum script desse tipo está rodando, as chamadas respondem false, null ou o próprio valor do jogo, como cada entrada indica.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Se o jogador local está caído (morto ou em last stand), em qualquer script de morte rodando. Scripts de morte mantêm um ped caído vivo para animá-lo, então IsEntityDead sozinho não os detecta. Uma leitura em memória depois da primeira chamada.

Lado: Cliente · Espera: não

medical.isDead(): boolean

Sem equivalente em Lua: chame exports['ai-core']:IsDead() e escute o evento local ai-core:client:dead (dead).

RetornoCopy Anchor Link

boolean: true quando a camada médica do ai-core diz que o jogador está caído, ou o ped está morto para o jogo.

ExemploCopy 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

Roda um handler quando o jogador local cai ou se levanta.

Lado: Cliente · Espera: não

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

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

ExemploCopy Anchor Link

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

const points = new Points();
medical.onChange(() => points.refresh()); // pontos cujo canShow lê medical.isDead()

appearanceCopy Anchor Link

Visuais em peds pela camada de aparência do ai-core, qualquer que seja o script de roupas rodando.

appearance.applyCopy Anchor Link

Coloca um visual salvo em um ped do modelo desse visual. Pegue o visual no servidor com appearance.get(charId), crie o ped com look.model e depois aplique. No próprio ped do jogador, troca as roupas dele.

Lado: Cliente · Espera: não

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

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

ParâmetrosCopy Anchor Link

O tipo é CharacterAppearance.

RetornoCopy Anchor Link

boolean: false quando o ped sumiu, o modelo é diferente ou nenhum script de roupas está rodando.

ExemploCopy Anchor Link

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

// Uma cópia dormindo de um personagem, vestida como ele.
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

O visual que um ped está usando agora.

Lado: Cliente · Espera: não

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

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

CharacterAppearance | null: o visual, ou null (nil em Lua) quando o script de roupas não consegue informar ou nenhum está rodando.

ExemploCopy Anchor Link

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

const before = appearance.read(cache.ped); // coloque-o de volta depois com appearance.apply

appearance.openMenuCopy Anchor Link

Abre a loja de roupas, a barbearia ou as roupas salvas do script de roupas para o jogador.

Lado: Cliente · Espera: não

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParâmetrosCopy Anchor Link

O tipo é ClothingMenu.

RetornoCopy Anchor Link

boolean: false quando o script de roupas não tem esse menu ou nenhum está rodando.

ExemploCopy 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

Coloca uma roupa de emprego (um uniforme) no jogador até reloadSkin. Não é salva: uma reconexão ou reloadSkin devolve as roupas próprias do jogador. Só as peças listadas mudam.

Lado: Cliente · Espera: não

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParâmetrosCopy Anchor Link

Os tipos são JobOutfit e OutfitPiece.

RetornoCopy Anchor Link

boolean: false quando não consegue (sem script de roupas, um modelo que ele não suporta).

ExemploCopy 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

Coloca de volta o visual salvo do jogador (tira uma roupa de emprego).

Lado: Cliente · Espera: não

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

RetornoCopy Anchor Link

boolean: false sem um script de roupas.

ExemploCopy Anchor Link

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

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

gesturesCopy Anchor Link

Mãos para cima, apontar e emotes de qualquer script de emotes rodando, pelo ai-core.

gestures.isHandsUpCopy Anchor Link

Se o jogador local está com as mãos para cima.

Lado: Cliente · Espera: não

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

RetornoCopy Anchor Link

boolean: true enquanto as mãos estão para cima no script de emotes rodando.

ExemploCopy Anchor Link

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

// O servidor pergunta antes de um roubo se a vítima se rendeu.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Se o jogador local está apontando.

Lado: Cliente · Espera: não

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

RetornoCopy Anchor Link

boolean: true enquanto aponta.

ExemploCopy Anchor Link

if (gestures.isPointing()) return; // não inicie um emote por cima do apontar

gestures.providerCopy Anchor Link

O script de emotes que responde por mãos para cima e apontar.

Lado: Cliente · Espera: não

gestures.provider(): string | null

local name = aiLib.gestures.provider()

RetornoCopy Anchor Link

string | null: o nome do recurso dele, ou null (nil) quando nenhum está rodando.

ExemploCopy Anchor Link

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

gestures.playEmoteCopy Anchor Link

Toca um emote pelo nome de comando (o que os jogadores digitam depois de e) no script de emotes rodando.

Lado: Cliente · Espera: não

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: false sem um script de emotes.

ExemploCopy Anchor Link

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

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

gestures.cancelEmoteCopy Anchor Link

Para o emote que o jogador está tocando (algemado, derrubado).

Lado: Cliente · Espera: não

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

RetornoCopy Anchor Link

boolean: false sem um script de emotes.

ExemploCopy Anchor Link

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

gestures.emoteProviderCopy Anchor Link

O script de emotes que toca emotes (pode ser diferente do que responde por mãos para cima).

Lado: Cliente · Espera: não

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

RetornoCopy Anchor Link

string | null: o nome do recurso dele, ou null (nil) quando nenhum está rodando.

ExemploCopy Anchor Link

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

seatbeltCopy Anchor Link

O cinto de segurança do jogador local pelo ai-core, qualquer que seja o script de cinto rodando.

seatbelt.isOnCopy Anchor Link

Se o cinto está colocado. Pergunte sob demanda, não a cada frame.

Lado: Cliente · Espera: não

seatbelt.isOn(): boolean | null

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

RetornoCopy Anchor Link

boolean | null: true ou false; null (nil) quando nenhum script de cinto responde.

ExemploCopy 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

Roda um handler quando o cinto muda. Só os scripts de cinto que informam mudanças o disparam.

Lado: Cliente · Espera: não

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

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

ExemploCopy Anchor Link

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

seatbelt.providerCopy Anchor Link

O script de cinto que responde.

Lado: Cliente · Espera: não

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

RetornoCopy Anchor Link

string | null: o nome do recurso dele, ou null (nil) quando nenhum responde.

ExemploCopy Anchor Link

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

fuelCopy Anchor Link

fuel.getCopy Anchor Link

O nível de combustível de um veículo. O servidor mantém um state bag fuel para todo veículo, qualquer que seja o script de combustível rodando, então isto é uma leitura em memória; sem esse bag é o nível do tanque do jogo.

Lado: Cliente · Espera: não

fuel.get(vehicle: number): number

Sem equivalente em Lua: leia Entity(vehicle).state.fuel. Definir o combustível é só no servidor (fuel.set em Veículos).

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

number: 0-100.

ExemploCopy 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 o MDT da polícia ativo para o jogador local. O MDT verifica o emprego ele mesmo.

Lado: Cliente · Espera: não

mdt.open(): boolean

local ok = aiLib.mdt.open()

RetornoCopy Anchor Link

boolean: false quando nenhum MDT está rodando ou ele não pode ser aberto de fora.

ExemploCopy Anchor Link

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

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

radialCopy Anchor Link

Itens em qualquer menu radial rodando (ai-radialmenu, ou outro pela camada radial do ai-core). O ai-core os mantém entre reinícios do radial e os descarta quando o seu recurso para: adicione uma vez na inicialização.

radial.addCopy Anchor Link

Adiciona um item à roda, ou substitui o item com o mesmo id.

Lado: Cliente · Espera: não

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParâmetrosCopy Anchor Link

RadialItemCopy Anchor Link

O tipo é RadialItem.

RetornoCopy Anchor Link

void.

ExemploCopy 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

Remove um dos seus itens. Um id desconhecido não faz nada.

Lado: Cliente · Espera: não

radial.remove(id: string): void

aiLib.radial.remove(id)

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

ExemploCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Lê de novo todo canShow de uma roda aberta. Chame depois que algo que eles leem mudou enquanto a roda pode estar aberta.

Lado: Cliente · Espera: não

radial.refresh(): void

aiLib.radial.refresh()

RetornoCopy Anchor Link

void.

ExemploCopy Anchor Link

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

worldCopy Anchor Link

A sincronização de clima e hora de qualquer script de clima rodando, pausada enquanto um motivo vale.

world.pauseSyncCopy Anchor Link

Pausa a sincronização de clima e hora por um motivo: dentro de um interior, durante uma cena, ou enquanto o seu script define o próprio clima.

Lado: Cliente · Espera: não

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

ExemploCopy 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

Remove um motivo de pausa; a sincronização volta a rodar quando não sobra nenhum motivo.

Lado: Cliente · Espera: não

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void. Veja o exemplo de world.pauseSync.

inventoryCopy Anchor Link

O inventário do jogador local pela camada de inventário do ai-core: o inventário que o servidor escolheu responde. Dar e tirar itens é só no servidor (Itens).

inventory.openInventoryCopy Anchor Link

Abre a tela do próprio inventário do jogador.

Lado: Cliente · Espera: não

inventory.openInventory(): void

aiLib.inventory.openInventory()

RetornoCopy Anchor Link

void.

ExemploCopy Anchor Link

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

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

inventory.hasItemCopy Anchor Link

Se o jogador tem pelo menos count de um item. Use em canShow para que o jogador só veja o que pode fazer; o servidor verifica de novo.

Lado: Cliente · Espera: não

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

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o jogador tem o suficiente.

ExemploCopy 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

O item de arma na mão do jogador: nome, rótulo e imagem.

Lado: Cliente · Espera: não

inventory.currentWeapon(): HeldWeapon | null

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

RetornoCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name como WEAPON_PISTOL, image uma url nui:// quando o inventário tem uma), ou null (nil) quando a mão está vazia.

ExemploCopy Anchor Link

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

// Leia quando a arma muda, nunca a cada frame.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));