GameMaker Studio · GML · Achievements

gmda_getAchievementInfo

Fetches one achievement's panel definition plus this player's unlock state.

Asynchronous (result via event)

Signature

gmda_getAchievementInfo(key) -> real

What it does

POSTs /achievements/info (session-auth). Returns 1 when fired, 0 with no active session. The achievement_info_loaded event carries the detail in response: { achievement_key, name, description, icon_url, points, is_hidden, unlocked, unlocked_at }. A hidden achievement the player hasn't unlocked yet comes back masked: name "???", description and icon_url null, points 0, unlocked false. 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_getAchievementInfo(), then read achievement_info_loaded from gmda_pollEvent().

Result event: achievement_info_loaded { success, response }

Example

gmda_getAchievementInfo("first_win");

// In the Step event:
var _e = gmda_pollEvent();
while (!is_undefined(_e)) {
    if (_e.event == "achievement_info_loaded" && _e.success) {
        var _info = _e.response;
        show_debug_message(_info.name + "; " + string(_info.description) + " (" + string(_info.points) + " pts)");
    }
    _e = gmda_pollEvent();
}

Use cases

Show a single achievement's details and icon in a popup or tooltip.
Render hidden achievements as masked entries until the player unlocks them.

Functions Reference