Skip to content

PopupManager

Enhanced PIXI Container that has: a factory for adding children, a reference to the Application instance, a signal connection manager, and auto update / resize capabilities Container

Extends

Type parameters

T extends Application = Application

Constructors

new PopupManager()

new PopupManager<T>(_app, overlayColor, overlayAlpha): PopupManager<T>

Parameters

_app: Application<T>

overlayColor: number= 0x000000

overlayAlpha: number= 0.75

Returns

PopupManager<T>

Overrides

Container.constructor

Source

src/popup/PopupManager.ts:25

Properties

childrenEditable

childrenEditable: boolean = true

Inherited from

Container.childrenEditable

Source

src/gameobjects/Container.ts:22


editable

editable: boolean = true

Inherited from

Container.editable

Source

src/gameobjects/Container.ts:21


onPopupHide

onPopupHide: Signal<(id) => void>

Source

src/popup/PopupManager.ts:17


onPopupHideComplete

onPopupHideComplete: Signal<(id) => void>

Source

src/popup/PopupManager.ts:16


onPopupShow

onPopupShow: Signal<(id) => void>

Source

src/popup/PopupManager.ts:15


__dill_pixel_top_level_class

static __dill_pixel_top_level_class: boolean = true

Inherited from

Container.__dill_pixel_top_level_class

Source

src/gameobjects/Container.ts:20

Accessors

add

get add(): Add

Returns

Add

Source

src/gameobjects/Container.ts:120


app

get app(): T

Returns

T

Source

src/popup/PopupManager.ts:46


debug

set debug(value): void

Enabling this will print all debug logs.

Parameters

value: boolean

Source

src/popup/PopupManager.ts:51


editMode

get editMode(): boolean

set editMode(value): void

Parameters

value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:107


focusPosition

get focusPosition(): Point

set focusPosition(value): void

Parameters

value: Point

Returns

Point

Source

src/gameobjects/Container.ts:83


focusSize

get focusSize(): Point

set focusSize(value): void

Parameters

value: Point

Returns

Point

Source

src/gameobjects/Container.ts:91


focusable

get focusable(): boolean

set focusable(value): void

Parameters

value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:99


make

get make(): typeof Make

Returns

typeof Make

Source

src/gameobjects/Container.ts:124


useAsCaptionTarget

get useAsCaptionTarget(): boolean

set useAsCaptionTarget(value): void

Parameters

value: boolean

Returns

boolean

Source

src/gameobjects/Container.ts:61


voiceover

get voiceover(): string

set voiceover(value): void

Parameters

value: string

Returns

string

Source

src/gameobjects/Container.ts:69

Methods

destroy()

destroy(_options?): void

Parameters

_options?: boolean | IDestroyOptions

Returns

void

Inherited from

Container.destroy

Source

src/gameobjects/Container.ts:132


disableEditMode()

disableEditMode(): void

Returns

void

Inherited from

Container.disableEditMode

Source

src/gameobjects/Container.ts:173


enableEditMode()

enableEditMode(): void

Returns

void

Inherited from

Container.enableEditMode

Source

src/gameobjects/Container.ts:169


getFocusPosition()

getFocusPosition(): Point

Gets the position in global coordinate space that the focus should be centred around.

Returns

Point

The position that the focus should be centred around.

Inherited from

Container.getFocusPosition

Source

src/gameobjects/Container.ts:157


getFocusSize()

getFocusSize(): IPoint

Gets the size of the area in global coordinate space that the focus should surround.

Returns

IPoint

The size of the area that the focus should surround.

Inherited from

Container.getFocusSize

Source

src/gameobjects/Container.ts:161


isFocusable()

isFocusable(): boolean

Returns

boolean

true if this focusable can be focused Defaults to this.interactive && this.worldVisible

Inherited from

Container.isFocusable

Source

src/gameobjects/Container.ts:165


onFocusActivated()

onFocusActivated(): void

Called when this Focusable is focussed and then activated.

Returns

void

Inherited from

Container.onFocusActivated

Source

src/gameobjects/Container.ts:155


onFocusBegin()

onFocusBegin(): void

Called when this Focusable is focussed.

Returns

void

Inherited from

Container.onFocusBegin

Source

src/gameobjects/Container.ts:143


onFocusEnd()

onFocusEnd(): void

Called when this Focusable is no longer focussed.

Returns

void

Inherited from

Container.onFocusEnd

Source

src/gameobjects/Container.ts:149


onResize()

onResize(size): void

Tick update() on all open popups

Parameters

size: Point

Screen size, in pixels(?)

Returns

void

Overrides

Container.onResize

Description

Expectation is that this is called in Application.onResize

Source

src/popup/PopupManager.ts:73


register()

register(popupClass, popupId?): void

Register a popup, so that it can be spawned later.

Parameters

popupClass: typeof Popup

popupId?: string

Unique ID for this type of popup

Returns

void

Description

Expectation is that this is called in Application.registerPopups

Source

src/popup/PopupManager.ts:88


update()

update(deltaTime): void

Tick update on all open popups

Parameters

deltaTime: number

Seconds elapsed since last call to update()

Returns

void

Overrides

Container.update

Description

Expectation is that this is called in Application.update

Source

src/popup/PopupManager.ts:62