Skip to main content
Aquiver Proficiency

Exports & Usage

Use synchronized client data and secure server-side management to integrate proficiency progression with gameplay resources.

Exports​

Client exports​

Client exports provide access to the local player's synchronized proficiency data.

ExportDescription
get(id)Returns a registered proficiency object.
getAll()Returns all registered proficiencies.
getPoints()Returns all proficiency XP values for the local player.
getPoint(id)Returns total XP for a proficiency.
getLevel(id)Returns the current proficiency level.
getCurrentXp(id)Returns XP earned within the current level.
getRequiredXp(id)Returns the cumulative XP threshold for the current level.
getNextRequiredXp(id)Returns the cumulative XP threshold for the next level.
getPercentage(id)Returns the current progression percentage.
serialize(id)Returns a proficiency definition as a table.
serializeAll()Returns all proficiency definitions as tables.

Server exports​

targetSource refers to the player's server ID, while id refers to the registered proficiency identifier.

ExportDescription
register(options)Registers a new proficiency with configurable settings.
get(id)Returns a registered proficiency object.
getAll()Returns all registered proficiencies.
addPoint(targetSource, id, count)Adds XP to a player's proficiency.
removePoint(targetSource, id, count)Removes XP from a player's proficiency.
setPoint(targetSource, id, count)Sets a player's proficiency XP.
getPoint(targetSource, id)Returns total proficiency XP.
getLevel(targetSource, id)Returns the current proficiency level.
getCurrentXp(targetSource, id)Returns XP earned within the current level.
getRequiredXp(targetSource, id)Returns the current level's cumulative XP threshold.
getNextRequiredXp(targetSource, id)Returns the next level's cumulative XP threshold.
getPercentage(targetSource, id)Returns the current progression percentage.
getBenefit(targetSource, id)Returns the combined per-level and milestone bonuses.
serialize(id)Returns a proficiency definition as a table.
serializeAll()Returns all proficiency definitions as tables.

Usage examples​

The following examples assume the resource folder is named aquiver-proficiency.

Server

Register a proficiency

Create a fishing proficiency with its own progression curve, benefits and milestones.

Register a proficiency (server)
exports['aquiver-proficiency']:register({
id = 'fishing',
name = 'Fishing',
description = 'Improve your fishing skills to earn additional bonuses.',
benefit = 'Fishing bonus',
benefitPerLevel = 2,
icon = 'fas fa-fish',
levelCap = 20,
baseXp = 100,
multiplier = 1.2,
milestones = {
{ level = 5, value = 5 },
{ level = 10, value = 10 },
{ level = 20, value = 15 }
}
})

Each proficiency can define its own progression curve, level cap and benefit values.

Milestone bonuses stack with per-level bonuses. The integrating resource determines how these bonuses affect gameplay.

Immersive Greenhouse integration​

When Aquiver Proficiency is installed, Immersive Greenhouse can display its five farming skills and their progression on the dedicated Proficiency management page.