API Reference

Class List

ResourceHandler

Summary

Methods

[patch]

Optional function to perform any operations on a resource, that requires a dependency on its asset data or any other asset data.

load

Load a resource from a remote URL.

open

Convert raw resource data into a resource instance.

Details

Constructor

ResourceHandler()

Interface for ResourceHandlers used by ResourceLoader.

Methods

[patch](asset, assets)

Optional function to perform any operations on a resource, that requires a dependency on its asset data or any other asset data.

Parameters

assetAsset

The asset to patch.

assetsAssetRegistry

The asset registry.

load(url, callback, [asset])

Load a resource from a remote URL. When loaded (or failed), use the callback to return an the raw resource data (or error).

Parameters

urlstring, object

Either the URL of the resource to load or a structure containing the load and original URL.

url.loadstring

The URL to be used for loading the resource.

url.originalstring

The original URL to be used for identifying the resource format. This is necessary when loading, for example from blob.

callbackResourceHandlerCallback

The callback used when the resource is loaded or an error occurs.

assetAsset

Optional asset that is passed by ResourceLoader.

open(url, data, [asset])

Convert raw resource data into a resource instance. E.g. Take 3D model format JSON and return a Model.

Parameters

urlstring

The URL of the resource to open.

data*

The raw resource data passed by callback from ResourceHandler#load.

assetAsset

Optional asset that is passed by ResourceLoader.

Returns

*

The parsed resource data.