Skip to main content

Module

Module exports for the framework. Provides API to install it in your place. SharedFramework is installed in ReplicatedStorage, named rtrf ServerFramework is installed in ServerStorage, named rtrfServer

Properties​

shared​

</>
Module.shared: SharedFramework

server​

</>
Module.server: ServerFramework

Functions​

getInstalledSharedFramework​

</>
Module.getInstalledSharedFramework() → Instance | nil

Gets the current installed shared framework module. Used to check if framework is installed.

getInstalledServerFramework​

</>
Module.getInstalledServerFramework() → Instance | nil

Gets the current installed server framework module. Used to check if framework is installed.

getInstalledVersion​

</>
Module.getInstalledVersion() → Option<string>

Gets the current installed framework version Returns it as an Option. If framework is not installed or version is not found, returns Option.none.

uninstall​

</>
Module.uninstall() → ()

Uninstalls the framework from your place

install​

</>
Module.install() → ()

Installs the framework in your place

update​

</>
Module.update() → ()

Replaces the current installed version with this version

Show raw api
{
    "functions": [
        {
            "name": "getInstalledSharedFramework",
            "desc": "Gets the current installed shared framework module.\nUsed to check if framework is installed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance | nil"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/init.lua"
            }
        },
        {
            "name": "getInstalledServerFramework",
            "desc": "Gets the current installed server framework module.\nUsed to check if framework is installed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance | nil"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/init.lua"
            }
        },
        {
            "name": "getInstalledVersion",
            "desc": "Gets the current installed framework version\nReturns it as an Option.\nIf framework is not installed or version is not found, returns Option.none.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Option<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/init.lua"
            }
        },
        {
            "name": "uninstall",
            "desc": "Uninstalls the framework from your place",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/init.lua"
            }
        },
        {
            "name": "install",
            "desc": "Installs the framework in your place",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/init.lua"
            }
        },
        {
            "name": "update",
            "desc": "Replaces the current installed version with this version",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/init.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "shared",
            "desc": "",
            "lua_type": "SharedFramework",
            "source": {
                "line": 25,
                "path": "src/init.lua"
            }
        },
        {
            "name": "server",
            "desc": "",
            "lua_type": "ServerFramework",
            "source": {
                "line": 31,
                "path": "src/init.lua"
            }
        }
    ],
    "types": [],
    "name": "Module",
    "desc": "Module exports for the framework.\nProvides API to install it in your place.\nSharedFramework is installed in `ReplicatedStorage`, named `rtrf`\nServerFramework is installed in `ServerStorage`, named `rtrfServer`",
    "source": {
        "line": 20,
        "path": "src/init.lua"
    }
}