Photon Quantum 3.0.0

Static Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Quantum.PhotonServerSettings Class Reference

This class wraps the AppSettings into a scriptable object and adds a few Quantum connection related configurations. Connect to specific region cloud: UseNameSever = true, FixedRegion = "us", Server = "" Connect to best region: UseNameSever = true, FixedRegion = "", Server = "" Connect to (local) master server: UseNameSever = false, FixedRegion = "", Server = "10.0.0.0.", Port = 5055 Connect to (local) name server: UseNameSever = true, FixedRegion = "", Server = "10.0.0.0.", Port = 5058 More...

Inheritance diagram for Quantum.PhotonServerSettings:
Quantum.QuantumGlobalScriptableObject< PhotonServerSettings >

Static Public Member Functions

static AppSettings CloneAppSettings (AppSettings appSettings)
 Obsolete: use new AppSettings(appsSettings) More...
 

Public Attributes

AppSettings AppSettings
 Photon AppSettings is serialized on this class. More...
 
string BestRegionSummaryKey = "Quantum.BestRegionSummary"
 Best region summary key used to store ping results in PlayerPrefs. More...
 
bool CanRejoin => PlayerTtlInSeconds > 0
 Rejoining rooms (after the 10 second default timeout) is only possible when PlayerTTL > 0. More...
 
int EmptyRoomTtlInSeconds = 0
 EmptyRoomTTL used when opening rooms. More...
 
int PlayerTtlInSeconds = 0
 PlayerTTL used when opening rooms. More...
 

Static Public Attributes

const string DefaultPath = "Assets/QuantumUser/Resources/PhotonServerSettings.asset"
 The default asset path to search or create a default server settings asset. More...
 

Properties

string? BestRegionSummary [get, set]
 Access best region summary in PlayerPrefs. More...
 

Detailed Description

This class wraps the AppSettings into a scriptable object and adds a few Quantum connection related configurations. Connect to specific region cloud: UseNameSever = true, FixedRegion = "us", Server = "" Connect to best region: UseNameSever = true, FixedRegion = "", Server = "" Connect to (local) master server: UseNameSever = false, FixedRegion = "", Server = "10.0.0.0.", Port = 5055 Connect to (local) name server: UseNameSever = true, FixedRegion = "", Server = "10.0.0.0.", Port = 5058

Member Function Documentation

◆ CloneAppSettings()

static AppSettings Quantum.PhotonServerSettings.CloneAppSettings ( AppSettings  appSettings)
inlinestatic

Obsolete: use new AppSettings(appsSettings)

Member Data Documentation

◆ DefaultPath

const string Quantum.PhotonServerSettings.DefaultPath = "Assets/QuantumUser/Resources/PhotonServerSettings.asset"
static

The default asset path to search or create a default server settings asset.

◆ AppSettings

AppSettings Quantum.PhotonServerSettings.AppSettings

Photon AppSettings is serialized on this class.

◆ PlayerTtlInSeconds

int Quantum.PhotonServerSettings.PlayerTtlInSeconds = 0

PlayerTTL used when opening rooms.

◆ EmptyRoomTtlInSeconds

int Quantum.PhotonServerSettings.EmptyRoomTtlInSeconds = 0

EmptyRoomTTL used when opening rooms.

◆ BestRegionSummaryKey

string Quantum.PhotonServerSettings.BestRegionSummaryKey = "Quantum.BestRegionSummary"

Best region summary key used to store ping results in PlayerPrefs.

◆ CanRejoin

bool Quantum.PhotonServerSettings.CanRejoin => PlayerTtlInSeconds > 0

Rejoining rooms (after the 10 second default timeout) is only possible when PlayerTTL > 0.

Property Documentation

◆ BestRegionSummary

string? Quantum.PhotonServerSettings.BestRegionSummary
getset

Access best region summary in PlayerPrefs.