:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/GKTurnBasedMatch.xml. .. _class_GKTurnBasedMatch: GKTurnBasedMatch ================ **Inherits:** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`active_exchanges` | ``[]`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`completed_exchanges` | ``[]`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`creation_date` | ``0.0`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`GKTurnBasedParticipant` | :ref:`current_participant` | ``null`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`exchange_data_maximum_size` | ``0`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`exchange_max_initiated_exchanges_per_player` | ``0`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`exchanges` | ``[]`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`is_active_player` | ``false`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`match_data` | ``PackedByteArray()`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`match_data_maximum_size` | ``0`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`match_id` | ``""`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`message` | ``""`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`participants` | ``[]`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`status` | ``0`` | +-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`accept_invite`\ (\ callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decline_invite`\ (\ callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`end_match_in_turn`\ (\ data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`end_turn`\ (\ nextParticipants\: :ref:`Array`, timeout\: :ref:`float`, data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`exchange_timeout_default`\ (\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`exchange_timeout_none`\ (\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`find`\ (\ request\: :ref:`GKMatchRequest`, callback\: :ref:`Callable`\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load`\ (\ matchID\: :ref:`String`, callback\: :ref:`Callable`\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_match_data`\ (\ callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_matches`\ (\ callback\: :ref:`Callable`\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`participant_quit_in_turn`\ (\ outcome\: :ref:`int`, nextParticipants\: :ref:`Array`, timeout\: :ref:`float`, data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`participant_quit_out_of_turn`\ (\ outcome\: :ref:`int`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rematch`\ (\ callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove`\ (\ callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`save_current_turn`\ (\ data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`save_merged_match`\ (\ data\: :ref:`PackedByteArray`, resolvedExchanges\: :ref:`Array`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`send_exchange`\ (\ participants\: :ref:`Array`, data\: :ref:`PackedByteArray`, localizableMessageKey\: :ref:`String`, arguments\: :ref:`PackedStringArray`, timeout\: :ref:`float`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`send_reminder`\ (\ participants\: :ref:`Array`, localizableMessageKey\: :ref:`String`, arguments\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_localizable_message_with_key`\ (\ key\: :ref:`String`, arguments\: :ref:`PackedStringArray`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`turn_timeout_default`\ (\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`turn_timeout_none`\ (\ ) |static| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GKTurnBasedMatch_property_active_exchanges: .. rst-class:: classref-property :ref:`Array` **active_exchanges** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_active_exchanges**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_completed_exchanges: .. rst-class:: classref-property :ref:`Array` **completed_exchanges** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_completed_exchanges**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_creation_date: .. rst-class:: classref-property :ref:`float` **creation_date** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_creation_date**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_current_participant: .. rst-class:: classref-property :ref:`GKTurnBasedParticipant` **current_participant** = ``null`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`GKTurnBasedParticipant` **get_current_participant**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_exchange_data_maximum_size: .. rst-class:: classref-property :ref:`int` **exchange_data_maximum_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_exchange_data_maximum_size**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_exchange_max_initiated_exchanges_per_player: .. rst-class:: classref-property :ref:`int` **exchange_max_initiated_exchanges_per_player** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_exchange_max_initiated_exchanges_per_player**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_exchanges: .. rst-class:: classref-property :ref:`Array` **exchanges** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_exchanges**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_is_active_player: .. rst-class:: classref-property :ref:`bool` **is_active_player** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`bool` **get_is_active_player**\ (\ ) True when the local player is the current participant whose turn is active. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_match_data: .. rst-class:: classref-property :ref:`PackedByteArray` **match_data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`PackedByteArray` **get_match_data**\ (\ ) .. container:: contribute 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 :ref:`PackedByteArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_match_data_maximum_size: .. rst-class:: classref-property :ref:`int` **match_data_maximum_size** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_match_data_maximum_size**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_match_id: .. rst-class:: classref-property :ref:`String` **match_id** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_match_id**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_message: .. rst-class:: classref-property :ref:`String` **message** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_message**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_participants: .. rst-class:: classref-property :ref:`Array` **participants** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_participants**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_property_status: .. rst-class:: classref-property :ref:`int` **status** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_status**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GKTurnBasedMatch_method_accept_invite: .. rst-class:: classref-method |void| **accept_invite**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_decline_invite: .. rst-class:: classref-method |void| **decline_invite**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_end_match_in_turn: .. rst-class:: classref-method |void| **end_match_in_turn**\ (\ data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_end_turn: .. rst-class:: classref-method |void| **end_turn**\ (\ nextParticipants\: :ref:`Array`, timeout\: :ref:`float`, data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_exchange_timeout_default: .. rst-class:: classref-method :ref:`float` **exchange_timeout_default**\ (\ ) |static| :ref:`🔗` Returns Apple's default timeout constant for turn-based exchanges. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_exchange_timeout_none: .. rst-class:: classref-method :ref:`float` **exchange_timeout_none**\ (\ ) |static| :ref:`🔗` Returns Apple's constant meaning "no timeout" for turn-based exchanges. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_find: .. rst-class:: classref-method |void| **find**\ (\ request\: :ref:`GKMatchRequest`, callback\: :ref:`Callable`\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_load: .. rst-class:: classref-method |void| **load**\ (\ matchID\: :ref:`String`, callback\: :ref:`Callable`\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_load_match_data: .. rst-class:: classref-method |void| **load_match_data**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_load_matches: .. rst-class:: classref-method |void| **load_matches**\ (\ callback\: :ref:`Callable`\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_participant_quit_in_turn: .. rst-class:: classref-method |void| **participant_quit_in_turn**\ (\ outcome\: :ref:`int`, nextParticipants\: :ref:`Array`, timeout\: :ref:`float`, data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_participant_quit_out_of_turn: .. rst-class:: classref-method |void| **participant_quit_out_of_turn**\ (\ outcome\: :ref:`int`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_rematch: .. rst-class:: classref-method |void| **rematch**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` 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``. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_remove: .. rst-class:: classref-method |void| **remove**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_save_current_turn: .. rst-class:: classref-method |void| **save_current_turn**\ (\ data\: :ref:`PackedByteArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_save_merged_match: .. rst-class:: classref-method |void| **save_merged_match**\ (\ data\: :ref:`PackedByteArray`, resolvedExchanges\: :ref:`Array`, callback\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_send_exchange: .. rst-class:: classref-method |void| **send_exchange**\ (\ participants\: :ref:`Array`, data\: :ref:`PackedByteArray`, localizableMessageKey\: :ref:`String`, arguments\: :ref:`PackedStringArray`, timeout\: :ref:`float`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sends an exchange to the selected participants. Pass ``arguments`` as ``PackedStringArray(["arg1", "arg2"])``, or ``PackedStringArray()`` when the localized message does not need substitution values. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_send_reminder: .. rst-class:: classref-method |void| **send_reminder**\ (\ participants\: :ref:`Array`, localizableMessageKey\: :ref:`String`, arguments\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` Sends a reminder to the selected participants. Pass ``arguments`` as ``PackedStringArray(["arg1", "arg2"])``, or ``PackedStringArray()`` if the localized string has no substitutions. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_set_localizable_message_with_key: .. rst-class:: classref-method |void| **set_localizable_message_with_key**\ (\ key\: :ref:`String`, arguments\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the localized message for the match using ``key``. Pass ``arguments`` as ``PackedStringArray(["arg1", "arg2"])``, or ``PackedStringArray()`` if no substitutions are required. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_turn_timeout_default: .. rst-class:: classref-method :ref:`float` **turn_timeout_default**\ (\ ) |static| :ref:`🔗` Returns Apple's default timeout constant for player turns. .. rst-class:: classref-item-separator ---- .. _class_GKTurnBasedMatch_method_turn_timeout_none: .. rst-class:: classref-method :ref:`float` **turn_timeout_none**\ (\ ) |static| :ref:`🔗` Returns Apple's constant meaning "no timeout" for player turns. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`