Popup

Defined in: ui/Popup.ts:80

Class representing a Popup

Extends

Container

Type Parameters

T

T = any

Implements

IPopup<T>

Constructors

Constructor

new Popup<T>(id, config): Popup<T>

Defined in: ui/Popup.ts:98

Create a new Popup

Parameters

id

The unique identifier for the popup

string | number

config

Partial<PopupConfig> = {}

The configuration for the popup

Returns

Popup<T>

Overrides

Container.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean = true

Defined in: display/Container.ts:68

Inherited from

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

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

backing?

optional backing: Sprite

Defined in: ui/Popup.ts:84

Implementation of

IPopup.backing

config

config: PopupConfig<T>

Defined in: ui/Popup.ts:85

Implementation of

IPopup.config

firstFocusableEntity

firstFocusableEntity: IFocusable

Defined in: ui/Popup.ts:82

Implementation of

IPopup.firstFocusableEntity

id

readonly id: string | number

Defined in: ui/Popup.ts:99

The unique identifier for the popup

Implementation of

IPopup.id

isShowing

isShowing: boolean = false

Defined in: ui/Popup.ts:81

Implementation of

IPopup.isShowing

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

Container.make

onAnimationComplete

onAnimationComplete: Signal<(entity) => void>

Defined in: mixins/animated.ts:21

Inherited from

Container.onAnimationComplete

onAnimationStart

onAnimationStart: Signal<(entity) => void>

Defined in: mixins/animated.ts:19

Inherited from

Container.onAnimationStart

onAnimationUpdate

onAnimationUpdate: Signal<(entity) => void>

Defined in: mixins/animated.ts:20

Inherited from

Container.onAnimationUpdate

onDestroy

onDestroy: Signal<() => void>

Defined in: display/Container.ts:67

Implementation of

IPopup.onDestroy

Inherited from

Container.onDestroy

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

Container.signalConnections

view

view: Container

Defined in: ui/Popup.ts:83

Implementation of

IPopup.view

onGlobalChildAdded

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

Defined in: display/Container.ts:81

Inherited from

Container.onGlobalChildAdded

onGlobalChildRemoved

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

Defined in: display/Container.ts:82

Inherited from

Container.onGlobalChildRemoved

Accessors

actionContext

Get Signature

get actionContext(): undefined | ActionContext

Defined in: ui/Popup.ts:89

Returns

undefined | ActionContext

Implementation of

IPopup.actionContext

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

IPopup.animationContext

Inherited from

Container.animationContext

app

Get Signature

get app(): A

Defined in: display/Container.ts:111

Get the application instance.

Returns

A

Implementation of

IPopup.app

Inherited from

Container.app

data

Get Signature

get data(): T

Defined in: ui/Popup.ts:108

Returns

T

Implementation of

IPopup.data

Methods

addColoredBackground()

addColoredBackground(colorOrConfig, alpha): Sprite

Defined in: display/Container.ts:115

Parameters

colorOrConfig

number | Partial<BackgroundConfig>

alpha

number = 1

Returns

Sprite

Implementation of

IPopup.addColoredBackground

Inherited from

Container.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

IPopup.added

Inherited from

Container.added

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

Container.addSignalConnection

afterShow()

afterShow(): void

Defined in: ui/Popup.ts:178

Returns

void

Implementation of

IPopup.afterShow

animate()

animate(animationProps, instance?): Tween

Defined in: mixins/animated.ts:23

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

Container.animate

animateFrom()

animateFrom(animationProps, instance?): Tween

Defined in: mixins/animated.ts:25

Parameters

animationProps

GSAPAnimationConfigExtended

instance?

any

Returns

Tween

Inherited from

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

Container.animateFromTo

animateSequence()

animateSequence(sequences, instance?): Timeline

Defined in: mixins/animated.ts:33

Parameters

sequences

GSAPAnimationConfigExtended[]

instance?

any

Returns

Timeline

Inherited from

Container.animateSequence

beforeHide()

beforeHide(): void

Defined in: ui/Popup.ts:139

Returns

void

Implementation of

IPopup.beforeHide

beforeShow()

beforeShow(): void

Defined in: ui/Popup.ts:134

Returns

void

Implementation of

IPopup.beforeShow

bob()

bob(config?, instance?): Tween

Defined in: mixins/animated.ts:50

Parameters

config?

duration?

number

intensity?

number

instance?

any

Returns

Tween

Inherited from

Container.bob

childAdded()

childAdded(child): void

Defined in: display/Container.ts:176

Parameters

child

Container

Returns

void

Implementation of

IPopup.childAdded

Inherited from

Container.childAdded

childRemoved()

childRemoved(child): void

Defined in: display/Container.ts:191

Parameters

child

Container

Returns

void

Implementation of

IPopup.childRemoved

Inherited from

Container.childRemoved

close()

close(): void | Promise<void>

Defined in: ui/Popup.ts:189

Returns

void | Promise<void>

Implementation of

IPopup.close

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(options?): void

Defined in: ui/Popup.ts:143

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

IPopup.destroy

Overrides

Container.destroy

destroyAnimations()

destroyAnimations(): void

Defined in: mixins/animated.ts:39

Returns

void

Inherited from

Container.destroyAnimations

end()

end(): void

Defined in: ui/Popup.ts:187

End the popup

Returns

void

Implementation of

IPopup.end

hide()

hide(): any

Defined in: ui/Popup.ts:153

Hide the popup

Returns

any

A promise that resolves when the popup is hidden

Implementation of

IPopup.hide

initialize()

initialize(): void

Defined in: ui/Popup.ts:132

Returns

void

Implementation of

IPopup.initialize

isAnimationPlaying()

isAnimationPlaying(): boolean

Defined in: mixins/animated.ts:43

Returns

boolean

Inherited from

Container.isAnimationPlaying

pauseAnimations()

pauseAnimations(): void

Defined in: mixins/animated.ts:35

Returns

void

Inherited from

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

Container.pulse

removed()

removed(): void

Defined in: display/Container.ts:189

Returns

void

Implementation of

IPopup.removed

Inherited from

Container.removed

resize()

resize(): void

Defined in: ui/Popup.ts:194

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

Returns

void

Implementation of

IPopup.resize

Overrides

Container.resize

restoreActionContext()

restoreActionContext(): void

Defined in: ui/Popup.ts:232

Returns

void

Implementation of

IPopup.restoreActionContext

resumeAnimations()

resumeAnimations(): void

Defined in: mixins/animated.ts:37

Returns

void

Inherited from

Container.resumeAnimations

reverseAnimation()

reverseAnimation(): void

Defined in: mixins/animated.ts:41

Returns

void

Inherited from

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

Container.shake

show()

show(): void | Promise<any>

Defined in: ui/Popup.ts:164

Show the popup

Returns

void | Promise<any>

A promise that resolves when the popup is shown

Implementation of

IPopup.show

start()

start(): void | Promise<any>

Defined in: ui/Popup.ts:175

Start the popup

Returns

void | Promise<any>

Implementation of

IPopup.start

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

IPopup.update

Inherited from

Container.update

childAdded()

static childAdded(child): void

Defined in: display/Container.ts:84

Parameters

child

Container

Returns

void

Inherited from

Container.childAdded

childRemoved()

static childRemoved(child): void

Defined in: display/Container.ts:88

Parameters

child

Container

Returns

void

Inherited from

Container.childRemoved