Lobbies API Reference
This section documents all Steam Lobbies Blueprint nodes provided by the plugin. These nodes allow you to create, join, search, and manage Steam lobbies, access lobby and member data, and subscribe to lobby-related events.
All functions operate on the currently logged-in Steam user and require Steam to be running and initialized.
Lobby State Getters
These nodes are synchronous getters and do not provide callbacks.
| Node | Parameters | Return | Description |
|---|---|---|---|
| Is In Lobby | – | bool |
Returns whether the local user is currently in a Steam lobby. |
| Get Current Lobby ID | – | FSteamLobbyID |
Returns the current Steam lobby ID, or invalid if not in a lobby. |
| Is Lobby Owner | – | bool |
Returns whether the local user is the owner of the current lobby. |
Lobby Lifecycle
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Create Lobby | Type (ESteamLobbyType)MaxMembers (int) |
On Success (LobbyID): FSteamLobbyID.On Failure (Result): ESteamCreateLobbyResult |
Creates a new Steam lobby with the specified visibility type and maximum number of members. |
| Join Lobby | LobbyID (FSteamLobbyID) |
On Success (LobbyID) On Failure (Result): ESteamLobbyJoinResult |
Joins an existing Steam lobby by its ID. |
| Find Lobbies | MaxResults (int)Distance (ESteamLobbyDistanceFilter) |
On Success (Lobbies): Array of FSteamLobbyID.On Failure (Error Message) |
Searches for available Steam lobbies using the specified result limit and distance filter. |
| Leave Lobby | – | – | Leaves the current Steam lobby and clears local lobby state. |
Lobby Data
| Node | Parameters | Return | Description |
|---|---|---|---|
| Set Lobby Data | LobbyID (FSteamLobbyID), Key (string), Value (string) |
bool |
Sets a key-value pair for the specified lobby. |
| Get Lobby Data | LobbyID (FSteamLobbyID), Key (string) |
string |
Retrieves a value associated with the specified lobby key. |
Lobby Members
| Node | Parameters | Return | Description |
|---|---|---|---|
| Set Lobby Member Data | LobbyID (FSteamLobbyID), Key (string), Value (string) |
– | Sets custom member data for the local user in the lobby. |
| Get Lobby Member Data | LobbyID (FSteamLobbyID), UserID (FSteamUserID), Key (string) |
string |
Retrieves custom member data for the specified lobby member. |
| Get Lobby Member Count | LobbyID (FSteamLobbyID) |
int32 |
Returns the number of members in the specified lobby. |
| Get Lobby Members | LobbyID (FSteamLobbyID) |
Array of FSteamLobbyMember |
Returns a list of all members in the specified lobby. |
| Get Lobby Owner | LobbyID (FSteamLobbyID) |
FSteamUserID |
Returns the owner of the specified lobby. |
Lobby Events
These nodes allow subscribing to lobby-related events. Each subscription returns a listener handle that must be stored to unsubscribe later.
| Node | Parameters | Return | Description |
|---|---|---|---|
| Subscribe To Lobby Entered | OnEntered |
FSteamLobbyListenerHandle |
Subscribes to the lobby entered event. |
| Subscribe To Lobby Left | OnLeft |
FSteamLobbyListenerHandle |
Subscribes to the lobby left event. |
| Subscribe To Lobby Data Changed | OnChanged |
FSteamLobbyListenerHandle |
Subscribes to the lobby data changed event. |
| Subscribe To Lobby Member Joined | OnJoined |
FSteamLobbyListenerHandle |
Subscribes to the lobby member joined event. |
| Subscribe To Lobby Member Left | OnLeft |
FSteamLobbyListenerHandle |
Subscribes to the lobby member left event. |
| Subscribe To Lobby Owner Changed | OnChanged |
FSteamLobbyListenerHandle |
Subscribes to the lobby owner changed event. |
Event Unsubscription
| Node | Parameters | Description |
|---|---|---|
| Unsubscribe From Lobby Entered | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby entered event. |
| Unsubscribe From Lobby Left | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby left event. |
| Unsubscribe From Lobby Data Changed | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby data changed event. |
| Unsubscribe From Lobby Member Joined | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby member joined event. |
| Unsubscribe From Lobby Member Left | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby member left event. |
| Unsubscribe From Lobby Owner Changed | Handle (FSteamLobbyListenerHandle) |
Unsubscribes from the lobby owner changed event. |