Quantum 3 3.0.5

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

The SDK implementation of the mini menu connection logic. Implements simple Photon connection and Quantum stating processes. Adds Quantum specific settings. More...

Inheritance diagram for Quantum.QuantumStartUIConnection:
Quantum.QuantumStartUIConnectionBase Quantum.QuantumMonoBehaviour

Public Member Functions

override async System.Threading.Tasks.Task ConnectAsync (StartParameter startParameter)
 Connect and start the Quantum game session. This method throws exception on errors. More...
 
override async System.Threading.Tasks.Task DisconnectAsync ()
 Disconnect and shutdown the Quantum game session. This method throws exception on errors. More...
 

Public Attributes

SimulationUpdateTime DeltaTimeType = SimulationUpdateTime.EngineDeltaTime
 The update delta time type. More...
 
InstantReplaySettings InstantReplayConfig = InstantReplaySettings.Default
 The instant replay settings to this session. More...
 
override int Ping => (int)(Client?.RealtimePeer?.Stats.RoundtripTime ?? 0)
 The current ping to the Photon server in milliseconds. More...
 
RuntimePlayer[] Players
 The Quantum runtime players to add. More...
 
RecordingFlags RecordingFlags = RecordingFlags.None
 The recording flags to use for the session. More...
 
override string Region => Client?.CurrentRegion
 The actual region code to connected to. More...
 
override string RoomName => Client?.CurrentRoom?.Name
 The actual room name connected to. More...
 
RuntimeConfig RuntimeConfig
 The Quantum runtime config settings to use. More...
 
PhotonServerSettings ServerSettings
 The Photon cloud setting to use. More...
 
QuantumDeterministicSessionConfigAsset SessionConfig
 The Quantum session config to use, will use QuantumDeterministicSessionConfigAsset.DefaultConfig if not set. More...
 
- Public Attributes inherited from Quantum.QuantumStartUIConnectionBase
string AppVersion => AppVersionMachineId != null ? $"{AppVersionMachineId.AppVersion}{AppVersionMachineIdPostfix}" : AppVersionOverride
 Return the app version that has been configured by AppVersionMachineId and AppVersionOverride. Will append AppVersionMachineIdPostfix when machine id is selected. More...
 
string AppVersionMachineIdPostfix
 Append this to the AppVersionMachineId to isolate players from different maps inside the matchmaking. More...
 

Properties

RealtimeClient Client [get]
 The Realtime client connection object used to connect to the Photon cloud and enter a room. More...
 
QuantumRunner Runner [get]
 The Quantum runner object used to start the game. More...
 
- Properties inherited from Quantum.QuantumStartUIConnectionBase
abstract int Ping [get]
 Implemented by the SDK to show the current ping. More...
 
abstract string Region [get]
 Implemented by the SDK to show the actual region connected to. More...
 
abstract string RoomName [get]
 Implemented by the SDK to show the actual room name connected to. More...
 

Additional Inherited Members

- Protected Attributes inherited from Quantum.QuantumStartUIConnectionBase
QuantumMachineId AppVersionMachineId
 The machine id scriptable object used to generate a unique AppVersion for the Photon matchmaking. This should be used most of the time during development as it uses an id that is unique to the machine and builds so non-compatible others clients do not matchmake with each other. More...
 
string AppVersionOverride
 Set an explicit AppVersion to use instead of AppVersionMachineId. More...
 
bool EnableMultiplayerPlayMode = true
 Enabled Unity Multiplayer Play Mode to launch all clients simultaneously. More...
 

Detailed Description

The SDK implementation of the mini menu connection logic. Implements simple Photon connection and Quantum stating processes. Adds Quantum specific settings.

Member Function Documentation

◆ ConnectAsync()

override async System.Threading.Tasks.Task Quantum.QuantumStartUIConnection.ConnectAsync ( StartParameter  startParameter)
inlinevirtual

Connect and start the Quantum game session. This method throws exception on errors.

Parameters
startParameterMini menu start parameter
Returns
When the connection has been established and game started.

Implements Quantum.QuantumStartUIConnectionBase.

◆ DisconnectAsync()

override async System.Threading.Tasks.Task Quantum.QuantumStartUIConnection.DisconnectAsync ( )
inlinevirtual

Disconnect and shutdown the Quantum game session. This method throws exception on errors.

Returns
When the shutdown is completed

Implements Quantum.QuantumStartUIConnectionBase.

Member Data Documentation

◆ ServerSettings

PhotonServerSettings Quantum.QuantumStartUIConnection.ServerSettings

The Photon cloud setting to use.

◆ SessionConfig

QuantumDeterministicSessionConfigAsset Quantum.QuantumStartUIConnection.SessionConfig

The Quantum session config to use, will use QuantumDeterministicSessionConfigAsset.DefaultConfig if not set.

◆ RuntimeConfig

RuntimeConfig Quantum.QuantumStartUIConnection.RuntimeConfig

The Quantum runtime config settings to use.

◆ Players

RuntimePlayer [] Quantum.QuantumStartUIConnection.Players

The Quantum runtime players to add.

◆ DeltaTimeType

SimulationUpdateTime Quantum.QuantumStartUIConnection.DeltaTimeType = SimulationUpdateTime.EngineDeltaTime

The update delta time type.

◆ RecordingFlags

RecordingFlags Quantum.QuantumStartUIConnection.RecordingFlags = RecordingFlags.None

The recording flags to use for the session.

◆ InstantReplayConfig

InstantReplaySettings Quantum.QuantumStartUIConnection.InstantReplayConfig = InstantReplaySettings.Default

The instant replay settings to this session.

◆ RoomName

override string Quantum.QuantumStartUIConnection.RoomName => Client?.CurrentRoom?.Name

The actual room name connected to.

◆ Region

override string Quantum.QuantumStartUIConnection.Region => Client?.CurrentRegion

The actual region code to connected to.

◆ Ping

override int Quantum.QuantumStartUIConnection.Ping => (int)(Client?.RealtimePeer?.Stats.RoundtripTime ?? 0)

The current ping to the Photon server in milliseconds.

Property Documentation

◆ Client

RealtimeClient Quantum.QuantumStartUIConnection.Client
get

The Realtime client connection object used to connect to the Photon cloud and enter a room.

◆ Runner

QuantumRunner Quantum.QuantumStartUIConnection.Runner
get

The Quantum runner object used to start the game.