Popup

Defined in: ui/Popup.ts:68

Class representing a Popup

Extends

• Container

Type Parameters

• T = any

Implements

• IPopup<T>

Constructors

new Popup()

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

Defined in: ui/Popup.ts:80

Create a new Popup

Parameters

id

The unique identifier for the popup

string | number

config

Partial<PopupConfig<any>> = {}

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:61

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

Parameters

props?

Partial<ContainerProps>

Returns

Container

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

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer

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

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

Container.add

---

backing?

optional backing: Sprite

Defined in: ui/Popup.ts:72

Implementation of

IPopup.backing

---

config

config: PopupConfig<T>

Defined in: ui/Popup.ts:73

Implementation of

IPopup.config

---

firstFocusableEntity

firstFocusableEntity: IFocusable

Defined in: ui/Popup.ts:70

Implementation of

IPopup.firstFocusableEntity

---

id

readonly id: string | number

Defined in: ui/Popup.ts:81

The unique identifier for the popup

Implementation of

IPopup.id

---

isShowing

isShowing: boolean = false

Defined in: ui/Popup.ts:69

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

Parameters

props?

Partial<ContainerProps>

Returns

Container

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

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer

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

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

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:60

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:71

Implementation of

IPopup.view

Accessors

app

Get Signature

get app(): A

Defined in: display/Container.ts:82

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:90

Returns

T

Implementation of

IPopup.data

Methods

addColoredBackground()

addColoredBackground(colorOrConfig, alpha): Sprite

Defined in: display/Container.ts:86

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:144

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:155

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:117

Returns

void

Implementation of

IPopup.beforeHide

---

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

---

close()

close(): void | Promise<void>

Defined in: ui/Popup.ts:167

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:121

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

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:165

End the popup

Returns

void

Implementation of

IPopup.end

---

hide()

hide(): any

Defined in: ui/Popup.ts:130

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:115

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:154

Returns

void

Inherited from

Container.removed

---

resize()

resize(): void

Defined in: ui/Popup.ts:172

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

Returns

void

Implementation of

IPopup.resize

Overrides

Container.resize

---

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:141

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:152

Start the popup

Returns

void | Promise<any>

Implementation of

IPopup.start

---

update()

update(ticker?): void

Defined in: display/Container.ts:129

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