Skip to main content

ServerBootstrap

This item only works when running on the server. Server

Internal module only to be used by Axis itself

Functions​

ApplyPlayerConfig​

</>
ServerBootstrap:ApplyPlayerConfig(Player: Player) → ()

Applies the current player config to the given player

ApplyCharacterConfig​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
ServerBootstrap:ApplyCharacterConfig(Player: Player) → ()

Applies the current player config to the given player's character

Errors

TypeDescription
"Player currently doesn't have a character"Error happens when the function is called but the player's character does not yet exist

BootSequence​

</>
ServerBootstrap:BootSequence() → bool

Executes all the phases in order

Show raw api
{
    "functions": [
        {
            "name": "ApplyPlayerConfig",
            "desc": "Applies the current player config to the given player",
            "params": [
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 17,
                "path": "Axis/Core/Bootstrap/Server.luau"
            }
        },
        {
            "name": "ApplyCharacterConfig",
            "desc": "Applies the current player config to the given player's character",
            "params": [
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "\"Player currently doesn't have a character\"",
                    "desc": "Error happens when the function is called but the player's character does not yet exist"
                }
            ],
            "yields": true,
            "source": {
                "line": 35,
                "path": "Axis/Core/Bootstrap/Server.luau"
            }
        },
        {
            "name": "BootSequence",
            "desc": "Executes all the phases in order",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "bool"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "Axis/Core/Bootstrap/Server.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ServerBootstrap",
    "desc": "Internal module only to be used by Axis itself",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "Axis/Core/Bootstrap/Server.luau"
    }
}