Layers through ai-core

These objects never talk to a specific script. They ask ai-core, and ai-core forwards to whichever script the server runs for that job: ai-death or another death script, ai-appearance or tgiann-clothing, any supported emote or radial script. Your script keeps working when the owner swaps one. How the layers work is on Layers and the bridge.

When no script of that kind runs, the calls answer false, null or the game's own value, as each entry says.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Whether the local player is down (dead or in last stand), in whatever death script runs. Death scripts keep a downed ped alive to animate it, so IsEntityDead alone misses them. A memory read after the first call.

Side: Client · Waits: no

medical.isDead(): boolean

No Lua twin: call exports['ai-core']:IsDead() and listen to the local event ai-core:client:dead (dead).

ReturnsCopy Anchor Link

boolean: true when ai-core's medical layer says the player is down, or the ped is dead for the game.

ExampleCopy 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

Runs a handler when the local player goes down or gets up.

Side: Client · Waits: no

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

No Lua twin: AddEventHandler('ai-core:client:dead', function(dead) end).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void.

ExampleCopy Anchor Link

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

const points = new Points();
medical.onChange(() => points.refresh()); // points whose canShow reads medical.isDead()

appearanceCopy Anchor Link

Looks on peds through ai-core's appearance layer, whatever clothing script runs.

appearance.applyCopy Anchor Link

Puts a stored look on a ped of the look's model. Get the look on the server with appearance.get(charId), create the ped with look.model, then apply. On the player's own ped it changes their clothes.

Side: Client · Waits: no

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

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

ParametersCopy Anchor Link

The type is CharacterAppearance.

ReturnsCopy Anchor Link

boolean: false when the ped is gone, the model differs, or no clothing script runs.

ExampleCopy Anchor Link

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

// A sleeping copy of a character, dressed like them.
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

The look a ped wears now.

Side: Client · Waits: no

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

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

CharacterAppearance | null: the look, or null (nil in Lua) when the clothing script cannot tell or none runs.

ExampleCopy Anchor Link

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

const before = appearance.read(cache.ped); // put it back later with appearance.apply

appearance.openMenuCopy Anchor Link

Opens the clothing script's clothing shop, barber or saved outfits for the player.

Side: Client · Waits: no

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParametersCopy Anchor Link

The type is ClothingMenu.

ReturnsCopy Anchor Link

boolean: false when the clothing script has no such menu or none runs.

ExampleCopy 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

Puts a job outfit (a uniform) on the player until reloadSkin. It is not saved: a reconnect or reloadSkin gives the player's own clothes back. Only the listed pieces change.

Side: Client · Waits: no

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParametersCopy Anchor Link

The types are JobOutfit and OutfitPiece.

ReturnsCopy Anchor Link

boolean: false when it cannot (no clothing script, a model it does not support).

ExampleCopy 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

Puts the player's saved look back on (takes a job outfit off).

Side: Client · Waits: no

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

ReturnsCopy Anchor Link

boolean: false without a clothing script.

ExampleCopy Anchor Link

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

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

gesturesCopy Anchor Link

Hands up, pointing and emotes of whatever emote script runs, through ai-core.

gestures.isHandsUpCopy Anchor Link

Whether the local player has the hands up.

Side: Client · Waits: no

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

ReturnsCopy Anchor Link

boolean: true while the hands are up in the running emote script.

ExampleCopy Anchor Link

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

// The server asks before a robbery whether the victim surrendered.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Whether the local player is pointing.

Side: Client · Waits: no

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

ReturnsCopy Anchor Link

boolean: true while pointing.

ExampleCopy Anchor Link

if (gestures.isPointing()) return; // do not start an emote over pointing

gestures.providerCopy Anchor Link

The emote script that answers hands up and pointing.

Side: Client · Waits: no

gestures.provider(): string | null

local name = aiLib.gestures.provider()

ReturnsCopy Anchor Link

string | null: its resource name, or null (nil) when none runs.

ExampleCopy Anchor Link

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

gestures.playEmoteCopy Anchor Link

Plays an emote by its command name (what players type after e) in the running emote script.

Side: Client · Waits: no

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: false without an emote script.

ExampleCopy Anchor Link

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

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

gestures.cancelEmoteCopy Anchor Link

Stops the emote the player plays (cuffed, knocked down).

Side: Client · Waits: no

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

