AssetsPlugin
Defined in: plugins/AssetsPlugin.ts:108
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AssetsPlugin(
id):AssetsPlugin
Defined in: plugins/Plugin.ts:48
Parameters
Section titled “Parameters”string = 'Plugin'
Returns
Section titled “Returns”AssetsPlugin
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”__dill_pixel_method_binding_root
Section titled “__dill_pixel_method_binding_root”__dill_pixel_method_binding_root:
boolean
Defined in: plugins/Plugin.ts:39
Inherited from
Section titled “Inherited from”Plugin.__dill_pixel_method_binding_root
readonlyid:string='assets'
Defined in: plugins/AssetsPlugin.ts:109
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”onBackgroundAssetLoaded
Section titled “onBackgroundAssetLoaded”onBackgroundAssetLoaded:
Signal<(asset) =>void>
Defined in: plugins/AssetsPlugin.ts:119
Implementation of
Section titled “Implementation of”IAssetsPlugin.onBackgroundAssetLoaded
onBackgroundBundlesLoaded
Section titled “onBackgroundBundlesLoaded”onBackgroundBundlesLoaded:
Signal<(bundles) =>void>
Defined in: plugins/AssetsPlugin.ts:120
Implementation of
Section titled “Implementation of”IAssetsPlugin.onBackgroundBundlesLoaded
onBackgroundLoadStart
Section titled “onBackgroundLoadStart”onBackgroundLoadStart:
Signal<() =>void>
Defined in: plugins/AssetsPlugin.ts:118
Implementation of
Section titled “Implementation of”IAssetsPlugin.onBackgroundLoadStart
onLoadComplete
Section titled “onLoadComplete”onLoadComplete:
Signal<() =>void>
Defined in: plugins/AssetsPlugin.ts:112
Implementation of
Section titled “Implementation of”onLoadProgress
Section titled “onLoadProgress”onLoadProgress:
Signal<(progress) =>void>
Defined in: plugins/AssetsPlugin.ts:111
Implementation of
Section titled “Implementation of”onLoadRequiredComplete
Section titled “onLoadRequiredComplete”onLoadRequiredComplete:
Signal<() =>void>
Defined in: plugins/AssetsPlugin.ts:116
Implementation of
Section titled “Implementation of”IAssetsPlugin.onLoadRequiredComplete
onLoadRequiredProgress
Section titled “onLoadRequiredProgress”onLoadRequiredProgress:
Signal<(progress) =>void>
Defined in: plugins/AssetsPlugin.ts:115
Implementation of
Section titled “Implementation of”IAssetsPlugin.onLoadRequiredProgress
onLoadRequiredStart
Section titled “onLoadRequiredStart”onLoadRequiredStart:
Signal<() =>void>
Defined in: plugins/AssetsPlugin.ts:114
Implementation of
Section titled “Implementation of”IAssetsPlugin.onLoadRequiredStart
onLoadStart
Section titled “onLoadStart”onLoadStart:
Signal<() =>void>
Defined in: plugins/AssetsPlugin.ts:110
Implementation of
Section titled “Implementation of”webCompleteEvent
Section titled “webCompleteEvent”webCompleteEvent:
Event
Defined in: plugins/AssetsPlugin.ts:163
Implementation of
Section titled “Implementation of”IAssetsPlugin.webCompleteEvent
webProgressEvent
Section titled “webProgressEvent”webProgressEvent:
CustomEvent<{progress:number; }>
Defined in: plugins/AssetsPlugin.ts:153
Implementation of
Section titled “Implementation of”IAssetsPlugin.webProgressEvent
webRequiredCompleteEvent
Section titled “webRequiredCompleteEvent”webRequiredCompleteEvent:
Event
Defined in: plugins/AssetsPlugin.ts:144
Implementation of
Section titled “Implementation of”IAssetsPlugin.webRequiredCompleteEvent
webRequiredProgressEvent
Section titled “webRequiredProgressEvent”webRequiredProgressEvent:
CustomEvent<{progress:number; }>
Defined in: plugins/AssetsPlugin.ts:134
Implementation of
Section titled “Implementation of”IAssetsPlugin.webRequiredProgressEvent
webRequiredStartEvent
Section titled “webRequiredStartEvent”webRequiredStartEvent:
Event
Defined in: plugins/AssetsPlugin.ts:130
Implementation of
Section titled “Implementation of”IAssetsPlugin.webRequiredStartEvent
webStartEvent
Section titled “webStartEvent”webStartEvent:
Event
Defined in: plugins/AssetsPlugin.ts:149
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
A
Defined in: plugins/Plugin.ts:53
Returns
Section titled “Returns”A
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:79
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IAssetsPlugin.addSignalConnection
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:85
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IAssetsPlugin.clearSignalConnections
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:57
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”initialize()
Section titled “initialize()”initialize(
options?):void|Promise<void>
Defined in: plugins/AssetsPlugin.ts:168
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”loadAssets()
Section titled “loadAssets()”loadAssets(
assets,reportProgress):Promise<void>
Defined in: plugins/AssetsPlugin.ts:225
Parameters
Section titled “Parameters”assets
Section titled “assets”reportProgress
Section titled “reportProgress”boolean = true
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”loadBackground()
Section titled “loadBackground()”loadBackground():
void
Defined in: plugins/AssetsPlugin.ts:200
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”loadBundles()
Section titled “loadBundles()”loadBundles(
bundles,reportProgress):Promise<void>
Defined in: plugins/AssetsPlugin.ts:232
Parameters
Section titled “Parameters”bundles
Section titled “bundles”string | string[]
reportProgress
Section titled “reportProgress”boolean = true
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”loadRequired()
Section titled “loadRequired()”loadRequired():
Promise<void>
Defined in: plugins/AssetsPlugin.ts:178
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”loadSceneAssets()
Section titled “loadSceneAssets()”loadSceneAssets(
scene,background):Promise<void>
Defined in: plugins/AssetsPlugin.ts:255
Parameters
Section titled “Parameters”IScene | SceneImportListItem<any>
background
Section titled “background”boolean = false
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:68
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”unloadSceneAssets()
Section titled “unloadSceneAssets()”unloadSceneAssets(
scene):Promise<void>
Defined in: plugins/AssetsPlugin.ts:238
Parameters
Section titled “Parameters”IScene | SceneImportListItem<any>
Returns
Section titled “Returns”Promise<void>