Class CircularMovement

Orbits around a center point at a given radius and angular speed.

Hierarchy (View Summary)

Component
- CircularMovement

Index

Constructors

Properties

Methods

getAngle onAttach onDetach reset setAngularSpeed setCenter setRadius update

Constructors

constructor

new CircularMovement(
    config?: {
        angularSpeed?: number;
        centerX?: number;
        centerY?: number;
        radius?: number;
        startAngle?: number;
    },
): CircularMovement
Parameters
- config: {
      angularSpeed?: number;
      centerX?: number;
      centerY?: number;
      radius?: number;
      startAngle?: number;
  } = {}
Returns CircularMovement
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/CircularMovement.ts:13

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

getAngle

getAngle(): number
Returns number
- Defined in packages/clik-engine/src/entity/components/CircularMovement.ts:44

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

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/CircularMovement.ts:55

setAngularSpeed

setAngularSpeed(speed: number): this
Parameters
- speed: number
Returns this
- Defined in packages/clik-engine/src/entity/components/CircularMovement.ts:39

setCenter

setCenter(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in packages/clik-engine/src/entity/components/CircularMovement.ts:28

setRadius

setRadius(radius: number): this
Parameters
- radius: number
Returns this
- Defined in packages/clik-engine/src/entity/components/CircularMovement.ts:34

update

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