GameMaker Studio · GML · Groups & clans

gmda_disbandGroup

Disbands the caller's group entirely (leader only).

Signature

gmda_disbandGroup() -> real

What it does

POSTs /groups/disband, then queues group_disbanded { success, response }. Permanently dissolves the group and removes all members. On failure e.error carries the raw server message, e.g. "Insufficient rank" (not the leader) or "Forbidden".

Parameters

This function takes no parameters.

How to call it

Call it, then read group_disbanded from gmda_pollEvent(). Only the group leader may do this; for everyone else use gmda_leaveGroup().

Example

gmda_disbandGroup();             // leader only

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_disbanded") {
        if (e.success) show_debug_message("Group disbanded");
        else show_debug_message("Failed: " + e.error);
    }
    e = gmda_pollEvent();
}

Use cases

• Let a leader permanently delete the clan.
• Clean up an empty or abandoned group.