Skip to main content

LevelController

This item only works when running on the server. Server

Centralized controller for levels.

Functions​

AddXP​

</>
LevelController.AddXP(
player: Player,
addend: number
) → ()

Adds a desired amount of exp to a player

GetRequiredXP​

</>
LevelController.GetRequiredXP(
desiredLevel: number--

The level to check.

) → number--

The required amount of EXP

Checks a levels exp requirement based off an expontential formula.

Formula

XP = BASE_XP_REQUIREMENT * (EXPONENTIAL_FALLOFF ^ (desiredLevel - 1))

AttemptLevelUp​

</>
LevelController:AttemptLevelUp(player: Player) → ()

Attemps to level up a player, if their required EXP isnt high enough then the function runs nil.

Show raw api
{
    "functions": [
        {
            "name": "AddXP",
            "desc": "Adds a desired amount of exp to a player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "addend",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "global/ServerStorage/Scripts/Modules/LevelController.luau"
            }
        },
        {
            "name": "AttemptLevelUp",
            "desc": "Attemps to level up a player, if their required EXP isnt high enough then the function runs nil.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "global/ServerStorage/Scripts/Modules/LevelController.luau"
            }
        },
        {
            "name": "GetRequiredXP",
            "desc": "Checks a levels exp requirement based off an expontential formula.\n\n### [Formula](https://www.desmos.com/calculator/upt0fbgroz \"Desmos Visualizer\")\n```\nXP = BASE_XP_REQUIREMENT * (EXPONENTIAL_FALLOFF ^ (desiredLevel - 1))\n```",
            "params": [
                {
                    "name": "desiredLevel",
                    "desc": "The level to check.",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "The required amount of EXP",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 77,
                "path": "global/ServerStorage/Scripts/Modules/LevelController.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "LevelController",
    "desc": "Centralized controller for levels.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "global/ServerStorage/Scripts/Modules/LevelController.luau"
    }
}