Skip to main content

Flags

Flags are a way of turning on or off Developer or Experimental features of Toasty. All flags are documented Here

Types​

Flag​

</>
type Flag = string

PossibleFlags​

</>
interface PossibleFlags {
Verbose: Flag
FlatNetworkStructure: Flag
WarnOnMiddlewareError: Flag
}

Properties​

Flags​

This item is read only and cannot be modified. Read Only
</>
Flags.Flags: PossibleFlags

Functions​

Enable​

</>
Flags.Enable(flag: Flag) → ()

Disable​

</>
Flags.Disable(flag: Flag) → ()

IsEnabled​

</>
Flags.IsEnabled(flag: Flag) → ()
Show raw api
{
    "functions": [
        {
            "name": "Enable",
            "desc": "",
            "params": [
                {
                    "name": "flag",
                    "desc": "",
                    "lua_type": "Flag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "Source/Flags.luau"
            }
        },
        {
            "name": "Disable",
            "desc": "",
            "params": [
                {
                    "name": "flag",
                    "desc": "",
                    "lua_type": "Flag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "Source/Flags.luau"
            }
        },
        {
            "name": "IsEnabled",
            "desc": "",
            "params": [
                {
                    "name": "flag",
                    "desc": "",
                    "lua_type": "Flag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "Source/Flags.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Flags",
            "desc": "",
            "lua_type": "PossibleFlags",
            "readonly": true,
            "source": {
                "line": 26,
                "path": "Source/Flags.luau"
            }
        }
    ],
    "types": [
        {
            "name": "Flag",
            "desc": "",
            "lua_type": "string",
            "source": {
                "line": 12,
                "path": "Source/Flags.luau"
            }
        },
        {
            "name": "PossibleFlags",
            "desc": "",
            "fields": [
                {
                    "name": "Verbose",
                    "lua_type": "Flag",
                    "desc": ""
                },
                {
                    "name": "FlatNetworkStructure",
                    "lua_type": "Flag",
                    "desc": ""
                },
                {
                    "name": "WarnOnMiddlewareError",
                    "lua_type": "Flag",
                    "desc": ""
                }
            ],
            "source": {
                "line": 20,
                "path": "Source/Flags.luau"
            }
        }
    ],
    "name": "Flags",
    "desc": "Flags are a way of turning on or off Developer or Experimental features of Toasty.\nAll flags are documented [Here](../docs/Guide/Config)",
    "source": {
        "line": 7,
        "path": "Source/Flags.luau"
    }
}