SessionInfo Class Reference

Holds information about the Game Session More...

Public Member Functions
override string	ToString ()
	String representation of a SessionInfo More...
bool	UpdateCustomProperties (Dictionary< string, SessionProperty > customProperties)
	Update or change the Custom Properties of the current joined Room More...

Static Public Member Functions
static implicit	operator bool (SessionInfo sessionInfo)
	Check if the SessionInfo reference is not Null and is Valid. More...

Properties
bool??	IsOpen [get, set]
	Signal if the current connected Room is open More...
bool	IsValid [get]
	Flag to signal if the SessionInfo is ready for use More...
bool??	IsVisible [get, set]
	Signal if the current connected Room is visible More...
int	MaxPlayers [get]
	Max number of peer that can join this Session, this value always include an extra slot for the Server/Host More...
string	Name [get]
	Stores the current Room Name More...
int	PlayerCount [get]
	Current number of peers inside this Session, this includes the Server/Host and Clients More...
ReadOnlyDictionary< string, SessionProperty >	Properties [get]
	Room Custom Properties More...
string	Region [get]
	Stores the current connected Region More...

Detailed Description

Holds information about the Game Session

Member Function Documentation

operator bool()

static implicit operator bool ( SessionInfo  sessionInfo )

static

Check if the SessionInfo reference is not Null and is Valid.

Parameters

sessionInfo

Session Info

ToString()

override string ToString

(

)

String representation of a SessionInfo

Returns

Formatted SessionInfo

UpdateCustomProperties()

bool UpdateCustomProperties

(

Dictionary< string, SessionProperty >

customProperties

)

Update or change the Custom Properties of the current joined Room

Parameters

customProperties

New custom properties

Property Documentation

IsOpen

bool?? IsOpen

getset

Signal if the current connected Room is open

IsValid

bool IsValid

get

Flag to signal if the SessionInfo is ready for use

IsVisible

bool?? IsVisible

getset

Signal if the current connected Room is visible

MaxPlayers

int MaxPlayers

get

Max number of peer that can join this Session, this value always include an extra slot for the Server/Host

Name

string Name

get

Stores the current Room Name

PlayerCount

int PlayerCount

get

Current number of peers inside this Session, this includes the Server/Host and Clients

Properties

ReadOnlyDictionary<string, SessionProperty> Properties

get

Room Custom Properties

Region

string Region

get

Stores the current connected Region