GameMaker Studio · GML · Groups & clans

gmda_listGroupRequests

Lists join requests, incoming (to review) or outgoing (your own).

Signature

gmda_listGroupRequests([direction="incoming"], [status="pending"], [limit=50]) -> real

What it does

POSTs /groups/requests/list, then queues group_requests_listed { success, response }. e.response is the raw server body: the list of requests, { id, direction, group_id, group_name, player, status, message, created_at, ... }, is the array at e.response.requests. Returns 0 (and queues nothing) when there is no active session.

Parameters

How to call it

Call it, then read the array from e.response.requests on the group_requests_listed event in gmda_pollEvent(). The "incoming" direction needs review permission. Use each returned id with gmda_respondGroupRequest() or gmda_cancelGroupRequest().

Example

gmda_listGroupRequests("incoming");   // -> group_requests_listed

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_requests_listed" && e.success) {
        var reqs = e.response.requests;   // the list lives at response.requests
        for (var i = 0; i < array_length(reqs); i++) {
            show_debug_message(reqs[i].player.player_name + " wants to join");
        }
    }
    e = gmda_pollEvent();
}

Use cases

• Show leaders the pending applications to review.
• Let a player track the status of requests they sent.