: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/GKMatchmaker.xml.

.. _class_GKMatchmaker:

GKMatchmaker
============

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

.. container:: contribute

	There is currently no description for this class. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`add_players<class_GKMatchmaker_method_add_players>`\ (\ match\: :ref:`GKMatch<class_GKMatch>`, request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ ) |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`cancel<class_GKMatchmaker_method_cancel>`\ (\ )                                                                                                                                                     |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`cancel_pending_invite<class_GKMatchmaker_method_cancel_pending_invite>`\ (\ player\: :ref:`GKPlayer<class_GKPlayer>`\ )                                                                             |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`find_match<class_GKMatchmaker_method_find_match>`\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ )                                          |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`find_matched_players<class_GKMatchmaker_method_find_matched_players>`\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ )                      |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`find_players<class_GKMatchmaker_method_find_players>`\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ )                                      |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`finish_matchmaking<class_GKMatchmaker_method_finish_matchmaking>`\ (\ match\: :ref:`GKMatch<class_GKMatch>`\ )                                                                                      |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`match_for_invite<class_GKMatchmaker_method_match_for_invite>`\ (\ invite\: :ref:`GKInvite<class_GKInvite>`, callback\: :ref:`Callable<class_Callable>`\ )                                           |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`query_activity<class_GKMatchmaker_method_query_activity>`\ (\ callback\: :ref:`Callable<class_Callable>`\ )                                                                                         |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`query_player_group_activity<class_GKMatchmaker_method_query_player_group_activity>`\ (\ groupID\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )                              |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`query_queue_activity<class_GKMatchmaker_method_query_queue_activity>`\ (\ queueName\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ )                                    |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`start_browsing_for_nearby_players<class_GKMatchmaker_method_start_browsing_for_nearby_players>`\ (\ )                                                                                               |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`start_group_activity<class_GKMatchmaker_method_start_group_activity>`\ (\ )                                                                                                                         |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`stop_browsing_for_nearby_players<class_GKMatchmaker_method_stop_browsing_for_nearby_players>`\ (\ )                                                                                                 |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`stop_group_activity<class_GKMatchmaker_method_stop_group_activity>`\ (\ )                                                                                                                           |
   +--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_GKMatchmaker_signal_nearby_player_reachable:

.. rst-class:: classref-signal

**nearby_player_reachable**\ (\ player\: :ref:`GKPlayer<class_GKPlayer>`, is_reachable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_GKMatchmaker_signal_nearby_player_reachable>`

.. container:: contribute

	There is currently no description for this signal. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_signal_player_joining_group_activity:

.. rst-class:: classref-signal

**player_joining_group_activity**\ (\ player\: :ref:`GKPlayer<class_GKPlayer>`\ ) :ref:`🔗<class_GKMatchmaker_signal_player_joining_group_activity>`

.. container:: contribute

	There is currently no description for this signal. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_GKMatchmaker_method_add_players:

.. rst-class:: classref-method

|void| **add_players**\ (\ match\: :ref:`GKMatch<class_GKMatch>`, request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_add_players>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_cancel:

.. rst-class:: classref-method

|void| **cancel**\ (\ ) :ref:`🔗<class_GKMatchmaker_method_cancel>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_cancel_pending_invite:

.. rst-class:: classref-method

|void| **cancel_pending_invite**\ (\ player\: :ref:`GKPlayer<class_GKPlayer>`\ ) :ref:`🔗<class_GKMatchmaker_method_cancel_pending_invite>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_find_match:

.. rst-class:: classref-method

|void| **find_match**\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_find_match>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_find_matched_players:

.. rst-class:: classref-method

|void| **find_matched_players**\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_find_matched_players>`

Searches for matched players and returns additional match properties provided by GameKit.

The callback receives ``(GKMatchedPlayers matched_players, Variant error)``. On failure, ``matched_players`` is ``null`` and ``error`` contains a ``GKError``.

Requires iOS 17.2, macOS 14.2, tvOS 17.2, or visionOS 1.1. Older versions return an ``apiNotAvailable`` error.

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_find_players:

.. rst-class:: classref-method

|void| **find_players**\ (\ request\: :ref:`GKMatchRequest<class_GKMatchRequest>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_find_players>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_finish_matchmaking:

.. rst-class:: classref-method

|void| **finish_matchmaking**\ (\ match\: :ref:`GKMatch<class_GKMatch>`\ ) :ref:`🔗<class_GKMatchmaker_method_finish_matchmaking>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_match_for_invite:

.. rst-class:: classref-method

|void| **match_for_invite**\ (\ invite\: :ref:`GKInvite<class_GKInvite>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_match_for_invite>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_query_activity:

.. rst-class:: classref-method

|void| **query_activity**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_query_activity>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_query_player_group_activity:

.. rst-class:: classref-method

|void| **query_player_group_activity**\ (\ groupID\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_query_player_group_activity>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_query_queue_activity:

.. rst-class:: classref-method

|void| **query_queue_activity**\ (\ queueName\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_GKMatchmaker_method_query_queue_activity>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_start_browsing_for_nearby_players:

.. rst-class:: classref-method

|void| **start_browsing_for_nearby_players**\ (\ ) :ref:`🔗<class_GKMatchmaker_method_start_browsing_for_nearby_players>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_start_group_activity:

.. rst-class:: classref-method

|void| **start_group_activity**\ (\ ) :ref:`🔗<class_GKMatchmaker_method_start_group_activity>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_stop_browsing_for_nearby_players:

.. rst-class:: classref-method

|void| **stop_browsing_for_nearby_players**\ (\ ) :ref:`🔗<class_GKMatchmaker_method_stop_browsing_for_nearby_players>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_GKMatchmaker_method_stop_group_activity:

.. rst-class:: classref-method

|void| **stop_group_activity**\ (\ ) :ref:`🔗<class_GKMatchmaker_method_stop_group_activity>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. |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.)`