: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/GKGameActivity.xml. .. _class_GKGameActivity: GKGameActivity ============== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Represents an active Game Activity session. .. rst-class:: classref-introduction-group Description ----------- Wraps ``GKGameActivity``, including lifecycle control, matching helpers, and score/achievement progress APIs. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`Array` | :ref:`achievements` | ``[]`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`GKGameActivityDefinition` | :ref:`activity_definition` | ``null`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`creation_date` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`duration` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`end_date` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`String` | :ref:`identifier` | ``""`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`last_resume_date` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`Array` | :ref:`leaderboard_scores` | ``[]`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`String` | :ref:`party_code` | ``""`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`String` | :ref:`party_url` | ``""`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`Dictionary` | :ref:`properties` | ``{}`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`start_date` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`state` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`check_pending_game_activity_existence`\ (\ callback\: :ref:`Callable`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GKGameActivity` | :ref:`create_with_definition`\ (\ definition\: :ref:`GKGameActivityDefinition`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`end`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`find_match`\ (\ callback\: :ref:`Callable`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`find_players_for_hosted_match`\ (\ callback\: :ref:`Callable`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_progress_on_achievement`\ (\ achievement\: :ref:`GKAchievement`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GKLeaderboardScore` | :ref:`get_score_on_leaderboard`\ (\ leaderboard\: :ref:`GKLeaderboard`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_party_code`\ (\ partyCode\: :ref:`String`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GKMatchRequest` | :ref:`make_match_request`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`pause`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_achievements`\ (\ achievements\: :ref:`Array`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_scores_from_leaderboards`\ (\ leaderboards\: :ref:`Array`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`resume`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_achievement_completed`\ (\ achievement\: :ref:`GKAchievement`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_progress_on_achievement`\ (\ achievement\: :ref:`GKAchievement`, percentComplete\: :ref:`float`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_score_on_leaderboard`\ (\ leaderboard\: :ref:`GKLeaderboard`, score\: :ref:`int`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_score_on_leaderboard_with_context`\ (\ leaderboard\: :ref:`GKLeaderboard`, score\: :ref:`int`, context\: :ref:`int`\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`start`\ (\ ) | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`start_with_definition`\ (\ definition\: :ref:`GKGameActivityDefinition`, callback\: :ref:`Callable`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`start_with_definition_and_party_code`\ (\ definition\: :ref:`GKGameActivityDefinition`, partyCode\: :ref:`String`, callback\: :ref:`Callable`\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`valid_party_code_alphabet`\ (\ ) |static| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GKGameActivity_property_achievements: .. rst-class:: classref-property :ref:`Array` **achievements** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_achievements**\ (\ ) Achievements associated with this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_activity_definition: .. rst-class:: classref-property :ref:`GKGameActivityDefinition` **activity_definition** = ``null`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`GKGameActivityDefinition` **get_activity_definition**\ (\ ) Definition used to create/configure this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_creation_date: .. rst-class:: classref-property :ref:`float` **creation_date** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_creation_date**\ (\ ) Activity creation timestamp (Unix seconds). .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_duration: .. rst-class:: classref-property :ref:`float` **duration** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_duration**\ (\ ) Current activity duration in seconds. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_end_date: .. rst-class:: classref-property :ref:`float` **end_date** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_end_date**\ (\ ) End timestamp (Unix seconds), or ``0`` while active. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_identifier: .. rst-class:: classref-property :ref:`String` **identifier** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_identifier**\ (\ ) Unique activity identifier. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_last_resume_date: .. rst-class:: classref-property :ref:`float` **last_resume_date** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_last_resume_date**\ (\ ) Last resume timestamp (Unix seconds). .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_leaderboard_scores: .. rst-class:: classref-property :ref:`Array` **leaderboard_scores** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_leaderboard_scores**\ (\ ) Leaderboard scores associated with this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_party_code: .. rst-class:: classref-property :ref:`String` **party_code** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_party_code**\ (\ ) Party code for joining this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_party_url: .. rst-class:: classref-property :ref:`String` **party_url** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_party_url**\ (\ ) Party URL for this activity, if available. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_properties: .. rst-class:: classref-property :ref:`Dictionary` **properties** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_properties**\ (\ value\: :ref:`Dictionary`\ ) - :ref:`Dictionary` **get_properties**\ (\ ) Custom properties attached to this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_start_date: .. rst-class:: classref-property :ref:`float` **start_date** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`float` **get_start_date**\ (\ ) Start timestamp (Unix seconds). .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_property_state: .. rst-class:: classref-property :ref:`int` **state** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_state**\ (\ ) Apple activity-state raw value. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GKGameActivity_method_check_pending_game_activity_existence: .. rst-class:: classref-method |void| **check_pending_game_activity_existence**\ (\ callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Checks whether a pending game activity exists. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_create_with_definition: .. rst-class:: classref-method :ref:`GKGameActivity` **create_with_definition**\ (\ definition\: :ref:`GKGameActivityDefinition`\ ) |static| :ref:`🔗` Creates an activity object from ``definition``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_end: .. rst-class:: classref-method |void| **end**\ (\ ) :ref:`🔗` Ends this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_find_match: .. rst-class:: classref-method |void| **find_match**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Finds a realtime :ref:`GKMatch` for this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_find_players_for_hosted_match: .. rst-class:: classref-method |void| **find_players_for_hosted_match**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Finds players for a hosted-match flow. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_get_progress_on_achievement: .. rst-class:: classref-method :ref:`float` **get_progress_on_achievement**\ (\ achievement\: :ref:`GKAchievement`\ ) :ref:`🔗` Returns progress percentage for ``achievement``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_get_score_on_leaderboard: .. rst-class:: classref-method :ref:`GKLeaderboardScore` **get_score_on_leaderboard**\ (\ leaderboard\: :ref:`GKLeaderboard`\ ) :ref:`🔗` Gets this activity's score entry for ``leaderboard``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_is_valid_party_code: .. rst-class:: classref-method :ref:`bool` **is_valid_party_code**\ (\ partyCode\: :ref:`String`\ ) |static| :ref:`🔗` Returns ``true`` if ``partyCode`` is valid. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_make_match_request: .. rst-class:: classref-method :ref:`GKMatchRequest` **make_match_request**\ (\ ) :ref:`🔗` Creates a :ref:`GKMatchRequest` based on this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_pause: .. rst-class:: classref-method |void| **pause**\ (\ ) :ref:`🔗` Pauses this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_remove_achievements: .. rst-class:: classref-method |void| **remove_achievements**\ (\ achievements\: :ref:`Array`\ ) :ref:`🔗` Removes the given achievements from this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_remove_scores_from_leaderboards: .. rst-class:: classref-method |void| **remove_scores_from_leaderboards**\ (\ leaderboards\: :ref:`Array`\ ) :ref:`🔗` Removes scores from the specified leaderboards. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_resume: .. rst-class:: classref-method |void| **resume**\ (\ ) :ref:`🔗` Resumes a paused activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_set_achievement_completed: .. rst-class:: classref-method |void| **set_achievement_completed**\ (\ achievement\: :ref:`GKAchievement`\ ) :ref:`🔗` Marks ``achievement`` as completed. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_set_progress_on_achievement: .. rst-class:: classref-method |void| **set_progress_on_achievement**\ (\ achievement\: :ref:`GKAchievement`, percentComplete\: :ref:`float`\ ) :ref:`🔗` Sets progress on ``achievement`` to ``percentComplete``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_set_score_on_leaderboard: .. rst-class:: classref-method |void| **set_score_on_leaderboard**\ (\ leaderboard\: :ref:`GKLeaderboard`, score\: :ref:`int`\ ) :ref:`🔗` Sets ``score`` on ``leaderboard``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_set_score_on_leaderboard_with_context: .. rst-class:: classref-method |void| **set_score_on_leaderboard_with_context**\ (\ leaderboard\: :ref:`GKLeaderboard`, score\: :ref:`int`, context\: :ref:`int`\ ) :ref:`🔗` Sets ``score`` and ``context`` on ``leaderboard``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_start: .. rst-class:: classref-method |void| **start**\ (\ ) :ref:`🔗` Starts this activity. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_start_with_definition: .. rst-class:: classref-method |void| **start_with_definition**\ (\ definition\: :ref:`GKGameActivityDefinition`, callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Starts an activity from ``definition``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_start_with_definition_and_party_code: .. rst-class:: classref-method |void| **start_with_definition_and_party_code**\ (\ definition\: :ref:`GKGameActivityDefinition`, partyCode\: :ref:`String`, callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Starts an activity from ``definition`` and ``partyCode``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivity_method_valid_party_code_alphabet: .. rst-class:: classref-method :ref:`PackedStringArray` **valid_party_code_alphabet**\ (\ ) |static| :ref:`🔗` Returns valid characters for Game Activity party codes. .. |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.)`