Rich Presence API Reference
This section documents all Rich Presence Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Rich Presence
| Node |
Parameters |
Callbacks / Return |
Description |
| Set Steam Presence |
Key (ESteamPresenceKey)
Value (string) |
bool |
Sets a Steam Rich Presence value using a predefined key. Returns true if the value was successfully applied by Steam. |
| Set Steam Presence Raw |
Key (string)
Value (string) |
bool |
Sets a Steam Rich Presence value using a raw string key. Returns true if the value was successfully applied by Steam. |
| Remove Steam Presence |
Key (ESteamPresenceKey) |
bool |
Removes a Steam Rich Presence value by key. Returns true if the value was successfully removed by Steam. |
| Remove Steam Presence Raw |
Key (string) |
bool |
Removes a Steam Rich Presence value by raw key. Returns true if the value was successfully removed by Steam. |
| Clear Steam Presence |
– |
– |
Clears all Steam Rich Presence values. |
Join
| Node |
Parameters |
Callbacks / Return |
Description |
| Set Steam Connect String |
ConnectString (string) |
bool |
Sets the Steam connect string to enable Join Game. Returns true if the connect string was successfully applied by Steam. |
| Clear Steam Connect String |
– |
– |
Clears the Steam connect string and disables Join Game. |
| Get Steam Connect String |
– |
string |
Returns the currently set connect string. |
State
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Cached Steam Presence |
– |
FSteamPresenceSnapshot |
Returns the current local presence snapshot. |
| Has Cached Steam Presence |
Key (ESteamPresenceKey) |
bool |
Checks whether a presence key is currently set. |
| Has Cached Steam Presence Raw |
Key (string) |
bool |
Checks whether a raw presence key is currently set. |
Friends
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Steam Friend Presence |
UserID (FSteamUserID) |
FSteamFriendPresence |
Returns the Rich Presence of a Steam friend. |
| Get Steam Friend Presence Key Count |
UserID (FSteamUserID) |
int32 |
Returns the number of Rich Presence keys for a Steam friend. |
| Get Steam Friend Presence Key |
UserID (FSteamUserID)
Index (int32) |
string |
Returns a Rich Presence key name for a Steam friend by index. |
| Get Steam Friend Presence Value |
UserID (FSteamUserID)
Key (string) |
string |
Returns a specific Rich Presence value for a Steam friend. |