# Sandbox.Game.Overlay

Provides static methods for displaying various modal overlays in the game UI.

The [Sandbox.Game.Overlay](/api/Sandbox.Game.Overlay) class allows you to open modals for packages, maps, news, organizations, reviews, friends lists, server lists, settings, input bindings, and player profiles.
It serves as a central point for invoking user interface overlays that interact with core game and community features.

## Examples

```csharp
// Show a modal for a specific game package
Game.Overlay.ShowGameModal("facepunch.sandbox");

// Check if any overlay is currently open
if (Game.Overlay.IsOpen)
{
    // Pause game logic or input
}
```

- Kind: class
- Assembly: `Sandbox.Engine`

## Constructors

- [`Overlay`](/api/Sandbox.Game.Overlay/.ctor)

## Properties

- [`IsOpen`](/api/Sandbox.Game.Overlay/IsOpen): Returns true if any overlay is open
- [`IsPauseMenuOpen`](/api/Sandbox.Game.Overlay/IsPauseMenuOpen): Returns true if the pause menu overlay is open

## Methods

- [`Close`](/api/Sandbox.Game.Overlay/Close): Closes the top overlay if one exists
- [`CloseAll`](/api/Sandbox.Game.Overlay/CloseAll): Close all open overlays
- [`CreateGame`](/api/Sandbox.Game.Overlay/CreateGame): Opens a modal to create a game with a bunch of settings. We use this in the menu when you click "Create Game" and the game has options.
- [`RunLocalBenchmarks`](/api/Sandbox.Game.Overlay/RunLocalBenchmarks): Starts a local benchmark run from within the game. The results panel is shown when all packages complete.
- [`ShowBenchmarkResults`](/api/Sandbox.Game.Overlay/ShowBenchmarkResults)
- [`ShowBinds`](/api/Sandbox.Game.Overlay/ShowBinds): Opens a modal that lets you view and rebind game input actions.
- [`ShowFriendsList`](/api/Sandbox.Game.Overlay/ShowFriendsList)
- [`ShowGameModal`](/api/Sandbox.Game.Overlay/ShowGameModal): Opens a modal for the specified game package
- [`ShowMapModal`](/api/Sandbox.Game.Overlay/ShowMapModal): Opens a modal for the specified map package
- [`ShowMapSelector`](/api/Sandbox.Game.Overlay/ShowMapSelector)
- [`ShowNewsModal`](/api/Sandbox.Game.Overlay/ShowNewsModal): Opens a modal for the news item
- [`ShowOrganizationModal`](/api/Sandbox.Game.Overlay/ShowOrganizationModal): Opens a modal for the specified organization. This is most likely called from a Package - so get the organization from there.
- [`ShowPackageModal`](/api/Sandbox.Game.Overlay/ShowPackageModal): Opens a modal for the specified package
- [`ShowPackageSelector`](/api/Sandbox.Game.Overlay/ShowPackageSelector)
- [`ShowPauseMenu`](/api/Sandbox.Game.Overlay/ShowPauseMenu): Opens the pause menu overlay. This is the same menu that appears when pressing ESC.
- [`ShowPlayer`](/api/Sandbox.Game.Overlay/ShowPlayer): View a selected user's profile
- [`ShowPlayerList`](/api/Sandbox.Game.Overlay/ShowPlayerList): Open a modal that shows a list of players currently in the game
- [`ShowReportModal`](/api/Sandbox.Game.Overlay/ShowReportModal): Opens a modal to report the specified package
- [`ShowReviewModal`](/api/Sandbox.Game.Overlay/ShowReviewModal): Opens a modal to review the specified package
- [`ShowServerList`](/api/Sandbox.Game.Overlay/ShowServerList): Opens a modal that shows a list of active servers
- [`ShowServiceConnector`](/api/Sandbox.Game.Overlay/ShowServiceConnector): Shows modal to edit the streaming settings
- [`ShowSettingsModal`](/api/Sandbox.Game.Overlay/ShowSettingsModal): Opens the settings. In the menu that's a tab; in a game it goes up over the top. Optionally, you can specify a category to open directly to: "display", "graphics", "audio", "controls", "keybinds", "game", "storage", "developer", "about". The old page names "video" and "input" still work, and land on display and controls.
- [`WorkshopPublish`](/api/Sandbox.Game.Overlay/WorkshopPublish): Open a modal that prompts the user to publish content to the workshop