Skip to main content

FlagAuth

Resolves per-pole authorization attributes and checks players.

Functions​

resolve​

</>
FlagAuth.resolve(pole: Instance—FlagModel) → Types.PoleAuth

Reads pole Attributes with Config fallbacks.

isAuthorized​

</>
FlagAuth.isAuthorized(
player: Player,
pole: Instance
) → boolean

Returns whether player may change this pole.

Show raw api
{
    "functions": [
        {
            "name": "resolve",
            "desc": "Reads pole Attributes with Config fallbacks.",
            "params": [
                {
                    "name": "pole",
                    "desc": "",
                    "lua_type": "Instance — Flag Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.PoleAuth"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "src/ServerScriptService/NationFlagSystem/FlagAuth.luau"
            }
        },
        {
            "name": "isAuthorized",
            "desc": "Returns whether `player` may change this pole.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "pole",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/ServerScriptService/NationFlagSystem/FlagAuth.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FlagAuth",
    "desc": "Resolves per-pole authorization attributes and checks players.",
    "source": {
        "line": 12,
        "path": "src/ServerScriptService/NationFlagSystem/FlagAuth.luau"
    }
}