Class AnimationHandler

handlerType

app

• get app(): AppBase

  Gets the running AppBase instance.

  Returns AppBase

maxRetries

• get maxRetries(): number

  Gets the number of times to retry a failed request for the resource.

  Returns number

• set maxRetries(value: number): void

  Sets the number of times to retry a failed request for the resource.

  Parameters

  • value: number

  Returns void

parsers

• get parsers(): ResourceParser[]

  Gets a read-only copy of the registered parsers.

  Returns ResourceParser[]

addParser

• addParser(parser: ResourceParser, decider?: any): void

  Registers a ResourceParser for this handler. Parsers are consulted newest-first: the most recently added parser whose ResourceParser#canParse returns true is selected. This lets a later registration override a built-in parser for the same format.

  Register parsers before starting loads for this handler's type - selection runs for both the load and open phases, so changing the registry while loads are in flight can route them inconsistently. Note that handlers that implement their own loading without consulting registered parsers (for example cubemap or font) ignore registered parsers.

  Parameters

  • parser: ResourceParser

    The parser to register. Must implement canParse(context).

  • Optionaldecider: any

    Removed. Previously a (url, data) => boolean selector; implement canParse(context) on the parser instead. If passed, it is ignored and logs a warning.

  Returns void

  Example

  app.loader.getHandler('model').addParser(new ObjModelParser(app.graphicsDevice));
  Copy

fetch

• fetch(
      url: string | { load: string; original: string },
      responseType: string,
      callback: ResourceHandlerCallback,
      asset?: Asset,
  ): void

  Fetches a resource's raw data using this handler's retry settings, reusing pre-fetched asset.file.contents when available. A convenience for a ResourceParser's load method, so parsers don't reimplement the fetch boilerplate.

  Parameters

  • url: string | { load: string; original: string }

    The resource URL, or a load/original structure.

  • responseType: string

    The Http.ResponseType to fetch as (for example Http.ResponseType.ARRAY_BUFFER for a binary format, or Http.ResponseType.TEXT).

  • callback: ResourceHandlerCallback

    Called with (err, data) when the fetch completes.

  • Optionalasset: Asset

    The asset being loaded, used to reuse already-fetched contents.

  Returns void

load

• load(
      url: string | { load: string; original: string },
      callback: ResourceHandlerCallback,
      asset?: Asset,
  ): void

  Load a resource from a remote URL. When parsers are registered, the matching parser's load is used; otherwise the base implementation does nothing (subclasses may override).

  Parameters

  • url: string | { load: string; original: string }

    Either the URL of the resource to load or a structure containing the load URL (used for loading the resource) and the original URL (used for identifying the resource format; necessary when loading, for example, from a blob URL).

  • callback: ResourceHandlerCallback

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

  • Optionalasset: Asset

    Optional asset that is passed by ResourceLoader.

  Returns void

open

• open(url: string, data: any, asset?: Asset): any

  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. When parsers are registered, the matching parser's open is used (if it implements one); otherwise the base implementation simply returns the data.

  Parameters

  • url: string

    The URL of the resource to open.

  • data: any

    The raw resource data passed by callback from load.

  • Optionalasset: Asset

    Optional asset that is passed by ResourceLoader.

  Returns any

  The parsed resource data.

patch

• patch(asset: Asset, assets: AssetRegistry): 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: Asset

    The asset to patch.

  • assets: AssetRegistry

    The asset registry.

  Returns void

removeParser

• removeParser(parser: ResourceParser): void

  Removes a previously registered ResourceParser.

  Parameters

  • parser: ResourceParser

    The parser to remove.

  Returns void