ezEngine  Release 25.03
ezObjectFlags Struct Reference

Internal flags of game objects or components. More...

#include <Declarations.h>

Classes

struct  Bits
 

Public Types

enum  Enum {
  None = 0, Dynamic = EZ_BIT(0), ForceDynamic = EZ_BIT(1), ActiveFlag = EZ_BIT(2),
  ActiveState = EZ_BIT(3), Initialized = EZ_BIT(4), Initializing = EZ_BIT(5), SimulationStarted = EZ_BIT(6),
  SimulationStarting = EZ_BIT(7), UnhandledMessageHandler = EZ_BIT(8), ChildChangesNotifications = EZ_BIT(9), ComponentChangesNotifications = EZ_BIT(10),
  StaticTransformChangesNotifications = EZ_BIT(11), ParentChangesNotifications = EZ_BIT(12), CreatedByPrefab = EZ_BIT(13), UserFlag0 = EZ_BIT(24),
  UserFlag1 = EZ_BIT(25), UserFlag2 = EZ_BIT(26), UserFlag3 = EZ_BIT(27), UserFlag4 = EZ_BIT(28),
  UserFlag5 = EZ_BIT(29), UserFlag6 = EZ_BIT(30), UserFlag7 = EZ_BIT(31), Default = None
}
 
using StorageType = ezUInt32
 

Detailed Description

Internal flags of game objects or components.

Member Enumeration Documentation

◆ Enum

Enumerator
Dynamic 

Usually detected automatically. A dynamic object will not cache render data across frames.

ForceDynamic 

Set by the user to enforce the 'Dynamic' mode. Necessary when user code (or scripts) should change objects, and the automatic detection cannot know that.

ActiveFlag 

The object/component has the 'active flag' set.

ActiveState 

The object/component and all its parents have the active flag.

Initialized 

The object/component has been initialized.

Initializing 

The object/component is currently initializing. Used to prevent recursions during initialization.

SimulationStarted 

OnSimulationStarted() has been called on the component.

SimulationStarting 

Used to prevent recursion during OnSimulationStarted()

UnhandledMessageHandler 

For components, when a message is not handled, a virtual function is called.

ChildChangesNotifications 

The object should send a notification message when children are added or removed.

ComponentChangesNotifications 

The object should send a notification message when components are added or removed.

StaticTransformChangesNotifications 

The object should send a notification message if it is static and its transform changes.

ParentChangesNotifications 

The object should send a notification message when the parent is changes.

CreatedByPrefab 

Such flagged objects and components are ignored during scene export (see ezWorldWriter) and will be removed when a prefab needs to be re-instantiated.


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