Godot 4 · GDScript · Groups & clans

kick_group_member

Removes a member from the caller's group.

Asynchronous (result via signal)

Signature

kick_group_member(player_key: String) -> void

What it does

POSTs /groups/members/kick. Permission and rank are enforced server-side (you cannot kick someone of equal or higher rank). error_code may be insufficient_rank / target_not_member / forbidden / not_found.

Parameters

Name	Type	Default	Description
player_key	String	required	Key of the member to remove.

How to call it

Connect group_member_kicked first, then call kick_group_member(). Get player keys from get_group_info()'s members list.

Result signal: group_member_kicked(success: bool, player_key: String, error_code: String)

Example

Gamdato.group_member_kicked.connect(_on_kicked)
Gamdato.kick_group_member(player_key)

func _on_kicked(ok: bool, player_key: String, error_code: String) -> void:
    if ok: print("Removed %s" % player_key)
    else: print("Failed: %s" % error_code)

Use cases

Let officers remove a disruptive member.
Prune inactive players from the roster.