configs Folder
Files Index
| file | helios/engine/builder/gameObject/builders/configs/_module.ixx |
|
Module aggregation for helios.engine.builder.gameObject.builders.configs. More... | |
| file | ChaseConfig.ixx |
|
Configuration for AI chase behavior. More... | |
| file | CollisionConfig.ixx |
|
Configuration for collision detection components. More... | |
| file | CombatConfig.ixx |
| file | GfxEffectsConfig.ixx |
|
Configuration for visual effects components. More... | |
| file | HealthConfig.ixx |
|
Configuration for health components. More... | |
| file | LevelBoundsCollisionConfig.ixx |
|
Configuration for level boundary collision behavior. More... | |
| file | LifecycleConfig.ixx |
|
Configuration class for lifecycle and delayed component activation. More... | |
| file | MeshRenderableConfig.ixx |
|
Configuration for renderable components (mesh, material, shader). More... | |
| file | Move2DConfig.ixx |
|
Configuration for 2D movement components. More... | |
| file | ObserverConfig.ixx |
|
Configuration for observer components. More... | |
| file | SceneNodeConfig.ixx |
|
Configuration for scene graph integration. More... | |
| file | ScorePoolConfig.ixx |
|
Configuration for score pool association components. More... | |
| file | ScoreValueConfig.ixx |
|
Configuration for score value components. More... | |
| file | SpawnConfig.ixx |
|
Configuration for spawn system integration. More... | |
| file | SteeringConfig.ixx |
|
Configuration for steering/rotation components. More... | |
| file | TextRenderableConfig.ixx |
|
Configuration for renderable components (mesh, material, shader). More... | |
| file | TransformConfig.ixx |
|
Configuration for spatial transform components. More... | |
| file | UiTransformConfig.ixx |
|
Configuration for spatial transform components. More... | |
| file | WeaponConfig.ixx |
|
Configuration for weapon and combat components. More... | |
Description
helios::engine::builder::gameObject::builders::configs
Fine-grained configuration classes for component setup.
Overview
Config classes provide a fluent interface for adding and configuring specific components on a GameObject. Each config is responsible for a narrow domain and automatically handles component dependencies.
Config Classes
Motion
| Config | Components Added | Purpose |
|---|---|---|
| Move2DConfig | Move2DComponent, ComposeTransformComponent, DirectionComponent, TranslationStateComponent | 2D movement with acceleration |
| SteeringConfig | SteeringComponent, ComposeTransformComponent, RotationStateComponent, DirectionComponent | Rotation and steering |
Rendering
| Config | Components Added | Purpose |
|---|---|---|
| MeshRenderableConfig | RenderableComponent | Mesh, material, shader setup |
| SceneNodeConfig | SceneNodeComponent | Scene graph integration |
Spatial
| Config | Components Added | Purpose |
|---|---|---|
| TransformConfig | ComposeTransformComponent, ScaleStateComponent, TranslationStateComponent | Transform setup |
Physics
| Config | Components Added | Purpose |
|---|---|---|
| CollisionConfig | CollisionStateComponent, AabbColliderComponent, CollisionComponent | Collision detection |
| LevelBoundsCollisionConfig | LevelBoundsBehaviorComponent | Arena boundary responses |
Effects
| Config | Components Added | Purpose |
|---|---|---|
| GfxEffectsConfig | SpinComponent, RotationStateComponent | Visual effects |
Gameplay
| Config | Components Added | Purpose |
|---|---|---|
| SpawnConfig | SpawnedByProfileComponent | Spawn profile tracking |
| ChaseConfig | ChaseComponent | AI chase behavior |
| WeaponConfig | Aim2DComponent, ShootComponent | Weapon configuration |
Lifecycle
| Config | Components Added | Purpose |
|---|---|---|
| LifecycleConfig | DelayedComponentEnabler | Delayed component activation |
Usage Pattern
All configs follow the fluent builder pattern:
Automatic Dependencies
Configs automatically add required dependent components using getOrAdd(). This prevents duplicates when multiple configs share dependencies.
Example: Both Move2DConfig and SteeringConfig require ComposeTransformComponent. If both are used, only one instance is created.
Related Modules
| Module | Purpose |
|---|---|
| helios.engine.modules.physics | Motion and collision components |
| helios.engine.modules.spatial | Transform components |
| helios.engine.modules.rendering | Rendering components |
| helios.engine.mechanics | Gameplay components |
| helios.engine.mechanics.lifecycle | Lifecycle and delayed activation |
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.