AwardBadge

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

BadgeService

Description:

AwardBadge grants a Player a articles/Badges Special Game Awards|badge given the player’s Player/UserId|UserId and the badge ID. In order to successfully award a badge, the following criteria must be met:

The player must be presently connected to the game.
The player must not already have the badge (note that a player may delete an awarded badge from their profile and be awarded the badge again).
The badge must be awarded from a server-side Script or a ModuleScript eventually required by a Script, not from a LocalScript.
The badge must be awarded in a place that is part of the game associated with the badge.
The owner of the place must also own the badge (for example, the owner must not have deleted the badge).
The badge must be enabled; check this using the IsEnabled property of the badge fetched via BadgeService/GetBadgeInfoAsync|BadgeService:GetBadgeInfoAsync().

Parameters

Name	Type	Default	Description
Name userId	Type int64	Default	Summary The `Player/UserId` of the user the badge is to be awarded to.
Name badgeId	Type int64	Default	Summary The ID of the badge to be awarded.

Returns

Return Type	Summary
Return Type bool	Summary Boolean of `true` if the badge was awarded successfully.

Code Samples

Awarding a Badge

The following example creates an awardBadge() function that handles potential errors that may occur when awarding a badge. Using properties of the badge fetched via BadgeService/GetBadgeInfoAsync|BadgeService:GetBadgeInfoAsync(), it confirms that the badge can be awarded and does so using BadgeService/AwardBadge|BadgeService:AwardBadge().

			
				Awarding a Badge

				Expected Output
			
				Expand
				
			local BadgeService = game:GetService("BadgeService")

local function awardBadge(player, badgeId)
	-- Fetch badge information
	local success, badgeInfo = pcall(function()
		return BadgeService:GetBadgeInfoAsync(badgeId)
	end)
	
	if success then
		-- Confirm that badge can be awarded
		if badgeInfo.IsEnabled then
			-- Award badge
			local success, result = pcall(function()
				return BadgeService:AwardBadge(player.UserId, badgeId)
			end)
			
			if not success then
				-- the AwardBadge function threw an error
				warn("Error while awarding badge:", result)
			elseif not result then
				-- the AwardBadge function did not award a badge
				warn("Failed to award badge.")
			end
		end
	else
		warn("Error while fetching badge info: " .. badgeInfo)
	end
end
		
				Copy Code
			
				Light Theme

AwardBadge

See also

Parameters

userId

badgeId

Returns

bool

Code Samples

Awarding a Badge