Godot Apple Plugins › Class

GKTurnBasedMatch

Inherits: RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

Properties

Array	active_exchanges	[]
Array	completed_exchanges	[]
float	creation_date	0.0
GKTurnBasedParticipant	current_participant	null
int	exchange_data_maximum_size	0
int	exchange_max_initiated_exchanges_per_player	0
Array	exchanges	[]
bool	is_active_player	false
PackedByteArray	match_data	PackedByteArray()
int	match_data_maximum_size	0
String	match_id	""
String	message	""
Array	participants	[]
int	status	0

Methods

void	accept_invite(callback: Callable)
void	decline_invite(callback: Callable)
void	end_match_in_turn(data: PackedByteArray, callback: Callable)
void	end_turn(nextParticipants: Array, timeout: float, data: PackedByteArray, callback: Callable)
float	exchange_timeout_default() static
float	exchange_timeout_none() static
void	find(request: GKMatchRequest, callback: Callable) static
void	load(matchID: String, callback: Callable) static
void	load_match_data(callback: Callable)
void	load_matches(callback: Callable) static
void	participant_quit_in_turn(outcome: int, nextParticipants: Array, timeout: float, data: PackedByteArray, callback: Callable)
void	participant_quit_out_of_turn(outcome: int, callback: Callable)
void	rematch(callback: Callable)
void	remove(callback: Callable)
void	save_current_turn(data: PackedByteArray, callback: Callable)
void	save_merged_match(data: PackedByteArray, resolvedExchanges: Array, callback: Callable)
void	send_exchange(participants: Array, data: PackedByteArray, localizableMessageKey: String, arguments: PackedStringArray, timeout: float, callback: Callable)
void	send_reminder(participants: Array, localizableMessageKey: String, arguments: PackedStringArray, callback: Callable)
void	set_localizable_message_with_key(key: String, arguments: PackedStringArray)
float	turn_timeout_default() static
float	turn_timeout_none() static

---

Property Descriptions

Array active_exchanges = [] 🔗

• Array get_active_exchanges()

There is currently no description for this property. Please help us by contributing one!

---

Array completed_exchanges = [] 🔗

• Array get_completed_exchanges()

There is currently no description for this property. Please help us by contributing one!

---

float creation_date = 0.0 🔗

• float get_creation_date()

There is currently no description for this property. Please help us by contributing one!

---

GKTurnBasedParticipant current_participant = null 🔗

• GKTurnBasedParticipant get_current_participant()

There is currently no description for this property. Please help us by contributing one!

---

int exchange_data_maximum_size = 0 🔗

• int get_exchange_data_maximum_size()

There is currently no description for this property. Please help us by contributing one!

---

int exchange_max_initiated_exchanges_per_player = 0 🔗

• int get_exchange_max_initiated_exchanges_per_player()

There is currently no description for this property. Please help us by contributing one!

---

Array exchanges = [] 🔗

• Array get_exchanges()

There is currently no description for this property. Please help us by contributing one!

---

bool is_active_player = false 🔗

• bool get_is_active_player()

True when the local player is the current participant whose turn is active.

---

PackedByteArray match_data = PackedByteArray() 🔗

• PackedByteArray get_match_data()

There is currently no description for this property. Please help us by contributing one!

Note: The returned array is copied and any changes to it will not update the original property value. See PackedByteArray for more details.

---

int match_data_maximum_size = 0 🔗

• int get_match_data_maximum_size()

There is currently no description for this property. Please help us by contributing one!

---

String match_id = "" 🔗

• String get_match_id()

There is currently no description for this property. Please help us by contributing one!

---

String message = "" 🔗

• String get_message()

There is currently no description for this property. Please help us by contributing one!

---

Array participants = [] 🔗

• Array get_participants()

There is currently no description for this property. Please help us by contributing one!

---

int status = 0 🔗

• int get_status()

There is currently no description for this property. Please help us by contributing one!

---

Method Descriptions

void accept_invite(callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void decline_invite(callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void end_match_in_turn(data: PackedByteArray, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void end_turn(nextParticipants: Array, timeout: float, data: PackedByteArray, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

float exchange_timeout_default() static 🔗

Returns Apple’s default timeout constant for turn-based exchanges.

---

float exchange_timeout_none() static 🔗

Returns Apple’s constant meaning “no timeout” for turn-based exchanges.

---

void find(request: GKMatchRequest, callback: Callable) static 🔗

There is currently no description for this method. Please help us by contributing one!

---

void load(matchID: String, callback: Callable) static 🔗

There is currently no description for this method. Please help us by contributing one!

---

void load_match_data(callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void load_matches(callback: Callable) static 🔗

There is currently no description for this method. Please help us by contributing one!

---

void participant_quit_in_turn(outcome: int, nextParticipants: Array, timeout: float, data: PackedByteArray, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void participant_quit_out_of_turn(outcome: int, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void rematch(callback: Callable) 🔗

Creates a rematch from the current turn-based match.

The callback receives (GKTurnBasedMatch rematched_match, Variant error). On failure, rematched_match is null and error contains a GKError.

---

void remove(callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void save_current_turn(data: PackedByteArray, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void save_merged_match(data: PackedByteArray, resolvedExchanges: Array, callback: Callable) 🔗

There is currently no description for this method. Please help us by contributing one!

---

void send_exchange(participants: Array, data: PackedByteArray, localizableMessageKey: String, arguments: PackedStringArray, timeout: float, callback: Callable) 🔗

Sends an exchange to the selected participants. Pass arguments as PackedStringArray(["arg1", "arg2"]), or PackedStringArray() when the localized message does not need substitution values.

---

void send_reminder(participants: Array, localizableMessageKey: String, arguments: PackedStringArray, callback: Callable) 🔗

Sends a reminder to the selected participants. Pass arguments as PackedStringArray(["arg1", "arg2"]), or PackedStringArray() if the localized string has no substitutions.

---

void set_localizable_message_with_key(key: String, arguments: PackedStringArray) 🔗

Sets the localized message for the match using key. Pass arguments as PackedStringArray(["arg1", "arg2"]), or PackedStringArray() if no substitutions are required.

---

float turn_timeout_default() static 🔗

Returns Apple’s default timeout constant for player turns.

---

float turn_timeout_none() static 🔗

Returns Apple’s constant meaning “no timeout” for player turns.