Skip to main content

helios/engine/common/types/README.md File

Namespaces Index

namespacetypes

Shared context structs for entity-to-entity interactions. More...

File Listing

The file content with the documentation metadata removed is:

 # helios::engine::common::types
 
 Shared context structs for entity-to-entity interactions.
 
 ## Types
 
 | Type | Description |
 |------|-------------|
 | `InteractionContext` | Base context carrying target, instigator, causer, and contact point |
 | `DamageContext` | Extends InteractionContext with a damage amount |
 
 ## InteractionContext
 
 Generic interaction between two entities:
 - `target` – Entity affected by the interaction
 - `instigator` – Entity that initiated the interaction
 - `causer` – Entity that directly caused the interaction (e.g. projectile)
 - `contact` – World-space contact point
 
 ## DamageContext
 
 Builds on InteractionContext by adding:
 - `interactionContext` – The underlying interaction
 - `damage` – Amount of damage to apply
 
 Used by `HealthManager` and `ApplyDamageCommand` to transport damage
 information from the collision/combat layer to the health system.
 
 ---
 
 <details>
 <summary>Doxygen</summary><p>
 @namespace helios::engine::common::types
 @brief Shared context structs for entity-to-entity interactions.
 @details Contains InteractionContext and DamageContext used across combat, health, and scoring subsystems.
 </p></details>
 

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.