IScene
Defined in: display/Scene.ts:10
Interface for the Container class.
Extends
Section titled “Extends”Properties
Section titled “Properties”animationContext
Section titled “animationContext”animationContext:
undefined|string
Defined in: display/Container.ts:39
Inherited from
Section titled “Inherited from”app:
IApplication
Defined in: display/Container.ts:37
Inherited from
Section titled “Inherited from”assets?
Section titled “assets?”
optionalassets:SceneAssets
Defined in: display/Scene.ts:13
autoUnloadAssets?
Section titled “autoUnloadAssets?”
optionalautoUnloadAssets:boolean
Defined in: display/Scene.ts:14
id:
string
Defined in: display/Scene.ts:11
label?
Section titled “label?”
optionallabel:string
Defined in: display/Scene.ts:12
onDestroy
Section titled “onDestroy”onDestroy:
Signal<() =>void>
Defined in: display/Container.ts:41
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addColoredBackground()
Section titled “addColoredBackground()”addColoredBackground(
colorOrConfig?,alpha?):Sprite
Defined in: display/Container.ts:56
Parameters
Section titled “Parameters”colorOrConfig?
Section titled “colorOrConfig?”number | Partial<BackgroundConfig>
alpha?
Section titled “alpha?”number
Returns
Section titled “Returns”Sprite
Inherited from
Section titled “Inherited from”IContainer.addColoredBackground
added()
Section titled “added()”added():
void|Promise<void>
Defined in: display/Container.ts:45
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”childAdded()
Section titled “childAdded()”childAdded(
child):void|Promise<void>
Defined in: display/Container.ts:49
Parameters
Section titled “Parameters”Container
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”childRemoved()
Section titled “childRemoved()”childRemoved(
child):void|Promise<void>
Defined in: display/Container.ts:50
Parameters
Section titled “Parameters”Container
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy(
options?):void
Defined in: display/Container.ts:43
Parameters
Section titled “Parameters”options?
Section titled “options?”DestroyOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”enter()
Section titled “enter()”enter():
Promise<any>
Defined in: display/Scene.ts:16
Returns
Section titled “Returns”Promise<any>
exit()
Section titled “exit()”exit():
Promise<any>
Defined in: display/Scene.ts:18
Returns
Section titled “Returns”Promise<any>
initialize()
Section titled “initialize()”initialize():
void|Promise<void>
Defined in: display/Scene.ts:20
Returns
Section titled “Returns”void | Promise<void>
onPause()
Section titled “onPause()”onPause(
config):void
Defined in: display/Scene.ts:24
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”void
onResume()
Section titled “onResume()”onResume(
config):void
Defined in: display/Scene.ts:26
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”void
removed()
Section titled “removed()”removed():
void|Promise<void>
Defined in: display/Container.ts:47
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”resize()
Section titled “resize()”resize(
size?):void
Defined in: display/Container.ts:52
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”start()
Section titled “start()”start():
void|Promise<void>
Defined in: display/Scene.ts:22
Returns
Section titled “Returns”void | Promise<void>
update()
Section titled “update()”update(
ticker?):void
Defined in: display/Container.ts:54
Parameters
Section titled “Parameters”ticker?
Section titled “ticker?”number | Ticker
Returns
Section titled “Returns”void