AssetsPlugin

Defined in: plugins/AssetsPlugin.ts:82

Extends

• Plugin

Implements

• IAssetsPlugin

Constructors

new AssetsPlugin()

new AssetsPlugin(id): AssetsPlugin

Defined in: plugins/Plugin.ts:40

Parameters

id

string = 'Plugin'

Returns

AssetsPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:37

Inherited from

Plugin.__dill_pixel_method_binding_root

---

id

readonly id: string = 'assets'

Defined in: plugins/AssetsPlugin.ts:83

Implementation of

IAssetsPlugin.id

Overrides

Plugin.id

---

onBackgroundAssetLoaded

onBackgroundAssetLoaded: Signal<(asset) => void>

Defined in: plugins/AssetsPlugin.ts:89

---

onBackgroundBundlesLoaded

onBackgroundBundlesLoaded: Signal<() => void>

Defined in: plugins/AssetsPlugin.ts:90

---

onBackgroundLoadStart

onBackgroundLoadStart: Signal<() => void>

Defined in: plugins/AssetsPlugin.ts:88

---

onLoadComplete

onLoadComplete: Signal<() => void>

Defined in: plugins/AssetsPlugin.ts:86

Implementation of

IAssetsPlugin.onLoadComplete

---

onLoadProgress

onLoadProgress: Signal<(progress) => void>

Defined in: plugins/AssetsPlugin.ts:85

Implementation of

IAssetsPlugin.onLoadProgress

---

onLoadStart

onLoadStart: Signal<() => void>

Defined in: plugins/AssetsPlugin.ts:84

Implementation of

IAssetsPlugin.onLoadStart

Accessors

app

Get Signature

get app(): T

Defined in: plugins/Plugin.ts:45

Returns

T

Implementation of

IAssetsPlugin.app

Inherited from

Plugin.app

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:71

Add signal connections to the container.

Parameters

args

…SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IAssetsPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:77

Returns

void

Implementation of

IAssetsPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:49

Returns

void

Implementation of

IAssetsPlugin.destroy

Inherited from

Plugin.destroy

---

initialize()

initialize(_app, options?): void | Promise<void>

Defined in: plugins/AssetsPlugin.ts:98

Parameters

_app

IApplication

options?

AssetLoadingOptions

Returns

void | Promise<void>

Implementation of

IAssetsPlugin.initialize

Overrides

Plugin.initialize

---

loadAssets()

loadAssets(assets): Promise<void>

Defined in: plugins/AssetsPlugin.ts:148

Parameters

assets

AssetTypes

Returns

Promise<void>

Implementation of

IAssetsPlugin.loadAssets

---

loadBackground()

loadBackground(): void

Defined in: plugins/AssetsPlugin.ts:123

Returns

void

Implementation of

IAssetsPlugin.loadBackground

---

loadBundles()

loadBundles(bundles): Promise<void>

Defined in: plugins/AssetsPlugin.ts:156

Parameters

bundles

string | string[]

Returns

Promise<void>

Implementation of

IAssetsPlugin.loadBundles

---

loadRequired()

loadRequired(): Promise<void>

Defined in: plugins/AssetsPlugin.ts:108

Returns

Promise<void>

Implementation of

IAssetsPlugin.loadRequired

---

loadSceneAssets()

loadSceneAssets(scene, background): Promise<void>

Defined in: plugins/AssetsPlugin.ts:179

Parameters

scene

IScene | SceneImportListItem<any>

background

boolean = false

Returns

Promise<void>

Implementation of

IAssetsPlugin.loadSceneAssets

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:60

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IAssetsPlugin.postInitialize

Inherited from

Plugin.postInitialize

---

unloadSceneAssets()

unloadSceneAssets(scene): Promise<void>

Defined in: plugins/AssetsPlugin.ts:162

Parameters

scene

IScene | SceneImportListItem<any>

Returns

Promise<void>

Implementation of

IAssetsPlugin.unloadSceneAssets