Friends API Reference
This section documents all Friends Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Friends List
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Steam Friends List |
– |
On Completed (Friends: array of FSteamFriend) |
Returns the full friends list. The list is collected asynchronously and returned once friend persona data is available. |
| Get Steam Friend Count |
– |
int32 |
Returns the total number of Steam friends. |
| Get Steam Friend ID |
Index (int32) |
FSteamUserID |
Returns the Steam user ID of a friend by index. |
| Get Steam Friend |
Index (int32) |
FSteamFriend |
Returns summary information about a friend by index. |
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Steam Friend By ID |
UserID (FSteamUserID) |
FSteamFriend |
Returns summary information about a friend by Steam user ID. |
| Get Steam Friend Relationship |
UserID (FSteamUserID) |
ESteamFriendRelationship |
Returns the relationship between the local user and another Steam user. |
| Is Steam Friend Online |
UserID (FSteamUserID) |
bool |
Returns true if the specified friend is currently online. |
Friend Game State
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Steam Friend Game Info |
UserID (FSteamUserID) |
FSteamFriendGameInfo |
Returns information about the game the friend is currently playing. |
| Get Steam Friend Lobby ID |
UserID (FSteamUserID) |
int64 |
Returns the Steam lobby ID the friend is currently in, or 0 if unavailable. |
| Get Steam Friends Playing This Game |
– |
array of FSteamFriend |
Returns Steam friends who are currently playing this application. |
Invites
| Node |
Parameters |
Callbacks / Return |
Description |
| Invite Steam Friend To Game |
UserID (FSteamUserID)
ConnectString (string) |
bool |
Sends a direct Steam game invite with a custom connect string, without opening Overlay. The receiving game must interpret the string. true does not confirm acceptance or connection. |
For managed games and pre-game lobby alternatives, see Steam Invitations and Join Requests.