Skip to content

Removed UserStats RequestCurrentStats() #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Removed UserStats RequestCurrentStats() #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a0dd81
Removed UserStats RequestCurrentStats() API call - no longer exists i…
OmarTapps Nov 10, 2025
6c0c8c0
Removed RequestCurrentStats() from the docs
OmarTapps Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 2 additions & 41 deletions docs/user_stats.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ List of Functions
* :func:`userStats.setAchievement`
* :func:`userStats.resetAllStats`
* :func:`userStats.storeStats`
* :func:`userStats.requestCurrentStats`
* :func:`userStats.findLeaderboard`
* :func:`userStats.findOrCreateLeaderboard`
* :func:`userStats.getLeaderboardEntryCount`
Expand All @@ -37,8 +36,6 @@ Function Reference
:returns: (`boolean`)
This function returns true upon success if all of the following conditions are met; otherwise, false.

* :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: (`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>`_
Expand Down Expand Up @@ -75,14 +72,10 @@ Function Reference
This function returns true upon success if all of the following conditions are met; otherwise, false.

* The specified stat 'API Name' exists in App Admin on the Steamworks website, and the changes are published.

* :func:`userStats.requestCurrentStats` has completed and successfully returned its callback.
:SteamWorks: `SetStat <https://partner.steamgames.com/doc/api/ISteamUserStats#SetStat>`_

Sets the value of a stat for the current user.

You must have called :func:`userStats.requestCurrentStats` and it needs to return successfully via its callback prior to calling this!

This call only modifies Steam's in-memory state so it is quite cheap. To submit the stats to the server you must call :func:`userStats.storeStats`.

**Example**::
Expand All @@ -106,8 +99,6 @@ Function Reference
:returns: (`boolean`)
This function returns true upon success if all of the following conditions are met; otherwise, false.

* :func:`userStats.requestCurrentStats` has completed and successfully returned its callback.

* The 'API Name' of the specified achievement 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 unlock status of the achievement.
:SteamWorks: `GetAchievement <https://partner.steamgames.com/doc/api/ISteamUserStats#GetAchievement>`_
Expand All @@ -130,14 +121,10 @@ Function Reference
This function returns true upon success if all of the following conditions are met; otherwise, false.

* The specified achievement 'API Name' exists in App Admin on the Steamworks website, and the changes are published.

* :func:`userStats.requestCurrentStats` has completed and successfully returned its callback.
:SteamWorks: `SetAchievement <https://partner.steamgames.com/doc/api/ISteamUserStats#SetAchievement>`_

Unlocks an achievement.

You must have called :func:`userStats.requestCurrentStats` and it needs to return successfully via its callback prior to calling this!

You can unlock an achievement multiple times so you don't need to worry about only setting achievements that aren't already set. This call only modifies Steam's in-memory state so it is quite cheap. To send the unlock status to the server and to trigger the Steam overlay notification you must call :func:`userStats.storeStats`.

**Example**::
Expand All @@ -150,12 +137,12 @@ Function Reference
.. function:: userStats.resetAllStats(achievementsToo)

:param boolean achievementsToo: Also reset the user's achievements?
:returns: (`boolean`) true indicating success if :func:`userStats.requestCurrentStats` has already been called and successfully returned its callback; otherwise false.
:returns: (`boolean`) true indicating success; otherwise false.
:SteamWorks: `ResetAllStats <https://partner.steamgames.com/doc/api/ISteamUserStats#ResetAllStats>`_

Resets the current users stats and, optionally achievements.

This automatically calls :func:`userStats.storeStats` to persist the changes to the server. This should typically only be used for testing purposes during development. Ensure that you sync up your stats with the new default values provided by Steam after calling this by calling :func:`userStats.requestCurrentStats`.
This automatically calls :func:`userStats.storeStats` to persist the changes to the server. This should typically only be used for testing purposes during development.

**Example**::

Expand All @@ -168,8 +155,6 @@ Function Reference
:returns: (`boolen`)
This function returns true upon success if all of the following conditions are met; otherwise, false.

* :func:`userStats.requestCurrentStats` has completed and successfully returned its callback.

* The current game has stats associated with it in the Steamworks Partner backend, and those stats are published.
:SteamWorks: `StoreStats <https://partner.steamgames.com/doc/api/ISteamUserStats#StoreStats>`_

Expand All @@ -194,30 +179,6 @@ Function Reference
Steam.userStats.storeStats()
end

.. function:: userStats.requestCurrentStats()

:returns: (`boolean`)
Only returns false if there is no user logged in; otherwise, true.
:SteamWorks: `RequestCurrentStats <https://partner.steamgames.com/doc/api/ISteamUserStats#RequestCurrentStats>`_

Asynchronously request the user's current stats and achievements from the server.

You must **always call this first** to get the initial status of stats and achievements.
Only after the resulting callback comes back can you start calling the rest of the stats and achievement functions for the current user.

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

Triggers a :func:`userStats.onUserStatsReceived` callback.

**Example**::

-- before any achievement/stats stuff
Steam.userStats.requestCurrentStats()

function Steam.userStats.onUserStatsReceived()
can_do_stats_stuff = true
end


.. function:: userStats.findLeaderboard(name, callback)

Expand Down
8 changes: 0 additions & 8 deletions src/user_stats.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,13 +275,6 @@ EXTERN int luasteam_storeStats(lua_State *L) {
return 1;
}

// bool RequestCurrentStats();
EXTERN int luasteam_requestCurrentStats(lua_State *L) {
bool success = SteamUserStats()->RequestCurrentStats();
lua_pushboolean(L, success);
return 1;
}

EXTERN int luasteam_findLeaderboard(lua_State *L) {
const char *name = luaL_checkstring(L, 1);
luaL_checktype(L, 2, LUA_TFUNCTION);
Expand Down Expand Up @@ -399,7 +392,6 @@ void add_user_stats(lua_State *L) {
add_func(L, "setAchievement", luasteam_setAchievement);
add_func(L, "resetAllStats", luasteam_resetAllStats);
add_func(L, "storeStats", luasteam_storeStats);
add_func(L, "requestCurrentStats", luasteam_requestCurrentStats);
add_func(L, "findLeaderboard", luasteam_findLeaderboard);
add_func(L, "findOrCreateLeaderboard", luasteam_findOrCreateLeaderboard);
add_func(L, "getLeaderboardEntryCount", luasteam_getLeaderboardEntryCount);
Expand Down