GameMaker Studio · GML · Groups & clans

gmda_createGroupRequest

Requests to join a request-only group.

Asynchronous (result via event)

Signature

gmda_createGroupRequest(group_id, [message]) -> real

What it does

POSTs /groups/requests/create, then queues group_request_created { success, response }. e.response is the raw server body: on success the request { id, group_id, status, message, created_at } is at e.response.request. On failure e.error carries the raw server message, e.g. "This group does not accept join requests", "Request already pending", "You are already in a group", "Group is full", or "Group not found".

Parameters

Name	Type	Default	Description
group_id	string	required	Id of the group to request to join (must have join_policy "request").
message	string	""	Optional note to reviewers (sanitized to max 200 chars).

How to call it

Call it, then read group_request_created from gmda_pollEvent(). Use this for request groups; for open groups call gmda_joinGroup() instead. A reviewer then responds with gmda_respondGroupRequest().

Result event: group_request_created { success, response }

Example

gmda_createGroupRequest(group_id, "Please let me in");

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_request_created") {
        if (e.success) show_debug_message("Request sent");
        else show_debug_message("Failed: " + e.error);
    }
    e = gmda_pollEvent();
}

Use cases

Let a player apply to a clan that approves new members.
Send a join request with a short introduction message.

Referencia de funciones