Skip to content

Overlay

The Overlay subsystem provides access to the Steam Overlay, allowing the game to open Steam UI panels, user dialogs, web pages, and invite interfaces.

This subsystem also exposes events related to overlay activation and join requests, enabling integration of Steam UI interactions into gameplay and menu flows.

Capabilities

  • Check whether the Steam Overlay is enabled and currently active.
  • Open the Steam Overlay to predefined sections such as Friends, Community, or Stats.
  • Open the Steam Overlay to a specific web page.
  • Open user-specific overlay dialogs such as chat, profile, or add friend.
  • Open invite dialogs for lobbies or custom connect strings.
  • Subscribe to overlay activation events.
  • Subscribe to join request events triggered via Steam Overlay interactions.

Important Notes

  • Steam Overlay availability depends on the user's Steam client settings and platform support.
  • Overlay activation pauses or interrupts gameplay depending on game implementation.
  • Join request events require a valid connect string or lobby context to be meaningful.
  • The subsystem does not manage session joining logic; it only reports overlay-driven events.