Godot 4 · GDScript · Friends

list_pending_invitations

Lists all pending friend invitations; incoming and outgoing; in one combined result.

Signature

list_pending_invitations() -> void

What it does

Fires two parallel queries (direction incoming + outgoing, status pending) against /friends/invitations/list and merges them into a single invitations_listed emit. Each entry: { id, direction: "incoming"|"outgoing", counterpart: { player_key, player_name }, status, message, created_at, expires_at }.

Parameters

This function takes no parameters.

How to call it

Connect invitations_listed first, then call list_pending_invitations(). Emits an empty array when there is no active session.

Example

Gamdato.invitations_listed.connect(_on_invites)
Gamdato.list_pending_invitations()

func _on_invites(invitations: Array) -> void:
    for inv in invitations:
        print("%s from %s" % [inv.direction, inv.counterpart.player_name])

Use cases

• Build an inbox screen showing who invited you and who you've invited.
• Show a badge count of pending friend requests.