Skip to content

LoadScreen

Load screen

Extends

Constructors

new LoadScreen()

new LoadScreen(): LoadScreen

Returns

LoadScreen

Overrides

State.constructor

Source

src/load/LoadScreen.ts:9

Properties

childrenEditable

childrenEditable: boolean = true

Inherited from

State.childrenEditable

Source

src/gameobjects/Container.ts:22


editable

editable: boolean = true

Inherited from

State.editable

Source

src/gameobjects/Container.ts:21


NAME

static NAME: string = 'State'

Inherited from

State.NAME

Source

src/state/State.ts:13


__dill_pixel_top_level_class

static __dill_pixel_top_level_class: boolean = true

Inherited from

State.__dill_pixel_top_level_class

Source

src/gameobjects/Container.ts:20

Accessors

add

get add(): Add

gets the Add factory

Returns

Add

Source

src/state/State.ts:38


app

get app(): T

Returns

T

Source

src/gameobjects/Container.ts:128


autoProgress

get autoProgress(): boolean

autoProgress

Returns

boolean

Source

src/load/LoadScreen.ts:17


data

get data(): any

set data(value): void

Parameters

value: any

Returns

any

Source

src/state/State.ts:57


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

gets the Make factory

Returns

typeof Make

Source

src/state/State.ts:45


size

get size(): IPoint

set size(value): void

Parameters

value: IPoint

Returns

IPoint

Source

src/state/State.ts:49


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


Assets

get static Assets(): AssetMapData[]

set static Assets(pAssets): void

Parameters

pAssets: AssetMapData[]

Returns

AssetMapData[]

Source

src/state/State.ts:27


ID

get static ID(): string

Returns

string

Source

src/state/State.ts:23

Methods

animateIn()

animateIn(callback): void | Promise<void>

Animates in

Parameters

callback

Returns

void | Promise<void>

Inherited from

State.animateIn

Source

src/state/State.ts:110


animateOut()

animateOut(callback): void | Promise<void>

Animates out

Parameters

callback

Returns

void | Promise<void>

Inherited from

State.animateOut

Source

src/state/State.ts:119


destroy()

destroy(destroyOptions): void

Destroys state.

Parameters

destroyOptions: undefined | boolean | IDestroyOptions= undefined

Returns

void

Inherited from

State.destroy

Source

src/state/State.ts:85


disableEditMode()

disableEditMode(): void

Returns

void

Inherited from

State.disableEditMode

Source

src/gameobjects/Container.ts:173


enableEditMode()

enableEditMode(): void

Returns

void

Inherited from

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

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

State.getFocusSize

Source

src/gameobjects/Container.ts:161


init()

init(size): void | Promise<void>

Inits state

Parameters

size: IPoint

Returns

void | Promise<void>

Inherited from

State.init

Source

src/state/State.ts:97


isFocusable()

isFocusable(): boolean

Returns

boolean

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

Inherited from

State.isFocusable

Source

src/gameobjects/Container.ts:165


onFocusActivated()

onFocusActivated(): void

Called when this Focusable is focussed and then activated.

Returns

void

Inherited from

State.onFocusActivated

Source

src/gameobjects/Container.ts:155


onFocusBegin()

onFocusBegin(): void

Called when this Focusable is focussed.

Returns

void

Inherited from

State.onFocusBegin

Source

src/gameobjects/Container.ts:143


onFocusEnd()

onFocusEnd(): void

Called when this Focusable is no longer focussed.

Returns

void

Inherited from

State.onFocusEnd

Source

src/gameobjects/Container.ts:149


onLoadComplete()

onLoadComplete(pCallback): void

onLoadComplete

Parameters

pCallback

Returns

void

Source

src/load/LoadScreen.ts:33


onLoadProgress()

onLoadProgress(_progress): void

onLoadProgress

Parameters

_progress: number

Returns

void

Source

src/load/LoadScreen.ts:25


onResize()

onResize(size): void

Determines whether resize on

Parameters

size: IPoint

Returns

void

Inherited from

State.onResize

Source

src/state/State.ts:77


positionSelfCenter()

positionSelfCenter(size): void

Parameters

size: Point

Returns

void

Inherited from

State.positionSelfCenter

Source

src/state/State.ts:102


update()

update(deltaTime): void

Updates state

Parameters

deltaTime: number

Returns

void

Inherited from

State.update

Source

src/state/State.ts:69