s&box docs
API ReferenceSandbox.Modals

IModalSystemclass

object→IModalSystem
Namespace
Sandbox.Modals
Assembly
Sandbox.Engine
Declaration
public abstract interface Sandbox.Modals.IModalSystem

Methods22

Showing 22 methods

public virtual void CloseAll(bool immediate = False)PUBLICVIRTUAL

ParameterTypeDescription
immediate = Falsebool—
Returns:void—

public virtual void CreateGame(Sandbox.Modals.CreateGameOptions& modreq(System.Runtime.InteropServices.InAttribute) options)PUBLICVIRTUAL

ParameterTypeDescription
optionsCreateGameOptions& modreq(InAttribute)—
Returns:void—

public virtual void FriendsList(Sandbox.Modals.FriendsListModalOptions& modreq(System.Runtime.InteropServices.InAttribute) options)PUBLICVIRTUAL

ParameterTypeDescription
optionsFriendsListModalOptions& modreq(InAttribute)—
Returns:void—

public virtual void Game(string packageIdent)PUBLICVIRTUAL

ParameterTypeDescription
packageIdentstring—
Returns:void—

public virtual bool HasModalsOpen()PUBLICVIRTUAL

Returns:bool—

public virtual void Map(string packageIdent)PUBLICVIRTUAL

ParameterTypeDescription
packageIdentstring—
Returns:void—

public virtual void MapSelect(System.Action`1<string> onMapSelected, string selected = null)PUBLICVIRTUAL

ParameterTypeDescription
onMapSelectedAction<string>—
selected = nullstring—
Returns:void—

public virtual void News(Sandbox.Services.News newsitem)PUBLICVIRTUAL

ParameterTypeDescription
newsitemNews—
Returns:void—

public virtual void Notice(string title, string message, string icon)PUBLICVIRTUAL

ParameterTypeDescription
titlestring—
messagestring—
iconstring—
Returns:void—

public virtual void Organization(Sandbox.Package.Organization org)PUBLICVIRTUAL

ParameterTypeDescription
orgOrganization—
Returns:void—

public virtual void Package(string packageIdent, string page)PUBLICVIRTUAL

ParameterTypeDescription
packageIdentstring—
pagestring—
Returns:void—

public virtual void PackageSelect(string query, System.Action`1<Sandbox.Package> onPackageSelected, System.Action`1<string> onFilterChanged = null)PUBLICVIRTUAL

ParameterTypeDescription
querystring—
onPackageSelectedAction<Package>—
onFilterChanged = nullAction<string>—
Returns:void—

public virtual void PauseMenu()PUBLICVIRTUAL

The menu that is shown when escape is pressed while playing.

Returns:void—

public virtual void Player(Sandbox.SteamId steamid, string page)PUBLICVIRTUAL

ParameterTypeDescription
steamidSteamId—
pagestring—
Returns:void—

public virtual void PlayerList()PUBLICVIRTUAL

Returns:void—

public virtual void Report(string packageIdent)PUBLICVIRTUAL

ParameterTypeDescription
packageIdentstring—
Returns:void—

public virtual void Review(Sandbox.Package package)PUBLICVIRTUAL

ParameterTypeDescription
packagePackage—
Returns:void—

public virtual void ServerList(Sandbox.Modals.ServerListConfig& modreq(System.Runtime.InteropServices.InAttribute) config)PUBLICVIRTUAL

ParameterTypeDescription
configServerListConfig& modreq(InAttribute)—
Returns:void—

public virtual void ServiceConnector()PUBLICVIRTUAL

Returns:void—

public virtual void Settings(string page)PUBLICVIRTUAL

ParameterTypeDescription
pagestring—
Returns:void—

public virtual void WorkshopPublish(Sandbox.Modals.WorkshopPublishOptions& modreq(System.Runtime.InteropServices.InAttribute) options)PUBLICVIRTUAL

ParameterTypeDescription
optionsWorkshopPublishOptions& modreq(InAttribute)—
Returns:void—

Properties2

Showing 2 properties

public virtual bool Sandbox.Modals.IModalSystem.IsModalOpen { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public virtual bool Sandbox.Modals.IModalSystem.IsPauseMenuOpen { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

FriendsListModalOptions.ctor()

Previous Page

IsModalOpen

Next Page

On this page

Methodspublic virtual System.Void CloseAll(System.Boolean immediate = False)public virtual System.Void CreateGame(Sandbox.Modals.CreateGameOptions& modreq(System.Runtime.InteropServices.InAttribute) options)public virtual System.Void FriendsList(Sandbox.Modals.FriendsListModalOptions& modreq(System.Runtime.InteropServices.InAttribute) options)public virtual System.Void Game(System.String packageIdent)public virtual System.Boolean HasModalsOpen()public virtual System.Void Map(System.String packageIdent)public virtual System.Void MapSelect(System.Action`1<System.String> onMapSelected, System.String selected = null)public virtual System.Void News(Sandbox.Services.News newsitem)public virtual System.Void Notice(System.String title, System.String message, System.String icon)public virtual System.Void Organization(Sandbox.Package.Organization org)public virtual System.Void Package(System.String packageIdent, System.String page)public virtual System.Void PackageSelect(System.String query, System.Action`1<Sandbox.Package> onPackageSelected, System.Action`1<System.String> onFilterChanged = null)public virtual System.Void PauseMenu()public virtual System.Void Player(Sandbox.SteamId steamid, System.String page)public virtual System.Void PlayerList()public virtual System.Void Report(System.String packageIdent)public virtual System.Void Review(Sandbox.Package package)public virtual System.Void Server(Sandbox.Network.LobbyInformation lobby)public virtual System.Void ServerList(Sandbox.Modals.ServerListConfig& modreq(System.Runtime.InteropServices.InAttribute) config)public virtual System.Void ServiceConnector()public virtual System.Void Settings(System.String page)public virtual System.Void WorkshopPublish(Sandbox.Modals.WorkshopPublishOptions& modreq(System.Runtime.InteropServices.InAttribute) options)Propertiespublic virtual System.Boolean Sandbox.Modals.IModalSystem.IsModalOpen { get; set; }public virtual System.Boolean Sandbox.Modals.IModalSystem.IsPauseMenuOpen { get; set; }Metadata