Overlay API Reference
This section documents all Overlay Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Overlay
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Is Steam Overlay Enabled | – | bool | Returns true if Steam Overlay is enabled for the current user. |
| Is Steam Overlay Active | – | bool | Returns true if Steam Overlay is currently active (opened). |
| Activate Steam Overlay | Section (ESteamOverlaySection) |
– | Opens the Steam Overlay to a specific section (Friends, Community, Stats, etc.). |
| Activate Steam Overlay To Web Page | URL (string) |
– | Opens the Steam Overlay to a specific web page. |
| Activate Steam Overlay To User | UserID (FSteamUserID)Dialog (ESteamOverlayUserDialog) |
– | Opens the Steam Overlay to a specific user dialog (Chat, Profile, Add Friend, etc.). |
| Activate Steam Overlay To Chat Room | GroupName (string) |
– | Opens the Steam Overlay to a specific chat room group. |
Invites
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Open Steam Invite Dialog To Lobby | LobbyID (FSteamLobbyID) |
– | Requests Steam Overlay invite dialog for a specified lobby; does not join players or report invite acceptance. |
| Open Steam Invite Dialog Connect String | ConnectString (string) |
– | Requests Steam Overlay invite dialog with a game-defined connect string. The receiving game must handle the connect string. |
Events
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Subscribe To Steam Overlay Activated | – | On Activated (b Is Active: bool)FSteamOverlayListenerHandle |
Subscribe to Steam Overlay activated event. Returns a handle for later unsubscription. |
| Subscribe To Steam Join Requested | – | On Requested (Request: FSteamJoinRequest)FSteamOverlayListenerHandle |
Reports a lobby or Rich Presence join request on the local client. LobbyID may be invalid and ConnectString may be empty. Does not join automatically. |
| Unsubscribe From Steam Overlay Activated | Handle (FSteamOverlayListenerHandle) |
– | Unsubscribe from Steam Overlay activated event using the previously obtained handle. |
| Unsubscribe From Steam Join Requested | Handle (FSteamOverlayListenerHandle) |
– | Unsubscribe from Steam join requested event using the previously obtained handle. |
For workflows and callback differences, see Steam Invitations and Join Requests.