Quantum.QuantumStartUIConnectionBase Class Reference

The base class to be implemented by the SDK to provide connection and game starting/shutdown functionality. More...

Inheritance diagram for Quantum.QuantumStartUIConnectionBase:

Classes
class	StartParameter
	The start parameters. More...

Public Member Functions
abstract System.Threading.Tasks.Task	ConnectAsync (StartParameter startParameter)
	Implement in the SDK to connect and start a game with the given start parameters. This method used exceptions to escalate errors. More...
abstract System.Threading.Tasks.Task	DisconnectAsync ()
	Implement in the SDK to disconnect from the current game and shutdown the connection. This method used exceptions to escalate errors. More...

Public Attributes
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...

Protected Attributes
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...

Properties
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...

Detailed Description

The base class to be implemented by the SDK to provide connection and game starting/shutdown functionality.

Member Function Documentation

ConnectAsync()

abstract System.Threading.Tasks.Task Quantum.QuantumStartUIConnectionBase.ConnectAsync ( StartParameter  startParameter )

pure virtual

Implement in the SDK to connect and start a game with the given start parameters. This method used exceptions to escalate errors.

Parameters

startParameter

Game connection and start parameters.

Returns

When the game has been started or failed

Implemented in Quantum.QuantumStartUIConnection.

DisconnectAsync()

abstract System.Threading.Tasks.Task Quantum.QuantumStartUIConnectionBase.DisconnectAsync ( )

pure virtual

Implement in the SDK to disconnect from the current game and shutdown the connection. This method used exceptions to escalate errors.

Returns

When the connection and game have been terminated

Implemented in Quantum.QuantumStartUIConnection.

Member Data Documentation

AppVersionMachineId

QuantumMachineId Quantum.QuantumStartUIConnectionBase.AppVersionMachineId

protected

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.

AppVersionMachineIdPostfix

string Quantum.QuantumStartUIConnectionBase.AppVersionMachineIdPostfix

Append this to the AppVersionMachineId to isolate players from different maps inside the matchmaking.

AppVersionOverride

string Quantum.QuantumStartUIConnectionBase.AppVersionOverride

protected

Set an explicit AppVersion to use instead of AppVersionMachineId.

EnableMultiplayerPlayMode

bool Quantum.QuantumStartUIConnectionBase.EnableMultiplayerPlayMode = true

protected

Enabled Unity Multiplayer Play Mode to launch all clients simultaneously.

AppVersion

string Quantum.QuantumStartUIConnectionBase.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.

Property Documentation

RoomName

abstract string Quantum.QuantumStartUIConnectionBase.RoomName

get

Implemented by the SDK to show the actual room name connected to.

Region

abstract string Quantum.QuantumStartUIConnectionBase.Region

get

Implemented by the SDK to show the actual region connected to.

Ping

abstract int Quantum.QuantumStartUIConnectionBase.Ping

get

Implemented by the SDK to show the current ping.