Skip to main content

WorldLifecycleCommand Class

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

Declaration​

class helios::engine::mechanics::lifecycle::commands::WorldLifecycleCommand { ... }

Public Constructors Index​

WorldLifecycleCommand (const WorldLifecycleAction action) noexcept

Constructs a command with the specified action. More...

Public Member Functions Index​

WorldLifecycleActionaction () const noexcept

Returns the requested lifecycle action. More...

Private Member Attributes Index​

WorldLifecycleActionaction_

The lifecycle action to perform. More...

Description​

Command for requesting a world-level lifecycle operation.

Encapsulates a WorldLifecycleAction that is routed through the EngineCommandBuffer to the WorldLifecycleManager. The manager executes the requested action during its flush cycle.

See Also

WorldLifecycleAction

See Also

WorldLifecycleManager

Definition at line 26 of file WorldLifecycleCommand.ixx.

Public Constructors​

WorldLifecycleCommand()​

helios::engine::mechanics::lifecycle::commands::WorldLifecycleCommand::WorldLifecycleCommand (const WorldLifecycleAction action)
 inline explicit noexcept

Constructs a command with the specified action.

Parameters
action

The lifecycle action to request.

Definition at line 40 of file WorldLifecycleCommand.ixx.

40 explicit WorldLifecycleCommand(const WorldLifecycleAction action) noexcept
41 : action_(action) {}

Reference action.

Public Member Functions​

action()​

WorldLifecycleAction helios::engine::mechanics::lifecycle::commands::WorldLifecycleCommand::action ()
 inline nodiscard noexcept

Returns the requested lifecycle action.

Returns

The lifecycle action.

Definition at line 48 of file WorldLifecycleCommand.ixx.

48 [[nodiscard]] WorldLifecycleAction action() const noexcept {
49 return action_;
50 }

Referenced by WorldLifecycleCommand.

Private Member Attributes​

action_​

WorldLifecycleAction helios::engine::mechanics::lifecycle::commands::WorldLifecycleCommand::action_

The lifecycle action to perform.

Definition at line 31 of file WorldLifecycleCommand.ixx.

31 WorldLifecycleAction action_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.