Scene

Defined in: display/Scene.ts:69

Interface for the Container class.

Extends

• Container

Implements

• IScene

Constructors

Constructor

new Scene(): Scene

Defined in: display/Scene.ts:81

Returns

Scene

Overrides

Container.constructor

Properties

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<BitmapTextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container

Parameters

props?

Partial<ContainerProps>

Returns

Container

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

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

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

Type Parameters

ANames

ANames extends string = string

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames>

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

Container.add

---

autoUnloadAssets

autoUnloadAssets: boolean = false

Defined in: display/Scene.ts:71

Implementation of

IScene.autoUnloadAssets

---

id

readonly id: string

Defined in: display/Scene.ts:70

Implementation of

IScene.id

---

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<BitmapTextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container

Parameters

props?

Partial<ContainerProps>

Returns

Container

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

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

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

Type Parameters

ANames

ANames extends string = string

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames>

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

Container.make

---

onAnimationComplete

onAnimationComplete: Signal<(entity) => void>

Defined in: mixins/animated.ts:37

Inherited from

Container.onAnimationComplete

---

onAnimationStart

onAnimationStart: Signal<(entity) => void>

Defined in: mixins/animated.ts:35

Inherited from

Container.onAnimationStart

---

onAnimationUpdate

onAnimationUpdate: Signal<(entity) => void>

Defined in: mixins/animated.ts:36

Inherited from

Container.onAnimationUpdate

---

onDestroy

onDestroy: Signal<() => void>

Defined in: display/Container.ts:65

Implementation of

IScene.onDestroy

Inherited from

Container.onDestroy

---

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

Container.signalConnections

---

onGlobalChildAdded

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

Defined in: display/Container.ts:79

Inherited from

Container.onGlobalChildAdded

---

onGlobalChildRemoved

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

Defined in: display/Container.ts:80

Inherited from

Container.onGlobalChildRemoved

Accessors

animationContext

Get Signature

get animationContext(): string

Defined in: display/Scene.ts:74

Returns

string

Set Signature

set animationContext(value): void

Defined in: display/Scene.ts:77

Parameters

value

string

Returns

void

Implementation of

IScene.animationContext

Overrides

Container.animationContext

---

app

Get Signature

get app(): Application

Defined in: display/Container.ts:93

Get the application instance.

Returns

Application

Implementation of

IScene.app

Inherited from

Container.app

---

assets

Get Signature

get assets(): SceneAssets

Defined in: display/Scene.ts:105

Returns

SceneAssets

Set Signature

set assets(value): void

Defined in: display/Scene.ts:109

Parameters

value

SceneAssets

Returns

void

Implementation of

IScene.assets

Methods

addColoredBackground()

addColoredBackground(colorOrConfig, alpha): Sprite

Defined in: display/Container.ts:113

Parameters

colorOrConfig

number | Partial<BackgroundConfig>

alpha

number = 1

Returns

Sprite

Implementation of

IScene.addColoredBackground

Inherited from

Container.addColoredBackground

---

added()

added(): void

Defined in: display/Container.ts:172

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

Returns

void

Implementation of

IScene.added

Inherited from

Container.added

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Container.addSignalConnection

---

animate()

animate(animationProps, instance?): Tween

Defined in: mixins/animated.ts:39

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Container.animate

---

animateFrom()

animateFrom(animationProps, instance?): Tween

Defined in: mixins/animated.ts:41

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Container.animateFrom

---

animateFromTo()

animateFromTo(fromProps, toProps, instance?): Tween

Defined in: mixins/animated.ts:43

Parameters

fromProps

GSAPAnimationConfigExtended

toProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Container.animateFromTo

---

animateSequence()

animateSequence(sequences, instance?): Timeline

Defined in: mixins/animated.ts:49

Parameters

sequences

GSAPAnimationConfigExtended[]

instance?

any

Returns

Timeline

Inherited from

Container.animateSequence

---

bob()

bob(config?, instance?): Tween

Defined in: mixins/animated.ts:66

Parameters

config?

duration?

number

intensity?

number

instance?

any

Returns

Tween

