GKTurnBasedMatchΒΆ
Inherits: RefCounted < Object
There is currently no description for this class. Please help us by contributing one!
PropertiesΒΆ
Array |
|
|
Array |
|
|
float |
|
|
|
||
int |
|
|
int |
|
|
Array |
|
|
bool |
|
|
PackedByteArray |
|
|
int |
|
|
String |
|
|
String |
|
|
Array |
|
|
int |
|
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.