Photon Fusion 1.1.9

Public Member Functions | Static Public Member Functions | Properties | List of all members
SessionInfo Class Reference

Holds information about the Game Session. More...

Public Member Functions

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

Static Public Member Functions

static implicit operator bool (SessionInfo sessionInfo)
 Check if the SessionInfo reference is not Null and is Valid.
 

Properties

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

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

◆ 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
customPropertiesNew custom properties