Skip to main content

SpawnSystemConfigurator Class

Lightweight handle for chaining pool configurations. More...

Declaration

class helios::engine::builder::spawnSystem::builders::configs::SpawnSystemConfigurator { ... }

Public Constructors Index

SpawnSystemConfigurator (helios::engine::runtime::pooling::GameObjectPoolManager &poolManager, helios::engine::runtime::spawn::SpawnManager &spawnManager) noexcept

Constructs a configurator with the given managers. More...

Public Member Functions Index

SpawnPoolConfigpool (helios::engine::runtime::pooling::types::GameObjectPoolId poolId, helios::engine::common::types::PrefabId prefabId, size_t poolSize)

Begins ID-centric configuration of a spawn pool. More...

Private Member Attributes Index

helios::engine::runtime::pooling::GameObjectPoolManager &poolManager_

The pool manager for pool registration. More...

helios::engine::runtime::spawn::SpawnManager &spawnManager_

The spawn manager for profile and scheduler registration. More...

Description

Lightweight handle for chaining pool configurations.

Returned by commit() and commitCyclic() to allow starting the next pool() call. Holds only the two manager references.

Definition at line 43 of file SpawnPoolConfig.ixx.

Public Constructors

SpawnSystemConfigurator()

helios::engine::builder::spawnSystem::builders::configs::SpawnSystemConfigurator::SpawnSystemConfigurator (helios::engine::runtime::pooling::GameObjectPoolManager & poolManager, helios::engine::runtime::spawn::SpawnManager & spawnManager)
inline noexcept

Constructs a configurator with the given managers.

Parameters
poolManager

The pool manager for pool registration.

spawnManager

The spawn manager for profile and scheduler registration.

Definition at line 63 of file SpawnPoolConfig.ixx.

66 ) noexcept : poolManager_(poolManager), spawnManager_(spawnManager) {}

Public Member Functions

pool()

SpawnPoolConfig helios::engine::builder::spawnSystem::builders::configs::SpawnSystemConfigurator::pool (helios::engine::runtime::pooling::types::GameObjectPoolId poolId, helios::engine::common::types::PrefabId prefabId, size_t poolSize)
inline nodiscard

Begins ID-centric configuration of a spawn pool.

Parameters
poolId

Unique pool identifier.

prefab

Template GameObject for cloning.

poolSize

Number of instances to pre-allocate.

Returns

SpawnPoolConfig for fluent configuration.

Definition at line 77 of file SpawnPoolConfig.ixx.

634 size_t poolSize
635 ) {
636 return SpawnPoolConfig{poolManager_, spawnManager_, poolId, prefabId, poolSize};
637 }

Private Member Attributes

poolManager_

helios::engine::runtime::pooling::GameObjectPoolManager& helios::engine::builder::spawnSystem::builders::configs::SpawnSystemConfigurator::poolManager_

The pool manager for pool registration.

Definition at line 48 of file SpawnPoolConfig.ixx.

spawnManager_

helios::engine::runtime::spawn::SpawnManager& helios::engine::builder::spawnSystem::builders::configs::SpawnSystemConfigurator::spawnManager_

The spawn manager for profile and scheduler registration.

Definition at line 53 of file SpawnPoolConfig.ixx.


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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.