Overlay API Reference
This section documents all Steam Overlay Blueprint nodes provided by the plugin. These nodes allow you to query overlay state, open the Steam Overlay to specific sections or dialogs, and subscribe to overlay-related events.
All functions operate on the currently logged-in Steam user and require Steam to be running and initialized.
Overlay State
These nodes are synchronous getters and do not provide callbacks.
| Node |
Parameters |
Return |
Description |
| Is Overlay Enabled |
– |
bool |
Returns whether Steam Overlay is enabled for the current user. |
| Is Overlay Active |
– |
bool |
Returns whether Steam Overlay is currently active (opened). |
Overlay Activation
| Node |
Parameters |
Description |
| Activate Overlay |
Section (ESteamOverlaySection) |
Opens the Steam Overlay to the specified section (Friends, Community, Stats, etc.). |
| Activate Overlay To Web Page |
URL (string) |
Opens the Steam Overlay to the specified web page. |
| Activate Overlay To User |
UserID (FSteamUserID), Dialog (ESteamOverlayUserDialog) |
Opens the Steam Overlay to a specific user dialog (Chat, Profile, Add Friend, etc.). |
| Activate Overlay To Chat Room |
GroupName (string) |
Opens the Steam Overlay to a specific chat room group. |
Invite Dialogs
| Node |
Parameters |
Description |
| Open Invite Dialog To Lobby |
LobbyID (FSteamLobbyID) |
Opens the Steam invite dialog for the specified lobby. |
| Open Invite Dialog Connect String |
ConnectString (string) |
Opens the Steam invite dialog using a custom connect string. |
Overlay Events
These nodes allow subscribing to Steam Overlay related events. Each subscription returns a listener handle that must be stored to unsubscribe later.
| Node |
Parameters |
Return |
Description |
| Subscribe To Overlay Activated |
OnActivated |
FSteamOverlayListenerHandle |
Subscribes to the Steam Overlay activated event. The callback provides whether the overlay is currently active. |
| Subscribe To Join Requested |
OnRequested |
FSteamOverlayListenerHandle |
Subscribes to the Steam join requested event. The callback provides join request details. |
Event Unsubscription
| Node |
Parameters |
Description |
| Unsubscribe From Overlay Activated |
Handle (FSteamOverlayListenerHandle) |
Unsubscribes from the Steam Overlay activated event. |
| Unsubscribe From Join Requested |
Handle (FSteamOverlayListenerHandle) |
Unsubscribes from the Steam join requested event. |