Class LoaderAdvanced

constructor

• new Loader(): Loader

  Returns Loader

loadOptions

// Create a loader with custom default options
const loader = new Loader();
loader.loadOptions = {
  strategy: 'skip', // Default strategy to 'skip'
  retryCount: 5,   // Default retry count to 5
  retryDelay: 500, // Default retry delay to 500ms
};

// This load call will use the loader's default options
await loader.load('image1.png'
Copy

parsers

promiseCache

StaticdefaultOptions

// Change default load options globally
Loader.defaultOptions = {
  strategy: 'skip', // Change default strategy to 'skip'
  retryCount: 5,   // Change default retry count to 5
  retryDelay: 500, // Change default retry delay to 500ms
};
Copy

load

• load<T = any>(
      assetsToLoadIn: string | ResolvedAsset<any>,
      onProgress?: LoadOptions | ProgressCallback,
  ): Promise<T>

  Loads one or more assets using the parsers added to the Loader.

  Type Parameters

  • T = any

  Parameters

  • assetsToLoadIn: string | ResolvedAsset<any>

    urls that you want to load, or a single one!
  • OptionalonProgress: LoadOptions | ProgressCallback

    For multiple asset loading only, an optional function that is called when progress on asset loading is made. The function is passed a single parameter, progress, which represents the percentage (0.0 - 1.0) of the assets loaded. Do not use this function to detect when assets are complete and available, instead use the Promise returned by this function.

  Returns Promise<T>

  Example

  // Single asset:
  const asset = await Loader.load('cool.png');
  console.log(asset);
  
  // Multiple assets:
  const assets = await Loader.load(['cool.png', 'cooler.png']);
  console.log(assets);
  Copy

• load<T = any>(
      assetsToLoadIn: string[] | ResolvedAsset<any>[],
      onProgress?: LoadOptions | ProgressCallback,
  ): Promise<Record<string, T>>

  Loads one or more assets using the parsers added to the Loader.

  Type Parameters

  • T = any

  Parameters

  • assetsToLoadIn: string[] | ResolvedAsset<any>[]

    urls that you want to load, or a single one!
  • OptionalonProgress: LoadOptions | ProgressCallback

    For multiple asset loading only, an optional function that is called when progress on asset loading is made. The function is passed a single parameter, progress, which represents the percentage (0.0 - 1.0) of the assets loaded. Do not use this function to detect when assets are complete and available, instead use the Promise returned by this function.

  Returns Promise<Record<string, T>>

  Example

  // Single asset:
  const asset = await Loader.load('cool.png');
  console.log(asset);
  
  // Multiple assets:
  const assets = await Loader.load(['cool.png', 'cooler.png']);
  console.log(assets);
  Copy

reset

• reset(): void

  function used for testing

  Returns void

unload

• unload(
      assetsToUnloadIn:
          | string
          | string[]
          | ResolvedAsset<any>
          | ResolvedAsset<any>[],
  ): Promise<void>

  Unloads one or more assets. Any unloaded assets will be destroyed, freeing up memory for your app. The parser that created the asset, will be the one that unloads it.

  Parameters

  • assetsToUnloadIn: string | string[] | ResolvedAsset<any> | ResolvedAsset<any>[]

    urls that you want to unload, or a single one!

  Returns Promise<void>

  Example

  // Single asset:
  const asset = await Loader.load('cool.png');
  
  await Loader.unload('cool.png');
  
  console.log(asset.destroyed); // true
  Copy