Module sv_levels

Level functions

Functions

GetLevels () GetLevels function.
GetLevel (src, category) GetLevel function.
HasLevel (src, category, level) HasLevel function.
HasLevels (src, levels) HasLevels function.
GetXP (src, category) GetXP function.
SetLevel (src, category, level) SetLevel function.
SetXP (src, category, xp) SetXP function.
AddXP (src, category, xp) AddXP function.
RemoveXP (src, category, xp) RemoveXP function.
GetLevelXP (src, category) GetLevelXP function.
GetLevelMultiplier (src, category) GetLevelMultiplier function.
GetPrestige (src, category) GetPrestige function.
SetPrestige (src, category, prestige) SetPrestige function.
AddPrestige (src, category, prestige) AddPrestige function.
RemovePrestige (src, category, prestige) RemovePrestige function.
GetPrestigeMultiplier (src, category) GetPrestigeMultiplier function.
GetMaxLevel (src) GetMaxLevel function.
GetMaxPrestige (src) GetMaxPrestige function.


Functions

GetLevels ()
GetLevels function. This function returns the levels table.

Returns:

    table

Usage:

    local levels = exports.jones_util:GetLevels()
GetLevel (src, category)
GetLevel function. This function returns the player's level.

Parameters:

  • src The player to get the level from. number
  • category The category to get the level from. string

Returns:

    number

Usage:

    local level = exports.jones_util:GetLevel(src, "farming")
HasLevel (src, category, level)
HasLevel function. This function checks if the player has a level.

Parameters:

  • src The player to check the level for. number
  • category The category to check the level for. string
  • level The level to check for. number

Returns:

    boolean

Usage:

    local hasLevel = exports.jones_util:HasLevel(src, "farming", 1)
HasLevels (src, levels)
HasLevels function. This function checks if the player has levels.

Parameters:

  • src The player to check the levels for. number
  • levels The levels to check for. table

Returns:

    boolean

Usage:

    local hasLevels = exports.jones_util:HasLevels(src, {farming = 1, mining = 1})
GetXP (src, category)
GetXP function. This function returns the player's xp.

Parameters:

  • src The player to get the xp from. number
  • category The category to get the xp from. string

Returns:

    number

Usage:

    local xp = exports.jones_util:GetXP(src, "farming")
SetLevel (src, category, level)
SetLevel function. This function sets the player's level.

Parameters:

  • src The player to set the level for. number
  • category The category to set the level for. string
  • level The level to set. number

Usage:

    exports.jones_util:SetLevel(src, "farming", 1)
SetXP (src, category, xp)
SetXP function. This function sets the player's xp.

Parameters:

  • src The player to set the xp for. number
  • category The category to set the xp for. string
  • xp The xp to set. number

Usage:

    exports.jones_util:SetXP(src, "farming", 0)
AddXP (src, category, xp)
AddXP function. This function adds xp to the player's xp.

Parameters:

  • src The player to add the xp to. number
  • category The category to add the xp to. string
  • xp The xp to add. number

Usage:

    exports.jones_util:AddXP(src, "farming", 100)
RemoveXP (src, category, xp)
RemoveXP function. This function removes xp from the player's xp.

Parameters:

  • src The player to remove the xp from. number
  • category The category to remove the xp from. string
  • xp The xp to remove. number

Usage:

    exports.jones_util:RemoveXP(src, "farming", 100)
GetLevelXP (src, category)
GetLevelXP function. This function returns the player's level xp.

Parameters:

  • src The player to get the level xp from. number
  • category The category to get the level xp from. string

Returns:

    number

Usage:

    local levelXp = exports.jones_util:GetLevelXP(src, "farming")
GetLevelMultiplier (src, category)
GetLevelMultiplier function. This function returns the player's level multiplier.

Parameters:

  • src The player to get the level multiplier from. number
  • category The category to get the level multiplier from. string

Returns:

    number

Usage:

    local levelMultiplier = exports.jones_util:GetLevelMultiplier(src, "farming")
GetPrestige (src, category)
GetPrestige function. This function returns the player's prestige.

Parameters:

  • src The player to get the prestige from. number
  • category The category to get the prestige from. string

Returns:

    number

Usage:

    local prestige = exports.jones_util:GetPrestige(src, "farming")
SetPrestige (src, category, prestige)
SetPrestige function. This function sets the player's prestige.

Parameters:

  • src The player to set the prestige for. number
  • category The category to set the prestige for. string
  • prestige The prestige to set. number

Usage:

    exports.jones_util:SetPrestige(src, "farming", 0)
AddPrestige (src, category, prestige)
AddPrestige function. This function adds prestige to the player's prestige.

Parameters:

  • src The player to add the prestige to. number
  • category The category to add the prestige to. string
  • prestige The prestige to add. number

Usage:

    exports.jones_util:AddPrestige(src, "farming", 1)
RemovePrestige (src, category, prestige)
RemovePrestige function. This function removes prestige from the player's prestige.

Parameters:

  • src The player to remove the prestige from. number
  • category The category to remove the prestige from. string
  • prestige The prestige to remove. number

Usage:

    exports.jones_util:RemovePrestige(src, "farming", 1)
GetPrestigeMultiplier (src, category)
GetPrestigeMultiplier function. This function returns the player's prestige multiplier.

Parameters:

  • src The player to get the prestige multiplier from. number
  • category The category to get the prestige multiplier from. string

Returns:

    number

Usage:

    local prestigeMultiplier = exports.jones_util:GetPrestigeMultiplier(src, "farming")
GetMaxLevel (src)
GetMaxLevel function. This function returns the player's max level.

Parameters:

  • src The player to get the max level from. number

Returns:

    number

Usage:

    local maxLevel = exports.jones_util:GetMaxLevel(src)
GetMaxPrestige (src)
GetMaxPrestige function. This function returns the player's max prestige.

Parameters:

  • src The player to get the max prestige from. number

Returns:

    number

Usage:

    local maxPrestige = exports.jones_util:GetMaxPrestige(src
generated by LDoc 1.5.0 Last updated 2024-05-13 19:05:24