Skip to main content

Types

Shared type aliases for Nation Flag System modules.

Types​

AuthMode​

</>
type AuthMode = "Group" | "Team" | "Either" | "Anyone"

Authorization mode for a pole or global Config.

Possible values: Group, Team, Either, Anyone.

NationEntry​

</>
interface NationEntry {
displayName: string—Human-readablename
id: string—Stableid(
ISO2,
ISO3alias,
orcustome.g.`UNO`
)
inPassportAssets: boolean—Listedinpassport-systemassets/defaults
iso2: string?—ISO3166-1alpha-2whenapplicable
textureId: string—`rbxassetid://...`forMeshPart.TextureID
}

A selectable nation in the picker / registry.

PoleAuth​

</>
interface PoleAuth {
authMode: AuthMode
groupId: number
minGroupRank: number
teamName: string
}

Resolved authorization settings for a pole.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "AuthMode",
            "desc": "Authorization mode for a pole or global Config.\n\nPossible values: `Group`, `Team`, `Either`, `Anyone`.",
            "lua_type": "\"Group\" | \"Team\" | \"Either\" | \"Anyone\"",
            "source": {
                "line": 16,
                "path": "src/ReplicatedStorage/NationFlagSystem/Types.luau"
            }
        },
        {
            "name": "NationEntry",
            "desc": "A selectable nation in the picker / registry.",
            "fields": [
                {
                    "name": "displayName",
                    "lua_type": "string — Human-readable name",
                    "desc": ""
                },
                {
                    "name": "id",
                    "lua_type": "string — Stable id (ISO2, ISO3 alias, or custom e.g. `UNO`)",
                    "desc": ""
                },
                {
                    "name": "inPassportAssets",
                    "lua_type": "boolean — Listed in passport-system assets / defaults",
                    "desc": ""
                },
                {
                    "name": "iso2",
                    "lua_type": "string? — ISO 3166-1 alpha-2 when applicable",
                    "desc": ""
                },
                {
                    "name": "textureId",
                    "lua_type": "string — `rbxassetid://...` for MeshPart.TextureID",
                    "desc": ""
                }
            ],
            "source": {
                "line": 29,
                "path": "src/ReplicatedStorage/NationFlagSystem/Types.luau"
            }
        },
        {
            "name": "PoleAuth",
            "desc": "Resolved authorization settings for a pole.",
            "fields": [
                {
                    "name": "authMode",
                    "lua_type": "AuthMode",
                    "desc": ""
                },
                {
                    "name": "groupId",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "minGroupRank",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "teamName",
                    "lua_type": "string",
                    "desc": ""
                }
            ],
            "source": {
                "line": 47,
                "path": "src/ReplicatedStorage/NationFlagSystem/Types.luau"
            }
        }
    ],
    "name": "Types",
    "desc": "Shared type aliases for Nation Flag System modules.",
    "source": {
        "line": 7,
        "path": "src/ReplicatedStorage/NationFlagSystem/Types.luau"
    }
}