ezEngine  Milestone 7
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), RequiresRestart = EZ_BIT(1), Default = None }
 
typedef ezUInt8 StorageType
 

Detailed Description

The flags that can be used on an ezCVar.


Class Documentation

struct ezCVarFlags::Bits
Class Members
StorageType RequiresRestart: 1
StorageType Save: 1

Member Enumeration Documentation

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.

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 'SetToRestartValue' is called.

Default 

By default CVars are not saved.


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