Class Collectible

Hierarchy (View Summary)

Component
- Collectible

Index

Constructors

Properties

Methods

collect getType getValue isCollected onAttach onCollect onDetach reset update

Constructors

constructor

new Collectible(type?: string, value?: number): Collectible
Parameters
- type: string = 'coin'
- value: number = 1
Returns Collectible
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:11

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

collect

collect(collector: GameObject): boolean
Parameters
- collector: GameObject
Returns boolean
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:22

getType

getType(): string
Returns string
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:34

getValue

getValue(): number
Returns number
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:38

isCollected

isCollected(): boolean
Returns boolean
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:30

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

onCollect

onCollect(callback: (collector: GameObject) => void): this
Parameters
- callback: (collector: GameObject) => void
Returns this
- Defined in packages/clik-engine/src/entity/components/Collectible.ts:17

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/Collectible.ts:42

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