Class ResourceHandler

constructor

• new ResourceHandler(app: AppBase, handlerType: string): ResourceHandler

• Parameters

  • app: AppBase

    The running AppBase.
  • handlerType: string

    The type of the resource the handler handles.

  Returns ResourceHandler

_app

handlerType

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

load

• load(
      url: string | object,
      callback: ResourceHandlerCallback,
      asset?: Asset,
  ): void

• Load a resource from a remote URL. The base implementation does nothing.

  Parameters

  • url: string | object

    Either the URL of the resource to load or a structure containing the load and original 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. 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 ResourceHandler#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