Skip to content

Commit

Permalink
[get-stats] Fix return type, change wording a bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
yancouto committed Apr 2, 2021
1 parent bc32c02 commit cbdffe5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user_stats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ Function Reference
* :func:`userStats.requestCurrentStats` has completed and successfully returned its callback.

* The 'API Name' of the specified stat exists in App Admin on the Steamworks website, and the changes are published.
:returns: (`boolean?`) If the call is successful, returns a second value, the current value of the stat.
:returns: (`number?`) If the call is successful, returns a second value, the current value of the stat.
:SteamWorks: `GetStat <https://partner.steamgames.com/doc/api/ISteamUserStats#GetStat>`_

Gets the current value of a users stat as a integer. For floats see :func:`userStats.getStatFloat`
Gets the current value of a users stat, it must have been set as an int. For floats see :func:`userStats.getStatFloat`

The equivalent function for other users is :func:`userStats.getUserStatInt` **(missing)**.

Expand All @@ -56,7 +56,7 @@ Function Reference

.. function:: userStats.getStatFloat(name)

See :func:`userStats.getStatInt` which is the same but this function is used to read stats as a float.
Same as :func:`userStats.getStatInt`, but this function reads stats that are set as floats.

The equivalent function for other users is :func:`userStats.getUserStatFloat` **(missing)**.

Expand Down Expand Up @@ -92,7 +92,7 @@ Function Reference

.. function:: userStats.setStatFloat(stat_name, stat_value)

See :func:`userStats.setStatInt` which is the same but this function is used to set stats as a float.
Same as :func:`userStats.setStatInt`, but this function sets stats as floats.

**Example**::

Expand Down

0 comments on commit cbdffe5

Please sign in to comment.