Appearance

Looks go through ai-core, never through a clothing script's own exports, events or tables (ai-appearance included). ai-core reads them from the active clothing script: the one the panel's Clothing script setting picks, or the first one running. Putting a look on a ped happens on the client (client export ApplyAppearance, lib appearance.apply); see Client exports.

A look is a CharacterAppearance: { model, data }. model is the ped model hash; data is the clothing script's own format. Treat data as a sealed box: pass it back to ApplyAppearance unchanged.

GetAppearanceSystemCopy Anchor Link

The resource name of the clothing script ai-core reads looks from.

Side: Server · Waits: no · Lib: appearance.provider()

GetAppearanceSystem(): string | null

local system = exports['ai-core']:GetAppearanceSystem() -- string or nil

ParametersCopy Anchor Link

None.

ReturnsCopy Anchor Link

string | null: the clothing script's resource name. null when none runs (peds then wear default clothes).

ExampleCopy Anchor Link

import { addCommand, resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");

addCommand("clothingsystem", { help: "Shows the clothing script in use", restricted: true }, () => {
  console.log(core.GetAppearanceSystem() ?? "none");
});

GetCharacterAppearanceCopy Anchor Link

A character's stored look, whether the character is loaded or not. Use it to dress a ped as that character: a sleeping body, a statue, a photo, a preview.

Side: Server · Waits: no (answers through done) · Lib: appearance.get(charId) returns a Promise

GetCharacterAppearance(charId: number, done: (look: CharacterAppearance | null) => void): void

exports['ai-core']:GetCharacterAppearance(charId, function(look) end) -- look: table or nil

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Nothing. done gets { model, data }, or null when the character has no stored look, no clothing script runs, charId is not a positive whole number, or the clothing script failed (logged). Without a function as done the call does nothing.

ExampleCopy Anchor Link

import { onClientCallback, online, resourceExport } from "@aicore-fivem/lib/server";
import { fail } from "@aicore-fivem/lib/shared";
import type { CharacterAppearance } from "@aicore-fivem/shared";

const core = resourceExport("ai-core");

// The client asks for the player's own look to dress a photo-booth ped.
onClientCallback("myscript:myLook", async (source) => {
  const charId = online.charId(source);
  if (charId === undefined) return fail("NO_CHARACTER");
  const look = await new Promise<CharacterAppearance | null>((resolve) => core.GetCharacterAppearance(charId, resolve));
  return look ? { ok: true, look } : fail("NO_LOOK");
});