Friends API Reference
This section documents all Steam Friends Blueprint nodes provided by the plugin. These nodes allow you to retrieve the friends list, query friend state and relationship information, access game and lobby data, and send game invites.
All functions operate on the currently logged-in Steam user and require Steam to be running and initialized.
Friends List
| Node |
Parameters |
Callbacks / Return |
Description |
| Get Friends List |
– |
On Completed (Friends): Returns an array of FSteamFriend. |
Asynchronously retrieves the full Steam friends list. The callback is triggered once persona data for all friends is available. |
| Get Friend Count |
– |
int32 |
Returns the total number of Steam friends. |
| Get Friend ID |
Index (int32) |
FSteamUserID |
Returns the Steam user ID of a friend by index. |
| Get Friend |
Index (int32) |
FSteamFriend |
Returns summary information about a friend by index. |
These nodes are synchronous getters and do not provide callbacks.
| Node |
Parameters |
Return |
Description |
| Get Friend By ID |
UserID (FSteamUserID) |
FSteamFriend |
Returns summary information about a friend by Steam user ID. |
| Get Friend Relationship |
UserID (FSteamUserID) |
ESteamFriendRelationship |
Returns the relationship between the local user and another Steam user. |
| Is Friend Online |
UserID (FSteamUserID) |
bool |
Returns whether the specified friend is currently online. |
Friend Game State
| Node |
Parameters |
Return |
Description |
| Get Friend Game Info |
UserID (FSteamUserID) |
FSteamFriendGameInfo |
Returns information about the game the specified friend is currently playing. |
| Get Friend Lobby ID |
UserID (FSteamUserID) |
int64 |
Returns the Steam lobby ID the friend is currently in, or 0 if unavailable. |
Game Invites
| Node |
Parameters |
Return |
Description |
| Invite Friend To Game |
UserID (FSteamUserID), ConnectString (string) |
bool |
Sends a direct Steam invite to the specified friend using a connect string. This call does not open the Steam overlay UI. |