Addon ID

  • steamworksstats_ext

Info

Statistics

  • Download count6 total downloads
  • Latest download count 6 downloads of latest version
  • Average download count1 downloads per day average

Owners

A list of all Actions, Conditions and Expressions supported in this addon.

Steamworks Stats

  • Conditions

    Is available

    True when the native companion can access ISteamUserStats. Scirra's official Steamworks plugin must be present and configured because it initializes Steam.

    On Steam overlay activated

    Triggered when Steam posts GameOverlayActivated_t with m_bActive set to 1. Use this to pause gameplay or change input handling while the Steam overlay is open.

Achievement progress

  • Actions

    Indicate achievement {0} progress {1} / {2}

    Ask Steam to display an achievement-progress notification. This does not change the linked stat and does not unlock the achievement.

    Get {1} progress limits for achievement {0}

    Read the configured min/max bounds of the stat linked to an achievement progress bar.

  • Conditions

    On indicate achievement {0} progress error

    Triggered when Steam reports error for the specified Indicate achievement progress call.

    On indicate achievement {0} progress success

    Triggered when Steam reports success for the specified Indicate achievement progress call.

    On any indicate achievement progress error

    Triggered when Steam reports error for any Indicate achievement progress call.

    On any indicate achievement progress success

    Triggered when Steam reports success for any Indicate achievement progress call.

    On achievement {0} progress reported

    Triggered after Steam processes a progress notification for the specified achievement. This does not mean progress was saved.

    On any achievement progress reported

    Triggered after Steam processes a progress notification for any achievement. This does not mean progress was saved.

    On get achievement {0} progress limits error

    Triggered when Get achievement progress limits for the specified achievement reports error.

    On get achievement {0} progress limits success

    Triggered when Get achievement progress limits for the specified achievement reports success.

    On any get achievement progress limits error

    Triggered when any Get achievement progress limits action reports error.

    On any get achievement progress limits success

    Triggered when any Get achievement progress limits action reports success.

  • Expressions

    AchievementProgress

    The current progress value associated with the latest achievement-progress trigger.

    AchievementProgressMax

    The maximum progress value associated with the latest achievement-progress trigger.

    AchievementProgressPercent

    The current progress percentage associated with the latest achievement-progress trigger.

    AchievementProgressLimitMin

    The minimum configured value returned by Get achievement progress limits.

    AchievementProgressLimitMax

    The maximum configured value returned by Get achievement progress limits.

Current user stats

  • Actions

    Get {1} stat {0}

    Read a current-user stat from Steam. The type must match your configuration in Steamworks.

    Set {2} stat {0} to {1} (store immediately: {3})

    Set an absolute current-user stat value in the local cache. Integer values must be whole numbers in signed 32-bit range.

    Add {1} to {2} stat {0} (store immediately: {3})

    Convenience action that reads the current value, adds the delta, and calls SetStat. This is not an atomic server-side increment.

    Update AVGRATE stat {0}: count {1} over session length {2} (store immediately: {3})

    Update an AVGRATE stat. Session length must use the same time unit as the stat Window configured in Steamworks.

    Store stats

    Submit local cache stat and achievement changes to Steam servers. Call frequency should be on the order of minutes, not seconds (rate-limited). Only call this during major state changes. This call is required to display the achievement unlock notification.

    Reset all stats (achievements too: {0})

    Reset the current user’s stats to their defaults and optionally clear achievements. Steam automatically stores the reset. Intended for development/testing.

  • Conditions

    On get stat {0} error

    Triggered after Get stat for the specified stat reports error.

    On get stat {0} success

    Triggered after Get stat for the specified stat reports success.

    On any get stat error

    Triggered after any Get stat action reports error.

    On any get stat success

    Triggered after any Get stat action reports success.

    On set/add stat {0} error

    Triggered after Set stat or Add stat for the specified stat reports error.

    On set/add stat {0} success

    Triggered after Set stat or Add stat for the specified stat reports success.

    On any set/add stat error

    Triggered after any Set stat or Add stat action reports error.

    On any set/add stat success

    Triggered after any Set stat or Add stat action reports success.

    On update AVGRATE stat {0} error

    Triggered after Update AVGRATE stat for the specified stat reports error.

    On update AVGRATE stat {0} success

    Triggered after Update AVGRATE stat for the specified stat reports success.

    On any update AVGRATE stat error

    Triggered after any Update AVGRATE stat action reports error.

    On any update AVGRATE stat success

    Triggered after any Update AVGRATE stat action reports success.

    On store stats request rejected

    Triggered when StoreStats returns false or the native request cannot be made. No server completion callback should be expected for this request.

    On store stats request accepted

    Triggered when StoreStats returns true. This means Steam accepted the request, not that server storage has completed.

    On Steam stats stored error

    Triggered by a failed UserStatsStored_t callback. StatsStoreResult contains the Steam EResult code. This callback cannot be reliably attributed to one StoreStats action.

    On Steam stats stored success

    Triggered by a successful UserStatsStored_t callback. This is a global callback and may originate from this companion, the official Steamworks plugin, or Steam storing pending changes on exit.

    On reset all stats rejected

    Triggered when ResetAllStats returns false or cannot be called.

    On reset all stats accepted

    Triggered when ResetAllStats returns true. Steam automatically calls StoreStats; completion is reported by the global Steam stats stored callback.

  • Expressions

    StatName

    The current-user stat API name associated with the current trigger.

    StatValue

    The current-user stat value associated with the current Get/Set/Add trigger.

    StatsStoreResult

    The numeric Steam EResult from the latest global UserStatsStored_t callback. This is not the immediate bool returned by StoreStats.

