GetBadgeInfoAsync

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:

This function fteches information about a articles/Badges Special Game Awards|badge given its ID. It takes a brief moment to load the information from the Roblox website; repeated calls will cache for a short duration. It returns a dictionary with the following fields:

Key	Type	Description
Name	string	The name of the badge.
Description	string	The description of the badge.
IconImageId	int64	The asset ID of the image for the badge.
IsEnabled	bool	Indicates whether the badge is available to be awarded.

Parameters

Name	Type	Default	Description
Name badgeId	Type int64	Default	Summary The badge ID of the badge whose information should be fetched.

Returns

Return Type	Summary
Return Type Dictionary	Summary A dictionary of information about the specified badge.

Code Samples

Getting Badge Info

This sample prints badge information fetched via BadgeService/GetBadgeInfoAsync|BadgeService:GetBadgeInfoAsync().

			
				Getting Badge Info

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

-- Fetch badge information
local success, result = pcall(function()
	return BadgeService:GetBadgeInfoAsync(00000000)  -- Change this to desired badge ID
end)

-- Output the information
if success then
	print("Badge:", result.Name)
	print("Enabled:", result.IsEnabled)
	print("Description:", result.Description)
	print("Icon:", "rbxassetid://" .. result.IconImageId)	
else
	warn("Error while fetching badge info:", result)
end
		
				Copy Code
			
				Light Theme

GetBadgeInfoAsync

See also

Parameters

badgeId

Returns

Dictionary

Code Samples

Getting Badge Info