AchievementsService

Inherits Instance

Service for managing achievements

Static Class

This object is a static class. It can be accessed by using its name as a keyword.

Additionally, it cannot be created in the creator menu or with Instance.New().

Not newable

This object cannot be created by scripts using Instance.New().

Properties

UseAchievementSound : boolean

Determine if achievement sound effect should play when user receives an achievement

NotifyAchievements : boolean

Determine if achievement toast should show when user receives an achievement

Methods

Award → nil

Parameters

userID [ number ]

achievementID [ number ]

callback [ function ]

Award achievement to the user

AwardAsync → nil

Parameters

userID [ number ]

achievementID [ number ]

Award achievement to the user asynchronously.

HasAchievement → nil

Parameters

userID [ number ]

achievementID [ number ]

callback [ function ]

Check if user of ID has the achievement.

HasAchievementAsync → boolean

Parameters

userID [ number ]

achievementID [ number ]

Check if player of ID has the achievement, asynchronously.

Events

GotAchievement

Parameters: achievementID [ number ]

Fires when the local player got an achievement