Inherited from

Container.bob

---

childAdded()

childAdded(child): void

Defined in: display/Container.ts:174

Parameters

child

Container

Returns

void

Implementation of

IScene.childAdded

Inherited from

Container.childAdded

---

childRemoved()

childRemoved(child): void

Defined in: display/Container.ts:189

Parameters

child

Container

Returns

void

Implementation of

IScene.childRemoved

Inherited from

Container.childRemoved

---

connectAction()

connectAction(…args): void

Defined in: mixins/signals.ts:15

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Container.connectAction

---

connectSignal()

connectSignal(…args): void

Defined in: mixins/signals.ts:14

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Container.connectSignal

---

destroy()

destroy(): void

Defined in: display/Scene.ts:165

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

Returns

void

Example

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

Implementation of

IScene.destroy

Overrides

Container.destroy

---

destroyAnimations()

destroyAnimations(): void

Defined in: mixins/animated.ts:55

Returns

void

Inherited from

Container.destroyAnimations

---

enter()

enter(): Promise<any>

Defined in: display/Scene.ts:127

Called to animate the scene in

Returns

Promise<any>

Implementation of

IScene.enter

---

exit()

exit(): Promise<any>

Defined in: display/Scene.ts:135

Called to animate the scene out

Returns

Promise<any>

Implementation of

IScene.exit

---

initialize()

initialize(): void | Promise<void>

Defined in: display/Scene.ts:119

Called to initialize the scene Called before the scene is added to the stage and before the scene is animated in

Returns

void | Promise<void>

Implementation of

IScene.initialize

---

isAnimationPlaying()

isAnimationPlaying(): boolean

Defined in: mixins/animated.ts:59

Returns

boolean

Inherited from

Container.isAnimationPlaying

---

onPause()

onPause(config): void

Defined in: display/Scene.ts:170

Parameters

config

PauseConfig

Returns

void

Implementation of

IScene.onPause

---

onResume()

onResume(config): void

Defined in: display/Scene.ts:174

Parameters

config

PauseConfig

Returns

void

Implementation of

IScene.onResume

---

pauseAnimations()

pauseAnimations(): void

Defined in: mixins/animated.ts:51

Returns

void

Inherited from

Container.pauseAnimations

---

pulse()

pulse(config?, instance?): Tween

Defined in: mixins/animated.ts:64

Parameters

config?

duration?

number

intensity?

number

times?

number

instance?

any

Returns

Tween

Inherited from

Container.pulse

---

removed()

removed(): void

Defined in: display/Container.ts:187

Returns

void

Implementation of

IScene.removed

Inherited from

Container.removed

---

resize()

resize(size?): void

Defined in: display/Scene.ts:161

Called when the window is resized

Parameters

size?

Size

Returns

void

Implementation of

IScene.resize

Overrides

Container.resize

---

resumeAnimations()

resumeAnimations(): void

Defined in: mixins/animated.ts:53

Returns

void

Inherited from

Container.resumeAnimations

---

reverseAnimation()

reverseAnimation(): void

Defined in: mixins/animated.ts:57

Returns

void

Inherited from

Container.reverseAnimation

---

shake()

shake(config?, instance?): Tween

Defined in: mixins/animated.ts:62

Parameters

config?

Partial<ShakeConfig>

instance?

any

Returns

Tween

Inherited from

Container.shake

---

start()

start(): void | Promise<void>

Defined in: display/Scene.ts:144

Called after the enter resolves If enter doesn’t return a promise, this is called immediately after enter

Returns

void | Promise<void>

Implementation of

IScene.start

---

update()

update(ticker?): void

Defined in: display/Scene.ts:152

Called every frame

Parameters

ticker?

Ticker

Returns

void

Implementation of

IScene.update

Overrides

Container.update

---

childAdded()

static childAdded(child): void

Defined in: display/Container.ts:82

Parameters

child

Container

Returns

void

Inherited from

Container.childAdded

---

childRemoved()

static childRemoved(child): void

Defined in: display/Container.ts:86

Parameters

child

Container

Returns

void

Inherited from

Container.childRemoved