Engine API Reference - v2.6.1
    Preparing search index...

    Class AssetListLoader

    Used to load a group of assets and fires a callback when all assets are loaded.

    const assets = [
        new Asset('model', 'container', { url: `http://example.com/asset.glb` }),
        new Asset('styling', 'css', { url: `http://example.com/asset.css` })
    ];
    const assetListLoader = new AssetListLoader(assets, app.assets);
    assetListLoader.load((err, failed) => {
        if (err) {
            console.error(`${failed.length} assets failed to load`);
        } else {
            console.log(`${assets.length} assets loaded`);
       }
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    destroy fire hasEvent load off on once ready

    Constructors

    • Create a new AssetListLoader using a list of assets to load and the asset registry used to load and manage them.

      Parameters

      • assetList: number[] | Asset[]

        An array of Asset objects to load or an array of Asset IDs to load.

      • assetRegistry: AssetRegistry

        The application's asset registry.

      Returns AssetListLoader

      const assetListLoader = new pc.AssetListLoader([
          new pc.Asset("texture1", "texture", { url: 'http://example.com/my/assets/here/texture1.png') }),
          new pc.Asset("texture2", "texture", { url: 'http://example.com/my/assets/here/texture2.png') })
      ], app.assets);

    Methods

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Start loading asset list and call done() when all assets have loaded or failed to load.

      Parameters

      • done: Function

        Callback called when all assets in the list are loaded. Passed (err, failed) where err is undefined if no errors are encountered and failed contains an array of assets that failed to load.

      • Optionalscope: any

        Scope to use when calling callback.

      Returns void

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    • Sets a callback which will be called when all assets in the list have been loaded.

      Parameters

      • done: Function

        Callback called when all assets in the list are loaded.

      • Optionalscope: any = ...

        Scope to use when calling callback.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods