EntityId.ixx File

Type alias for entity identifiers within an EntityPool. More...

Included Headers

#include <cstdint>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	ecs
	Core Entity-Component-System architecture. More...
namespace	types

Description

Type alias for entity identifiers within an EntityPool.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file EntityId.ixx

3 * @brief Type alias for entity identifiers within an EntityPool.

4 */

5module;

6

7#include <cstdint>

8

9export module helios.engine.ecs.types.EntityId;

10

11

12

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

14

15 /**

16 * @brief Unique identifier for an entity within an EntityPool.

17 *

18 * Used as the index into the sparse array of an EntityPool. Combined with

19 * a VersionId in an EntityHandle, it enables safe entity references that

20 * detect stale handles after entity removal.

21 *

22 * @see EntityHandle

23 * @see VersionId

24 * @see EntityPool

25 */

26 using EntityId = uint32_t;

27

28}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.