Skip to main content

AvalogClient

The client-side module of Avalog.

Functions​

Start​

</>
AvalogClient:Start() → ()

Starts Avalog on the client.

Configure​

</>
AvalogClient:Configure(NewConfig: Config) → ()

Configures Avalog with the given config.

ToggleOpen​

</>
AvalogClient:ToggleOpen() → ()

Toggles whether or not Avalog is open.

SetOpen​

</>
AvalogClient:SetOpen(Open: boolean) → ()

Sets whether or not Avalog is open.

Show raw api
{
    "functions": [
        {
            "name": "Start",
            "desc": "Starts Avalog on the client.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 36,
                "path": "src/API/Client.luau"
            }
        },
        {
            "name": "Configure",
            "desc": "Configures Avalog with the given config.",
            "params": [
                {
                    "name": "NewConfig",
                    "desc": "",
                    "lua_type": "Config"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 49,
                "path": "src/API/Client.luau"
            }
        },
        {
            "name": "ToggleOpen",
            "desc": "Toggles whether or not Avalog is open.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 56,
                "path": "src/API/Client.luau"
            }
        },
        {
            "name": "SetOpen",
            "desc": "Sets whether or not Avalog is open.",
            "params": [
                {
                    "name": "Open",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 65,
                "path": "src/API/Client.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AvalogClient",
    "desc": "The client-side module of Avalog.",
    "source": {
        "line": 27,
        "path": "src/API/Client.luau"
    }
}