Appearance

These exports go through ai-core's appearance layer: the clothing script the server runs (ai-appearance, tgiann-clothing, illenium-appearance, qb-clothing, crm-appearance, rcore_clothing, bl_appearance) does the work. Your script never touches a clothing script's own format, so it keeps working when the server owner changes it.

A look (CharacterAppearance) is { model, data }: the ped model hash and the clothing script's own data. Treat data as a closed box: get a look from the server (appearance.get(charId) in the server lib, aiLib.appearance.get in Lua) or from GetPedAppearance, and give it back unchanged.

ApplyAppearanceCopy Anchor Link

Puts a look on a ped through the active clothing script. Use it to dress a local ped as a character (a shop keeper who looks like the owner, a sleeping body, a photo) or to put a stored look back on the player.

Side: Client · Waits: no

ApplyAppearance(ped: number, look: CharacterAppearance): boolean

local ok = exports['ai-core']:ApplyAppearance(ped, look) -- or aiLib.appearance.apply(ped, look)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when the clothing script was given the look. false when the ped does not exist, its model differs from look.model, the look is not a { model, data } table, or no clothing script runs.

ExampleCopy Anchor Link

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

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

// The asking player's own stored look.
onClientCallback("myscript:myLook", async (source) => {
  const character = core.GetCharacter(source);
  return character ? await appearance.get(character.id) : null;
});

import { appearance, requestModel, triggerServerCallback } from "@aicore-fivem/lib/client";
import { toCharacterAppearance } from "@aicore-fivem/shared";

// A local copy of the player standing at a point, dressed like them.
export async function spawnLookalike(x: number, y: number, z: number): Promise<number> {
  const look = toCharacterAppearance(await triggerServerCallback("myscript:myLook", []));
  if (!look) return 0;
  await requestModel(look.model);
  const ped = CreatePed(4, look.model, x, y, z, 0, false, false);
  SetModelAsNoLongerNeeded(look.model);
  appearance.apply(ped, look);
  return ped;
}

GetPedAppearanceCopy Anchor Link

Returns the look a ped wears right now, in the same { model, data } shape the server's stored looks use.

Side: Client · Waits: no

GetPedAppearance(ped: number): CharacterAppearance | null

local look = exports['ai-core']:GetPedAppearance(ped) -- or aiLib.appearance.read(ped)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

CharacterAppearance: model is the ped's model hash, data the clothing script's data. null when the ped does not exist, no clothing script runs, or the clothing script cannot read that ped (some only read the local player's own ped).

ExampleCopy Anchor Link

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

// Copies what the player wears now onto another ped of the same model.
export function copyPlayerLook(target: number): boolean {
  const look = appearance.read(cache.ped);
  return look !== null && appearance.apply(target, look);
}

OpenClothingMenuCopy Anchor Link

Opens one of the active clothing script's menus for the local player: the clothing shop, the barber, or their saved outfits. Use it for your own shop markers or a wardrobe in a house.

Side: Client · Waits: no

OpenClothingMenu(menu: ClothingMenu): boolean

local opened = exports['ai-core']:OpenClothingMenu(menu) -- or aiLib.appearance.openMenu(menu)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when the clothing script opened the menu. false for an unknown menu, when no clothing script runs, or when the running one has no such menu.

ExampleCopy Anchor Link

import { appearance, notify, Points } from "@aicore-fivem/lib/client";
import { Locale } from "common";

const points = new Points();

// A wardrobe in a motel room.
points.add("motel_wardrobe", {
  coords: { x: 151.3, y: -1001.2, z: -99.0 },
  label: Locale("WARDROBE"),
  onPressed: () => {
    if (!appearance.openMenu("outfits")) notify(Locale("NO_WARDROBE"), "error");
  },
});

WearOutfitCopy Anchor Link

Puts a job outfit (a uniform) on the local player until ReloadSkin. Only the pieces you list change; the rest of their clothes stay. The outfit is never saved as the player's own look.

Side: Client · Waits: no

WearOutfit(outfit: JobOutfit): boolean

local ok = exports['ai-core']:WearOutfit(outfit) -- or aiLib.appearance.wearOutfit(outfit)

ParametersCopy Anchor Link

JobOutfitCopy Anchor Link

OutfitPieceCopy Anchor Link

See also OutfitPiece.

ReturnsCopy Anchor Link

boolean: true when the clothing script put the outfit on. false when no valid piece is left after checking, no clothing script runs, or the running one cannot wear outfits. Invalid pieces (wrong id range, bad index) are dropped one by one; the valid ones are still worn.

ExampleCopy Anchor Link

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

// A plain uniform from base-game pieces: shirt, trousers, shoes, no hat.
const UNIFORM: JobOutfit = {
  components: [
    { id: 11, collection: "", index: 55, texture: 0 },
    { id: 4, collection: "", index: 35, texture: 0 },
    { id: 6, collection: "", index: 25, texture: 0 },
  ],
  props: [{ id: 0, collection: "", index: -1, texture: 0 }],
};

export const putOnUniform = (): boolean => appearance.wearOutfit(UNIFORM);
export const takeOffUniform = (): boolean => appearance.reloadSkin();

ReloadSkinCopy Anchor Link

Puts the local player's saved look back on. Use it to take a job outfit off.

Side: Client · Waits: no

ReloadSkin(): boolean

local ok = exports['ai-core']:ReloadSkin() -- or aiLib.appearance.reloadSkin()

ParametersCopy Anchor Link

None.

ReturnsCopy Anchor Link

boolean: true when the clothing script was asked to reload the look. false when no clothing script runs or the running one cannot reload.

ExampleCopy Anchor Link

See the example of WearOutfit.