WorldLifecycleCommand.ixx File

Command for requesting world-level lifecycle operations. More...

Included Headers

#include <helios.engine.mechanics.lifecycle.types>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	mechanics
	High-level gameplay systems and components for game logic. More...
namespace	lifecycle
	Lifecycle management for entity components and world-level operations. More...
namespace	commands
	World-level lifecycle commands for the command buffer. More...

Classes Index

class	WorldLifecycleCommand
	Command for requesting a world-level lifecycle operation. More...

Description

Command for requesting world-level lifecycle operations.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file WorldLifecycleCommand.ixx

3 * @brief Command for requesting world-level lifecycle operations.

4 */

5module;

6

7export module helios.engine.mechanics.lifecycle.commands.WorldLifecycleCommand;

8

9

10import helios.engine.mechanics.lifecycle.types;

11

12using namespace helios::engine::mechanics::lifecycle::types;

13

14export namespace helios::engine::mechanics::lifecycle::commands {

15

16 /**

17 * @brief Command for requesting a world-level lifecycle operation.

18 *

19 * @details Encapsulates a WorldLifecycleAction that is routed through

20 * the EngineCommandBuffer to the WorldLifecycleManager. The manager

21 * executes the requested action during its flush cycle.

22 *

23 * @see WorldLifecycleAction

24 * @see WorldLifecycleManager

25 */

26 class WorldLifecycleCommand {

27

28 /**

29 * @brief The lifecycle action to perform.

30 */

31 WorldLifecycleAction action_;

32

33 public:

34

35 /**

36 * @brief Constructs a command with the specified action.

37 *

38 * @param action The lifecycle action to request.

39 */

40 explicit WorldLifecycleCommand(const WorldLifecycleAction action) noexcept

41 : action_(action) {}

42

43 /**

44 * @brief Returns the requested lifecycle action.

45 *

46 * @return The lifecycle action.

47 */

48 [[nodiscard]] WorldLifecycleAction action() const noexcept {

49 return action_;

50 }

51 };

52

53}

54

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.