GameMaker Studio · GML · Rewards

gmda_getRewardsStatus

Fetches this player's reward status (what's claimable now and when each unlocks next).

Asynchronous (result via event)

Signature

gmda_getRewardsStatus()

What it does

GETs /rewards (session-auth). The queued rewards_status_loaded event carries response = { server_now, rewards: [...] }. response.rewards is an array, one struct per panel-defined reward: { id, key, display_name, description, cadence_type, cadence_n_days, event_starts_at, event_ends_at, payload_keys, currency_grant_id, last_claimed_at, claimable_now, next_claimable_at }. claimable_now is a bool; next_claimable_at is an ISO string (or undefined). response.server_now is an ISO timestamp you can use to correct for client clock skew. Returns 0 immediately (no event) when there is no active session.

Parameters

This function takes no parameters.

How to call it

Fire gmda_getRewardsStatus(), then read response.rewards in a Step event with gmda_pollEvent() when e.event == "rewards_status_loaded".

Result event: rewards_status_loaded { success, response }

Example

gmda_getRewardsStatus();

// later, in a Step event:
var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "rewards_status_loaded" && e.success) {
        var _rewards = e.response.rewards;
        for (var _i = 0; _i < array_length(_rewards); _i++) {
            var _r = _rewards[_i];
            if (_r.claimable_now) show_debug_message("ready: " + string(_r.key));
        }
    }
    e = gmda_pollEvent();
}

Use cases

Build a daily or weekly rewards screen showing which rewards are claimable now.
Show a countdown to the next claim using next_claimable_at and server_now.

Functions Reference