EVENTS#

Events allow communication between scripts and onex-creation. This page documents all available client and server events.

Client Events#

onex-creation:client:openCreationMenu#

Open the creation menu with a specific type.

TriggerEvent('onex-creation:client:openCreationMenu', shopType)

Parameters:

Name	Type	Description
`shopType`	string	Shop type to open

Example:

Client Script
-- Open clothing store
TriggerEvent('onex-creation:client:openCreationMenu', 'clothes')

-- Open admin menu
TriggerEvent('onex-creation:client:openCreationMenu', 'admin')

-- Open barber
TriggerEvent('onex-creation:client:openCreationMenu', 'barber')

onex-creation:client:CreateNewChar#

Open the new character creation menu.

TriggerEvent('onex-creation:client:CreateNewChar')

Example:

Client Script
-- From your multicharacter script
RegisterNetEvent('yourscript:newCharacter')
AddEventHandler('yourscript:newCharacter', function()
    TriggerEvent('onex-creation:client:CreateNewChar')
end)

onex-creation:cListen:CreateNewChar#

Open new character creation with a callback listener.

TriggerEvent('onex-creation:cListen:CreateNewChar', callback)

Parameters:

Name	Type	Description
`callback`	function	Called when creation completes

Example:

Client Script
TriggerEvent('onex-creation:cListen:CreateNewChar', function(appearance)
    if appearance then
        print('Character created successfully')
        -- Continue with your flow
    else
        print('Character creation cancelled')
    end
end)

onex-creation:onClothingMenuClose#

Fired when the clothing menu closes.

RegisterNetEvent('onex-creation:onClothingMenuClose')
AddEventHandler('onex-creation:onClothingMenuClose', function(saved)
    -- Handle menu close
end)

Parameters:

Name	Type	Description
`saved`	boolean	Whether changes were saved

Example:

Client Script
RegisterNetEvent('onex-creation:onClothingMenuClose')
AddEventHandler('onex-creation:onClothingMenuClose', function(saved)
    if saved then
        print('Player saved their changes')
    else
        print('Player discarded changes')
    end
end)

Appearance Events#

onex-creation:client:loadPedModel#

Load a ped model.

TriggerEvent('onex-creation:client:loadPedModel', model)

Parameters:

Name	Type	Description
`model`	string	Model name to load

Example:

Client Script
TriggerEvent('onex-creation:client:loadPedModel', 'mp_m_freemode_01')

onex-creation:client:loadPedSkin#

Load an appearance onto the player ped.

TriggerEvent('onex-creation:client:loadPedSkin', skin)

Parameters:

Name	Type	Description
`skin`	table	Appearance data

Example:

Client Script
local appearance = {
    schema_version = 2,
    model = 'mp_m_freemode_01',
    components = {
        ["11"] = { collection = "base", localIndex = 15, texture = 0 }
    }
}

TriggerEvent('onex-creation:client:loadPedSkin', appearance)

onex-creation:client:loadCustomOutfit#

Load a custom outfit (job uniform).

TriggerEvent('onex-creation:client:loadCustomOutfit', outfit, persist)

Parameters:

Name	Type	Description
`outfit`	table	Outfit data
`persist`	boolean	Persist across sessions

Example:

Client Script
local uniform = {
    torso = { collection = "base", localIndex = 55, texture = 0 },
    pants = { collection = "base", localIndex = 25, texture = 0 }
}

TriggerEvent('onex-creation:client:loadCustomOutfit', uniform, true)

onex-creation:client:syncClothes#

Fetches the player's saved appearance from the database and loads it onto the player character.

TriggerEvent('onex-creation:client:syncClothes')

Use Case: Perfect for job systems where you temporarily change the player's clothes (e.g., police uniform, mechanic outfit). When the job ends, simply call this event to restore the player's original saved appearance from the database.

Example:

Client Script
-- Job system example: Restore original clothes when job ends
RegisterNetEvent('myJob:endShift', function()
    -- Player finished their job shift, restore their saved outfit
    TriggerEvent('onex-creation:client:syncClothes')
end)

Outfit Events#

onex-creation:openOutfitMenu#

Open the main outfit menu.

TriggerEvent('onex-creation:openOutfitMenu')

Example:

Client Script
-- Open outfit management
TriggerEvent('onex-creation:openOutfitMenu')

onex-creation:client:oOutifit#

Open outfit selection menu.

TriggerEvent('onex-creation:client:oOutifit')

onex-creation:client:JobOutifit#

Open job outfit selection.

TriggerEvent('onex-creation:client:JobOutifit', jobName)

Parameters:

Name	Type	Description
`jobName`	string	Job name for outfits

Example:

Client Script
-- Open police uniform selection
TriggerEvent('onex-creation:client:JobOutifit', 'police')

-- Open EMS uniform selection
TriggerEvent('onex-creation:client:JobOutifit', 'ambulance')

onex-creation:client:openOutfitUpdateMenu#

Open menu to update an existing outfit.

TriggerEvent('onex-creation:client:openOutfitUpdateMenu', outfitData)

onex-creation:client:deleteOutfitMenu#

Open menu to delete outfits.

TriggerEvent('onex-creation:client:deleteOutfitMenu')

Permission Events#

onex-creation:client:DynamicBlackListClothesHandler#

Dynamically update blacklist at runtime.

TriggerEvent('onex-creation:client:DynamicBlackListClothesHandler', data)

Parameters:

Name	Type	Description
`data.action`	string	'add', 'remove', or 'clear'
`data.gender`	string	'male' or 'female'
`data.category`	string	Component category
`data.items`	table	Item IDs (for add/remove)

Example:

Client Script
-- Add items to blacklist
TriggerEvent('onex-creation:client:DynamicBlackListClothesHandler', {
    action = 'add',
    gender = 'male',
    category = 'mask',
    items = { 100, 101, 102 }
})

