Lobbies API Reference
This section documents all Lobbies Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Getters
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Is In Steam Lobby | – | bool | Returns true if the local user is currently in a Steam lobby. |
| Get Current Steam Lobby ID | – | FSteamLobbyID |
Returns the current Steam lobby ID, or invalid if not in a lobby. |
| Is Steam Lobby Owner | – | bool | Returns true if the local user is the owner of the current lobby. |
Lobbies
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Create Steam Lobby | Type (ESteamLobbyType)MaxMembers (int32) |
On Success (Lobby ID: FSteamLobbyID)On Failure (Result: ESteamCreateLobbyResult) |
Creates a new Steam lobby with the specified parameters. |
| Join Steam Lobby | LobbyID (FSteamLobbyID) |
On Success (Lobby ID: FSteamLobbyID)On Failure (Result: ESteamLobbyJoinResult) |
Joins an existing Steam lobby by its ID. |
| Find Steam Lobbies | MaxResults (int32)Distance (ESteamLobbyDistanceFilter)MinimumAvailableSlots (int32)SearchFilters (array of FSteamLobbySearchFilter) |
On Success (Lobbies: array of FSteamLobbyID)On Failure (Error Message: string) |
Searches for available Steam lobbies. Optional filters can require free slots and match string or numeric lobby data. |
| Leave Steam Lobby | – | – | Leaves the current Steam lobby. |
Settings
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Invite Friend To Steam Lobby | LobbyID (FSteamLobbyID)UserID (FSteamUserID) |
bool | Sends a Steam lobby invitation to the specified user. This does not start a managed multiplayer game; the recipient must join the lobby. true does not mean the invite was accepted. |
| Set Steam Lobby Type | LobbyID (FSteamLobbyID)Type (ESteamLobbyType) |
bool | Changes the visibility type of the specified lobby. Only the lobby owner can change it. |
| Set Steam Lobby Joinable | LobbyID (FSteamLobbyID)bJoinable (bool) |
bool | Sets whether new users can join the specified lobby. Only the lobby owner can change it. |
| Is Steam Lobby Joinable | LobbyID (FSteamLobbyID) |
bool | Returns the plugin-managed joinable state of the specified lobby. |
| Set Steam Lobby Member Limit | LobbyID (FSteamLobbyID)MaxMembers (int32) |
bool | Changes the maximum number of members allowed in the specified lobby. Only the lobby owner can change it. |
| Get Steam Lobby Member Limit | LobbyID (FSteamLobbyID) |
int32 | Returns the maximum number of members allowed in the specified lobby. |
For lobby invitations and acceptance handling, see Steam Invitations and Join Requests.
Data
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Steam Lobby Data | LobbyID (FSteamLobbyID)Key (string)Value (string) |
bool | Sets a key-value pair for the specified lobby. |
| Get Steam Lobby Data | LobbyID (FSteamLobbyID)Key (string) |
string | Gets a value associated with the specified lobby key. |
| Delete Steam Lobby Data | LobbyID (FSteamLobbyID)Key (string) |
bool | Deletes a key-value pair from the specified lobby. |
Members
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Steam Lobby Member Data | LobbyID (FSteamLobbyID)Key (string)Value (string) |
– | Sets custom member data for the local user in the lobby. |
| Get Steam Lobby Member Data | LobbyID (FSteamLobbyID)UserID (FSteamUserID)Key (string) |
string | Gets custom member data for the specified user in the lobby. |
| Get Steam Lobby Member Count | LobbyID (FSteamLobbyID) |
int32 | Returns the number of members in the specified lobby. |
| Get Steam Lobby Members | LobbyID (FSteamLobbyID) |
array of FSteamLobbyMember |
Returns a list of all members in the specified lobby. |
| Get Steam Lobby Owner | LobbyID (FSteamLobbyID) |
FSteamUserID |
Returns the owner of the specified lobby. |
Events
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Subscribe To Steam Lobby Entered | – | On Entered (Lobby ID: FSteamLobbyID)FSteamLobbyListenerHandle |
Subscribe to lobby entered event. |
| Subscribe To Steam Lobby Left | – | On LeftFSteamLobbyListenerHandle |
Subscribe to lobby left event. |
| Subscribe To Steam Lobby Data Changed | – | On Changed (Lobby ID: FSteamLobbyID, b Success: bool)FSteamLobbyListenerHandle |
Subscribe to lobby data changed event. |
| Subscribe To Steam Lobby Member Joined | – | On Joined (Lobby ID: FSteamLobbyID, User ID: FSteamUserID)FSteamLobbyListenerHandle |
Subscribe to lobby member joined event. |
| Subscribe To Steam Lobby Member Left | – | On Left (Lobby ID: FSteamLobbyID, User ID: FSteamUserID)FSteamLobbyListenerHandle |
Subscribe to lobby member left event. |
| Subscribe To Steam Lobby Owner Changed | – | On Changed (New Owner: FSteamUserID)FSteamLobbyListenerHandle |
Subscribe to lobby owner changed event. |
| Unsubscribe From Steam Lobby Entered | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby entered event. |
| Unsubscribe From Steam Lobby Left | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby left event. |
| Unsubscribe From Steam Lobby Data Changed | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby data changed event. |
| Unsubscribe From Steam Lobby Member Joined | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby member joined event. |
| Unsubscribe From Steam Lobby Member Left | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby member left event. |
| Unsubscribe From Steam Lobby Owner Changed | Handle (FSteamLobbyListenerHandle) |
– | Unsubscribe from lobby owner changed event. |