Godot 4 · GDScript · Players

get_invitability

Reads whether other players are currently allowed to send this player friend invites.

Signature

get_invitability() -> void

What it does

Reads THIS player's own is_invitable flag. The read verb is POST here (POST /players/invitability, session-auth). On no active session it pushes a warning and emits invitability_loaded(false) immediately.

Parameters

This function takes no parameters.

How to call it

Connect invitability_loaded first, then call get_invitability().

Example

Gamdato.invitability_loaded.connect(_on_invitability)
Gamdato.get_invitability()

func _on_invitability(is_invitable: bool) -> void:
    invite_toggle.button_pressed = is_invitable

Use cases

• Initialize a privacy toggle showing whether the player accepts friend invites.
• Check the current invitability state before opening a settings menu.