ReturnsCopy Anchor Link

boolean: false without an emote script.

ExampleCopy Anchor Link

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

gestures.emoteProviderCopy Anchor Link

The emote script that plays emotes (it may differ from the one answering hands up).

Side: Client · Waits: no

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

ReturnsCopy Anchor Link

string | null: its resource name, or null (nil) when none runs.

ExampleCopy Anchor Link

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

seatbeltCopy Anchor Link

The local player's seat belt through ai-core, whatever seat belt script runs.

seatbelt.isOnCopy Anchor Link

Whether the belt is on. Ask on demand, not every frame.

Side: Client · Waits: no

seatbelt.isOn(): boolean | null

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

ReturnsCopy Anchor Link

boolean | null: true or false; null (nil) when no seat belt script answers.

ExampleCopy 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

Runs a handler when the belt changes. Only seat belt scripts that report changes trigger it.

Side: Client · Waits: no

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

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void.

ExampleCopy Anchor Link

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

seatbelt.providerCopy Anchor Link

The seat belt script that answers.

Side: Client · Waits: no

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

ReturnsCopy Anchor Link

string | null: its resource name, or null (nil) when none answers.

ExampleCopy Anchor Link

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

fuelCopy Anchor Link

fuel.getCopy Anchor Link

A vehicle's fuel level. The server keeps a fuel state bag for every vehicle whatever fuel script runs, so this is a memory read; without that bag it is the game's tank level.

Side: Client · Waits: no

fuel.get(vehicle: number): number

No Lua twin: read Entity(vehicle).state.fuel. Setting fuel is server-only (fuel.set on Vehicles).

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

number: 0-100.

ExampleCopy 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

Opens the active police MDT for the local player. The MDT checks the job itself.

Side: Client · Waits: no

mdt.open(): boolean

local ok = aiLib.mdt.open()

ReturnsCopy Anchor Link

boolean: false when no MDT runs or it cannot be opened from outside.

ExampleCopy Anchor Link

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

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

radialCopy Anchor Link

Items on whichever radial menu runs (ai-radialmenu, or another through ai-core's radial layer). ai-core keeps them across radial restarts and drops them when your resource stops: add once at start.

radial.addCopy Anchor Link

Adds an item to the wheel, or replaces the item with the same id.

Side: Client · Waits: no

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParametersCopy Anchor Link

RadialItemCopy Anchor Link

The type is RadialItem.

ReturnsCopy Anchor Link

void.

ExampleCopy 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

Removes one of your items. An unknown id does nothing.

Side: Client · Waits: no

radial.remove(id: string): void

aiLib.radial.remove(id)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void.

ExampleCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Reads every canShow of an open wheel again. Call it after something they read changed while the wheel may be open.

Side: Client · Waits: no

radial.refresh(): void

aiLib.radial.refresh()

ReturnsCopy Anchor Link

void.

ExampleCopy Anchor Link

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

worldCopy Anchor Link

The weather and time sync of whatever weather script runs, paused while a reason holds.

world.pauseSyncCopy Anchor Link

Pauses the weather and time sync for a reason: inside an interior, during a scene, or while your script sets its own weather.

Side: Client · Waits: no

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void.

ExampleCopy 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

Removes one pause reason; the sync runs again when no reason is left.

Side: Client · Waits: no

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void. See the world.pauseSync example.

inventoryCopy Anchor Link

The local player's inventory through ai-core's inventory layer: the inventory the server picked answers. Giving and taking items is server-only (Items).

inventory.openInventoryCopy Anchor Link

Opens the player's own inventory screen.

Side: Client · Waits: no

inventory.openInventory(): void

aiLib.inventory.openInventory()

ReturnsCopy Anchor Link

void.

ExampleCopy Anchor Link

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

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

inventory.hasItemCopy Anchor Link

Whether the player holds at least count of an item. Use it in canShow so the player only sees what they can do; the server checks again.

Side: Client · Waits: no

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

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when the player has enough.

ExampleCopy 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

The weapon item in the player's hand: its name, label and picture.

Side: Client · Waits: no

inventory.currentWeapon(): HeldWeapon | null

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

ReturnsCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name like WEAPON_PISTOL, image a nui:// url when the inventory has one), or null (nil) when the hand is empty.

ExampleCopy Anchor Link

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

// Read it when the weapon changes, never every frame.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));