Class SpriteHandler

Resource handler used for loading Sprite resources.

Hierarchy (view full)

ResourceHandler
- SpriteHandler

Index

Properties

_app handlerType

Accessors

Methods

load open patch

Properties

_app

The running app instance.

handlerType

handlerType: string = ''

Type of the resource the handler handles.

Accessors

maxRetries

get maxRetries(): number
Gets the number of times to retry a failed request for the resource.

Returns number
Inherited from ResourceHandler.maxRetries
- Defined in submodules/engine/src/framework/handlers/handler.js:53
set maxRetries(value): void
Sets the number of times to retry a failed request for the resource.
Parameters
- value: number
Returns void
Inherited from ResourceHandler.maxRetries
- Defined in submodules/engine/src/framework/handlers/handler.js:44

Methods

load

load(url, callback): void
Load a resource from a remote URL. The base implementation does nothing.
Parameters
- url: any
  Either the URL of the resource to load or a structure containing the load and original URL.
- callback: any
  The callback used when the resource is loaded or an error occurs.
Returns void
Overrides ResourceHandler.load
- Defined in submodules/engine/src/framework/handlers/sprite.js:42

open

open(url, data): Sprite
The open function is passed the raw resource data. The handler can then process the data into a format that can be used at runtime. The base implementation simply returns the data.
Parameters
- url: any
  The URL of the resource to open.
- data: any
  The raw resource data passed by callback from ResourceHandler#load.
Returns Sprite
The parsed resource data.
Overrides ResourceHandler.open
- Defined in submodules/engine/src/framework/handlers/sprite.js:66

patch

patch(asset, assets): void
The patch function performs any operations on a resource that requires a dependency on its asset data or any other asset data. The base implementation does nothing.
Parameters
- asset: any
  The asset to patch.
- assets: any
  The asset registry.
Returns void
Overrides ResourceHandler.patch
- Defined in submodules/engine/src/framework/handlers/sprite.js:78