GameMaker Studio · GML · Groups & clans

gmda_getGroupInfo

Loads a group's details and its member list.

Asynchronous (result via event)

Signature

gmda_getGroupInfo([group_id=""]) -> real

What it does

POSTs /groups/info, then queues group_info_loaded { success, response }. response holds the group plus its members: { group, members }, where members is a list of { player_key, player_name, role, joined_at }. The group is empty when the caller has no group or it is not found.

Parameters

Name	Type	Default	Description
group_id	string	""	Group to inspect. Omit (or pass "") to fetch the caller's own group.

How to call it

Call it, then read group_info_loaded from gmda_pollEvent(). Pass no argument for your own group. Check e.success (and that the group is present) before reading fields.

Result event: group_info_loaded { success, response }

Example

gmda_getGroupInfo();            // your own group

var e = gmda_pollEvent();
while (!is_undefined(e)) {
    if (e.event == "group_info_loaded" && e.success) {
        var members = e.response.members;
        for (var i = 0; i < array_length(members); i++) {
            var m = members[i];
            show_debug_message(m.player_name + " - " + m.role);
        }
    }
    e = gmda_pollEvent();
}

Use cases

Render a clan's roster with each member's role.
Show a group's profile before the player decides to join.