ezEngine  Release 25.03
Classes | Public Types | List of all members
ezCVarFlags Struct Reference

The flags that can be used on an ezCVar. More...

#include <CVar.h>

Classes

struct  Bits
 

Public Types

enum  Enum {
  None = 0, Save = EZ_BIT(0), RequiresDelayedSync = EZ_BIT(1), ShowRequiresRestartMsg = EZ_BIT(2),
  RequiresRestart = Save | RequiresDelayedSync | ShowRequiresRestartMsg, Default = None
}
 
using StorageType = ezUInt8
 

Detailed Description

The flags that can be used on an ezCVar.

Member Enumeration Documentation

◆ Enum

enum ezCVarFlags::Enum
Enumerator
Save 

If this flag is set, the CVar will be stored on disk and loaded again. Otherwise all changes to it will be lost on shutdown.

RequiresDelayedSync 

If the CVar value is changed, the new value will not be visible by default, until SetToDelayedSyncValue() is called on it. This allows to finalize the value change at a specific sync point in code. When this flag is set the ezCVarEvent::DelayedSyncValueChanged will be broadcast.

RequiresRestart 

Indicates that changing this CVar will only take effect after the proper subsystem has been reinitialized. This will always enforce the 'Save' flag as well. With this flag set, the 'Current' value never changes, unless 'SetToDelayedSyncValue' is called.

Default 

By default CVars are not saved.

The documentation for this struct was generated from the following file: