extends Instance
Class fields
| Field | XML type | Value |
|---|---|---|
Name | string | BadgeService |
Functions
6SetAwardBadgeUrl
(url: string) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetAwardBadgeUrl |
Deprecated | bool | true |
Browsable | bool | false |
SetHasBadgeCooldown
(seconds: int) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetHasBadgeCooldown |
Deprecated | bool | true |
Browsable | bool | false |
SetHasBadgeUrl
(url: string) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetHasBadgeUrl |
Deprecated | bool | true |
Browsable | bool | false |
SetIsBadgeDisabledUrl
(url: string) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetIsBadgeDisabledUrl |
Deprecated | bool | true |
Browsable | bool | false |
SetIsBadgeLegalUrl
(url: string) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetIsBadgeLegalUrl |
Deprecated | bool | true |
Browsable | bool | false |
SetPlaceId
(placeId: int) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetPlaceId |
Deprecated | bool | true |
Browsable | bool | false |
Yield functions
8AwardBadge
(userId: int, badgeId: int) → bool| Field | XML type | Value |
|---|---|---|
Name | string | AwardBadge |
Deprecated | bool | true |
summary | string | Deprecated. Use AwardBadgeAsync instead. |
AwardBadgeAsync
| Field | XML type | Value |
|---|---|---|
Name | string | AwardBadgeAsync |
summary | string | Awards a badge to a player who is currently connected to the experience. |
CheckUserBadgesAsync
| Field | XML type | Value |
|---|---|---|
Name | string | CheckUserBadgesAsync |
summary | string | Returns the badge IDs, from a batch of at most 10, that the user owns. |
GetBadgeInfoAsync
| Field | XML type | Value |
|---|---|---|
Name | string | GetBadgeInfoAsync |
summary | string | Returns the name, description, icon image ID, and enabled state for a badge. |
IsDisabled
(badgeId: int) → bool| Field | XML type | Value |
|---|---|---|
Name | string | IsDisabled |
Deprecated | bool | true |
IsLegal
(badgeId: int) → bool| Field | XML type | Value |
|---|---|---|
Name | string | IsLegal |
Deprecated | bool | true |
UserHasBadge
(userId: int, badgeId: int) → bool| Field | XML type | Value |
|---|---|---|
Name | string | UserHasBadge |
Deprecated | bool | true |
summary | string | Deprecated. Use UserHasBadgeAsync instead. |
UserHasBadgeAsync
| Field | XML type | Value |
|---|---|---|
Name | string | UserHasBadgeAsync |
summary | string | Returns whether the user owns the badge. |
Events
2BadgeAwarded
(message: string, userId: int, badgeId: int) → void| Field | XML type | Value |
|---|---|---|
Name | string | BadgeAwarded |
OnBadgeAwarded
| Field | XML type | Value |
|---|---|---|
Name | string | OnBadgeAwarded |