Photon Fusion 1.1.2

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

bool UpdateCustomProperties (Dictionary< string, SessionProperty > customProperties)
 Update or change the Custom Properties of the current joined Room More...
 
override string ToString ()
 String representation of a SessionInfo 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 IsValid [get]
 Flag to signal if the SessionInfo is ready for use More...
 
string Name [get]
 Stores the current Room Name More...
 
string Region [get]
 Stores the current connected Region More...
 
bool IsVisible [get, set]
 Signal if the current connected Room is visible More...
 
bool IsOpen [get, set]
 Signal if the current connected Room is open More...
 
ReadOnlyDictionary< string, SessionProperty > Properties [get]
 Room Custom Properties More...
 
int PlayerCount [get]
 Current number of peers inside this Session, this includes the Server/Host and Clients 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...
 

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

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