Skip to main content

Badges

Utilities for checking and awarding Roblox badges with save-table support.

Properties​

BadgeAwarded​

</>
Badges.BadgeAwarded: Signal<(
Player,
BadgeAwardData,
BadgeSaveData?
) → ()>--Fireswhenabadgeisawardedfrommodule.

Functions​

SoftCheckBadgeOwnership​

</>
Badges.SoftCheckBadgeOwnership(
BadgeId: number,
BadgeSaveData: BadgeSaveData?
) → boolean

Checks badge ownership using only BadgeSaveData.

HardCheckBadgeOwnership​

</>
Badges.HardCheckBadgeOwnership(
Player: Player,
BadgeId: number,
BadgeSaveData: BadgeSaveData?
) → boolean

Checks badge ownership using both BadgeSaveData and BadgeService.UserHasBadgeAsync.

AwardBadge​

</>
Badges.AwardBadge(
Player: Player,
BadgeId: number,
BadgeSaveData: BadgeSaveData?
) → (
boolean,--

Whether this call awarded the badge.

BadgeAwardData?--

The award info for this badge.

)

Awards a badge if the player does not already own it.

If BadgeSaveData is provided, a new entry is inserted in this format: {BadgeId : number, AwardTimestampUTC : number, SerialNumber : number}

GetAllAwardedBadges​

</>
Badges.GetAllAwardedBadges(BadgeSaveData: BadgeSaveData?) → BadgeSaveData

Gets all awarded badges from save data.

GetBadgeAwardInfo​

</>
Badges.GetBadgeAwardInfo(
BadgeId: number,
BadgeSaveData: BadgeSaveData?
) → BadgeAwardData?

Gets saved award info for a specific badge.

Show raw api
{
    "functions": [
        {
            "name": "SoftCheckBadgeOwnership",
            "desc": "Checks badge ownership using only `BadgeSaveData`.",
            "params": [
                {
                    "name": "BadgeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "BadgeSaveData",
                    "desc": "",
                    "lua_type": "BadgeSaveData?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/Packages/Badges/init.luau"
            }
        },
        {
            "name": "HardCheckBadgeOwnership",
            "desc": "Checks badge ownership using both `BadgeSaveData` and `BadgeService.UserHasBadgeAsync`.",
            "params": [
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "BadgeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "BadgeSaveData",
                    "desc": "",
                    "lua_type": "BadgeSaveData?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/Packages/Badges/init.luau"
            }
        },
        {
            "name": "AwardBadge",
            "desc": "Awards a badge if the player does not already own it.\n\nIf `BadgeSaveData` is provided, a new entry is inserted in this format:\n`{BadgeId : number, AwardTimestampUTC : number, SerialNumber : number}`",
            "params": [
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "BadgeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "BadgeSaveData",
                    "desc": "",
                    "lua_type": "BadgeSaveData?"
                }
            ],
            "returns": [
                {
                    "desc": "Whether this call awarded the badge.",
                    "lua_type": "boolean"
                },
                {
                    "desc": "The award info for this badge.",
                    "lua_type": "BadgeAwardData?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/Packages/Badges/init.luau"
            }
        },
        {
            "name": "GetAllAwardedBadges",
            "desc": "Gets all awarded badges from save data.",
            "params": [
                {
                    "name": "BadgeSaveData",
                    "desc": "",
                    "lua_type": "BadgeSaveData?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BadgeSaveData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 150,
                "path": "src/Packages/Badges/init.luau"
            }
        },
        {
            "name": "GetBadgeAwardInfo",
            "desc": "Gets saved award info for a specific badge.",
            "params": [
                {
                    "name": "BadgeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "BadgeSaveData",
                    "desc": "",
                    "lua_type": "BadgeSaveData?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BadgeAwardData?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 166,
                "path": "src/Packages/Badges/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "BadgeAwarded",
            "desc": "",
            "lua_type": "Signal<(Player, BadgeAwardData, BadgeSaveData?) -> ()> -- Fires when a badge is awarded from module.",
            "source": {
                "line": 181,
                "path": "src/Packages/Badges/init.luau"
            }
        }
    ],
    "types": [],
    "name": "Badges",
    "desc": "Utilities for checking and awarding Roblox badges with save-table support.",
    "source": {
        "line": 6,
        "path": "src/Packages/Badges/init.luau"
    }
}