A list of all Actions, Conditions and Expressions supported in this addon.
Steamworks
-
Actions
Show overlay for {0}
Show the Steam game overlay.
Show overlay to URL {0} (modal: {1})
Show the Steam game overlay and load a URL from the web.
Show overlay invite dialog for {0}
Show the Steam game overlay to open the invite dialog.
Trigger screenshot
Activate the Steam feature to take a screenshot. Requires the overlay to be active.
-
Conditions
Is available
True if successfully initialized the Steam API.
Is running on Steam Deck
Checks if Steam is running on a Steam Deck device.
On overlay shown
Triggered when the game overlay is shown.
On overlay hidden
Triggered when the game overlay is hidden.
-
Expressions
AccountID
The current user's Steam account ID.
StaticAccountKey
The current user's Steam static account key (as a string).
SteamID64Bit
The current user's Steam ID (64-bit representation, as a string).
AppOwnerAccountID
The app owner's Steam account ID (for Family Sharing).
AppOwnerSteamID64Bit
The app owner's Steam ID (for Family Sharing, 64-bit representation, as a string).
AppOwnerStaticAccountKey
The app owner's Steam static account key as a string (for Family Sharing).
PersonaName
The current user's Steam persona (display) name.
PlayerSteamLevel
Gets the Steam level of the user, as shown on their Steam community profile.
AppID
Gets the App ID of the current game.
SteamUILanguage
Returns the language the Steam client is running in.
CurrentGameLanguage
Gets the current language that the user has set.
AvailableGameLanguages
Gets a comma separated list of the languages the current app supports.
Stats / Achievements
-
Actions
Unlock achievement {0}
Unlock an achievement for the current Steam game.
Clear achievement {0}
Reset the unlock status of an achievement. Typically only used for testing purposes.
Get achievement {0} info
Get an achievement's achieved state and unlock time. Fires a trigger when the result is available.
-
Conditions
On any achievement unlock success
Triggered after any successful 'Unlock achievement' action.
On achievement {0} unlock success
Triggered after a successful 'Unlock achievement' action.
On any achievement unlock error
Triggered after any 'Unlock achievement' action fails.
On achievement {0} unlock error
Triggered after an 'Unlock achievement' action failed.
On any get achievement info success
Triggered after any successful 'Get achievement info' action.
On get achievement {0} info success
Triggered after a successful 'Get achievement info' action.
On any get achievement info error
Triggered after any 'Get achievement info' action fails.
On achievement {0} unlock error
Triggered after an 'Unlock achievement' action failed.
Achievement is achieved
In a 'Get achievement info' trigger, whether the associated achievement has already been achieved.
-
Expressions
Achievement
In an achievement trigger, the 'API Name' of the achievement.
AchievementUnlockTime
In a 'Get achievement info' trigger, the unlock time of the achievement, in milliseconds since 1st Jan 1970.
Leaderboards
-
Actions
Upload leaderboard {0} score {1} (force update: {2})
Submit a score to a leaderboard.
Download leaderboard {0} entries ({1}, start {2}, end {3})
Download the scores on a leaderboard.
-
Conditions
On any upload leaderboard score success
Triggered after any 'Upload leaderboard score' action when successfully submitted.
On upload leaderboard {0} score success
Triggered after 'Upload leaderboard score' when successfully submitted.
On any upload leaderboard score error
Triggered after any 'Upload leaderboard score' action when submission failed.
On upload leaderboard {0} score error
Triggered after 'Upload leaderboard score' when submission failed.
Did score change
In a score upload success trigger, true if the leaderboard score was changed.
On any download leaderboard entries success
Triggered after any 'Download leaderboard entries' action once successfully downloaded.
On download leaderboard {0} entries success
Triggered after 'Download leaderboard entries' action successfully downloaded.
On any download leaderboard entries error
Triggered after any 'Download leaderboard entries' action if the download fails.
On download leaderboard {0} entries error
Triggered after 'Download leaderboard entries' if the download fails.
-
Expressions
GlobalRankNew
In a score upload success trigger, the new global rank.
GlobalRankPrevious
In a score upload success trigger, the previous global rank, or 0 if none.
LeaderboardName
In a leaderboard trigger, the name of the leaderboard.
LeaderboardEntryCount
The number of downloaded entries for a leaderboard.
LeaderboardEntryNameAt
The persona name of a leaderboard entry at a zero-based index.
LeaderboardEntryRankAt
The rank of a leaderboard entry at a zero-based index.
LeaderboardEntryScoreAt
The score of a leaderboard entry at a zero-based index.
DLC
-
Actions
Check DLC {0} installed
Check the installed status of one or more DLC.
Install DLC {0}
Install DLC by its app ID.
Uninstall DLC {0}
Uninstall DLC by its app ID.
-
Conditions
On DLC installed check complete
Triggered after 'Check DLC installed' when the status is updated.
Is DLC {0} installed
Check if DLC is installed by its app ID. Note this can only be used after 'On DLC installed check complete' triggers.
On DLC installed
Triggered after the 'Install DLC' action when the DLC has been installed.
-
Expressions
TriggerAppID
The app ID for a trigger, e.g. 'On DLC installed'.
Authentication
-
Actions
Get auth ticket for web API (identity {0})
Retrieve an authentication ticket from the Steamworks API.
Cancel auth ticket {0}
Cancel a previously obtained authentication ticket.
-
Conditions
On get auth ticket for web api success
Triggered after 'Get auth ticket for web API' when a ticket was obtained successfully.
On get auth ticket for web api error
Triggered after 'Get auth ticket for web API' when a ticket failed to be obtained.
-
Expressions
AuthTicket
The authentication ticket that was obtained (a HAuthTicket in the Steamworks SDK).
TicketHexStr
The ticket that was created as a hexadecimal string.
Rich presence
-
Actions
Set rich presence key {0} value {1}
Set a Rich Presence key/value for the current user that is automatically shared to all friends playing the same game.
Clear rich presence
Clears all of the current user's rich presence keys and values.