Stores app settings about how to connect to multiplayer sessions. More...
Inheritance diagram for IConnectionSettings:
Properties | |
| string | LobbySceneName [get] |
| The name of the lobby scene in the project. This is used determine if NetCode worlds should be created yet. | |
| string | SessionSceneName [get] |
| 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 [get] |
| The maximum number of players in a given session. Servers can use this number to gate access if the maximum was exceeded. | |
| ushort | LocalConnectionPort [get] |
| The port to use when connecting locally to a gameplay server during offline or LAN sessions. | |
| float | ConnectToServerTimeoutSeconds [get] |
| 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. | |
Detailed Description
Stores app settings about how to connect to multiplayer sessions.
Property Documentation
◆ ConnectToServerTimeoutSeconds
|
get |
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.
Implemented in ConnectionSettings.
◆ LobbySceneName
|
get |
The name of the lobby scene in the project. This is used determine if NetCode worlds should be created yet.
Implemented in ConnectionSettings.
◆ LocalConnectionPort
|
get |
The port to use when connecting locally to a gameplay server during offline or LAN sessions.
Implemented in ConnectionSettings.
◆ MaxPlayers
|
get |
The maximum number of players in a given session. Servers can use this number to gate access if the maximum was exceeded.
Implemented in ConnectionSettings.
◆ SessionSceneName
|
get |
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.
Implemented in ConnectionSettings.
The documentation for this interface was generated from the following file:
- Runtime/Settings/App/ConnectionSettings.cs