Class Movement

Hierarchy (View Summary)

Component
- Movement

Index

Constructors

Properties

enabled entity friction speed

Methods

getVelocity isMoving moveInDirection moveToward onAttach onDetach reset setVelocity stop update

Constructors

constructor

new Movement(speed?: number, friction?: number): Movement
Parameters
- speed: number = 200
- friction: number = 0
Returns Movement
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/Movement.ts:10

Properties

enabled

enabled: boolean = true

entity

entity: Entity

friction

friction: number = 0

speed

speed: number = 200

Methods

getVelocity

getVelocity(): { x: number; y: number }
Returns { x: number; y: number }
- Defined in packages/clik-engine/src/entity/components/Movement.ts:58

isMoving

isMoving(): boolean
Returns boolean
- Defined in packages/clik-engine/src/entity/components/Movement.ts:62

moveInDirection

moveInDirection(dx: number, dy: number): void
Parameters
- dx: number
- dy: number
Returns void
- Defined in packages/clik-engine/src/entity/components/Movement.ts:21

moveToward

moveToward(targetX: number, targetY: number): void
Parameters
- targetX: number
- targetY: number
Returns void
- Defined in packages/clik-engine/src/entity/components/Movement.ts:33

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/Movement.ts:66

setVelocity

setVelocity(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in packages/clik-engine/src/entity/components/Movement.ts:16

stop

stop(): void
Returns void
- Defined in packages/clik-engine/src/entity/components/Movement.ts:39

update

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