Quantum 3 3.1.0

Static Public Attributes | List of all members
Quantum.QuantumGameFlags Class Reference

This class contains values for flags that will be accessible with QuantumGame.GameFlags. Built-in flags control some aspects of QuantumGame inner workings, without affecting the simulation outcome. More...

Static Public Attributes

const int CustomFlagsStart = 1 << 16
 Custom user flags start from this value. Flags are accessible with QuantumGame.GameFlags. More...
 
const int DisableMemoryIntegrityCheck = 1 << 4
 Enable this flag to disable the memory integrity check during Quantum startup. It's highly recommended to only disable this in tested release builds. More...
 
const int DisableRecordInputCache = 1 << 7
 By default, QuantumGame caches the delta compressed input sets that were confirmed but not verified yet, so that QuantumGame.StartRecordingInput can be called mid-game without missing input at the start of the recording. Set this flag to disable the cache, for example when input recording is never started mid-game. More...
 
const int DisableSharedChecksumSerializer = 1 << 1
 By default, QuantumGame uses a single shared checksum serializer to reduce allocations. The serializer is not static - it is only shared between frames coming from the same QuantumGame. Set this flag if you want to disable this behaviour, for example if you calculate checksums for multiple frames using multiple threads. More...
 
const int IsLegacyFrameCopiesEnabled = 1 << 6
 A Quantum session creates additional frame instances to cache previous states that were used for view interpolation. Set this flag to enable this behaviour. More...
 
const int Server = 1 << 0
 Starts the game in the server mode. When this flag is not set, all the events marked with "server" get culled immediately. If this flag is set, all the events marked with "client" get culled immediately. More...
 

Detailed Description

This class contains values for flags that will be accessible with QuantumGame.GameFlags. Built-in flags control some aspects of QuantumGame inner workings, without affecting the simulation outcome.

Member Data Documentation

◆ Server

const int Quantum.QuantumGameFlags.Server = 1 << 0
static

Starts the game in the server mode. When this flag is not set, all the events marked with "server" get culled immediately. If this flag is set, all the events marked with "client" get culled immediately.

◆ DisableSharedChecksumSerializer

const int Quantum.QuantumGameFlags.DisableSharedChecksumSerializer = 1 << 1
static

By default, QuantumGame uses a single shared checksum serializer to reduce allocations. The serializer is not static - it is only shared between frames coming from the same QuantumGame. Set this flag if you want to disable this behaviour, for example if you calculate checksums for multiple frames using multiple threads.

◆ DisableMemoryIntegrityCheck

const int Quantum.QuantumGameFlags.DisableMemoryIntegrityCheck = 1 << 4
static

Enable this flag to disable the memory integrity check during Quantum startup. It's highly recommended to only disable this in tested release builds.

◆ IsLegacyFrameCopiesEnabled

const int Quantum.QuantumGameFlags.IsLegacyFrameCopiesEnabled = 1 << 6
static

A Quantum session creates additional frame instances to cache previous states that were used for view interpolation. Set this flag to enable this behaviour.

◆ DisableRecordInputCache

const int Quantum.QuantumGameFlags.DisableRecordInputCache = 1 << 7
static

By default, QuantumGame caches the delta compressed input sets that were confirmed but not verified yet, so that QuantumGame.StartRecordingInput can be called mid-game without missing input at the start of the recording. Set this flag to disable the cache, for example when input recording is never started mid-game.

◆ CustomFlagsStart

const int Quantum.QuantumGameFlags.CustomFlagsStart = 1 << 16
static

Custom user flags start from this value. Flags are accessible with QuantumGame.GameFlags.