Skip to content

ParticleContainer

Defined in: display/ParticleContainer.ts:37

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

  • ParticleContainer

Type Parameters

A extends Application = Application

Implements

Constructors

new ParticleContainer()

new ParticleContainer<A>(config): ParticleContainer<A>

Defined in: display/ParticleContainer.ts:49

The constructor for the Container class.

Parameters

config

Partial<ParticleContainerConfig> = {}

The configuration for the container.

Returns

ParticleContainer<A>

Overrides

PIXIParticleContainer.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean = true

Defined in: display/ParticleContainer.ts:42


onDestroy

onDestroy: Signal<() => void>

Defined in: display/ParticleContainer.ts:41

Implementation of

IParticleContainer.onDestroy

Accessors

app

Get Signature

get app(): A

Defined in: display/ParticleContainer.ts:62

Get the application instance.

Returns

A

Implementation of

IParticleContainer.app

Methods

added()

added(): void

Defined in: display/ParticleContainer.ts:84

This method is called when the container is added to the stage. It is meant to be overridden by subclasses.

Returns

void

Implementation of

IParticleContainer.added


destroy()

destroy(options?): void

Defined in: display/ParticleContainer.ts:86

Destroys this sprite renderable and optionally its texture.

Parameters

options?

DestroyOptions

Options parameter. A boolean will act as if all options have been set to that value

Returns

void

Implementation of

IParticleContainer.destroy

Overrides

PIXIParticleContainer.destroy


removed()

removed(): void

Defined in: display/ParticleContainer.ts:94

Returns

void


resize()

resize(size?): void

Defined in: display/ParticleContainer.ts:77

Resize the container. This method is meant to be overridden by subclasses.

Parameters

size?

Size

Returns

void


update()

update(ticker?): void

Defined in: display/ParticleContainer.ts:69

Update the container. This method is meant to be overridden by subclasses.

Parameters

ticker?

number | Ticker

Returns

void

Implementation of

IParticleContainer.update

Overrides

PIXIParticleContainer.update