Skip to main content

SteeringConfig Class

Fluent configuration for steering and rotation behavior. More...

Declaration​

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

Public Constructors Index​

SteeringConfig (helios::engine::ecs::GameObject gameObject)

Constructs a SteeringConfig and adds required components. More...

Public Member Functions Index​

SteeringConfig &instantSteering (const bool useInstantRotation)

Enables or disables instant rotation. More...

SteeringConfig &steeringSetsDirection (const bool directionFromSteering)

Sets whether steering input updates movement direction. More...

Private Member Attributes Index​

helios::engine::ecs::GameObjectgameObject_

Non-owning pointer to the target GameObject. More...

Description​

Fluent configuration for steering and rotation behavior.

Automatically adds required components:

  • SteeringComponent
  • ComposeTransformComponent
  • RotationStateComponent
  • DirectionComponent

Definition at line 24 of file SteeringConfig.ixx.

Public Constructors​

SteeringConfig()​

helios::engine::builder::gameObject::builders::configs::SteeringConfig::SteeringConfig (helios::engine::ecs::GameObject gameObject)
 inline explicit

Constructs a SteeringConfig and adds required components.

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

Target GameObject to configure.

Definition at line 38 of file SteeringConfig.ixx.

38 explicit SteeringConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {
39 gameObject_.add<helios::engine::modules::physics::motion::components::SteeringComponent>();
40
41 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::ComposeTransformComponent>();
42 gameObject_.getOrAdd<helios::engine::modules::spatial::transform::components::RotationStateComponent>();
43 gameObject_.getOrAdd<helios::engine::modules::physics::motion::components::DirectionComponent>();
44 }

Referenced by instantSteering and steeringSetsDirection.

Public Member Functions​

instantSteering()​

SteeringConfig & helios::engine::builder::gameObject::builders::configs::SteeringConfig::instantSteering (const bool useInstantRotation)
 inline

Enables or disables instant rotation.

When enabled, the entity rotates immediately to face target.

Parameters
useInstantRotation

True for instant rotation.

Returns

Reference to this config for chaining.

Definition at line 55 of file SteeringConfig.ixx.

55 SteeringConfig& instantSteering(const bool useInstantRotation) {
56 gameObject_.get<helios::engine::modules::physics::motion::components::SteeringComponent>()
57 ->setUseInstantRotation(useInstantRotation);
58
59 return *this;
60 }

Reference SteeringConfig.

steeringSetsDirection()​

SteeringConfig & helios::engine::builder::gameObject::builders::configs::SteeringConfig::steeringSetsDirection (const bool directionFromSteering)
 inline

Sets whether steering input updates movement direction.

Parameters
directionFromSteering

True to link direction to steering.

Returns

Reference to this config for chaining.

Definition at line 69 of file SteeringConfig.ixx.

69 SteeringConfig& steeringSetsDirection(const bool directionFromSteering) {
70 gameObject_.get<helios::engine::modules::physics::motion::components::SteeringComponent>()
71 ->setDirectionFromSteering(directionFromSteering);
72
73 return *this;
74 }

Reference SteeringConfig.

Private Member Attributes​

gameObject_​

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

Non-owning pointer to the target GameObject.

Definition at line 29 of file SteeringConfig.ixx.

29 helios::engine::ecs::GameObject gameObject_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.