CollisionConfig Class

Fluent configuration for collision detection setup. More...

Declaration

class helios::engine::builder::gameObject::builders::configs::CollisionConfig { ... }

Public Constructors Index

	CollisionConfig (helios::engine::ecs::GameObject gameObject)
	Constructs a CollisionConfig and adds CollisionStateComponent. More...

Public Member Functions Index

CollisionConfig &	useBoundingBox ()
	Adds AABB collider for bounding box collision. More...
CollisionConfig &	layerId (const uint32_t layerId)
	Sets the collision layer ID. More...
CollisionConfig &	hitPolicy (const helios::engine::modules::physics::collision::types::HitPolicy hitPolicy)
	Sets the hit policy for collision detection. More...
CollisionConfig &	reportCollisions (bool isCollisionReporter)
	Sets whether this entity reports collisions. More...
CollisionConfig &	solidCollisionMask (const uint32_t solidCollisionMask)
	Sets the solid collision mask. More...
CollisionConfig &	onSolidCollision (const uint32_t otherLayerId, const helios::engine::modules::physics::collision::types::CollisionBehavior collisionBehavior)
	Adds a collision behavior for a specific layer. More...
CollisionConfig &	dealDamage (const float damageAmount, const uint32_t otherLayerId)
	Configures damage dealing on collision with a specific layer. More...

Private Member Functions Index

void	ensureCollisionComponent (const bool isAvailable) const noexcept
	Validates CollisionComponent presence. More...

Private Member Attributes Index

helios::engine::ecs::GameObject	gameObject_
	Non-owning pointer to the target GameObject. More...

Description

Fluent configuration for collision detection setup.

Automatically adds CollisionStateComponent and provides methods for configuring collision layers, masks, and behaviors.

Definition at line 27 of file CollisionConfig.ixx.

Public Constructors

CollisionConfig()

helios::engine::builder::gameObject::builders::configs::CollisionConfig::CollisionConfig (helios::engine::ecs::GameObject gameObject)

inline explicit

Constructs a CollisionConfig and adds CollisionStateComponent.

Parameters

<a href="/docs/helios/namespaces/helios/engine/builder/gameobject">gameObject</a>

Target GameObject to configure.

Definition at line 58 of file CollisionConfig.ixx.

58 explicit CollisionConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {

59

60 gameObject.add<helios::engine::modules::physics::collision::components::CollisionStateComponent>();

61

62 }

Referenced by dealDamage, hitPolicy, layerId, onSolidCollision, reportCollisions, solidCollisionMask and useBoundingBox.

Public Member Functions

dealDamage()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::dealDamage (const float damageAmount, const uint32_t otherLayerId)

inline

Configures damage dealing on collision with a specific layer.

Adds or updates a DamageDealerComponent to deal the specified damage when colliding with entities on the given layer.

Parameters

damageAmount	The amount of damage to deal.
otherLayerId	The layer to deal damage to.

Returns

Reference to this config for chaining.

Definition at line 175 of file CollisionConfig.ixx.

175 CollisionConfig& dealDamage(

176 const float damageAmount,

177 const uint32_t otherLayerId

178 ) {

179 ensureCollisionComponent(true);

180

181 gameObject_.getOrAdd<helios::engine::mechanics::damage::components::DamageDealerComponent>()

182 .setDamage(damageAmount, otherLayerId);

183

184 return *this;

185 }

Reference CollisionConfig.

hitPolicy()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::hitPolicy (const helios::engine::modules::physics::collision::types::HitPolicy hitPolicy)

inline

Sets the hit policy for collision detection.

Controls how many collision events this entity receives per frame:

• `OneHit`: Only the first collision is reported (default)
• `All`: All collisions with overlapping entities are reported

Parameters

hitPolicy

The hit policy to apply.

Returns

Reference to this config for chaining.

See Also

HitPolicy

Definition at line 103 of file CollisionConfig.ixx.

103 CollisionConfig& hitPolicy(const helios::engine::modules::physics::collision::types::HitPolicy hitPolicy) {

104

105 ensureCollisionComponent(true);

106

107 gameObject_.get<helios::engine::modules::physics::collision::components::CollisionComponent>()

108 ->setHitPolicy(hitPolicy);

109

110 return *this;

111 }

References CollisionConfig and hitPolicy.

Referenced by hitPolicy.

