BadgeService

Show Deprecated
Not Creatable
Service

The BadgeService class provides information and functionality related to badges. Badges are used across the platform to recognize a player's achievements and activity. Upon awarding a badge to a player, it is added to their inventory and displayed on their profile page.

Code Samples

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(), it confirms that the badge can be awarded and does so using BadgeService:AwardBadge().

Awarding a Badge
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local BADGE_ID = 0



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 awardSuccess, result = pcall(function()

				return BadgeService:AwardBadge(player.UserId, badgeId)

			end)



			if not awardSuccess 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



local function onPlayerAdded(player)

	awardBadge(player, BADGE_ID)

end



Players.PlayerAdded:Connect(onPlayerAdded)

The following script waits for any player to enter the game and checks if they own a specific badge. This is useful for creating a restricted area with collision filtering or teleportation that only works if a player owns a special badge.

Checking Earned Badges
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local badgeId = 00000000 -- Change this to your badge ID



local function onPlayerAdded(player)

	-- Check if the player has the badge

	local success, hasBadge = pcall(function()

		return BadgeService:UserHasBadgeAsync(player.UserId, badgeId)

	end)



	-- If there's an error, issue a warning and exit the function

	if not success then

		warn("Error while checking if player has badge!")

		return

	end



	if hasBadge then

		-- Handle player's badge ownership as needed

		print(player.Name, "has badge", badgeId)

	end

end



-- Connect "PlayerAdded" events to the "onPlayerAdded()" function

Players.PlayerAdded:Connect(onPlayerAdded)

This script checks which badges a user owns when they join the experience.

Checking Earned Badges in Batches
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")

local badgeIds = { 0000000000, 1111111111, 2222222222 } -- Change this to a list of your badge IDs

local function onPlayerAdded(player)

	-- Check if the player has any of the badges

	local success, result = pcall(function()

		return BadgeService:CheckUserBadgesAsync(player.UserId, badgeIds)

	end)

	-- If there's an error, issue a warning and exit the function

	if not success then

		warn("Error while checking if player", player.Name, "has badges:", result)

		return

	end



	local ownedBadgeIds = result



	if #ownedBadgeIds == 0 then

		print(player.Name, "does not have any of the badges")

	else

		print(player.Name, "has the following badges:", table.concat(ownedBadgeIds, ", "))

	end

end



Players.PlayerAdded:Connect(onPlayerAdded)

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

Getting Badge Info
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

Summary

Methods

View all inherited from Instance
View all inherited from Object

Properties

View all inherited from Instance
View all inherited from Object

Methods

AwardBadge

boolean
Yields

Parameters

userId: number
badgeId: number

Returns

boolean

Code Samples

Awarding a Badge
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local BADGE_ID = 0



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 awardSuccess, result = pcall(function()

				return BadgeService:AwardBadge(player.UserId, badgeId)

			end)



			if not awardSuccess 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



local function onPlayerAdded(player)

	awardBadge(player, BADGE_ID)

end



Players.PlayerAdded:Connect(onPlayerAdded)

CheckUserBadgesAsync

Array
Yields

Parameters

userId: number
badgeIds: Array

Returns

Array

Code Samples

Checking Earned Badges in Batches
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")

local badgeIds = { 0000000000, 1111111111, 2222222222 } -- Change this to a list of your badge IDs

local function onPlayerAdded(player)

	-- Check if the player has any of the badges

	local success, result = pcall(function()

		return BadgeService:CheckUserBadgesAsync(player.UserId, badgeIds)

	end)

	-- If there's an error, issue a warning and exit the function

	if not success then

		warn("Error while checking if player", player.Name, "has badges:", result)

		return

	end



	local ownedBadgeIds = result



	if #ownedBadgeIds == 0 then

		print(player.Name, "does not have any of the badges")

	else

		print(player.Name, "has the following badges:", table.concat(ownedBadgeIds, ", "))

	end

end



Players.PlayerAdded:Connect(onPlayerAdded)

GetBadgeInfoAsync

Dictionary
Yields

Parameters

badgeId: number

Returns

Dictionary

Code Samples

Getting Badge Info
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

IsDisabled

boolean
Yields
Deprecated

Parameters

badgeId: number

Returns

boolean

Code Samples

[Deprecated] Checking if a Badge is Disabled
local BadgeService = game:GetService("BadgeService")



print(BadgeService:IsDisabled(17468517))
Awarding a Badge
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local BADGE_ID = 0



local function awardBadge(player, badgeId)

	-- check badge can be awarded

	if BadgeService:IsLegal(badgeId) and not BadgeService:IsDisabled(badgeId) then

		-- award badge

		BadgeService:AwardBadge(player.UserId, badgeId)

	end

end



local function onPlayerAdded(player)

	awardBadge(player, BADGE_ID)

end



Players.PlayerAdded:Connect(onPlayerAdded)

IsLegal

boolean
Yields
Deprecated

Parameters

badgeId: number

Returns

boolean

Code Samples

Awarding a Badge
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local BADGE_ID = 0



local function awardBadge(player, badgeId)

	-- check badge can be awarded

	if BadgeService:IsLegal(badgeId) and not BadgeService:IsDisabled(badgeId) then

		-- award badge

		BadgeService:AwardBadge(player.UserId, badgeId)

	end

end



local function onPlayerAdded(player)

	awardBadge(player, BADGE_ID)

end



Players.PlayerAdded:Connect(onPlayerAdded)

UserHasBadge

boolean
Yields
Deprecated

Parameters

userId: number
badgeId: number

Returns

boolean

Code Samples

[Deprecated] Checking if a User Has a Badge
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local BADGE_ID = 123



Players.PlayerAdded:Connect(function(player)

	if BadgeService:UserHasBadge(player.UserId, BADGE_ID) then

		print("The user has this badge")

	else

		print("The user does not have this badge")

	end

end)

UserHasBadgeAsync

boolean
Yields

Parameters

userId: number
badgeId: number

Returns

boolean

Code Samples

Checking Earned Badges
local BadgeService = game:GetService("BadgeService")

local Players = game:GetService("Players")



local badgeId = 00000000 -- Change this to your badge ID



local function onPlayerAdded(player)

	-- Check if the player has the badge

	local success, hasBadge = pcall(function()

		return BadgeService:UserHasBadgeAsync(player.UserId, badgeId)

	end)



	-- If there's an error, issue a warning and exit the function

	if not success then

		warn("Error while checking if player has badge!")

		return

	end



	if hasBadge then

		-- Handle player's badge ownership as needed

		print(player.Name, "has badge", badgeId)

	end

end



-- Connect "PlayerAdded" events to the "onPlayerAdded()" function

Players.PlayerAdded:Connect(onPlayerAdded)
View all inherited from Instance
View all inherited from Object

Events

View all inherited from Instance
View all inherited from Object