Skip to main content

Config

Global defaults for authorization, flag discovery, and prompts. Override per pole with Attributes (AuthMode, GroupId, MinGroupRank, TeamName).

Properties​

AuthMode​

</>
Config.AuthMode: Types.AuthMode

Default auth mode. "Either" allows group or team.

GroupId​

</>
Config.GroupId: number

Roblox group id. 0 disables the group check.

MinGroupRank​

</>
Config.MinGroupRank: number

Minimum rank required in GroupId.

TeamName​

</>
Config.TeamName: string

Exact Team.Name for team authorization.

FlagFolderPath​

</>
Config.FlagFolderPath: string

Dot path from game to the folder of flag Models (default Workspace.Flags).

CollectionTag​

</>
Config.CollectionTag: string

CollectionService tag for poles outside the flag folder.

PromptActionText​

</>
Config.PromptActionText: string

PromptMaxDistance​

</>
Config.PromptMaxDistance: number

PromptHoldDuration​

</>
Config.PromptHoldDuration: number

DenyMessage​

</>
Config.DenyMessage: string

Toast shown when a player is not authorized.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "AuthMode",
            "desc": "Default auth mode. `\"Either\"` allows group **or** team.",
            "lua_type": "Types.AuthMode",
            "source": {
                "line": 16,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "GroupId",
            "desc": "Roblox group id. `0` disables the group check.",
            "lua_type": "number",
            "source": {
                "line": 22,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "MinGroupRank",
            "desc": "Minimum rank required in `GroupId`.",
            "lua_type": "number",
            "source": {
                "line": 28,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "TeamName",
            "desc": "Exact `Team.Name` for team authorization.",
            "lua_type": "string",
            "source": {
                "line": 34,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "FlagFolderPath",
            "desc": "Dot path from `game` to the folder of flag Models (default `Workspace.Flags`).",
            "lua_type": "string",
            "source": {
                "line": 40,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "CollectionTag",
            "desc": "CollectionService tag for poles outside the flag folder.",
            "lua_type": "string",
            "source": {
                "line": 46,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "PromptActionText",
            "desc": "",
            "lua_type": "string",
            "source": {
                "line": 51,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "PromptMaxDistance",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 56,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "PromptHoldDuration",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 61,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        },
        {
            "name": "DenyMessage",
            "desc": "Toast shown when a player is not authorized.",
            "lua_type": "string",
            "source": {
                "line": 67,
                "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
            }
        }
    ],
    "types": [],
    "name": "Config",
    "desc": "Global defaults for authorization, flag discovery, and prompts.\nOverride per pole with Attributes (`AuthMode`, `GroupId`, `MinGroupRank`, `TeamName`).",
    "source": {
        "line": 10,
        "path": "src/ReplicatedStorage/NationFlagSystem/Config.luau"
    }
}