API ReferenceSandbox.Internal

IMenuSystemclass

This is how the engine communicates with the menu system

objectIMenuSystem
Namespace
Sandbox.Internal
Assembly
Sandbox.Engine
Declaration
public abstract interface Sandbox.Internal.IMenuSystem

Methods8

Showing 8 methods

public virtual void Init()PUBLICVIRTUAL

Called to initialize the menu system

Returns:void

public virtual void OnPackageClosed(Sandbox.Package package)PUBLICVIRTUAL

Package closed. Add a toast asking if it was cool or not

ParameterTypeDescription
packagePackage
Returns:void

public virtual void PackageFavouritesChanged(string packageIdent, long value)PUBLICVIRTUAL

Notifies that the number of favourites for the specified package has changed.

ParameterTypeDescription
packageIdentstring
valuelong
Returns:void

public virtual void PackageUsageChanged(string packageIdent, long userCount)PUBLICVIRTUAL

The backend is telling us that the number of users playing has changed

ParameterTypeDescription
packageIdentstring
userCountlong
Returns:void

public virtual void Question(string message, string icon, System.Action yes, System.Action no)PUBLICVIRTUAL

Show a question

ParameterTypeDescription
messagestring
iconstring
yesAction
noAction
Returns:void

public virtual void Shutdown()PUBLICVIRTUAL

Close down the menu, delete everything

Returns:void

public virtual void Tick()PUBLICVIRTUAL

Called every frame, to let the menu think

Returns:void

Properties1

Showing 1 properties

public virtual bool Sandbox.Internal.IMenuSystem.ForceCursorVisible { get; set; }PUBLICVIRTUALGETSET

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

Returns:bool

On this page