Class BulletEmitter

Spawns bullets from an entity pool using configurable patterns. Attach to a weapon/turret/player entity.

Usage:

emitter = new BulletEmitter(bulletPool, { type: 'radial', count: 12 });
entity.addComponent('emitter', emitter);
emitter.fire(); // or setAutoFire(true)

Hierarchy (View Summary)

Component
- BulletEmitter

Index

Constructors

constructor

new BulletEmitter(
    pool: EntityPool,
    pattern: PatternConfig,
    bulletConfig?: BulletConfig,
): BulletEmitter
Parameters
- pool: EntityPool
- pattern: PatternConfig
- bulletConfig: BulletConfig = {}
Returns BulletEmitter
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:29

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

fire

fire(): Entity[]
Fire one burst of bullets according to the current pattern

Returns Entity[]
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.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

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/BulletEmitter.ts:95

setAutoFire

setAutoFire(enabled: boolean): this
Parameters
- enabled: boolean
Returns this
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:68

setBulletConfig

setBulletConfig(config: BulletConfig): this
Parameters
- config: BulletConfig
Returns this
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:78

setPattern

setPattern(pattern: PatternConfig): this
Parameters
- pattern: PatternConfig
Returns this
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:60

setTarget

setTarget(target: PositionLike | null): this
Parameters
- target: PositionLike | null
Returns this
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:73

update

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

`Static`aimedStream

aimedStream(
    pool: EntityPool,
    target: PositionLike,
    config?: Partial<PatternConfig> & BulletConfig,
): BulletEmitter
Parameters
- pool: EntityPool
- target: PositionLike
- Optionalconfig: Partial<PatternConfig> & BulletConfig
Returns BulletEmitter
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:169

`Static`radialBurst

radialBurst(
pool: EntityPool,
config?: Partial<PatternConfig> & BulletConfig,
): BulletEmitter
Parameters
- pool: EntityPool
- Optionalconfig: Partial<PatternConfig> & BulletConfig
Returns BulletEmitter
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:165

`Static`shotgunSpread

shotgunSpread(
pool: EntityPool,
config?: Partial<PatternConfig> & BulletConfig,
): BulletEmitter
Parameters
- pool: EntityPool
- Optionalconfig: Partial<PatternConfig> & BulletConfig
Returns BulletEmitter
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:179

`Static`spiral

spiral(
pool: EntityPool,
config?: Partial<PatternConfig> & BulletConfig,
): BulletEmitter
Parameters
- pool: EntityPool
- Optionalconfig: Partial<PatternConfig> & BulletConfig
Returns BulletEmitter
- Defined in packages/clik-engine/src/entity/components/BulletEmitter.ts:175

Class BulletEmitter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BulletEmitter

Properties

enabled

entity

Methods

fire

Returns Entity[]

onAttach

Returns void

onDetach

Returns void

reset

Returns void

setAutoFire

Parameters

Returns this

setBulletConfig

Parameters

Returns this

setPattern

Parameters

Returns this

setTarget

Parameters

Returns this

update

Parameters

Returns void

StaticaimedStream

Parameters

Returns BulletEmitter

StaticradialBurst

Parameters

Returns BulletEmitter

StaticshotgunSpread

Parameters

Returns BulletEmitter

Staticspiral

Parameters

Returns BulletEmitter

Settings

On This Page

`Static`aimedStream

`Static`radialBurst

`Static`shotgunSpread

`Static`spiral