Small World Engine API Reference - v0.78.00
    Preparing search index...

    Class AssetManager

    Per-instance manager for loading and caching assets (images, text, etc.). Construct one per engine instance (see RendererContext.assetManager) so its cache can be released with the engine instead of living for the process's lifetime.

    Index
    • get isLoaded(): boolean

      Returns boolean

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Returns the global loading progress (0.0 to 1.0).

      Returns number

    • Parameters

      Returns Promise<ImageBitmap | HTMLImageElement>

    • Returns a promise that resolves when all currently active loading processes are finished.

      Returns Promise<void>

    • Resolves a relative or root-relative URL against the configured base URL or Vite base path.

      Parameters

      • url: string

        The asset URL to resolve.

      Returns string

    • Sets a custom header to be sent with every asset request.

      Parameters

      • key: string

        The header name (e.g. "Authorization").

      • value: string

        The header value.

      Returns void

    • Streams a binary resource chunk-by-chunk directly with chunk notifications and builds a contiguous ArrayBuffer (DirectStorage Web streaming).

      Parameters

      • url: string

        The resource URL.

      • OptionalonChunk: (chunk: Uint8Array, loaded: number, total: number) => void

        Optional callback invoked when each chunk is received.

      • OptionalonProgress: ProgressCallback

        Optional progress callback.

      Returns Promise<ArrayBuffer>

    • Returns number

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Parameters

      Returns Promise<ArrayBuffer>

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Parameters

      Returns Promise<ImageBitmap | HTMLImageElement>

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Returns Promise<void>

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Parameters

      • url: string

      Returns void

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Parameters

      • key: string
      • value: string

      Returns void

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.

    • Parameters

      • url: string
      • OptionalonChunk: (chunk: Uint8Array, loaded: number, total: number) => void
      • OptionalonProgress: ProgressCallback

      Returns Promise<ArrayBuffer>

      Use an instance via RendererContext.assetManager instead. Removal target: v1.0.0.