ParticleContainer
Defined in: display/ParticleContainer.ts:36
The Container class extends the _Container class (which includes the Animated and Factory mixins) and implements the IContainer interface. It represents a container for PIXI.js display objects.
Extends
Section titled “Extends”ParticleContainer
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ParticleContainer(
config):ParticleContainer
Defined in: display/ParticleContainer.ts:45
The constructor for the Container class.
Parameters
Section titled “Parameters”config
Section titled “config”Partial<ParticleContainerConfig> = {}
The configuration for the container.
Returns
Section titled “Returns”ParticleContainer
Overrides
Section titled “Overrides”PIXIParticleContainer.constructor
Properties
Section titled “Properties”__dill_pixel_method_binding_root
Section titled “__dill_pixel_method_binding_root”__dill_pixel_method_binding_root:
boolean=true
Defined in: display/ParticleContainer.ts:38
onDestroy
Section titled “onDestroy”onDestroy:
Signal<() =>void>
Defined in: display/ParticleContainer.ts:37
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
Application
Defined in: display/ParticleContainer.ts:58
Get the application instance.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”added()
Section titled “added()”added():
void
Defined in: display/ParticleContainer.ts:80
This method is called when the container is added to the stage. It is meant to be overridden by subclasses.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”destroy()
Section titled “destroy()”destroy(
options?):void
Defined in: display/ParticleContainer.ts:82
Destroys this sprite renderable and optionally its texture.
Parameters
Section titled “Parameters”options?
Section titled “options?”DestroyOptions
Options parameter. A boolean will act as if all options have been set to that value
Returns
Section titled “Returns”void
Example
Section titled “Example”particleContainer.destroy();particleContainer.destroy(true);particleContainer.destroy({ texture: true, textureSource: true, children: true });Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”PIXIParticleContainer.destroy
removed()
Section titled “removed()”removed():
void
Defined in: display/ParticleContainer.ts:90
Returns
Section titled “Returns”void
resize()
Section titled “resize()”resize(
size?):void
Defined in: display/ParticleContainer.ts:73
Resize the container. This method is meant to be overridden by subclasses.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
update()
Section titled “update()”update(
ticker?):void
Defined in: display/ParticleContainer.ts:65
Update the container. This method is meant to be overridden by subclasses.
Parameters
Section titled “Parameters”ticker?
Section titled “ticker?”number | Ticker
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”PIXIParticleContainer.update