ScheduledSpawnPlanCommand Class

Command for executing a scheduled spawn plan. More...

Declaration

class helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand { ... }

Public Constructors Index

	ScheduledSpawnPlanCommand (const SpawnProfileId spawnProfileId, const SpawnPlan spawnPlan, const SpawnContext &spawnContext)
	Constructs a command with the given spawn plan. More...

Public Member Functions Index

SpawnProfileId	spawnProfileId () const noexcept
	Retrieves the spawn profile identifier associated with the command. More...
SpawnPlan	spawnPlan () const noexcept
	Returns the spawn plan associated with this instance. More...
SpawnContext	spawnContext () const noexcept
	Retrieves the spawn context associated with this instance. More...

Private Member Attributes Index

helios::engine::runtime::spawn::types::SpawnProfileId	spawnProfileId_
	Profile identifying the spawn configuration. More...
helios::engine::runtime::spawn::scheduling::SpawnPlan	spawnPlan_
	The spawn plan containing rule ID and amount. More...
SpawnContext	spawnContext_
	Context providing spawn-time information. More...

Description

Command for executing a scheduled spawn plan.

ScheduledSpawnPlanCommand wraps a ScheduledSpawnPlan and routes it to the appropriate dispatcher for execution. The command itself does not perform spawning directly; instead, it delegates to a dispatcher which forwards the command to the SpawnManager.

## Execution Flow

1. GameObjectSpawnSystem creates command from ScheduledSpawnPlan 2. Command is added to CommandBuffer 3. CommandBuffer flushes and calls accept() on each command 4. Dispatcher routes command to SpawnManager 5. SpawnManager processes the spawn command

See Also

ScheduledSpawnPlan

See Also

ScheduledSpawnPlanCommandDispatcher

See Also

SpawnManager

Definition at line 44 of file ScheduledSpawnPlanCommand.ixx.

Public Constructors

ScheduledSpawnPlanCommand()

helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::ScheduledSpawnPlanCommand (const SpawnProfileId spawnProfileId, const SpawnPlan spawnPlan, const SpawnContext & spawnContext)

inline explicit

Constructs a command with the given spawn plan.

Parameters

spawnProfileId	The profile ID for spawning.
spawnPlan	The spawn plan containing rule ID and amount.
spawnContext	The context for spawn operations.

Definition at line 70 of file ScheduledSpawnPlanCommand.ixx.

70 explicit ScheduledSpawnPlanCommand(

71 const SpawnProfileId spawnProfileId,

72 const SpawnPlan spawnPlan,

73 const SpawnContext& spawnContext

74 ) :

75 spawnProfileId_(spawnProfileId),

76 spawnPlan_(spawnPlan),

77 spawnContext_(spawnContext)

78 {}

References spawnContext, spawnPlan and spawnProfileId.

Public Member Functions

spawnContext()

SpawnContext helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnContext ()

inline nodiscard noexcept

Retrieves the spawn context associated with this instance.

Returns

The spawn context.

Definition at line 103 of file ScheduledSpawnPlanCommand.ixx.

103 [[nodiscard]] SpawnContext spawnContext() const noexcept {

104 return spawnContext_;

105 }

Referenced by ScheduledSpawnPlanCommand.

spawnPlan()

SpawnPlan helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnPlan ()

inline nodiscard noexcept

Returns the spawn plan associated with this instance.

Returns

A structured plan that can be executed by the spawn management system.

Definition at line 94 of file ScheduledSpawnPlanCommand.ixx.

94 [[nodiscard]] SpawnPlan spawnPlan() const noexcept {

95 return spawnPlan_;

96 }

Referenced by ScheduledSpawnPlanCommand.

spawnProfileId()

SpawnProfileId helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnProfileId ()

inline nodiscard noexcept

Retrieves the spawn profile identifier associated with the command.

Returns

The spawn profile identifier encapsulated within the ScheduledSpawnPlanCommand.

Definition at line 85 of file ScheduledSpawnPlanCommand.ixx.

85 [[nodiscard]] SpawnProfileId spawnProfileId() const noexcept {

86 return spawnProfileId_;

87 }

Referenced by ScheduledSpawnPlanCommand.

Private Member Attributes

spawnContext_

SpawnContext helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnContext_

Context providing spawn-time information.

Definition at line 59 of file ScheduledSpawnPlanCommand.ixx.

59 SpawnContext spawnContext_;

spawnPlan_

helios::engine::runtime::spawn::scheduling::SpawnPlan helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnPlan_

The spawn plan containing rule ID and amount.

Definition at line 54 of file ScheduledSpawnPlanCommand.ixx.

54 helios::engine::runtime::spawn::scheduling::SpawnPlan spawnPlan_;

spawnProfileId_

helios::engine::runtime::spawn::types::SpawnProfileId helios::engine::runtime::spawn::commands::ScheduledSpawnPlanCommand::spawnProfileId_

Profile identifying the spawn configuration.

Definition at line 49 of file ScheduledSpawnPlanCommand.ixx.

49 helios::engine::runtime::spawn::types::SpawnProfileId spawnProfileId_;

---

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

• ScheduledSpawnPlanCommand.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.