Skip to main content

TriggerCollisionEvent Class

Event emitted when a trigger collision is detected. More...

Declaration​

class helios::engine::modules::physics::collision::events::TriggerCollisionEvent { ... }

Public Constructors Index​

TriggerCollisionEvent (const helios::engine::ecs::EntityHandle source, const collision::types::CollisionContext &collisionContext)

Constructs a TriggerCollisionEvent. More...

Public Member Functions Index​

const collision::types::CollisionContext &collisionContext () const noexcept

Returns the collision context. More...

helios::engine::ecs::EntityHandlesource () const noexcept

Returns the source entity handle. More...

Private Member Attributes Index​

collision::types::CollisionContextcollisionContext_

Context data describing the collision. More...

helios::engine::ecs::EntityHandlesource_

Handle of the entity that reported the collision. More...

Description​

Event emitted when a trigger collision is detected.

Trigger collisions are non-physical interactions used for gameplay logic such as pickups, damage zones, or area effects. Unlike solid collisions, trigger collisions do not block movement. This event is published to the event bus when an entity with PassEvent behavior detects a trigger collision.

Definition at line 24 of file TriggerCollisionEvent.ixx.

Public Constructors​

TriggerCollisionEvent()​

helios::engine::modules::physics::collision::events::TriggerCollisionEvent::TriggerCollisionEvent (const helios::engine::ecs::EntityHandle source, const collision::types::CollisionContext & collisionContext)
 inline explicit

Constructs a TriggerCollisionEvent.

Parameters
source

Handle of the reporting entity.

collisionContext

Context data describing the collision.

Definition at line 44 of file TriggerCollisionEvent.ixx.

44 explicit TriggerCollisionEvent(
45 const helios::engine::ecs::EntityHandle source,
46 const collision::types::CollisionContext& collisionContext
47 ) : collisionContext_(collisionContext), source_(source) {}

References collisionContext and source.

Public Member Functions​

collisionContext()​

const collision::types::CollisionContext & helios::engine::modules::physics::collision::events::TriggerCollisionEvent::collisionContext ()
 inline nodiscard noexcept

Returns the collision context.

Returns

Reference to the collision context data.

Definition at line 54 of file TriggerCollisionEvent.ixx.

54 [[nodiscard]] const collision::types::CollisionContext& collisionContext() const noexcept {
55 return collisionContext_;
56 }

Referenced by TriggerCollisionEvent.

source()​

helios::engine::ecs::EntityHandle helios::engine::modules::physics::collision::events::TriggerCollisionEvent::source ()
 inline nodiscard noexcept

Returns the source entity handle.

Returns

Handle of the entity that reported the collision.

Definition at line 63 of file TriggerCollisionEvent.ixx.

63 [[nodiscard]] helios::engine::ecs::EntityHandle source() const noexcept {
64 return source_;
65 }

Referenced by TriggerCollisionEvent.

Private Member Attributes​

collisionContext_​

collision::types::CollisionContext helios::engine::modules::physics::collision::events::TriggerCollisionEvent::collisionContext_

Context data describing the collision.

Definition at line 29 of file TriggerCollisionEvent.ixx.

29 collision::types::CollisionContext collisionContext_;

source_​

helios::engine::ecs::EntityHandle helios::engine::modules::physics::collision::events::TriggerCollisionEvent::source_

Handle of the entity that reported the collision.

Definition at line 34 of file TriggerCollisionEvent.ixx.

34 helios::engine::ecs::EntityHandle source_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.