VersionId.ixx File

Type alias for entity version numbers used in handle validation. More...

Included Headers

#include <cstdint>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	common
	Shared type definitions, concepts, and tags used across engine subsystems. More...
namespace	types
	Shared context structs for entity-to-entity interactions. More...

Description

Type alias for entity version numbers used in handle validation.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file VersionId.ixx

3 * @brief Type alias for entity version numbers used in handle validation.

4 */

5module;

6

7#include <cstdint>

8

9export module helios.engine.common.types.VersionId;

10

11

12

13export namespace helios::engine::common::types {

14

15 /**

16 * @brief Version number for detecting stale entity references.

17 *

18 * Each entity slot in an EntityPool has an associated version that is

19 * incremented when the entity is removed. EntityHandles store both the

20 * EntityId and VersionId, allowing the pool to detect when a handle

21 * refers to a recycled slot.

22 *

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

24 *

25 * @see EntityHandle

26 * @see EntityId

27 * @see EntityPool

28 */

29 using VersionId = uint32_t;

30

31}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.