Toast

Defined in: ui/Toast.ts:142

Extends

• Container<Application<DataSchema, ActionContext, Action, Renderer>, this> & ISignalContainer

Constructors

new Toast()

new Toast(config): Toast

Defined in: ui/Toast.ts:170

Parameters

config

Partial<ToastConfig> = {}

Returns

Toast

Overrides

WithSignals(Container).constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean = true

Defined in: display/Container.ts:61

Inherited from

WithSignals(Container).__dill_pixel_method_binding_root

---

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

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: (props?) => SpineAnimation

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation

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()

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

WithSignals(Container).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

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: (props?) => SpineAnimation

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation

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()

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

WithSignals(Container).make

---

onAnimationComplete

onAnimationComplete: Signal<(entity) => void>

Defined in: mixins/animated.ts:21

Inherited from

WithSignals(Container).onAnimationComplete

---

onAnimationStart

onAnimationStart: Signal<(entity) => void>

Defined in: mixins/animated.ts:19

Inherited from

WithSignals(Container).onAnimationStart

---

onAnimationUpdate

onAnimationUpdate: Signal<(entity) => void>

Defined in: mixins/animated.ts:20

Inherited from

WithSignals(Container).onAnimationUpdate

---

onDestroy

onDestroy: Signal<() => void>

Defined in: display/Container.ts:60

Inherited from

WithSignals(Container).onDestroy

---

onToastClosed

readonly onToastClosed: Signal<() => void>

Defined in: ui/Toast.ts:143

---

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

WithSignals(Container).signalConnections

Accessors

app

Get Signature

get app(): A

Defined in: display/Container.ts:82

Get the application instance.

Returns

A

Inherited from

WithSignals(Container).app

---

text

Set Signature

set text(value): void

Defined in: ui/Toast.ts:165

Parameters

value

string

Returns

void

---

toaster

Get Signature

get toaster(): Toaster

Defined in: ui/Toast.ts:161

Returns

Toaster

Set Signature

set toaster(value): void

Defined in: ui/Toast.ts:157

Parameters

value

Toaster

Returns

void

Methods

addColoredBackground()

addColoredBackground(colorOrConfig, alpha): Sprite

Defined in: display/Container.ts:86

Parameters

colorOrConfig

number | Partial<BackgroundConfig>

alpha

number = 1

Returns

Sprite

Inherited from

WithSignals(Container).addColoredBackground

---

added()

added(): void

Defined in: display/Container.ts:145

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

Returns

void

Inherited from

WithSignals(Container).added

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

WithSignals(Container).addSignalConnection

---

alignText()

alignText(): void

Defined in: ui/Toast.ts:283

Returns

void

---

animate()

animate(animationProps, instance?): Tween

Defined in: mixins/animated.ts:23

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

WithSignals(Container).animate

---

animateFrom()

animateFrom(animationProps, instance?): Tween

Defined in: mixins/animated.ts:25

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

WithSignals(Container).animateFrom

---

animateFromTo()

animateFromTo(fromProps, toProps, instance?): Tween

Defined in: mixins/animated.ts:27

Parameters

fromProps

GSAPAnimationConfigExtended

toProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

WithSignals(Container).animateFromTo

---

animateSequence()

animateSequence(sequences, instance?): Timeline

Defined in: mixins/animated.ts:33

Parameters

sequences

GSAPAnimationConfigExtended[]

instance?

any

Returns

Timeline

Inherited from

WithSignals(Container).animateSequence

---

bob()

bob(config?, instance?): Tween

Defined in: mixins/animated.ts:50

Parameters

config?

duration?

number

intensity?

number

instance?

any

Returns

Tween

Inherited from

WithSignals(Container).bob

---

connectAction()

connectAction(…args): void

Defined in: mixins/signals.ts:15

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

WithSignals(Container).connectAction

---

connectSignal()

connectSignal(…args): void

Defined in: mixins/signals.ts:14

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

WithSignals(Container).connectSignal

---

destroy()

destroy(): void

Defined in: ui/Toast.ts:375

Returns

void

Overrides

WithSignals(Container).destroy

---

destroyAnimations()

destroyAnimations(): void

Defined in: mixins/animated.ts:39

Returns

void

Inherited from

WithSignals(Container).destroyAnimations

---

getHideAnimation()

getHideAnimation(): Timeline

Defined in: ui/Toast.ts:321

Returns

Timeline

---

getShowAnimation()

getShowAnimation(): Timeline

Defined in: ui/Toast.ts:310

Returns

Timeline

---

hide()

hide(): Promise<Toast>

Defined in: ui/Toast.ts:344

Returns

Promise<Toast>

---

isAnimationPlaying()

isAnimationPlaying(): boolean

Defined in: mixins/animated.ts:43

Returns

boolean

Inherited from

WithSignals(Container).isAnimationPlaying

---

pauseAnimations()

pauseAnimations(): void

Defined in: mixins/animated.ts:35

Returns

void

Inherited from

WithSignals(Container).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

WithSignals(Container).pulse

---

removed()

removed(): void

Defined in: display/Container.ts:155

Returns

void

Inherited from

WithSignals(Container).removed

---

resize()

resize(size?): void

Defined in: display/Container.ts:138

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

Parameters

size?

Size

Returns

void

Inherited from

WithSignals(Container).resize

---

resumeAnimations()

resumeAnimations(): void

Defined in: mixins/animated.ts:37

Returns

void

Inherited from

WithSignals(Container).resumeAnimations

---

reverseAnimation()

reverseAnimation(): void

Defined in: mixins/animated.ts:41

Returns

void

Inherited from

WithSignals(Container).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

WithSignals(Container).shake

---

show()

show(): Promise<Toast>

Defined in: ui/Toast.ts:332

Returns

Promise<Toast>

---

update()

update(ticker?): void

Defined in: display/Container.ts:130

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

Parameters

ticker?

number | Ticker

Returns

void

Inherited from

WithSignals(Container).update