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

.. _class_GKLeaderboardEntry:

GKLeaderboardEntry
==================

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

Single score information on the leaderboard.

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

Properties
----------

.. table::
   :widths: auto

   +---------------------------------+---------------------------------------------------------------------------+----------+
   | :ref:`int<class_int>`           | :ref:`context<class_GKLeaderboardEntry_property_context>`                 | ``0``    |
   +---------------------------------+---------------------------------------------------------------------------+----------+
   | :ref:`String<class_String>`     | :ref:`formatted_score<class_GKLeaderboardEntry_property_formatted_score>` | ``""``   |
   +---------------------------------+---------------------------------------------------------------------------+----------+
   | :ref:`GKPlayer<class_GKPlayer>` | :ref:`player<class_GKLeaderboardEntry_property_player>`                   | ``null`` |
   +---------------------------------+---------------------------------------------------------------------------+----------+
   | :ref:`int<class_int>`           | :ref:`rank<class_GKLeaderboardEntry_property_rank>`                       | ``0``    |
   +---------------------------------+---------------------------------------------------------------------------+----------+
   | :ref:`int<class_int>`           | :ref:`score<class_GKLeaderboardEntry_property_score>`                     | ``0``    |
   +---------------------------------+---------------------------------------------------------------------------+----------+

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

----

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

Property Descriptions
---------------------

.. _class_GKLeaderboardEntry_property_context:

.. rst-class:: classref-property

:ref:`int<class_int>` **context** = ``0`` :ref:`🔗<class_GKLeaderboardEntry_property_context>`

.. rst-class:: classref-property-setget

- :ref:`int<class_int>` **get_context**\ (\ )

An integer value that your game uses.

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

----

.. _class_GKLeaderboardEntry_property_formatted_score:

.. rst-class:: classref-property

:ref:`String<class_String>` **formatted_score** = ``""`` :ref:`🔗<class_GKLeaderboardEntry_property_formatted_score>`

.. rst-class:: classref-property-setget

- :ref:`String<class_String>` **get_formatted_score**\ (\ )

The player’s score as a localized string.

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

----

.. _class_GKLeaderboardEntry_property_player:

.. rst-class:: classref-property

:ref:`GKPlayer<class_GKPlayer>` **player** = ``null`` :ref:`🔗<class_GKLeaderboardEntry_property_player>`

.. rst-class:: classref-property-setget

- :ref:`GKPlayer<class_GKPlayer>` **get_player**\ (\ )

The player who earns the score.

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

----

.. _class_GKLeaderboardEntry_property_rank:

.. rst-class:: classref-property

:ref:`int<class_int>` **rank** = ``0`` :ref:`🔗<class_GKLeaderboardEntry_property_rank>`

.. rst-class:: classref-property-setget

- :ref:`int<class_int>` **get_rank**\ (\ )

The position of the score in the results of a leaderboard search.

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

----

.. _class_GKLeaderboardEntry_property_score:

.. rst-class:: classref-property

:ref:`int<class_int>` **score** = ``0`` :ref:`🔗<class_GKLeaderboardEntry_property_score>`

.. rst-class:: classref-property-setget

- :ref:`int<class_int>` **get_score**\ (\ )

The score that the player earns.

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