Container

Defined in: display/Container.ts:63

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

IFactory<{ animatedSprite: (props?) => AnimatedSprite; bitmapText: (props?) => BitmapText; button: (props?) => Button; container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>; existing: <TEntity>(entity, props?) => TEntity; flexContainer: (props?) => FlexContainer; graphics: (props?) => Graphics; htmlText: (props?) => HTMLText; particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>; spine: (props?) => Spine; spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>; sprite: (props?) => Sprite; text: (props?) => Text; texture: (props?) => Texture; tilingSprite: (props?) => TilingSprite; toaster: (toasterConfig?, defaultToastConfig) => Toaster; uiCanvas: (props?) => UICanvas; svg: Svg; }, this> & ISignalContainer & IAnimated

Extended by

Type Parameters

A

A extends Application = Application

Implements

IContainer

Constructors

Constructor

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

Defined in: display/Container.ts:96

The constructor for the Container class.

Parameters

config

Partial<ContainerConfig> = {}

The configuration for the container.

Returns

Container<A>

Overrides

Animated(WithSignals(Factory())).constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean = true

Defined in: display/Container.ts:68

add

add: object

Defined in: mixins/factory/Factory.ts:6

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

Animated(WithSignals(Factory())).add

make

make: object

Defined in: mixins/factory/Factory.ts:7

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

Animated(WithSignals(Factory())).make

onAnimationComplete

onAnimationComplete: Signal<(entity) => void>

Defined in: mixins/animated.ts:21

Inherited from

Animated(WithSignals(Factory())).onAnimationComplete

onAnimationStart

onAnimationStart: Signal<(entity) => void>

Defined in: mixins/animated.ts:19

Inherited from

Animated(WithSignals(Factory())).onAnimationStart

onAnimationUpdate

onAnimationUpdate: Signal<(entity) => void>

Defined in: mixins/animated.ts:20

Inherited from

Animated(WithSignals(Factory())).onAnimationUpdate

onDestroy

onDestroy: Signal<() => void>

Defined in: display/Container.ts:67

Implementation of

IContainer.onDestroy

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

Animated(WithSignals(Factory())).signalConnections

onGlobalChildAdded

static onGlobalChildAdded: Signal<(child) => void>

Defined in: display/Container.ts:81

onGlobalChildRemoved

static onGlobalChildRemoved: Signal<(child) => void>

Defined in: display/Container.ts:82

Accessors

animationContext

Get Signature

get animationContext(): undefined | string

Defined in: display/Container.ts:72

Returns

undefined | string

Set Signature

set animationContext(value): void

Defined in: display/Container.ts:75

Parameters

value

string

Returns

void

Implementation of

IContainer.animationContext

app

Get Signature

get app(): A

Defined in: display/Container.ts:111

Get the application instance.

Returns

A

Implementation of

IContainer.app

Methods

addColoredBackground()

addColoredBackground(colorOrConfig, alpha): Sprite

Defined in: display/Container.ts:115

Parameters

colorOrConfig

number | Partial<BackgroundConfig>

alpha

number = 1

Returns

Sprite

Implementation of

IContainer.addColoredBackground

added()

added(): void

Defined in: display/Container.ts:174

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

Returns

void

Implementation of

IContainer.added

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Animated(WithSignals(Factory())).addSignalConnection

animate()

animate(animationProps, instance?): Tween

Defined in: mixins/animated.ts:23

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).animate

animateFrom()

animateFrom(animationProps, instance?): Tween

Defined in: mixins/animated.ts:25

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).animateFrom

animateFromTo()

animateFromTo(fromProps, toProps, instance?): Tween

Defined in: mixins/animated.ts:27

Parameters

fromProps

GSAPAnimationConfigExtended

toProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).animateFromTo

animateSequence()

animateSequence(sequences, instance?): Timeline

Defined in: mixins/animated.ts:33

Parameters

sequences

GSAPAnimationConfigExtended[]

instance?

any

Returns

Timeline

Inherited from

Animated(WithSignals(Factory())).animateSequence

bob()

bob(config?, instance?): Tween

Defined in: mixins/animated.ts:50

Parameters

config?

duration?

number

intensity?

number

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).bob

childAdded()

childAdded(child): void

Defined in: display/Container.ts:176

Parameters

child

Container

Returns

void

Implementation of

IContainer.childAdded

childRemoved()

childRemoved(child): void

Defined in: display/Container.ts:191

Parameters

child

Container

Returns

void

Implementation of

IContainer.childRemoved

connectAction()

connectAction(…args): void

Defined in: mixins/signals.ts:15

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Animated(WithSignals(Factory())).connectAction

connectSignal()

connectSignal(…args): void

Defined in: mixins/signals.ts:14

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Animated(WithSignals(Factory())).connectSignal

destroy()

destroy(options?): void

Defined in: display/Container.ts:180

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Parameters

options?

DestroyOptions

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

Returns

void

Example

container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });

Implementation of

IContainer.destroy

Overrides

Animated(WithSignals(Factory())).destroy

destroyAnimations()

destroyAnimations(): void

Defined in: mixins/animated.ts:39

Returns

void

Inherited from

Animated(WithSignals(Factory())).destroyAnimations

isAnimationPlaying()

isAnimationPlaying(): boolean

Defined in: mixins/animated.ts:43

Returns

boolean

Inherited from

Animated(WithSignals(Factory())).isAnimationPlaying

pauseAnimations()

pauseAnimations(): void

Defined in: mixins/animated.ts:35

Returns

void

Inherited from

Animated(WithSignals(Factory())).pauseAnimations

pulse()

pulse(config?, instance?): Tween

Defined in: mixins/animated.ts:48

Parameters

config?

duration?

number

intensity?

number

times?

number

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).pulse

removed()

removed(): void

Defined in: display/Container.ts:189

Returns

void

Implementation of

IContainer.removed

resize()

resize(size?): void

Defined in: display/Container.ts:167

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

Parameters

size?

Size

Returns

void

Implementation of

IContainer.resize

resumeAnimations()

resumeAnimations(): void

Defined in: mixins/animated.ts:37

Returns

void

Inherited from

Animated(WithSignals(Factory())).resumeAnimations

reverseAnimation()

reverseAnimation(): void

Defined in: mixins/animated.ts:41

Returns

void

Inherited from

Animated(WithSignals(Factory())).reverseAnimation

shake()

shake(config?, instance?): Tween

Defined in: mixins/animated.ts:46

Parameters

config?

duration?

number

intensity?

number

times?

number

instance?

any

Returns

Tween

Inherited from

Animated(WithSignals(Factory())).shake

update()

update(ticker?): void

Defined in: display/Container.ts:159

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

Parameters

ticker?

number | Ticker

Returns

void

Implementation of

IContainer.update

childAdded()

static childAdded(child): void

Defined in: display/Container.ts:84

Parameters

child

Container

Returns

void

childRemoved()

static childRemoved(child): void

Defined in: display/Container.ts:88

Parameters

child

Container

Returns

void