Studios
XP Systemhouse-3.jpg

Commands & Exports

SoonXP SystemQBCore · Qbox · ESX
PAGE 06 OF 06  ·  TROUBLESHOOTING → COMMANDS & EXPORTSdocs.glitchstudios.dev
Browse docs

Commands#

Command Who What it does
/xp Everyone Opens the skills drawer (name set by Config.MenuCommand). Bind a key under Settings > Key Bindings > FiveM.
/xpboosts Everyone Lists your active boosters.
/xpadmin Config.Admin.Group Admin drawer.
/giveboost, /serverboost Config.Admin.Group Personal and server-wide boosters.
/resetskills <id> [tree] Config.Admin.Group Resets a player's trees.

Integration guide#

Server: XP#

local xp = exports['glitch-xpSystem']

xp:AddPlayerXP(src, 'mining', 50)             -- perks and boosters applied; returns XP given
xp:AddPlayerXP(src, 'mining', 50, true, true) -- raw (no multipliers), quiet (no popup)
xp:RemovePlayerXP(src, 'mining', 20)
xp:SetPlayerXP(src, 'mining', 1000)           -- clamped to the category's max level
xp:GetPlayerLevel(src, 'mining')
xp:GetPlayerXPData(src)                       -- { [category] = { label, xp, level, level_xp, hidden } }
xp:GetXPForLevel('mining', 10)
xp:GetLevelXP('mining', 5)
xp:GetCategoryLevel('mining', 12000)
xp:IsCategoryHidden(src, 'hacking')
xp:RegisterXPCategory('fishing', 'Fishing', 1000, 0.2, 20, false)
xp:InitializePlayerXP(src)                    -- normally automatic

Server: skills#

xp:GetEffect(src, 'xp_mining')                -- summed perk effect
xp:GetBestEffect({ src1, src2 }, 'key')       -- highest effect in a crew
xp:GetPerkRank(src, 'perk_id')
xp:GetSkillPoints(src, 'mining')
xp:UnlockPerk(src, 'perk_id')
xp:ResetSkills(src, 'mining')
xp:GetTreeData(src, 'trucking')               -- one tree as the menu sees it (job tablets)
xp:GetPlayerTitle(src)                        -- capstone title or nil
xp:UseDaily(src, 'key')                       -- true once per server day
xp:CanUseDaily(src, 'key')
xp:SetMilestones('mining', data)

Server: boosters#

xp:ActivateBoost(src, 'all', 2.0, 3600)
xp:ActivateServerBoost({ 'mining' }, 1.5, 1800, 'Event')
xp:AddServerBoostTime('all', 2.0, 1800, 'Tebex')  -- extends a running server boost
xp:GetXPMultiplier(src, 'mining')
xp:HasActiveBoost(src, 'mining')

Client#

exports['glitch-xpSystem']:GetXP('mining')
exports['glitch-xpSystem']:GetLevel('mining')
exports['glitch-xpSystem']:GetXPData()

Client exports#

Export signature Implementation in your package
GetLevel(name) client.lua
GetXP(name) client.lua
GetXPData() client.lua

Server exports#

Export signature Implementation in your package
ActivateBoost(source, jobs, multiplier, duration) server/boosts.lua
ActivateServerBoost(jobs, multiplier, duration, by) server/boosts.lua
AddPlayerXP(source, name, xp, raw, quiet) server/xp.lua
AddServerBoostTime(jobs, multiplier, duration, by, bySrc) server/boosts.lua
CanUseDaily(source, key) server/skills.lua
ClearAura(member, leader) server/skills.lua
GetBestEffect(sources, key) server/skills.lua
GetEffect(source, key) server/skills.lua
GetPerkRank(source, perkId) server/skills.lua
GetPlayerLevel(source, name) server/xp.lua
GetPlayerTitle(source) server/skills.lua
GetPlayerXPData(source, name) server/xp.lua
GetSkillPoints(source, treeId) server/skills.lua
GetTreeData(source, treeId) server/skills.lua
GetXPForLevel(name, level) server/xp.lua
GetXPMultiplier(source, jobType) server/boosts.lua
HasActiveBoost(source, jobType) server/boosts.lua
InitializePlayerXP(source, cb) server/xp.lua
IsCategoryHidden(source, name) server/xp.lua
RegisterXPCategory(name, label, xpStart, xpFactor, maxLevel, hidden) server/xp.lua
RemovePlayerXP(source, name, xp) server/xp.lua
ResetDaily(source, key) server/skills.lua
ResetSkills(source, treeId) server/skills.lua
SetAura(member, leader, keys, seconds) server/skills.lua
SetMilestones(category, data) server/skills.lua
SetPlayerXP(source, name, xp) server/xp.lua
UnlockPerk(source, perkId) server/skills.lua
UseDaily(source, key) server/skills.lua
useXPBooster(event, item, inventory, slot, data) server/boosts.lua

Shared exports#

Export signature Implementation in your package
GetCategoryLevel(index, xp) shared.lua
GetLevelXP(index, level) shared.lua