Skip to main content

types Namespace

Definition

namespace helios::core::types { ... }

Classes Index

structno_init_t

Tag type used to indicate skipping default initialization. More...

Typedefs Index

usingStrongId_t = uint32_t

Underlying integer type for all strong identifiers. More...

usingVersionId = uint32_t

Version number for detecting stale entity references. More...

usingEntityId = uint32_t

Unique identifier for an entity within an EntityPool. More...

Variables Index

constexpr no_init_tno_init

Tag constant for requesting uninitialized construction. More...

constexpr size_tEntityTombstone = std::numeric_limits<size_t>::max()

Sentinel value indicating an invalid or removed sparse index. More...

Typedefs

EntityId

using helios::core::types::EntityId = uint32_t

Unique identifier for an entity within an EntityPool.

Used as the index into the sparse array of an EntityPool. Combined with a VersionId in an EntityHandle, it enables safe entity references that detect stale handles after entity removal.

See Also

EntityHandle

See Also

VersionId

See Also

EntityPool

Definition at line 106 of file types.ixx.

106 using EntityId = uint32_t;

StrongId_t

using helios::core::types::StrongId_t = uint32_t

Underlying integer type for all strong identifiers.

`StrongId_t` is the common numeric representation used by `StrongId<Tag>` and related lookup structures (e.g., `EntityRegistry`, `LinearLookupStrategy`, `HashedLookupStrategy`). Centralising the typedef ensures a consistent width across the entire identifier subsystem.

See Also

helios::core::data::StrongId

See Also

EntityId

See Also

VersionId

Definition at line 77 of file types.ixx.

77 using StrongId_t = uint32_t;

VersionId

using helios::core::types::VersionId = uint32_t

Version number for detecting stale entity references.

Each entity slot in an EntityPool has an associated version that is incremented when the entity is removed. EntityHandles store both the EntityId and VersionId, allowing the pool to detect when a handle refers to a recycled slot.

A valid version starts at 1 (uninitialized handles have version 0).

See Also

EntityHandle

See Also

EntityId

See Also

EntityPool

Definition at line 93 of file types.ixx.

93 using VersionId = uint32_t;

Variables

EntityTombstone

size_t helios::core::types::EntityTombstone = std::numeric_limits<size_t>::max()
constexpr

Sentinel value indicating an invalid or removed sparse index.

Used in sparse-set data structures (e.g., EntityPool, GameObjectPool) to mark slots that do not contain valid entity references. When a slot contains this value, the corresponding entity has been removed or was never assigned.

See Also

EntityPool

See Also

GameObjectPool

Definition at line 119 of file types.ixx.

119 constexpr size_t EntityTombstone = std::numeric_limits<size_t>::max();

no_init

no_init_t helios::core::types::no_init
constexpr

Tag constant for requesting uninitialized construction.

This is a convenience instance of `no_init_t` that can be passed to constructors supporting uninitialized construction.

```cpp helios::util::Guid id{helios::core::types::no_init}; ```

See Also

no_init_t

See Also

helios::util::Guid

Definition at line 62 of file types.ixx.

62 inline constexpr no_init_t no_init;

Referenced by helios::engine::mechanics::scoring::components::MaxScoreObserverComponent::helios::engine::mechanics::scoring::systems::MaxScoreObserverClearSystem, helios::engine::mechanics::scoring::components::ScoreObserverComponent::helios::engine::mechanics::scoring::systems::ScoreObserverClearSystem and helios::rendering::Viewport::Viewport.


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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.