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	DisableInterpolatableStates = 1 << 2
	By default, a Quantum session creates additional frame instances to cache previous states that can be used for interpolation, notably for transform interpolations on the View. Set this flag if you want to disable this behaviour (e.g. a server-side or console-only simulation), reducing memory allocations and the time spent copying states over. 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	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	InitSystemsBeforeCallbackGameStarted = 1 << 3
	By default, CallbackGameStarted is invoked before the systems are initialized. Use this flag to get it invoked after the systems are initialized. 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...
const int	UseLegacySystemStartEnabledMode = 1 << 5
	Enable this flag to keep calling SystemBase.OnEnabled(Frame) for all systems including the system that are marked SystemBase.StartEnabled as false by their parents. 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.

DisableInterpolatableStates

const int Quantum.QuantumGameFlags.DisableInterpolatableStates = 1 << 2

static

By default, a Quantum session creates additional frame instances to cache previous states that can be used for interpolation, notably for transform interpolations on the View. Set this flag if you want to disable this behaviour (e.g. a server-side or console-only simulation), reducing memory allocations and the time spent copying states over.

InitSystemsBeforeCallbackGameStarted

const int Quantum.QuantumGameFlags.InitSystemsBeforeCallbackGameStarted = 1 << 3

static

By default, CallbackGameStarted is invoked before the systems are initialized. Use this flag to get it invoked after the systems are initialized.

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.

UseLegacySystemStartEnabledMode

const int Quantum.QuantumGameFlags.UseLegacySystemStartEnabledMode = 1 << 5

static

Enable this flag to keep calling SystemBase.OnEnabled(Frame) for all systems including the system that are marked SystemBase.StartEnabled as false by their parents.

CustomFlagsStart

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

static

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