Rich Presence API Reference
This section documents all Steam Rich Presence Blueprint nodes provided by the plugin. These nodes allow you to set and manage local Rich Presence values, configure Join Game behavior, inspect cached presence state, and read Rich Presence data from Steam friends.
All functions operate on the currently logged-in Steam user and require Steam to be running and initialized.
Presence Values
| Node |
Parameters |
Return |
Description |
| Set Presence |
Key (ESteamPresenceKey), Value (string) |
bool |
Sets a Steam Rich Presence value using a predefined key. Returns whether the value was successfully applied by Steam. |
| Set Presence Raw |
Key (string), Value (string) |
bool |
Sets a Steam Rich Presence value using a raw string key. Returns whether the value was successfully applied by Steam. |
| Remove Presence |
Key (ESteamPresenceKey) |
bool |
Removes a Steam Rich Presence value by predefined key. |
| Remove Presence Raw |
Key (string) |
bool |
Removes a Steam Rich Presence value by raw string key. |
| Clear Presence |
– |
– |
Clears all Steam Rich Presence values for the local user. |
Join Game
| Node |
Parameters |
Return |
Description |
| Set Connect String |
ConnectString (string) |
bool |
Sets the Steam connect string used for Join Game functionality. |
| Clear Connect String |
– |
– |
Clears the Steam connect string and disables Join Game. |
| Get Connect String |
– |
string |
Returns the currently set connect string. |
Cached Presence State
These nodes are synchronous getters and operate on locally cached presence data.
| Node |
Parameters |
Return |
Description |
| Get Cached Presence |
– |
FSteamPresenceSnapshot |
Returns the current local Rich Presence snapshot. |
| Has Cached Presence |
Key (ESteamPresenceKey) |
bool |
Checks whether a predefined presence key is currently set. |
| Has Cached Presence Raw |
Key (string) |
bool |
Checks whether a raw presence key is currently set. |
Friends Rich Presence
| Node |
Parameters |
Return |
Description |
| Get Friend Presence |
UserID (FSteamUserID) |
FSteamFriendPresence |
Returns the Rich Presence data of the specified Steam friend. |
| Get Friend Presence Key Count |
UserID (FSteamUserID) |
int32 |
Returns the number of Rich Presence keys set for the specified Steam friend. |
| Get Friend Presence Key |
UserID (FSteamUserID), Index (int32) |
string |
Returns a Rich Presence key name for the specified Steam friend by index. |
| Get Friend Presence Value |
UserID (FSteamUserID), Key (string) |
string |
Returns the value of a specific Rich Presence key for the specified Steam friend. |