Other user stats

  • Actions

    Request stats for Steam user {0}

    Asynchronously download another user’s stats. The data is cached by Steam but is not refreshed automatically.

    Get Steam user {0} {2} stat {1}

    Read another user’s stat after a successful Request user stats action.

  • Conditions

    On request user stats for {0} error

    Triggered when Request user stats for the specified user completes with error.

    On request user stats for {0} success

    Triggered when Request user stats for the specified user completes with success.

    On any request user stats error

    Triggered when any Request user stats action completes with error.

    On any request user stats success

    Triggered when any Request user stats action completes with success.

    On get user {0} stat {1} error

    Triggered when Get user stat for the specified user and stat reports error.

    On get user {0} stat {1} success

    Triggered when Get user stat for the specified user and stat reports success.

    On any get user stat error

    Triggered when any Get user stat action reports error.

    On any get user stat success

    Triggered when any Get user stat action reports success.

    On user stats for {0} unloaded

    Triggered when Steam evicts another user’s cached stats. Request them again before calling Get user stat.

  • Expressions

    UserStatsSteamID64

    The exact Steam ID associated with the current other-user stats trigger.

    UserStatsResult

    The Steam EResult from the latest Request user stats completion.

    UserStatName

    The stat API name associated with the current Get user stat trigger.

    UserStatValue

    The value associated with the current Get user stat trigger.

Global stats

  • Actions

    Request global stats with {0} history days

    Asynchronously load lifetime totals for aggregated stats and up to 60 days of history. Call this successfully before reading global totals or history.

    Get global {1} stat {0}

    Read the lifetime total of a stat configured as Aggregated after Request global stats succeeds.

    Get global {1} stat {0} history

    Read the daily change history loaded by Request global stats. Index 0 is today, 1 is yesterday, and so on.

    Get current player count

    Asynchronously retrieve the number of players currently running the app, including online and offline mode.

  • Conditions

    On request global stats error

    Triggered if global stats cannot be requested or Steam returns an error.

    On request global stats success

    Triggered after Steam successfully loads aggregated global stat totals and the requested history window.

    On get global stat {0} error

    Triggered when Get global stat for the specified stat reports error.

    On get global stat {0} success

    Triggered when Get global stat for the specified stat reports success.

    On any get global stat error

    Triggered when any Get global stat action reports error.

    On any get global stat success

    Triggered when any Get global stat action reports success.

    On get global stat history {0} error

    Triggered when Get global stat history for the specified stat reports error.

    On get global stat history {0} success

    Triggered when Get global stat history for the specified stat reports success.

    On any get global stat history error

    Triggered when any Get global stat history action reports error.

    On any get global stat history success

    Triggered when any Get global stat history action reports success.

    On get current player count error

    Triggered when the current-player request fails.

    On get current player count success

    Triggered when Steam returns the current number of players for the app.

  • Expressions

    GlobalStatsResult

    The Steam EResult from the latest Request global stats completion.

    GlobalStatName

    The stat API name associated with the current global-stat trigger.

    GlobalStatValue

    The latest global stat total as a Construct number. Integer values above 2^53 may lose precision; use GlobalStatValueString for exact int64 data.

    GlobalStatValueString

    The latest global stat total as an exact decimal string for integer stats, or a numeric string for floating-point stats.

    GlobalStatHistoryLength

    The number of daily values returned by the latest Get global stat history action.

    GlobalStatHistoryValueAt

    A history value as a Construct number. Index 0 is today. Integer values above 2^53 may lose precision.

    GlobalStatHistoryValueStringAt

    A history value as an exact decimal string for integer stats. Index 0 is today.

    CurrentPlayerCount

    The player count from the latest successful Get current player count action.