Class SplineMovement

Follows a Catmull-Rom spline path through control points.

Hierarchy (View Summary)

Component
- SplineMovement

Index

Constructors

Properties

Methods

getProgress isCompleted onAttach onComplete onDetach reset setSpeed update

Constructors

constructor

new SplineMovement(
config: { loop?: boolean; points: PositionLike[]; speed?: number },
): SplineMovement
Parameters
- config: { loop?: boolean; points: PositionLike[]; speed?: number }
Returns SplineMovement
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:16

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

getProgress

getProgress(): number
Returns number
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:34

isCompleted

isCompleted(): boolean
Returns boolean
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:38

onAttach

onAttach(): void
Called when the component is added to an entity

Returns void
Inherited from Component.onAttach
- Defined in packages/clik-engine/src/entity/Component.ts:8

onComplete

onComplete(callback: () => void): this
Parameters
- callback: () => void
Returns this
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:24

onDetach

onDetach(): void
Called when the component is removed or entity is destroyed

Returns void
Inherited from Component.onDetach
- Defined in packages/clik-engine/src/entity/Component.ts:14

reset

reset(): void
Called when the owning entity is recycled from a pool. Reset internal state to defaults.

Returns void
Overrides Component.reset
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:64

setSpeed

setSpeed(speed: number): this
Parameters
- speed: number
Returns this
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:29

update

update(delta: number): void
Called every frame
Parameters
- delta: number
Returns void
Overrides Component.update
- Defined in packages/clik-engine/src/entity/components/SplineMovement.ts:42