s&box docs
API ReferenceSandbox.Network

LobbyConfigclass

object→LobbyConfig
Namespace
Sandbox.Network
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.Network.LobbyConfig

Constructors1

Showing 1 constructors

Properties6

Showing 6 properties

public bool Sandbox.Network.LobbyConfig.AutoSwitchToBestHost { get; set; }PUBLICGETSET

Whether to periodically switch to the best possible host candidate. This is only applicable to P2P lobbies.

Returns:bool—

public bool Sandbox.Network.LobbyConfig.DestroyWhenHostLeaves { get; set; }PUBLICGETSET

Whether to automatically destroy this lobby when the host leaves. This is only applicable to P2P lobbies.

Returns:bool—

public bool Sandbox.Network.LobbyConfig.Hidden { get; set; }PUBLICGETSET

Whether to hide this lobby from appearing in the server list. It will still be queryable programatically, so long as the `Sandbox.Network.LobbyConfig.Privacy` mode allows it.

Returns:bool—

public int Sandbox.Network.LobbyConfig.MaxPlayers { get; set; }PUBLICGETSET

The maximum amount of players this lobby can hold. By default, this will be the Max Players set in the current Game Package's project settings.

Returns:int—

public string Sandbox.Network.LobbyConfig.Name { get; set; }PUBLICGETSET

The name of this lobby. If this isn't set, a default lobby name will be chosen instead.

Returns:string—

Snapshot

Previous Page

AutoSwitchToBestHost

Next Page

On this page

Constructorspublic LobbyConfig()Propertiespublic System.Boolean Sandbox.Network.LobbyConfig.AutoSwitchToBestHost { get; set; }public System.Boolean Sandbox.Network.LobbyConfig.DestroyWhenHostLeaves { get; set; }public System.Boolean Sandbox.Network.LobbyConfig.Hidden { get; set; }public System.Int32 Sandbox.Network.LobbyConfig.MaxPlayers { get; set; }public System.String Sandbox.Network.LobbyConfig.Name { get; set; }public Sandbox.Network.LobbyPrivacy Sandbox.Network.LobbyConfig.Privacy { get; set; }Metadata