ParticleEmitter

class ParticleEmitter extends Container

Particle Emitter Object.

Constructor


new ParticleEmitter(x: number, y: number, settings: ParticleEmitterSettings) → {}
 // Create a particle emitter at position 100, 100
 let emitter = new ParticleEmitter(100, 100, {
     width: 16,
     height : 16,
     tint: "#f00",
     totalParticles: 32,
     angle: 0,
     angleVariation: 6.283185307179586,
     maxLife: 5,
     speed: 3
 });

 // Add the emitter to the game world
 me.game.world.addChild(emitter);

 // Launch all particles one time and stop, like a explosion
 emitter.burstParticles();

 // Launch constantly the particles, like a fountain
 emitter.streamParticles();

 // At the end, remove emitter from the game world
 // call this in onDestroyEvent function
 me.game.world.removeChild(emitter);
Parameters:
Name Type Attributes Default Description
x number

x position of the particle emitter

y number

y position of the particle emitter

settings ParticleEmitterSettings

<optional>

ParticleEmitterSettings

the settings for the particle emitter.

Summary


Properties from ParticleEmitter

Methods from ParticleEmitter

burstParticles(total: number)
number
getRandomPointX()
number
getRandomPointY()
boolean
isRunning()
reset(settings: ParticleEmitterSettings)
stopStream()

Stop the emitter from generating new particles (used only if emitter is Stream)

streamParticles(duration: number)

Properties inherited from Rect

number
bottom
number
centerX
number
centerY
number
height
number
left
number
right
number
top
string
type = "Rectangle"
number
width

Properties inherited from Polygon

Array<Vector2d>
points

Methods inherited from Container

Renderable
addChild(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, z: number)
Renderable
addChildAt(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, index: number)
forEach(callback: Function, thisArg: object)
Renderable
getChildAt(index: number)
Renderable
getChildByGUID(guid: string | RegExp | number | boolean)
Array<Renderable>
getChildByName(name: string | RegExp | number | boolean)
Array<Renderable>
getChildByProp(prop: string, value: string | RegExp | number | boolean)
Array<Renderable>
getChildByType(classType: object)
number
getChildIndex(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
Array<Renderable>
getChildren()
Renderable
getNextChild(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
Container
getRootAncestor()
boolean
hasChild(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
boolean
isAttachedToRoot()
moveDown(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
moveToBottom(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
moveToTop(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
moveUp(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
onChildChange(index: number)
removeChild(child: RendRenderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapTexterable, keepalive: boolean)
removeChildNow(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, keepalive: boolean)
setChildsProperty(prop: string, value: object, recursive: boolean)
sort(recursive: boolean)
swapChildren(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, child2: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText)
Bounds
updateBounds(absolute: boolean)
protected draw(renderer: CanvasRenderer | WebGLRenderer, viewport: Camera2d)
boolean
protected update(dt: number)

Public Properties


settings emitter.js:63
settings: ParticleEmitterSettings

ParticleEmitterSettings

the current (active) emitter settings

Public Methods


burstParticles emitter.js:180
burstParticles(total: number) → {}

Launch all particles from emitter and stop (e.g. for explosion)

Parameters:
Name Type Attributes Description
total number

<optional>

number of particles to launch

getRandomPointX emitter.js:128
getRandomPointX() → {number}

returns a random point on the x axis within the bounds of this emitter

Returns:
Type Description
number
getRandomPointY emitter.js:136
getRandomPointY() → {number}

returns a random point on the y axis within the bounds this emitter

Returns:
Type Description
number
isRunning emitter.js:154
isRunning() → {boolean}

Emitter is of type stream and is launching particles

Returns:
Type Description
boolean

Emitter is Stream and is launching particles

reset emitter.js:111
reset(settings: ParticleEmitterSettings) → {}

Reset the emitter with particle emitter settings.

Parameters:
Name Type Description
settings ParticleEmitterSettings

[optional] object with emitter settings. See ParticleEmitterSettings

stopStream emitter.js:173
stopStream() → {}

Stop the emitter from generating new particles (used only if emitter is Stream)

streamParticles emitter.js:162
streamParticles(duration: number) → {}

Launch particles from emitter constantly (e.g. for stream)

Parameters:
Name Type Attributes Description
duration number

<optional>

time that the emitter releases particles in ms


Powered by webdoc!