: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/GKAccessPoint.xml. .. _class_GKAccessPoint: GKAccessPoint ============= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Controls the Game Center access point overlay. .. rst-class:: classref-introduction-group Description ----------- The access point displays a control in a corner of your game that opens a Game Center dashboard when the player taps or clicks it. Use the :ref:`GameCenterManager.access_point` property to get the shared access point object, then configure its :ref:`location`, :ref:`active`, and other properties. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`active` | ``false`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Rect2` | :ref:`frame_in_screen_coordinates` | ``Rect2(0, 0, 0, 0)`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Rect2` | :ref:`frame_in_unit_coordinates` | ``Rect2(0, 0, 0, 0)`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`is_presenting_game_center` | ``false`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`location` | ``0`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`show_highlights` | ``false`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`visible` | ``false`` | +---------------------------+----------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger`\ (\ done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_for_challenges`\ (\ done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_for_friending`\ (\ done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_for_play_together`\ (\ done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_achievement`\ (\ achievementID\: :ref:`String`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_challenge_definition_id`\ (\ challengeDefinitionID\: :ref:`String`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_game_activity`\ (\ gameActivity\: :ref:`GKGameActivity`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_game_activity_definition_id`\ (\ gameActivityDefinitionID\: :ref:`String`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_leaderboard`\ (\ leaderboardID\: :ref:`String`, playerScope\: :ref:`int`, timeScope\: :ref:`int`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_leaderboard_set`\ (\ leaderboardSetID\: :ref:`String`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_player`\ (\ player\: :ref:`GKPlayer`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`trigger_with_state`\ (\ state\: :ref:`int`, done\: :ref:`Callable`\ ) | +--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_GKAccessPoint_Location: .. rst-class:: classref-enumeration enum **Location**: :ref:`🔗` .. _class_GKAccessPoint_constant_TOP_LEADING: .. rst-class:: classref-enumeration-constant :ref:`Location` **TOP_LEADING** = ``0`` Display the access point in the top-leading corner. .. _class_GKAccessPoint_constant_TOP_TRAILING: .. rst-class:: classref-enumeration-constant :ref:`Location` **TOP_TRAILING** = ``1`` Display the access point in the top-trailing corner. .. _class_GKAccessPoint_constant_BOTTOM_LEADING: .. rst-class:: classref-enumeration-constant :ref:`Location` **BOTTOM_LEADING** = ``2`` Display the access point in the bottom-leading corner. .. _class_GKAccessPoint_constant_BOTTOM_TRAILING: .. rst-class:: classref-enumeration-constant :ref:`Location` **BOTTOM_TRAILING** = ``3`` Display the access point in the bottom-trailing corner. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GKAccessPoint_property_active: .. rst-class:: classref-property :ref:`bool` **active** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_active**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_active**\ (\ ) A Boolean value that determines whether to display the access point. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_frame_in_screen_coordinates: .. rst-class:: classref-property :ref:`Rect2` **frame_in_screen_coordinates** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Rect2` **get_frame_in_screen_coordinates**\ (\ ) The frame of the access point in screen coordinates. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_frame_in_unit_coordinates: .. rst-class:: classref-property :ref:`Rect2` **frame_in_unit_coordinates** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Rect2` **get_frame_in_unit_coordinates**\ (\ ) Read-only frame of the access point normalized to the main screen size (0.0 to 1.0 in each axis). Returns ``Rect2(0, 0, 0, 0)`` when the screen size is unavailable or on visionOS. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_is_presenting_game_center: .. rst-class:: classref-property :ref:`bool` **is_presenting_game_center** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`bool` **get_is_presenting_game_center**\ (\ ) A Boolean value that indicates whether the game is presenting the Game Center dashboard. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_location: .. rst-class:: classref-property :ref:`int` **location** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_location**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_location**\ (\ ) The corner of the screen to display the access point. Use the :ref:`Location` constants. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_show_highlights: .. rst-class:: classref-property :ref:`bool` **show_highlights** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_show_highlights**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_show_highlights**\ (\ ) A Boolean value that indicates whether to display highlights for achievements and current ranks for leaderboards. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_property_visible: .. rst-class:: classref-property :ref:`bool` **visible** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`bool` **get_visible**\ (\ ) A Boolean value that indicates whether the access point is visible. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GKAccessPoint_method_trigger: .. rst-class:: classref-method |void| **trigger**\ (\ done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard as if the player taps or presses the access point. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_for_challenges: .. rst-class:: classref-method |void| **trigger_for_challenges**\ (\ done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in the Challenges context. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_for_friending: .. rst-class:: classref-method |void| **trigger_for_friending**\ (\ done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in the Friending context. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_for_play_together: .. rst-class:: classref-method |void| **trigger_for_play_together**\ (\ done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in the Play Together context. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_achievement: .. rst-class:: classref-method |void| **trigger_with_achievement**\ (\ achievementID\: :ref:`String`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in a state that shows a specific achievement. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Only available on macOS 15, iOS 18, tvOS 14, and visionOS 1; earlier versions perform no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_challenge_definition_id: .. rst-class:: classref-method |void| **trigger_with_challenge_definition_id**\ (\ challengeDefinitionID\: :ref:`String`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard focused on the challenge definition with identifier ``challengeDefinitionID``. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_game_activity: .. rst-class:: classref-method |void| **trigger_with_game_activity**\ (\ gameActivity\: :ref:`GKGameActivity`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard focused on ``gameActivity``. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_game_activity_definition_id: .. rst-class:: classref-method |void| **trigger_with_game_activity_definition_id**\ (\ gameActivityDefinitionID\: :ref:`String`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard focused on the game activity definition with identifier ``gameActivityDefinitionID``. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Available on iOS 26 and macOS 26. On older OS versions, tvOS, and visionOS, this method performs no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_leaderboard: .. rst-class:: classref-method |void| **trigger_with_leaderboard**\ (\ leaderboardID\: :ref:`String`, playerScope\: :ref:`int`, timeScope\: :ref:`int`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in a state that shows a specific leaderboard. Use :ref:`PlayerScope` for ``playerScope`` and :ref:`TimeScope` for ``timeScope``. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Only available on macOS 15, iOS 18, tvOS 14, and visionOS 1; earlier versions perform no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_leaderboard_set: .. rst-class:: classref-method |void| **trigger_with_leaderboard_set**\ (\ leaderboardSetID\: :ref:`String`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in a state that shows a specific leaderboard set. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Only available on macOS 15, iOS 18, tvOS 14, and visionOS 1; earlier versions perform no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_player: .. rst-class:: classref-method |void| **trigger_with_player**\ (\ player\: :ref:`GKPlayer`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in a state that shows a player profile. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. Only available on macOS 15, iOS 18, tvOS 14, and visionOS 1; earlier versions perform no action. .. rst-class:: classref-item-separator ---- .. _class_GKAccessPoint_method_trigger_with_state: .. rst-class:: classref-method |void| **trigger_with_state**\ (\ state\: :ref:`int`, done\: :ref:`Callable`\ ) :ref:`🔗` Displays the Game Center dashboard in the specified state. See :ref:`State` for values. \ ``done`` is called (with no arguments) when the dashboard presentation completes or is dismissed. .. |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.)`