ConnectionSettings Class Reference

More...

Inheritance diagram for ConnectionSettings:

Static Public Attributes
const string	AssetPath
	The standard path where this asset should be stored.

Properties
string	LobbySceneName = "Lobby" [get, set]
	The name of the lobby scene in the project. This is used determine if NetCode worlds should be created yet.
string	SessionSceneName = "Session" [get, set]
	The name of the session loading scene in the project. When this scene is entered, NetCode worlds are started and loading of session content can start.
ushort	MaxPlayers = 20 [get, set]
	The maximum number of players in a given session. Servers can use this number to gate access if the maximum was exceeded.
ushort	LocalConnectionPort = 5050 [get, set]
	The port to use when connecting locally to a gameplay server during offline or LAN sessions.
float	ConnectToServerTimeoutSeconds = 20f [get, set]
	The number of seconds to wait for connecting to a session. This is relevant in cases where a server is not working correctly or when failing to connect to a LAN session.
Properties inherited from IConnectionSettings

Detailed Description

Member Data Documentation

AssetPath

const string AssetPath

static

Initial value:

=
            SettingsStandardPaths.AssetAppSettings + "/ConnectionSettings"

The standard path where this asset should be stored.

Property Documentation

ConnectToServerTimeoutSeconds

float ConnectToServerTimeoutSeconds = 20f

getset

The number of seconds to wait for connecting to a session. This is relevant in cases where a server is not working correctly or when failing to connect to a LAN session.

Implements IConnectionSettings.

LobbySceneName

string LobbySceneName = "Lobby"

getset

The name of the lobby scene in the project. This is used determine if NetCode worlds should be created yet.

Implements IConnectionSettings.

LocalConnectionPort

ushort LocalConnectionPort = 5050

getset

The port to use when connecting locally to a gameplay server during offline or LAN sessions.

Implements IConnectionSettings.

MaxPlayers

ushort MaxPlayers = 20

getset

The maximum number of players in a given session. Servers can use this number to gate access if the maximum was exceeded.

Implements IConnectionSettings.

SessionSceneName

string SessionSceneName = "Session"

getset

The name of the session loading scene in the project. When this scene is entered, NetCode worlds are started and loading of session content can start.

Implements IConnectionSettings.

---

The documentation for this class was generated from the following file:

• Runtime/Settings/App/ConnectionSettings.cs