Hierarchy

Properties

customState: GroupedMap
documentHeader: DocumentHeader

Methods

  • Retrieves a binary or text file from the container. If the file doesn't exist the promise will be rejected with an FileNotFoundError.

    Parameters

    • pFilename: string

      Name of the file. May include a path. e.g. "textures/123.jpg".

    • pBinary: false

      If true the file containes binary data and is returned as ArrayBuffer otherwise as string.

    Returns Promise<string>

  • Parameters

    • pFilename: string
    • pBinary: true

    Returns Promise<ArrayBuffer>

  • Parameters

    • pFilename: string
    • pBinary: boolean

    Returns Promise<string | ArrayBuffer>

  • Parameters

    • pIndex: number

    Returns null | string

  • Parameters

    • pIndex: number

    Returns null | string

  • Parameters

    • pIndex: number

    Returns null | string

  • Retrieves an embedded binary or text resource from the document container. If the file doesn't exist the promise will be rejected with an FileNotFoundError.

    Parameters

    • pFilename: string

      Name of the file. May include a path. e.g. "textures/123.jpg".

    • pBinary: false

      If true the file containes binary data and is returned as ArrayBuffer otherwise as string.

    Returns Promise<string>

  • Parameters

    • pFilename: string
    • pBinary: true

    Returns Promise<ArrayBuffer>

  • Parameters

    • pFilename: string
    • pBinary: boolean

    Returns Promise<string | ArrayBuffer>

  • Parameters

    • pIndex: number

    Returns null | string

  • Returns a list of files which are part of the given folder and its sub folders. The files are returned as a relative path including the file name. If the folder doesn't exist the promise will be rejected with an FileNotFoundError.

    Parameters

    • Optional pFolderPath: string

      Path of the folder.

    Returns Promise<string[]>

  • Can be used to register a task which needs to be finished before the the whole load/save process is finished. Tasks will be processed sequentially.

    Parameters

    • pTask: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    Returns void

Generated using TypeDoc