Documentation
Quasar Appearance is fully compatible with illenium-appearance. Every export is also registered under that name, so existing scripts keep working without any changes.
Quasar Appearance is fully compatible with illenium-appearance. Every export is also registered under that name, so existing scripts keep working without any changes.
Returns the model hash currently applied to a ped.
local model = exports['qs-appearance']:getPedModel(ped)Parameters
Parameter
Type |
|---|
Description |
|---|
| number | Ped entity handle |
Returns
numberReturns the model hash of the ped.
Returns all clothing components applied to a ped.
local components = exports['qs-appearance']:getPedComponents(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns a table containing every component id, drawable and texture.
Returns all props applied to a ped (hats, glasses, ears, watches).
local props = exports['qs-appearance']:getPedProps(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns a table containing every prop id, drawable and texture.
Returns the head blend data of a ped (parents and shape/skin mix).
local headBlend = exports['qs-appearance']:getPedHeadBlend(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns the facial feature values of a ped (nose, jaw, cheeks, eyes).
local faceFeatures = exports['qs-appearance']:getPedFaceFeatures(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns the head overlays of a ped (beard, makeup, blemishes, aging).
local headOverlays = exports['qs-appearance']:getPedHeadOverlays(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns the hair style and colors of a ped.
local hair = exports['qs-appearance']:getPedHair(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableReturns the complete appearance object of a ped, including model, components, props, head blend, face features, overlays, hair and tattoos.
local appearance = exports['qs-appearance']:getPedAppearance(ped)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
Returns
tableThis is the recommended export when you need to save, transfer or restore a full look.
Changes the player's ped model.
exports['qs-appearance']:setPlayerModel(model)Parameters
Parameter | Type | Description |
|---|---|---|
| string | number | Model name or hash |
Changing the model resets clothing components. Apply the appearance again afterwards.
Applies one or several clothing components to a ped.
exports['qs-appearance']:setPedComponent(ped, component)
exports['qs-appearance']:setPedComponents(ped, components)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
| table | Single component ( |
| table | Array of components |
Applies one or several props to a ped.
exports['qs-appearance']:setPedProp(ped, prop)
exports['qs-appearance']:setPedProps(ped, props)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
| table | Single prop ( |
| table | Array of props |
Applies facial and hair data to a ped.
exports['qs-appearance']:setPedHeadBlend(ped, headBlend)
exports['qs-appearance']:setPedFaceFeatures(ped, faceFeatures)
exports['qs-appearance']:setPedHeadOverlays(ped, headOverlays)
exports['qs-appearance']:setPedHair(ped, hair)
exports['qs-appearance']:setPedEyeColor(ped, eyeColor)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
| table | Head blend data |
| table | Facial feature values |
| table | Head overlay data |
| table | Hair style and colors |
| number | Eye color index |
Applies a tattoo collection to a ped.
exports['qs-appearance']:setPedTattoos(ped, tattoos)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
| table | Tattoo data |
Applies a complete appearance object to a ped or to the local player.
exports['qs-appearance']:setPedAppearance(ped, appearance)
exports['qs-appearance']:setPlayerAppearance(appearance)Parameters
Parameter | Type | Description |
|---|---|---|
| number | Ped entity handle |
| table | Full appearance object |
setPedAppearance targets a specific ped, while setPlayerAppearance applies directly to the local player.
Opens the customization menu and returns the result through a callback.
exports['qs-appearance']:startPlayerCustomization(function(appearance)
-- Your custom logic here
end, config)Parameters
Parameter | Type | Description |
|---|---|---|
| function | Callback receiving the final appearance, or |
| table | Which sections are editable (see |
This is the usual entry point for character creation scripts.
Returns the list of available peds defined in config/peds.lua.
local peds = exports['qs-appearance']:GetPedList()Returns
tableReturns the default customization config, useful as a base for startPlayerCustomization.
local config = exports['qs-appearance']:GetDefaultConfig()Returns
tableReturns the internal scaleform helper used by the appearance interfaces.
local Scaleforms = exports['qs-appearance']:Scaleforms()This export is mainly intended for advanced UI integrations and custom modifications.
TriggerEvent('qs-appearance:client:openClothingShop', id, isPedMenu)
TriggerEvent('qs-appearance:client:openClothingShopMenu', id, isPedMenu)
TriggerEvent('qs-appearance:client:OpenBarberShop')
TriggerEvent('qs-appearance:client:OpenTattooShop')
TriggerEvent('qs-appearance:client:OpenSurgeonShop')Parameters
Parameter | Type | Description |
|---|---|---|
| string | Store id defined in the catalog |
| boolean | Opens the menu in ped mode |
TriggerEvent('qs-appearance:client:reloadSkin', bypassChecks)
TriggerEvent('qs-appearance:client:ClearStuckProps')Parameters
Parameter | Type | Description |
|---|---|---|
| boolean | Forces the reload, skipping internal validations |
TriggerEvent('clothing:openOutfitMenu')
TriggerEvent('qb-clothing:client:openMenu')qb-clothing:client:openMenu is kept for QBCore compatibility, so scripts written for the default QB clothing system will still open the Quasar menu.
TriggerServerEvent('qs-appearance:server:saveOutfit', name, model, components, props)
TriggerServerEvent('qs-appearance:server:updateOutfit', id, model, components, props)
TriggerServerEvent('qs-appearance:server:deleteOutfit', id)Parameters
Parameter | Type | Description |
|---|---|---|
| string | Outfit name |
| number | Outfit id |
| string | number | Ped model |
| table | Clothing components |
| table | Props |
TriggerServerEvent('qs-appearance:server:saveManagementOutfit', outfitData)
TriggerServerEvent('qs-appearance:server:deleteManagementOutfit', id)
TriggerServerEvent('qs-appearance:server:syncUniform', uniform)Parameters
Parameter | Type | Description |
|---|---|---|
| table | Job outfit data |
| number | Management outfit id |
| table | Uniform to sync across players |
TriggerServerEvent('qs-appearance:server:ChangeRoutingBucket')
TriggerServerEvent('qs-appearance:server:ResetRoutingBucket')These events isolate the player during customization, so other players don't see the process.
TriggerServerEvent('clothing:createStore', storeData)
TriggerServerEvent('clothing:updateStore', storeData)
TriggerServerEvent('clothing:deleteStore', id)Parameters
Parameter | Type | Description |
|---|---|---|
| table | Store definition (label, coords, type) |
| string | Store id |
local appearance = exports['qs-appearance']:getPedAppearance(PlayerPedId())
exports['qs-appearance']:setPedAppearance(npcPed, appearance)Example: applying a job uniform when a player clocks in.
exports['qs-appearance']:setPedComponents(PlayerPedId(), uniform.components)
exports['qs-appearance']:setPedProps(PlayerPedId(), uniform.props)Example: opening the customization menu during first spawn.
local config = exports['qs-appearance']:GetDefaultConfig()
exports['qs-appearance']:startPlayerCustomization(function(appearance)
if appearance then
print('Character created successfully')
else
print('Customization cancelled')
end
end, config)local appearance = exports['qs-appearance']:getPedAppearance(PlayerPedId())
exports['qs-appearance']:setPlayerModel('mp_m_freemode_01')
exports['qs-appearance']:setPlayerAppearance(appearance)