layerId()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::layerId (const uint32_t layerId)

inline

Sets the collision layer ID.

Parameters

layerId

The layer this entity belongs to.

Returns

Reference to this config for chaining.

Definition at line 81 of file CollisionConfig.ixx.

81 CollisionConfig& layerId(const uint32_t layerId) {

82

83 ensureCollisionComponent(false);

84

85 gameObject_.add<helios::engine::modules::physics::collision::components::CollisionComponent>(layerId);

86

87 return *this;

88 }

References CollisionConfig and layerId.

Referenced by layerId.

onSolidCollision()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::onSolidCollision (const uint32_t otherLayerId, const helios::engine::modules::physics::collision::types::CollisionBehavior collisionBehavior)

inline

Adds a collision behavior for a specific layer.

Parameters

otherLayerId	The layer to respond to.
collisionBehavior	The behavior when colliding.

Returns

Reference to this config for chaining.

Definition at line 152 of file CollisionConfig.ixx.

152 CollisionConfig& onSolidCollision(

153 const uint32_t otherLayerId,

154 const helios::engine::modules::physics::collision::types::CollisionBehavior collisionBehavior

155 ) {

156 ensureCollisionComponent(true);

157

158 gameObject_.get<helios::engine::modules::physics::collision::components::CollisionComponent>()

159 ->addSolidCollisionBehavior(collisionBehavior, otherLayerId);

160

161 return *this;

162 }

Reference CollisionConfig.

reportCollisions()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::reportCollisions (bool isCollisionReporter)

inline

Sets whether this entity reports collisions.

Parameters

isCollisionReporter

True to generate collision events.

Returns

Reference to this config for chaining.

Definition at line 120 of file CollisionConfig.ixx.

120 CollisionConfig& reportCollisions(bool isCollisionReporter) {

121

122 ensureCollisionComponent(true);

123

124 gameObject_.get<helios::engine::modules::physics::collision::components::CollisionComponent>()

125 ->setIsCollisionReporter(isCollisionReporter);

126 return *this;

127 }

Reference CollisionConfig.

solidCollisionMask()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::solidCollisionMask (const uint32_t solidCollisionMask)

inline

Sets the solid collision mask.

Parameters

solidCollisionMask

Bitmask of layers to collide with.

Returns

Reference to this config for chaining.

Definition at line 136 of file CollisionConfig.ixx.

136 CollisionConfig& solidCollisionMask(const uint32_t solidCollisionMask) {

137 ensureCollisionComponent(true);

138

139 gameObject_.get<helios::engine::modules::physics::collision::components::CollisionComponent>()

140 ->setSolidCollisionMask(solidCollisionMask);

141 return *this;

142 }

References CollisionConfig and solidCollisionMask.

Referenced by solidCollisionMask.

useBoundingBox()

CollisionConfig & helios::engine::builder::gameObject::builders::configs::CollisionConfig::useBoundingBox ()

inline

Adds AABB collider for bounding box collision.

Returns

Reference to this config for chaining.

Definition at line 69 of file CollisionConfig.ixx.

69 CollisionConfig& useBoundingBox() {

70 gameObject_.add<helios::engine::modules::physics::collision::components::AabbColliderComponent>();

71 return *this;

72 }

Reference CollisionConfig.

Private Member Functions

ensureCollisionComponent()

void helios::engine::builder::gameObject::builders::configs::CollisionConfig::ensureCollisionComponent (const bool isAvailable)

inline noexcept

Validates CollisionComponent presence.

Parameters

isAvailable

Whether the component should exist.

Definition at line 39 of file CollisionConfig.ixx.

39 void ensureCollisionComponent(const bool isAvailable) const noexcept {

40

41 auto* cc = gameObject_.get<helios::engine::modules::physics::collision::components::CollisionComponent>();

42

43 if (isAvailable) {

44 assert(cc && "CollisionComponent not configured");

45 } else {

46 assert(!cc && "CollisionComponent already configured");

47 }

48

49 }

Private Member Attributes

gameObject_

helios::engine::ecs::GameObject helios::engine::builder::gameObject::builders::configs::CollisionConfig::gameObject_

Non-owning pointer to the target GameObject.

Definition at line 32 of file CollisionConfig.ixx.

32 helios::engine::ecs::GameObject gameObject_;

---

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

• CollisionConfig.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.