infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
IMenuSystem
chevron_left API Reference
interface
IMenuSystem

Properties

data_objectForceCursorVisible

Methods

functionsInitfunctionsOnPackageClosedfunctionsPackageFavouritesChangedfunctionsPackageUsageChangedfunctionsPopupfunctionsQuestionfunctionsShutdownfunctionsTick
IMenuSystem
This is how the engine communicates with the menu system
interface Sandbox.Internal .
abstractSandbox.Engine

data_object Properties 1

ForceCursorVisible
bool
True if we want to force the cursor to be visible and swallow input. This is used for the developer console and loading screens.

functions Methods 8

Init ()
Called to initialize the menu system
OnPackageClosed (package)
Package closed. Add a toast asking if it was cool or not
PackageFavouritesChanged (packageIdent, value)
Notifies that the number of favourites for the specified package has changed.
PackageUsageChanged (packageIdent, userCount)
The backend is telling us that the number of users playing has changed
Popup (type, title, subtitle)
Show a popup
Question (message, icon, yes, no)
Show a question
Shutdown ()
Close down the menu, delete everything
Tick ()
Called every frame, to let the menu think
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.