Class ParticleEmitter

classdesc: Creates a DuckEngine ParticleEmitter
description: The ParticleEmitter Class. Emits, creates, and destroys particles
since: 1.0.0-beta

Hierarchy

ParticleEmitter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ParticleEmitter(particle: Particle, rangeX: Range, rangeY: Range, amount: number, game: Game, scene: Scene, autoCreate?: boolean): ParticleEmitter

- Defined in core/gameobjects/particles/particleEmitter.ts:103
description
Creates ParticleEmitter instance

since
1.0.0-beta

Parameters
- particle: Particle
  
  Base particle that is cloned and modified from
- rangeX: Range
  
  Where the new emitted particles x position is. A range of 2 values
- rangeY: Range
  
  Where the new emitted particles y position is. A range of 2 values
- amount: number
  
  Amount of starting particles
- game: Game
  
  Game instance
- scene: Scene
  
  Scene instance
- autoCreate: boolean = true
Returns ParticleEmitter

Properties

Readonly amount

amount: number

memberof: ParticleEmitter
description: The starting amount of particle
since: 1.0.0-beta

emitting

emitting: boolean

memberof: ParticleEmitter
description: Determines if the ParticleEmitter is emitting or not
since: 1.0.0-beta

enabled

enabled: boolean

memberof: ParticleEmitter
description: Determines if the ParticleEmitter is enabled or not
since: 2.0.0

Protected floatRangeX

floatRangeX: Range

Protected floatRangeY

floatRangeY: Range

game

game: Game

memberof: ParticleEmitter
description: Game instance
since: 1.0.0-beta

Readonly id

id: string

memberof: ParticleEmitter
description: A unique identifier for the ParticleEmitter
since: 1.0.0-beta

list

list: Particle[]

memberof: ParticleEmitter
description: The list of current particles
since: 1.0.0-beta

Protected particle

particle: Particle

rangeX

rangeX: Range

memberof: ParticleEmitter
description: A range of numbers where particle x pos will be
since: 1.0.0-beta

rangeY

rangeY: Range

memberof: ParticleEmitter
description: A range of numbers where particle y pos will be
since: 1.0.0-beta

scene

scene: Scene

memberof: ParticleEmitter
description: Scene instance
since: 1.0.0-beta

Methods

create

create(): void

- Defined in core/gameobjects/particles/particleEmitter.ts:138
memberof
ParticleEmitter

description
Creates an amount of particles

since
2.1.0

Returns void

createOne

createOne(): void

- Defined in core/gameobjects/particles/particleEmitter.ts:149
memberof
ParticleEmitter

description
Creates one particle

since
2.1.0

Returns void

emit

emit(): void

- Defined in core/gameobjects/particles/particleEmitter.ts:192
memberof
ParticleEmitter

description
Starts emitting particles

since
1.0.0-beta

Returns void

emitFor

emitFor(ms: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:213
memberof
ParticleEmitter

description
Starts emitting particles for a certain duration

since
1.0.0-beta

Parameters
- ms: number
  
  Duration in milliseconds
Returns void

float

float(rangeVX: Range, rangeVY: Range): void

- Defined in core/gameobjects/particles/particleEmitter.ts:451
memberof
ParticleEmitter

description
Sets the floatVelocity of all particles in between a range

since
1.0.0-beta

Parameters
- rangeVX: Range
  
  A range of 2 values for the floatVelocity.x, randomly chosen between that range
- rangeVY: Range
  
  A range of 2 values for the floatVelocity.y, randomly chosen between that range
Returns void

keepEmitting

keepEmitting(intervalMS: number, limitTo?: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:258
memberof
ParticleEmitter

description
Spawns new particles after the initial particles

since
1.0.0-beta

Parameters
- intervalMS: number
  
  How often a new particle gets spawned
- Optional limitTo: number
Returns void

offloadBounds

offloadBounds(bounds: BoundsLike): void

- Defined in core/gameobjects/particles/particleEmitter.ts:301
memberof
ParticleEmitter

description
Offloads particles based on position

since
2.0.0

Parameters
- bounds: BoundsLike
  
  The Bounds of the particles, a BoundsLike object that causes a particle to be offloaded
Returns void

offloadMaxAge

offloadMaxAge(ageInSeconds: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:371
memberof
ParticleEmitter

description
Offloads particles based on how many seconds they existed for

since
1.0.0

Parameters
- ageInSeconds: number
  
  Max amount of seconds a particle existed for
Returns void

offloadMaxAmount

offloadMaxAmount(limit: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:275
memberof
ParticleEmitter

description
Pops particles from the list if too many particles exist

since
1.0.0

Parameters
- limit: number
Returns void

setFillColor

setFillColor(fillColor: string): void

- Defined in core/gameobjects/particles/particleEmitter.ts:470
memberof
ParticleEmitter

description
Sets the fillColor of all particles

since
1.0.0-beta

Parameters
- fillColor: string
  
  Color
Returns void

setImagePath

setImagePath(imagePath: string): void

- Defined in core/gameobjects/particles/particleEmitter.ts:482
memberof
ParticleEmitter

description
Sets the imagePath of all particles

since
1.0.0

Parameters
- imagePath: string
  
  Image path
Returns void

setRange

setRange(rangeX: Range, rangeY: Range): void

- Defined in core/gameobjects/particles/particleEmitter.ts:227
memberof
ParticleEmitter

description
Sets the new or old particles' position range

since
1.0.0-beta

Parameters
- rangeX: Range
  
  Where the new emitted particles x position is. A range of 2 values
- rangeY: Range
  
  Where the new emitted particles y position is. A range of 2 values
Returns void

setVelocity

setVelocity(axis: "x" | "y", v: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:404
memberof
ParticleEmitter

description
Sets the velocity of all particles

since
1.0.0-beta

Parameters
- axis: "x" | "y"
  
  'x' or 'y' axis to change the velocity of all particles
- v: number
  
  Value to set the velocity of all particles
Returns void

stopEmit

stopEmit(): void

- Defined in core/gameobjects/particles/particleEmitter.ts:202
memberof
ParticleEmitter

description
Stops emitting particles

since
1.0.0-beta

Returns void

wobble

wobble(v: number): void

- Defined in core/gameobjects/particles/particleEmitter.ts:416
memberof
ParticleEmitter

description
Wobbles the particle on a random direction and axis

since
1.0.0-beta

Parameters
- v: number
  
  Value to set the wobble velocity to
Returns void

Generated using TypeDoc