phaser - v4.0.0-rc.4
    Preparing search index...

    A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after the loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.

    You shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • loader: LoaderPlugin

        The Loader that is going to load this File.

      • type: string

        The file type string for sorting within the Loader.

      • key: string

        The key of the file within the loader.

      • files: File[]

        An array of Files that make-up this MultiFile.

      Returns MultiFile

    Properties

    baseURL: string

    A reference to the Loaders baseURL at the time this MultiFile was created. Used to populate child-files.

    complete: boolean

    The completion status of this MultiFile.

    config: any

    A storage container for transient data that the loading files need.

    failed: number

    The number of files that failed to load.

    files: File[]

    Array of files that make up this MultiFile.

    key: string

    Unique cache key (unique within its file type)

    loader: LoaderPlugin

    A reference to the Loader that is going to load this file.

    path: string

    A reference to the Loaders path at the time this MultiFile was created. Used to populate child-files.

    pending: number

    The number of files to load.

    prefix: string

    A reference to the Loaders prefix at the time this MultiFile was created. Used to populate child-files.

    state: number

    The current state of the file. One of the FILE_CONST values.

    type: string

    The file type string for sorting within the Loader.

    Methods

    • Adds another child to this MultiFile, increases the pending count and resets the completion status.

      Parameters

      • files: File

        The File to add to this MultiFile.

      Returns MultiFile

    • Checks if this MultiFile is ready to process its children or not.

      Returns boolean

    • Called by each File when it finishes loading.

      Parameters

      • file: File

        The File that has completed processing.

      Returns void

    • Called by each File that fails to load.

      Parameters

      • file: File

        The File that has failed to load.

      Returns void

    • Called once all children of this multi file have been added to their caches and is now ready for deletion from the Loader.

      It will emit a filecomplete event from the LoaderPlugin.

      Returns void