Quantum 3 3.1.0

Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Quantum.QuantumDeterministicSessionConfigAsset Class Reference

The asset wraps an instance of DeterministicSessionConfig and makes it globally (in Unity) accessible as a default config. More...

Inheritance diagram for Quantum.QuantumDeterministicSessionConfigAsset:
Quantum.QuantumGlobalScriptableObject< QuantumDeterministicSessionConfigAsset > Quantum.ISerializationCallbackReceiver

Public Member Functions

void OnAfterDeserialize ()
 Make sure limitations, calculations or overrides are applied. More...
 
void OnBeforeSerialize ()
 Not needed. More...
 

Static Public Member Functions

static int CalculateHardToleranceFrames (int offsetPingStart, int updateFps, int minInputDelay)
 Calculate the hard tolerance from the ping value that starts local input delay. ceil((rtt / 2 + delta + slack) / delta) + 1 - min More...
 

Public Attributes

DeterministicSessionConfig Config
 The config instance. More...
 
int HardTolerance = 8
 Override the calculated hard tolerance with this value. More...
 
bool OverrideHardTolerance
 Override the hard tolerance calculation. More...
 

Static Public Attributes

const int AliasingSlackTimeMs = 30
 A rule of thumb time added to compensate to additional network transport and condition. More...
 
static DeterministicSessionConfig DefaultConfig => Global.Config
 Return the default global config instance. More...
 
const string DefaultPath = "Assets/QuantumUser/Resources/SessionConfig.asset"
 The default location of the global QuantumDeterministicSessionConfigAsset asset. More...
 

Detailed Description

The asset wraps an instance of DeterministicSessionConfig and makes it globally (in Unity) accessible as a default config.

Member Function Documentation

◆ CalculateHardToleranceFrames()

static int Quantum.QuantumDeterministicSessionConfigAsset.CalculateHardToleranceFrames ( int  offsetPingStart,
int  updateFps,
int  minInputDelay 
)
static

Calculate the hard tolerance from the ping value that starts local input delay. ceil((rtt / 2 + delta + slack) / delta) + 1 - min

Parameters
offsetPingStartPing to start input delay
updateFpsSimulation update rate
minInputDelayMin input delay
Returns
Computed hard tolerance value

◆ OnAfterDeserialize()

void Quantum.QuantumDeterministicSessionConfigAsset.OnAfterDeserialize ( )
inline

Make sure limitations, calculations or overrides are applied.

Implements Quantum.ISerializationCallbackReceiver.

◆ OnBeforeSerialize()

void Quantum.QuantumDeterministicSessionConfigAsset.OnBeforeSerialize ( )
inline

Not needed.

Implements Quantum.ISerializationCallbackReceiver.

Member Data Documentation

◆ DefaultPath

const string Quantum.QuantumDeterministicSessionConfigAsset.DefaultPath = "Assets/QuantumUser/Resources/SessionConfig.asset"
static

The default location of the global QuantumDeterministicSessionConfigAsset asset.

◆ AliasingSlackTimeMs

const int Quantum.QuantumDeterministicSessionConfigAsset.AliasingSlackTimeMs = 30
static

A rule of thumb time added to compensate to additional network transport and condition.

◆ Config

DeterministicSessionConfig Quantum.QuantumDeterministicSessionConfigAsset.Config

The config instance.

◆ OverrideHardTolerance

bool Quantum.QuantumDeterministicSessionConfigAsset.OverrideHardTolerance

Override the hard tolerance calculation.

◆ HardTolerance

int Quantum.QuantumDeterministicSessionConfigAsset.HardTolerance = 8

Override the calculated hard tolerance with this value.

◆ DefaultConfig

DeterministicSessionConfig Quantum.QuantumDeterministicSessionConfigAsset.DefaultConfig => Global.Config
static

Return the default global config instance.