newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
Overlay
chevron_left Classes
class
Overlay

Constructors

functionsOverlay

Properties

data_objectIsOpendata_objectIsPauseMenuOpen

Static Methods

functionsClosefunctionsCloseAllfunctionsCreateGamefunctionsShowBindsremove_circleShowFriendsListfunctionsShowGameModalfunctionsShowMapModalfunctionsShowNewsModalfunctionsShowOrganizationModalfunctionsShowPackageModalfunctionsShowPackageSelectorfunctionsShowPauseMenufunctionsShowPlayerfunctionsShowPlayerListfunctionsShowReportModalfunctionsShowReviewModalfunctionsShowServerListfunctionsShowSettingsModalfunctionsWorkshopPublish
Overlay
Provides static methods for displaying various modal overlays in the game UI. <para> The 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. </para>
class Sandbox.Game .
Sandbox.Engine

Examples

// 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
}

build Constructors 1

Overlay ()

data_object Properties 2

IsOpen
bool
Returns true if any overlay is open
IsPauseMenuOpen
bool
Returns true if the pause menu overlay is open

functions Static Methods 19

Close ()
Closes the top overlay if one exists
CloseAll (immediate)
Close all open overlays
CreateGame (options)
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.
ShowBinds ()
Opens a modal that lets you view and rebind game input actions.
ShowFriendsList ()
obsolete
ShowGameModal (packageIdent)
Opens a modal for the specified game package
ShowMapModal (packageIdent)
Opens a modal for the specified map package
ShowNewsModal (newsitem)
Opens a modal for the news item
ShowOrganizationModal (org)
Opens a modal for the specified organization. This is most likely called from a Package - so get the organization from there.
ShowPackageModal (ident)
Opens a modal for the specified package
ShowPackageSelector (query, onSelect, onFilterChanged)
ShowPauseMenu ()
Opens the pause menu overlay. This is the same menu that appears when pressing ESC.
ShowPlayer (steamid, page)
View a selected user's profile
ShowPlayerList ()
Open a modal that shows a list of players currently in the game
ShowReportModal (packageIdent)
Opens a modal to report the specified package
ShowReviewModal (package)
Opens a modal to review the specified package
ShowServerList (config)
Opens a modal that shows a list of active servers
ShowSettingsModal (page)
Opens a modal that lets you modify your settings Optionally, you can specify a page to open directly to: "keybinds", "video", "input", "audio", "game", "storage", "developer"
WorkshopPublish (options)
Open a modal that prompts the user to publish content to the workshop
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.