Class RoomOptions

This class describes the options for a new room.

Inheritance
object
RoomOptions
Namespace: Evergine.Networking
Assembly: Evergine.Networking.dll
Syntax
public class RoomOptions

Constructors

RoomOptions()

Initializes a new instance of the RoomOptions class.

Declaration
public RoomOptions()

Properties

IsVisible

Gets or sets a value indicating whether this room will be in the list of visible rooms that can be seen from the lobby (i.e. players who are connected to the server but do not reside in a room). It is important to note that these rooms can still be joined, as long as the client knows the exact name of the room.

Declaration
public bool IsVisible { get; set; }
Property Value
Type Description
bool

MaxPlayers

Gets or sets a value that determines the maximum number of players in this room. If set to 0 (by default), the number is unlimited.

Declaration
public byte MaxPlayers { get; set; }
Property Value
Type Description
byte

PropertiesListedInLobby

Gets or sets a set of string properties that are in the RoomInfo of the Lobby. This list is defined when creating the room and can't be changed afterward.

Declaration
public HashSet<string> PropertiesListedInLobby { get; set; }
Property Value
Type Description
HashSet<string>
Remarks

You could name properties that are not set from the beginning. They will be synchronized with the lobby when added later on.

RoomName

Gets or sets the name to create a room with. It must be unique and not in use; otherwise, it can't be created. If null, the server will assign a GUID as the name.

Declaration
public string RoomName { get; set; }
Property Value
Type Description
string

Extension Methods