: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/GKError.xml. .. _class_GKError: GKError ======= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Represents an error returned by Game Center operations. .. rst-class:: classref-introduction-group Description ----------- This class wraps ``GKError`` information, providing the error code, domain, and localized message. The :ref:`code` property corresponds to the :ref:`Code` constants. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+------------------------------------------------+--------+ | :ref:`int` | :ref:`code` | ``0`` | +-----------------------------+------------------------------------------------+--------+ | :ref:`String` | :ref:`domain` | ``""`` | +-----------------------------+------------------------------------------------+--------+ | :ref:`String` | :ref:`message` | ``""`` | +-----------------------------+------------------------------------------------+--------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_GKError_Code: .. rst-class:: classref-enumeration enum **Code**: :ref:`🔗` .. _class_GKError_constant_GAME_UNRECOGNIZED: .. rst-class:: classref-enumeration-constant :ref:`Code` **GAME_UNRECOGNIZED** = ``0`` The system can't complete the requested operation because Game Center doesn't recognize the app. .. _class_GKError_constant_NOT_SUPPORTED: .. rst-class:: classref-enumeration-constant :ref:`Code` **NOT_SUPPORTED** = ``1`` Game Center isn't available for this app, device, or account. .. _class_GKError_constant_APP_UNLISTED: .. rst-class:: classref-enumeration-constant :ref:`Code` **APP_UNLISTED** = ``2`` The system can't complete the requested operation because the game isn't available on the App Store. .. _class_GKError_constant_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`Code` **UNKNOWN** = ``3`` The system can't complete the requested operation due to an unknown error. .. _class_GKError_constant_CANCELLED: .. rst-class:: classref-enumeration-constant :ref:`Code` **CANCELLED** = ``4`` The operation was canceled by the user or by the system. .. _class_GKError_constant_COMMUNICATIONS_FAILURE: .. rst-class:: classref-enumeration-constant :ref:`Code` **COMMUNICATIONS_FAILURE** = ``5`` The system can't complete the requested operation due to an error communicating with the server. .. _class_GKError_constant_INVALID_PLAYER: .. rst-class:: classref-enumeration-constant :ref:`Code` **INVALID_PLAYER** = ``6`` The system can't complete the requested operation because the player is invalid. .. _class_GKError_constant_INVALID_PARAMETER: .. rst-class:: classref-enumeration-constant :ref:`Code` **INVALID_PARAMETER** = ``7`` The system can't complete the requested operation because one or more parameters are invalid. .. _class_GKError_constant_GAME_SESSION_REQUEST_INVALID: .. rst-class:: classref-enumeration-constant :ref:`Code` **GAME_SESSION_REQUEST_INVALID** = ``8`` The properties of the game session request are impossible to fulfill. .. _class_GKError_constant_API_NOT_AVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`Code` **API_NOT_AVAILABLE** = ``9`` The system can't complete the requested operation because the API isn't available. .. _class_GKError_constant_CONNECTION_TIMEOUT: .. rst-class:: classref-enumeration-constant :ref:`Code` **CONNECTION_TIMEOUT** = ``10`` The system can't complete the requested operation because the connection timed out. .. _class_GKError_constant_API_OBSOLETE: .. rst-class:: classref-enumeration-constant :ref:`Code` **API_OBSOLETE** = ``11`` The operation uses an obsolete Game Center API. .. _class_GKError_constant_USER_DENIED: .. rst-class:: classref-enumeration-constant :ref:`Code` **USER_DENIED** = ``12`` The system can't complete the requested operation because the user denied it. .. _class_GKError_constant_INVALID_CREDENTIALS: .. rst-class:: classref-enumeration-constant :ref:`Code` **INVALID_CREDENTIALS** = ``13`` The system can't complete the requested operation because the user name or password are incorrect. .. _class_GKError_constant_NOT_AUTHENTICATED: .. rst-class:: classref-enumeration-constant :ref:`Code` **NOT_AUTHENTICATED** = ``14`` The local player is not authenticated with Game Center. .. _class_GKError_constant_AUTHENTICATION_IN_PROGRESS: .. rst-class:: classref-enumeration-constant :ref:`Code` **AUTHENTICATION_IN_PROGRESS** = ``15`` The system can't complete the requested operation because the local player is already authenticating. .. _class_GKError_constant_PARENTAL_CONTROLS_BLOCKED: .. rst-class:: classref-enumeration-constant :ref:`Code` **PARENTAL_CONTROLS_BLOCKED** = ``16`` The system can't complete the requested operation because the user disabled this feature in Restrictions. .. _class_GKError_constant_PLAYER_STATUS_EXCEEDS_MAXIMUM_LENGTH: .. rst-class:: classref-enumeration-constant :ref:`Code` **PLAYER_STATUS_EXCEEDS_MAXIMUM_LENGTH** = ``17`` The player's status exceeds the maximum length. .. _class_GKError_constant_PLAYER_STATUS_INVALID: .. rst-class:: classref-enumeration-constant :ref:`Code` **PLAYER_STATUS_INVALID** = ``18`` The player's status is invalid. .. _class_GKError_constant_UNDERAGE: .. rst-class:: classref-enumeration-constant :ref:`Code` **UNDERAGE** = ``19`` The system can't complete the requested operation because this feature isn't available to underage players. .. _class_GKError_constant_PLAYER_PHOTO_FAILURE: .. rst-class:: classref-enumeration-constant :ref:`Code` **PLAYER_PHOTO_FAILURE** = ``20`` The system can't complete the requested operation to retrieve a player's photo. .. _class_GKError_constant_UBIQUITY_CONTAINER_UNAVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`Code` **UBIQUITY_CONTAINER_UNAVAILABLE** = ``21`` The system can't complete the requested operation because the user hasn't signed in to iCloud or hasn't enabled iCloud Drive. .. _class_GKError_constant_NOT_AUTHORIZED: .. rst-class:: classref-enumeration-constant :ref:`Code` **NOT_AUTHORIZED** = ``22`` The app or player is not authorized to perform this operation. .. _class_GKError_constant_ICLOUD_UNAVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`Code` **ICLOUD_UNAVAILABLE** = ``23`` The system can't complete the requested operation because it can't access the player's iCloud account. .. _class_GKError_constant_LOCKDOWN_MODE: .. rst-class:: classref-enumeration-constant :ref:`Code` **LOCKDOWN_MODE** = ``24`` The system can't complete the requested operation because the player enabled Lockdown Mode on the device. .. _class_GKError_constant_FRIEND_LIST_DESCRIPTION_MISSING: .. rst-class:: classref-enumeration-constant :ref:`Code` **FRIEND_LIST_DESCRIPTION_MISSING** = ``25`` Access to the friends list was denied because a required usage description is missing. .. _class_GKError_constant_FRIEND_LIST_RESTRICTED: .. rst-class:: classref-enumeration-constant :ref:`Code` **FRIEND_LIST_RESTRICTED** = ``26`` Access to the local player's friends list is restricted by system policy. .. _class_GKError_constant_FRIEND_LIST_DENIED: .. rst-class:: classref-enumeration-constant :ref:`Code` **FRIEND_LIST_DENIED** = ``27`` Access to the local player's friends list was denied by the user. .. _class_GKError_constant_FRIEND_REQUEST_NOT_AVAILABLE: .. rst-class:: classref-enumeration-constant :ref:`Code` **FRIEND_REQUEST_NOT_AVAILABLE** = ``28`` The player can't send a friend request at this time from this device. .. _class_GKError_constant_MATCH_REQUEST_INVALID: .. rst-class:: classref-enumeration-constant :ref:`Code` **MATCH_REQUEST_INVALID** = ``29`` The system can't complete the requested operation because the match request is invalid. .. _class_GKError_constant_UNEXPECTED_CONNECTION: .. rst-class:: classref-enumeration-constant :ref:`Code` **UNEXPECTED_CONNECTION** = ``30`` An unexpected player has connected to a match. .. _class_GKError_constant_INVITATIONS_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`Code` **INVITATIONS_DISABLED** = ``31`` The system can't complete the requested operation because the receiving player has disabled invitations. .. _class_GKError_constant_MATCH_NOT_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Code` **MATCH_NOT_CONNECTED** = ``32`` The system can't complete the requested operation because the match isn't connected to other players. .. _class_GKError_constant_RESTRICTED_TO_AUTOMATCH: .. rst-class:: classref-enumeration-constant :ref:`Code` **RESTRICTED_TO_AUTOMATCH** = ``33`` The system can't complete the requested operation because the player is using automatch. .. _class_GKError_constant_TURN_BASED_MATCH_DATA_TOO_LARGE: .. rst-class:: classref-enumeration-constant :ref:`Code` **TURN_BASED_MATCH_DATA_TOO_LARGE** = ``34`` The system can't complete the requested operation because the match data is too large. .. _class_GKError_constant_TURN_BASED_TOO_MANY_SESSIONS: .. rst-class:: classref-enumeration-constant :ref:`Code` **TURN_BASED_TOO_MANY_SESSIONS** = ``35`` The system can't complete the requested operation because it exceeds the maximum number of sessions. .. _class_GKError_constant_TURN_BASED_INVALID_PARTICIPANT: .. rst-class:: classref-enumeration-constant :ref:`Code` **TURN_BASED_INVALID_PARTICIPANT** = ``36`` The system can't complete the requested operation because the specified participant is invalid. .. _class_GKError_constant_TURN_BASED_INVALID_TURN: .. rst-class:: classref-enumeration-constant :ref:`Code` **TURN_BASED_INVALID_TURN** = ``37`` The system can't complete the requested operation because the participant doesn't have the required turn state. .. _class_GKError_constant_TURN_BASED_INVALID_STATE: .. rst-class:: classref-enumeration-constant :ref:`Code` **TURN_BASED_INVALID_STATE** = ``38`` The system can't complete the requested operation because the session is in an invalid state. .. _class_GKError_constant_SCORE_NOT_SET: .. rst-class:: classref-enumeration-constant :ref:`Code` **SCORE_NOT_SET** = ``39`` The system can't complete the requested operation because the system hasn't set the score. .. _class_GKError_constant_CHALLENGE_INVALID: .. rst-class:: classref-enumeration-constant :ref:`Code` **CHALLENGE_INVALID** = ``40`` The challenge request failed due to invalid challenge data. (Deprecated) .. _class_GKError_constant_DEBUG_MODE: .. rst-class:: classref-enumeration-constant :ref:`Code` **DEBUG_MODE** = ``41`` The operation failed because Game Center is running in debug mode. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GKError_property_code: .. rst-class:: classref-property :ref:`int` **code** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_code**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_code**\ (\ ) The mapped Game Center error code. See :ref:`Code` for possible values. .. rst-class:: classref-item-separator ---- .. _class_GKError_property_domain: .. rst-class:: classref-property :ref:`String` **domain** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_domain**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_domain**\ (\ ) The NSError domain for the failure, typically ``GKErrorDomain``. .. rst-class:: classref-item-separator ---- .. _class_GKError_property_message: .. rst-class:: classref-property :ref:`String` **message** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_message**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_message**\ (\ ) A localized, user-readable description of the failure. .. |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.)`