ecspresso
    Preparing search index...

    Interface AssetsResource<A, G>

    Resource interface for accessing assets in systems Exposed as $assets resource

    interface AssetsResource<
        A extends Record<string, unknown>,
        G extends string = string,
    > {
        get<K extends string | number | symbol>(key: K): A[K];
        getGroupProgress(groupName: G): number;
        getHandle<K extends string | number | symbol>(key: K): AssetHandle<A[K]>;
        getStatus<K extends string | number | symbol>(key: K): AssetStatus;
        isGroupLoaded(groupName: G): boolean;
        isLoaded<K extends string | number | symbol>(key: K): boolean;
        tryGet<K extends string | number | symbol>(key: K): A[K] | undefined;
    }

    Type Parameters

    • A extends Record<string, unknown>
    • G extends string = string
    Index

    Methods

    get getGroupProgress getHandle getStatus isGroupLoaded isLoaded tryGet

    Methods

    • Get a loaded asset. Throws if not loaded.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • key: K

      Returns A[K]

    • Get the loading progress of a group (0-1)

      Parameters

      • groupName: G

      Returns number

    • Get a handle to an asset with status information

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • key: K

      Returns AssetHandle<A[K]>

    • Get the loading status of an asset

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • key: K

      Returns AssetStatus

    • Check if all assets in a group are loaded

      Parameters

      • groupName: G

      Returns boolean

    • Check if an asset is loaded

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • key: K

      Returns boolean

    • Get a loaded asset or undefined if not loaded

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • key: K

      Returns A[K] | undefined

    Settings

    Member Visibility

    On This Page

    Methods