Skip to main content

Nations

Merged nation catalog for the picker and server. Combines WorldFlags, PassportExtras, and place-known texture overrides.

Functions​

get​

</>
Nations.get(id: string) → Types.NationEntry?

Looks up a nation by id (ISO2, ISO3 alias, or custom code).

getByTexture​

</>
Nations.getByTexture(textureId: string) → Types.NationEntry?

Reverse-lookup by MeshPart TextureID / asset digits.

list​

</>
Nations.list() → {Types.NationEntry}

Ordered list for the picker (passport nations first, then A–Z).

</>
Nations.search(query: string) → {Types.NationEntry}

Case-insensitive filter on display name and codes.

Show raw api
{
    "functions": [
        {
            "name": "get",
            "desc": "Looks up a nation by id (ISO2, ISO3 alias, or custom code).",
            "params": [
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.NationEntry?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 161,
                "path": "src/ReplicatedStorage/NationFlagSystem/Nations.luau"
            }
        },
        {
            "name": "getByTexture",
            "desc": "Reverse-lookup by MeshPart TextureID / asset digits.",
            "params": [
                {
                    "name": "textureId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.NationEntry?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 172,
                "path": "src/ReplicatedStorage/NationFlagSystem/Nations.luau"
            }
        },
        {
            "name": "list",
            "desc": "Ordered list for the picker (passport nations first, then A–Z).",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Types.NationEntry}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 183,
                "path": "src/ReplicatedStorage/NationFlagSystem/Nations.luau"
            }
        },
        {
            "name": "search",
            "desc": "Case-insensitive filter on display name and codes.",
            "params": [
                {
                    "name": "query",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Types.NationEntry}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 194,
                "path": "src/ReplicatedStorage/NationFlagSystem/Nations.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Nations",
    "desc": "Merged nation catalog for the picker and server.\nCombines [WorldFlags], [PassportExtras], and place-known texture overrides.",
    "source": {
        "line": 14,
        "path": "src/ReplicatedStorage/NationFlagSystem/Nations.luau"
    }
}