Skip to Content

Types

Type definitions and data structures used throughout zh_appearance.


AppearanceData

Complete character appearance state.

---@class AppearanceData ---@field model string | number ---@field headBlend HeadBlendData ---@field faceFeatures number[] ---@field headOverlays HeadOverlayData[] ---@field hairColor { color: number, highlight: number } ---@field eyeColor number ---@field components ComponentData[] ---@field props PropData[] ---@field tattoos TattooData[]
  • model: string | number - Ped model name or hash.
  • headBlend: HeadBlendData - Parent / heritage blending.
  • faceFeatures: number[] - Array of 20 facial feature values (-1.0 to 1.0).
  • headOverlays: HeadOverlayData[] - Array of head overlays (hair, blemishes, makeup, etc.).
  • hairColor: table - { color: number, highlight: number }.
  • eyeColor: number - Eye color index.
  • components: ComponentData[] - Clothing variations.
  • props: PropData[] - Attached prop accessories.
  • tattoos: TattooData[] - Applied tattoos.

HeadBlendData

Parent / heritage face and skin blending parameters.

---@class HeadBlendData ---@field shapeFirst number ---@field shapeSecond number ---@field shapeThird number ---@field skinFirst number ---@field skinSecond number ---@field skinThird number ---@field shapeMix number ---@field skinMix number ---@field thirdMix number

HeadOverlayData

Facial overlays, makeup, facial hair, and blemishes.

---@class HeadOverlayData ---@field overlayId number ---@field index number ---@field opacity number ---@field color number ---@field secondColor number

ComponentData

Clothing component variation.

---@class ComponentData ---@field componentId number ---@field drawable number ---@field texture number

PropData

Prop accessory variation (hats, glasses, watches, etc.).

---@class PropData ---@field propId number ---@field drawable number ---@field texture number

TattooData

Applied tattoo entry.

---@class TattooData ---@field collection string | number ---@field overlay string | number ---@field opacity number

TattooItemConfig

Tattoo item configuration from data/tattoos.lua.

---@class TattooItemConfig ---@field id string ---@field label string ---@field collection string ---@field zone TattooZone ---@field maleOverlay string ---@field femaleOverlay string

TattooZone

Available tattoo body zones:

---@alias TattooZone ---| '"ZONE_HEAD"' ---| '"ZONE_TORSO"' ---| '"ZONE_LEFT_ARM"' ---| '"ZONE_RIGHT_ARM"' ---| '"ZONE_LEFT_LEG"' ---| '"ZONE_RIGHT_LEG"'

AppearanceTab

Available customization menu tabs:

---@alias AppearanceTab ---| '"heritage"' ---| '"features"' ---| '"hair"' ---| '"skin"' ---| '"clothing"' ---| '"props"' ---| '"tattoos"'

ShopTypeConfig

---@class ShopTypeConfig ---@field label string ---@field tabs? AppearanceTab[]

ShopConfig

---@class ShopConfig ---@field type ShopTypeConfig ---@field coords vector4 ---@field blip ShopBlip

ShopBlip

---@class ShopBlip ---@field id number ---@field color number ---@field label string
Last updated on