Class FlashOnHit

Flashes the entity white (or custom color) when triggered. Useful for damage feedback.

Hierarchy (View Summary)

Component
- FlashOnHit

Index

Constructors

Properties

Methods

flash isFlashing onAttach onDetach reset update

Constructors

constructor

new FlashOnHit(durationMs?: number, color?: number): FlashOnHit
Parameters
- durationMs: number = 100
- color: number = 0xffffff
Returns FlashOnHit
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/FlashOnHit.ts:13

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

flash

flash(): void
Returns void
- Defined in packages/clik-engine/src/entity/components/FlashOnHit.ts:19

isFlashing

isFlashing(): boolean
Returns boolean
- Defined in packages/clik-engine/src/entity/components/FlashOnHit.ts:52

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/FlashOnHit.ts:56

update

update(delta: number): void
Called every frame
Parameters
- delta: number
Returns void
Inherited from Component.update
- Defined in packages/clik-engine/src/entity/Component.ts:11