-- Remove from blacklist
TriggerEvent('onex-creation:client:DynamicBlackListClothesHandler', {
    action = 'remove',
    gender = 'male',
    category = 'mask',
    items = { 100 }
})

-- Clear category blacklist
TriggerEvent('onex-creation:client:DynamicBlackListClothesHandler', {
    action = 'clear',
    gender = 'male',
    category = 'mask'
})

Studio Events#

onex-creation:generationProgress#

Fired during screenshot generation progress.

RegisterNetEvent('onex-creation:generationProgress')
AddEventHandler('onex-creation:generationProgress', function(current, total, category)
    print(string.format('Progress: %d/%d(%s)', current, total, category))
end)

onex-creation:screenshotComplete#

Fired when a screenshot is complete.

RegisterNetEvent('onex-creation:screenshotComplete')
AddEventHandler('onex-creation:screenshotComplete', function(category, itemId)
    print(string.format('Screenshot complete: %s #%d', category, itemId))
end)

Server Events#

Appearance Events#

onex-creation:server:saveAppearance#

Save player appearance to database.

TriggerServerEvent('onex-creation:server:saveAppearance', appearance)

Parameters:

Name	Type	Description
`appearance`	table	Appearance data to save

Example:

Client Script
local appearance = exports['onex-creation']:FetchPlayerClothes()
TriggerServerEvent('onex-creation:server:saveAppearance', appearance)

Routing Bucket Events#

onex-creation:server:ChangeRoutingBucket#

Enable routing bucket isolation.

TriggerServerEvent('onex-creation:server:ChangeRoutingBucket')

onex-creation:server:ResetRoutingBucket#

Reset routing bucket to default.

TriggerServerEvent('onex-creation:server:ResetRoutingBucket')

Outfit Server Events#

onex-creation:server:saveOutfits#

Save a new outfit.

TriggerServerEvent('onex-creation:server:saveOutfits', outfitName, description, skin)

Parameters:

Name	Type	Description
`outfitName`	string	Name for the outfit
`description`	string	Optional description
`skin`	table	Outfit appearance data

onex-creation:server:UpdateOutfitdata#

Update an existing outfit.

TriggerServerEvent('onex-creation:server:UpdateOutfitdata', outfitId, skin)

onex-creation:client:DeleteOutfit#

Delete an outfit.

TriggerServerEvent('onex-creation:client:DeleteOutfit', outfitId)

onex-creation:server:importOutfit#

Import an outfit by share code.

TriggerServerEvent('onex-creation:server:importOutfit', code)

Parameters:

Name	Type	Description
`code`	string	5-character outfit share code

Framework Compatibility Events#

QBCore Events#

These events are handled for QB compatibility:

-- QBCore clothing events(handled by onex-creation)
'qb-clothes:client:CreateFirstCharacter'
'qb-clothing:client:loadPlayerClothing'
'qb-clothing:client:openMenu'

ESX Events#

These events are handled for ESX compatibility:

-- ESX skin events(handled by onex-creation)
'skinchanger:loadSkin'
'esx:playerLoaded'
'esx_skin:openSaveableMenu'
'skinchanger:loadDefaultModel'

OnexFx Events#

-- OnexFx event(handled by onex-creation)
'onexFx:client:playerLoaded'

Custom Event Listeners#

Example: On Appearance Change#

Your Script
-- Listen for menu close to detect changes
RegisterNetEvent('onex-creation:onClothingMenuClose')
AddEventHandler('onex-creation:onClothingMenuClose', function(saved)
    if saved then
        -- Get the new appearance
        local appearance = exports['onex-creation']:FetchPlayerClothes()

        -- Do something with it
        TriggerServerEvent('yourscript:appearanceChanged', appearance)
    end
end)

Example: Job Uniform Handler#

Your Script
-- Automatically apply uniform when job changes
RegisterNetEvent('QBCore:Client:OnJobUpdate')
AddEventHandler('QBCore:Client:OnJobUpdate', function(JobInfo)
    if JobInfo.name == 'police' and JobInfo.onduty then
        TriggerEvent('onex-creation:client:JobOutifit', 'police')
    end
end)

Next Steps#

RPC Calls

Client Exports

SHOPPING CART

Command Palette

EVENTS#

Client Events#

Menu Events#

onex-creation:client:openCreationMenu#

onex-creation:client:CreateNewChar#

onex-creation:cListen:CreateNewChar#

onex-creation:onClothingMenuClose#

Appearance Events#

onex-creation:client:loadPedModel#

onex-creation:client:loadPedSkin#

onex-creation:client:loadCustomOutfit#

onex-creation:client:syncClothes#

Outfit Events#

onex-creation:openOutfitMenu#

onex-creation:client:oOutifit#

onex-creation:client:JobOutifit#

onex-creation:client:openOutfitUpdateMenu#

onex-creation:client:deleteOutfitMenu#

Permission Events#

onex-creation:client:DynamicBlackListClothesHandler#

Studio Events#

onex-creation:generationProgress#

onex-creation:screenshotComplete#

Server Events#

Appearance Events#

onex-creation:server:saveAppearance#

Routing Bucket Events#

onex-creation:server:ChangeRoutingBucket#

onex-creation:server:ResetRoutingBucket#

Outfit Server Events#

onex-creation:server:saveOutfits#

onex-creation:server:UpdateOutfitdata#

onex-creation:client:DeleteOutfit#

onex-creation:server:importOutfit#

Framework Compatibility Events#

QBCore Events#

ESX Events#

OnexFx Events#

Custom Event Listeners#

Example: On Appearance Change#

Example: Job Uniform Handler#

Next Steps#