DespawnRequest Struct

Data structure representing a request to despawn a GameObject. More...

Declaration

struct helios::engine::mechanics::spawn::requests::DespawnRequest { ... }

Public Member Attributes Index

const helios::util::Guid	entityId
	The GUID of the entity to despawn. More...
const std::optional< helios::engine::core::data::GameObjectPoolId >	gameObjectPoolId
	Optional pool ID to return the entity to. More...

Description

Data structure representing a request to despawn a GameObject.

DespawnRequest is a lightweight data transfer object used by the DespawnCommandDispatcher to communicate despawn parameters to the SpawnManager. It identifies the target entity by GUID and optionally specifies the pool to return it to.

See Also

DespawnCommand

See Also

SpawnManager

Definition at line 31 of file DespawnRequest.ixx.

Public Member Attributes

entityId

const helios::util::Guid helios::engine::mechanics::spawn::requests::DespawnRequest::entityId

The GUID of the entity to despawn.

Definition at line 36 of file DespawnRequest.ixx.

36 const helios::util::Guid entityId;

gameObjectPoolId

const std::optional<helios::engine::core::data::GameObjectPoolId> helios::engine::mechanics::spawn::requests::DespawnRequest::gameObjectPoolId

Optional pool ID to return the entity to.

If specified, the entity will be returned to this pool. If nullopt, the SpawnManager must determine the correct pool or handle the despawn without pool return.

Definition at line 45 of file DespawnRequest.ixx.

45 const std::optional<helios::engine::core::data::GameObjectPoolId> gameObjectPoolId;

---

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

• DespawnRequest.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.