Skip to content

replace references to AwardBadge with AwardBadgeAsync #1376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
actuallyasmartname wants to merge 1 commit into from
Closed

replace references to AwardBadge with AwardBadgeAsync #1376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en-us/production/publishing/badges.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ A badge's ID is its unique identifier. You'll need this ID when implementing wor

### Award badges

You can award badges to players throughout your experience by calling the `Class.BadgeService:AwardBadge()` method in a server-side `Class.Script`. `Class.BadgeService:GetBadgeInfoAsync()` returns properties of the badge, including `IsEnabled` which confirms whether or not the badge can be awarded to a player. You can enable or disable a badge from the **Configure Badge** form on the [Creator Dashboard](https://create.roblox.com/dashboard/creations).
You can award badges to players throughout your experience by calling the `Class.BadgeService:AwardBadgeAsync()` method in a server-side `Class.Script`. `Class.BadgeService:GetBadgeInfoAsync()` returns properties of the badge, including `IsEnabled` which confirms whether or not the badge can be awarded to a player. You can enable or disable a badge from the **Configure Badge** form on the [Creator Dashboard](https://create.roblox.com/dashboard/creations).

The following is an example of a safe function for awarding badges to players.

Expand All @@ -101,7 +101,7 @@ local function awardBadge(player, badgeId)
-- Confirm that badge can be awarded
if badgeInfo.IsEnabled then
-- Award badge
local awarded, errorMessage = pcall(BadgeService.AwardBadge, BadgeService, player.UserId, badgeId)
local awarded, errorMessage = pcall(BadgeService.AwardBadgeAsync, BadgeService, player.UserId, badgeId)
if not awarded then
warn("Error while awarding badge:", errorMessage)
end
Expand Down
4 changes: 2 additions & 2 deletions content/en-us/reference/engine/classes/BadgeService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ methods:

See also:

- `Class.BadgeService:AwardBadge()`
- `Class.BadgeService:AwardBadgeAsync()`
- `Class.BadgeService:UserHasBadgeAsync()`
code_samples:
- getbadgeinfoasync
Expand Down Expand Up @@ -355,7 +355,7 @@ methods:

- `Class.BadgeService:CheckUserBadgesAsync()`
- `Class.BadgeService:GetBadgeInfoAsync()`
- `Class.BadgeService:AwardBadge()`
- `Class.BadgeService:AwardBadgeAsync()`
code_samples:
- badges---checking-earned-badges
parameters:
Expand Down