Documentation
  • 👋Introduction
  • 📚Guides
    • Useful Links
  • 🆓boii_utils
    • Installation
    • Configuration
    • Modules
    • API
      • Callbacks
      • Characters
      • Commands
      • Cooldowns
      • Debugging
      • Entities
      • Environment
      • Framework Bridge
      • Geometry
      • Items
      • Keys
      • Licences
      • Maths
      • Methods
      • Player
      • Requests
      • Strings
      • Tables
      • Timestamps
      • UI Bridges
      • Vehicles
      • Version
      • XP
      • UI Elements
Powered by GitBook
On this page
  • Accessing the Module
  • Server
  • get_all_xp(source)
  • get_xp(source, xp_id)
  • set_xp(source, xp_id, amount)
  • add_xp(source, xp_id, amount)
  • remove_xp(source, xp_id, amount)
  • Client
  • get_all_xp()
  1. boii_utils
  2. API

XP

Handles player XP tracking, leveling, and data persistence for skills, reputation, and other growth systems.


Accessing the Module

local XP <const> = exports.boii_utils:get("modules.xp")

Server

get_all_xp(source)

Retrieves all XP data for a player.

Parameters

Name
Type
Description

source

number

Player source ID

Returns

Type
Description

table

Table of XP entries

Example

local all_xp = XP.get_all(source)

get_xp(source, xp_id)

Gets a specific XP entry for a player.

Parameters

Name
Type
Description

source

number

Player source ID

xp_id

string

The XP ID

Returns

Type
Description

table

XP data for the ID

Example

local fishing = XP.get(source, "fishing")

set_xp(source, xp_id, amount)

Sets a player's XP to a fixed value.

Parameters

Name
Type
Description

source

number

Player source ID

xp_id

string

The XP ID

amount

number

Amount of XP to assign

Example

XP.set(source, "fishing", 100)

add_xp(source, xp_id, amount)

Adds XP to a player's skill and handles level-ups.

Parameters

Name
Type
Description

source

number

Player source ID

xp_id

string

The XP ID

amount

number

Amount of XP to add

Example

XP.add(source, "fishing", 10)

remove_xp(source, xp_id, amount)

Removes XP from a player's skill and handles level-downs.

Parameters

Name
Type
Description

source

number

Player source ID

xp_id

string

The XP ID

amount

number

Amount of XP to subtract

Example

XP.remove(source, "fishing", 5)

Client

get_all_xp()

Requests all XP data for the local player.

Returns

Type
Description

table

XP data for player

Example

local xp_data = XP.get_all()
PreviousVersionNextUI Elements

Last updated 1 month ago

🆓