Skip to main content

@modules/characters

Characters module - manages player characters and profiles.

Classes

ClassDescription
CharacterRepositoryRepository service for character database operations.
CharacterServiceService for managing player characters and profiles.

Type Aliases

Type AliasDescription
BaseAppearanceBase character appearance data - stored in database. Does NOT include clothing components or props (those come from equipment). Includes model, face/body customization for freemode characters.
CharacterFull character object with all properties.
CharacterAppearanceComplete character appearance data (computed at runtime). Includes model, components, props, and freemode-specific customization. This is the full appearance applied to the ped, combining base + equipment.
CharacterDataCharacter data bag for extensible storage.
CharacterSpawnPointCharacter spawn point with position and heading.
CharacterSummarySummary of a character for selection UI.
HeadBlendHead blend data for freemode characters (face shape, skin tone).
HeadOverlayHead overlay (makeup, blemishes, facial hair, etc.). Overlay IDs: 0: Blemishes, 1: Facial Hair, 2: Eyebrows, 3: Ageing, 4: Makeup, 5: Blush, 6: Complexion, 7: Sun Damage, 8: Lipstick, 9: Moles/Freckles, 10: Chest Hair, 11: Body Blemishes, 12: Add Body Blemishes
PedComponentPed component variation (clothing, body parts). Component IDs: 0: Face, 1: Mask, 2: Hair, 3: Torso, 4: Leg, 5: Parachute/bag, 6: Shoes, 7: Accessory, 8: Undershirt, 9: Kevlar, 10: Badge, 11: Torso2
PedPropPed prop (hats, glasses, watches, etc.). Prop IDs: 0: Hat, 1: Glasses, 2: Ear, 6: Watch, 7: Bracelet

Variables

default

default: Module;

Defined in: src/modules/core/characters/module.ts:28


MAX_CHARACTER_SLOTS

const MAX_CHARACTER_SLOTS: 3 = 3;

Defined in: src/modules/core/characters/types.ts:7

Maximum number of character slots per player.

References

PlayerProfile

Re-exports PlayerProfile