Esposter
    Preparing search index...

    Class TiledJSONExternalFile

    Hierarchy

    • MultiFile
      • TiledJSONExternalFile
    Index

    Constructors

    • Parameters

      • loader: LoaderPlugin
      • key: string | object
      • OptionaltilemapURL: string | object
      • Optionalpath: string | object
      • OptionalbaseURL: string | object
      • OptionaltilemapXhrSettings: XHRSettingsObject
      • OptionaltilesetXhrSettings: XHRSettingsObject

      Returns TiledJSONExternalFile

    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: [TilemapFile, ...TilesetFile[]]

    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

    • Returns Promise<void>

    • 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

    • Destroy this Multi File and any references it holds.

      Returns void

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

      Returns boolean

    • Called by each File when it finishes loading.

      Parameters

      • file: TilemapFile

        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