Skip to main content

Rorooms

Functions​

Start​

</>
Rorooms:Start() → ()

Starts Rorooms.

Configure​

</>
Rorooms:Configure(Config: Config) → ()

Types

​

interface Config {
Test: boolean?
}

Reconciles Rorooms' config to your liking.

Config type available here

Prompt​

This item only works when running on the client. Client
</>
Rorooms:Prompt(Prompt: Prompt) → ()

Prompts the client, with support for callback buttons.

Prompt type available here

Show raw api
{
    "functions": [
        {
            "name": "Start",
            "desc": "Starts Rorooms.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 11,
                "path": "src/API/init.luau"
            }
        },
        {
            "name": "Configure",
            "desc": "Reconciles Rorooms' config to your liking.\n\n[`Config` type available here](https://github.com/Rorooms/Rorooms/blob/main/src/API/Config.luau)",
            "params": [
                {
                    "name": "Config",
                    "desc": "",
                    "lua_type": "Config"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 22,
                "path": "src/API/init.luau"
            }
        },
        {
            "name": "Prompt",
            "desc": "Prompts the client, with support for callback buttons.\n\n[`Prompt` type available here](https://github.com/Rorooms/Rorooms/blob/main/src/Client/UI/States/Prompts.luau)",
            "params": [
                {
                    "name": "Prompt",
                    "desc": "",
                    "lua_type": "Prompt"
                }
            ],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 41,
                "path": "src/API/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "Config",
            "desc": "",
            "fields": [
                {
                    "name": "Test",
                    "lua_type": "boolean?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 29,
                "path": "src/API/init.luau"
            }
        }
    ],
    "name": "Rorooms",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/API/init.luau"
    }
}