Photon Unity Networking: ServerSettings Class Reference

Photon Unity Networking

Collection of connection-relevant settings, used internally by PhotonNetwork.ConnectUsingSettings. More...

Inherits ScriptableObject.

Public Types

enum  HostingOption {
  HostingOption.NotSet = 0, HostingOption.PhotonCloud = 1, HostingOption.SelfHosted = 2, HostingOption.OfflineMode = 3,
  HostingOption.BestRegion = 4
}
 

Public Member Functions

void UseCloudBestRegion (string cloudAppid)
 
void UseCloud (string cloudAppid)
 
void UseCloud (string cloudAppid, CloudRegionCode code)
 
void UseMyServer (string serverAddress, int serverPort, string application)
 
override string ToString ()
 

Static Public Member Functions

static bool IsAppId (string val)
 Checks if a string is a Guid by attempting to create one. More...
 
static void ResetBestRegionCodeInPreferences ()
 

Public Attributes

string AppID = ""
 
string VoiceAppID = ""
 
string ChatAppID = ""
 
HostingOption HostType = HostingOption.NotSet
 
CloudRegionCode PreferredRegion
 
CloudRegionFlag EnabledRegions = (CloudRegionFlag)(-1)
 
ConnectionProtocol Protocol = ConnectionProtocol.Udp
 
string ServerAddress = ""
 
int ServerPort = 5055
 
int VoiceServerPort = 5055
 
bool JoinLobby
 
bool EnableLobbyStatistics
 
PhotonLogLevel PunLogging = PhotonLogLevel.ErrorsOnly
 
DebugLevel NetworkLogging = DebugLevel.ERROR
 
bool RunInBackground = true
 
List< string > RpcList = new List<string>()
 
bool DisableAutoOpenWizard
 

Properties

static CloudRegionCode BestRegionCodeInPreferences [get]
 Gets the best region code in preferences. This composes the PhotonHandler, since its Internal and can not be accessed by the custom inspector More...
 

Detailed Description

Collection of connection-relevant settings, used internally by PhotonNetwork.ConnectUsingSettings.

Member Enumeration Documentation

Enumerator
NotSet 
PhotonCloud 
SelfHosted 
OfflineMode 
BestRegion 

Member Function Documentation

static bool ServerSettings.IsAppId ( string  val)
static

Checks if a string is a Guid by attempting to create one.

Parameters
valThe potential guid to check.
Returns
True if new Guid(val) did not fail.
static void ServerSettings.ResetBestRegionCodeInPreferences ( )
static
override string ServerSettings.ToString ( )
void ServerSettings.UseCloud ( string  cloudAppid)
void ServerSettings.UseCloud ( string  cloudAppid,
CloudRegionCode  code 
)
void ServerSettings.UseCloudBestRegion ( string  cloudAppid)
void ServerSettings.UseMyServer ( string  serverAddress,
int  serverPort,
string  application 
)

Member Data Documentation

string ServerSettings.AppID = ""
string ServerSettings.ChatAppID = ""
bool ServerSettings.DisableAutoOpenWizard
CloudRegionFlag ServerSettings.EnabledRegions = (CloudRegionFlag)(-1)
bool ServerSettings.EnableLobbyStatistics
HostingOption ServerSettings.HostType = HostingOption.NotSet
bool ServerSettings.JoinLobby
DebugLevel ServerSettings.NetworkLogging = DebugLevel.ERROR
CloudRegionCode ServerSettings.PreferredRegion
ConnectionProtocol ServerSettings.Protocol = ConnectionProtocol.Udp
PhotonLogLevel ServerSettings.PunLogging = PhotonLogLevel.ErrorsOnly
List<string> ServerSettings.RpcList = new List<string>()
bool ServerSettings.RunInBackground = true
string ServerSettings.ServerAddress = ""
int ServerSettings.ServerPort = 5055
string ServerSettings.VoiceAppID = ""
int ServerSettings.VoiceServerPort = 5055

Property Documentation

CloudRegionCode ServerSettings.BestRegionCodeInPreferences
staticget

Gets the best region code in preferences. This composes the PhotonHandler, since its Internal and can not be accessed by the custom inspector

The best region code in preferences.

Online Documentation  -  Dashboard  -  Support Forum Exit Games GmbH