Skip to main content

Introduction

You might want to add achievements to your game. If that is the case, this is the utility you want to use. The Achievements module allows you to display and register achievements easily. You will only care about triggering the achievement and the rest lays on the package.

How it works

You have to provide all available achievements on game startup (or at least before using the Achievements utility). Once they are initialized you will be able to use the Achievements API to unlock achievements for the user.

Behaviours like preventing achievements to be shown more than once (even during different game sessions) are managed by the utility. Also, you can use managed scripts that detect when achievements are unlocked to trigger custom code easily.

Important to know

Achievements are stored using the Storage utility. This means that at some point you will need to follow Storage initialization steps.