: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/GKGameActivityDefinition.xml. .. _class_GKGameActivityDefinition: GKGameActivityDefinition ======================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Describes a Game Activity template. .. rst-class:: classref-introduction-group Description ----------- Wraps ``GKGameActivityDefinition``, including metadata, defaults, and associated leaderboard/achievement loaders. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Dictionary`\[:ref:`String`, :ref:`String`\] | :ref:`default_properties` | ``{}`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`details` | ``""`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`fallback_url` | ``""`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`group_identifier` | ``""`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`identifier` | ``""`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Variant` | :ref:`max_players` | | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Variant` | :ref:`min_players` | | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`play_style` | ``0`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`release_state` | ``0`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`supports_party_code` | ``false`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`supports_unlimited_players` | ``false`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`title` | ``""`` | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_achievement_descriptions`\ (\ callback\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_game_activity_definitions`\ (\ callback\: :ref:`Callable`\ ) |static| | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_game_activity_definitions_with_ids`\ (\ ids\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) |static| | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_image`\ (\ callback\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`load_leaderboards`\ (\ callback\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GKGameActivityDefinition_property_default_properties: .. rst-class:: classref-property :ref:`Dictionary`\[:ref:`String`, :ref:`String`\] **default_properties** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Dictionary`\[:ref:`String`, :ref:`String`\] **get_default_properties**\ (\ ) Default key/value metadata assigned to created activities. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_details: .. rst-class:: classref-property :ref:`String` **details** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_details**\ (\ ) Detailed description. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_fallback_url: .. rst-class:: classref-property :ref:`String` **fallback_url** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_fallback_url**\ (\ ) Fallback URL when direct activity launch is unavailable. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_group_identifier: .. rst-class:: classref-property :ref:`String` **group_identifier** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_group_identifier**\ (\ ) Group identifier for related activity definitions. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_identifier: .. rst-class:: classref-property :ref:`String` **identifier** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_identifier**\ (\ ) Unique definition identifier. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_max_players: .. rst-class:: classref-property :ref:`Variant` **max_players** :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Variant` **get_max_players**\ (\ ) Maximum supported player count, or ``null`` if unspecified. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_min_players: .. rst-class:: classref-property :ref:`Variant` **min_players** :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Variant` **get_min_players**\ (\ ) Minimum supported player count, or ``null`` if unspecified. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_play_style: .. rst-class:: classref-property :ref:`int` **play_style** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_play_style**\ (\ ) Apple play-style raw value. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_release_state: .. rst-class:: classref-property :ref:`int` **release_state** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_release_state**\ (\ ) Apple release-state raw value. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_supports_party_code: .. rst-class:: classref-property :ref:`bool` **supports_party_code** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`bool` **get_supports_party_code**\ (\ ) Whether party-code joining is supported. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_supports_unlimited_players: .. rst-class:: classref-property :ref:`bool` **supports_unlimited_players** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`bool` **get_supports_unlimited_players**\ (\ ) Whether unlimited player counts are supported. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_property_title: .. rst-class:: classref-property :ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_title**\ (\ ) Display title. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GKGameActivityDefinition_method_load_achievement_descriptions: .. rst-class:: classref-method |void| **load_achievement_descriptions**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Loads achievement descriptions associated with this definition. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_method_load_game_activity_definitions: .. rst-class:: classref-method |void| **load_game_activity_definitions**\ (\ callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Loads available game activity definitions. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_method_load_game_activity_definitions_with_ids: .. rst-class:: classref-method |void| **load_game_activity_definitions_with_ids**\ (\ ids\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) |static| :ref:`🔗` Loads game activity definitions matching ``ids``. Pass them as ``PackedStringArray(["activity_id_1", "activity_id_2"])``. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_method_load_image: .. rst-class:: classref-method |void| **load_image**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Loads this definition's image. .. rst-class:: classref-item-separator ---- .. _class_GKGameActivityDefinition_method_load_leaderboards: .. rst-class:: classref-method |void| **load_leaderboards**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` Loads leaderboards associated with this definition. .. |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.)`