GameMaker Studio · GML · Achievements

gmda_checkAchievement

Checks whether this player has unlocked a given achievement.

Asynchronous (result via event)

Signature

gmda_checkAchievement(key) -> real

What it does

POSTs /achievements/check (session-auth). Returns 1 when fired, 0 with no active session. The achievement_checked event reports this player's state in response: response.unlocked is a bool, and response.unlocked_at is the ISO timestamp when it was unlocked (set only when unlocked, otherwise null). On failure success is false (achievement not found or an empty key).

Parameters

Name	Type	Default	Description
key	string	required	The achievement's key from the panel.

How to call it

Fire gmda_checkAchievement(), then read achievement_checked from gmda_pollEvent().

Result event: achievement_checked { success, response }

Example

gmda_checkAchievement("first_win");

// In the Step event:
var _e = gmda_pollEvent();
while (!is_undefined(_e)) {
    if (_e.event == "achievement_checked" && _e.success) {
        show_debug_message("unlocked: " + string(_e.response.unlocked));
    }
    _e = gmda_pollEvent();
}

Use cases

Decide whether to show an 'already earned' badge before offering to grant it again.
Gate content or a reward behind a specific achievement being unlocked.