IAssetsPlugin
Defined in: plugins/AssetsPlugin.ts:19
Extends
Section titled “Extends”Properties
Section titled “Properties”app:
IApplication
Defined in: plugins/Plugin.ts:10
Inherited from
Section titled “Inherited from”id:
string
Defined in: plugins/Plugin.ts:8
Inherited from
Section titled “Inherited from”onBackgroundAssetLoaded
Section titled “onBackgroundAssetLoaded”onBackgroundAssetLoaded:
Signal
<(asset
) =>void
>
Defined in: plugins/AssetsPlugin.ts:29
onBackgroundBundlesLoaded
Section titled “onBackgroundBundlesLoaded”onBackgroundBundlesLoaded:
Signal
<(bundles
) =>void
>
Defined in: plugins/AssetsPlugin.ts:30
onBackgroundLoadStart
Section titled “onBackgroundLoadStart”onBackgroundLoadStart:
Signal
<() =>void
>
Defined in: plugins/AssetsPlugin.ts:28
onLoadComplete
Section titled “onLoadComplete”onLoadComplete:
Signal
<() =>void
>
Defined in: plugins/AssetsPlugin.ts:22
onLoadProgress
Section titled “onLoadProgress”onLoadProgress:
Signal
<(progress
) =>void
>
Defined in: plugins/AssetsPlugin.ts:21
onLoadRequiredComplete
Section titled “onLoadRequiredComplete”onLoadRequiredComplete:
Signal
<() =>void
>
Defined in: plugins/AssetsPlugin.ts:26
onLoadRequiredProgress
Section titled “onLoadRequiredProgress”onLoadRequiredProgress:
Signal
<(progress
) =>void
>
Defined in: plugins/AssetsPlugin.ts:25
onLoadRequiredStart
Section titled “onLoadRequiredStart”onLoadRequiredStart:
Signal
<() =>void
>
Defined in: plugins/AssetsPlugin.ts:24
onLoadStart
Section titled “onLoadStart”onLoadStart:
Signal
<() =>void
>
Defined in: plugins/AssetsPlugin.ts:20
options
Section titled “options”
readonly
options:Partial
<O
>
Defined in: plugins/Plugin.ts:12
Inherited from
Section titled “Inherited from”webCompleteEvent
Section titled “webCompleteEvent”webCompleteEvent:
Event
Defined in: plugins/AssetsPlugin.ts:34
webProgressEvent
Section titled “webProgressEvent”webProgressEvent:
CustomEvent
<{progress
:number
; }>
Defined in: plugins/AssetsPlugin.ts:33
webRequiredCompleteEvent
Section titled “webRequiredCompleteEvent”webRequiredCompleteEvent:
Event
Defined in: plugins/AssetsPlugin.ts:38
webRequiredProgressEvent
Section titled “webRequiredProgressEvent”webRequiredProgressEvent:
CustomEvent
<{progress
:number
; }>
Defined in: plugins/AssetsPlugin.ts:37
webRequiredStartEvent
Section titled “webRequiredStartEvent”webRequiredStartEvent:
Event
Defined in: plugins/AssetsPlugin.ts:36
webStartEvent
Section titled “webStartEvent”webStartEvent:
Event
Defined in: plugins/AssetsPlugin.ts:32
Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args
):void
Defined in: plugins/Plugin.ts:20
Parameters
Section titled “Parameters”…SignalConnection
[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:22
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”IPlugin
.clearSignalConnections
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:18
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”initialize()
Section titled “initialize()”initialize(
options
,app
):void
|Promise
<void
>
Defined in: plugins/Plugin.ts:14
Parameters
Section titled “Parameters”options
Section titled “options”Partial
<O
>
Returns
Section titled “Returns”void
| Promise
<void
>
Inherited from
Section titled “Inherited from”loadAssets()
Section titled “loadAssets()”loadAssets(
assets
,reportProgress?
):Promise
<void
>
Defined in: plugins/AssetsPlugin.ts:40
Parameters
Section titled “Parameters”assets
Section titled “assets”string
| string
[] | UnresolvedAsset
| AssetLike
| UnresolvedAsset
[] | AssetLike
[]
reportProgress?
Section titled “reportProgress?”boolean
Returns
Section titled “Returns”Promise
<void
>
loadBackground()
Section titled “loadBackground()”loadBackground():
void
Defined in: plugins/AssetsPlugin.ts:53
Returns
Section titled “Returns”void
loadBundles()
Section titled “loadBundles()”loadBundles(
bundle
,reportProgress?
):Promise
<void
>
Defined in: plugins/AssetsPlugin.ts:45
Parameters
Section titled “Parameters”bundle
Section titled “bundle”string
| string
[]
reportProgress?
Section titled “reportProgress?”boolean
Returns
Section titled “Returns”Promise
<void
>
loadRequired()
Section titled “loadRequired()”loadRequired():
Promise
<void
>
Defined in: plugins/AssetsPlugin.ts:51
Returns
Section titled “Returns”Promise
<void
>
loadSceneAssets()
Section titled “loadSceneAssets()”loadSceneAssets(
scene
,background?
):Promise
<void
>
Defined in: plugins/AssetsPlugin.ts:47
Parameters
Section titled “Parameters”IScene
| SceneImportListItem
<any
>
background?
Section titled “background?”boolean
Returns
Section titled “Returns”Promise
<void
>
postInitialize()
Section titled “postInitialize()”postInitialize(
_app
):void
|Promise
<void
>
Defined in: plugins/Plugin.ts:16
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
| Promise
<void
>
Inherited from
Section titled “Inherited from”registerCoreFunctions()
Section titled “registerCoreFunctions()”registerCoreFunctions():
void
Defined in: plugins/Plugin.ts:24
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerCoreSignals()
Section titled “registerCoreSignals()”registerCoreSignals():
void
Defined in: plugins/Plugin.ts:26
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unloadSceneAssets()
Section titled “unloadSceneAssets()”unloadSceneAssets(
scene
):Promise
<void
>
Defined in: plugins/AssetsPlugin.ts:49
Parameters
Section titled “Parameters”IScene
| SceneImportListItem
<any
>
Returns
Section titled “Returns”Promise
<void
>