Interface ImageAsset

画像リソースを表すインターフェース。 本クラスのインスタンスをゲーム開発者が直接生成することはない。 game.jsonによって定義された内容をもとに暗黙的に生成されたインスタンスを、 Scene#assets、またはGame#assetsによって取得して利用する。

width, heightでメタデータとして画像の大きさをとることは出来るが、 ゲーム開発者はそれ以外の情報を本クラスから直接は取得せず、Sprite等に本リソースを指定して利用する。

interface ImageAsset {
    height: number;
    hint: undefined | ImageAssetHint;
    id: string;
    onDestroyed: Trigger<Asset>;
    originalPath: string;
    path: string;
    type: "image";
    width: number;
    asSurface(): Surface;
    destroy(): void;
    destroyed(): boolean;
    inUse(): boolean;
    initialize(hint: undefined | ImageAssetHint): void;
}

Hierarchy (view full)

Properties

height: number
hint: undefined | ImageAssetHint
id: string
onDestroyed: Trigger<Asset>
originalPath: string
path: string
type: "image"
width: number

Methods

  • Returns Surface

  • このアセットのリソースの破棄を行う。

    Returns void

  • このアセットのリソースが破棄済みであるかどうかを判定する。

    Returns boolean

  • 現在利用中で解放出来ない Asset かどうかを返す。 戻り値は、利用中である場合真、でなければ偽である。

    本メソッドは通常 false が返るべきである。 例えば Sprite の元画像として使われているケース等では、その Sprite によって AssetSurface に変換されているべきで、 Asset が利用中で解放出来ない状態になっていない事を各プラットフォームで保障する必要がある。

    唯一、例外的に本メソッドが true を返すことがあるのは音楽を表す Asset である。 BGM等はシーンをまたいで演奏することもありえる上、 演奏中のリソースのコピーを常に各プラットフォームに強制するにはコストがかかりすぎるため、 本メソッドは true を返し、適切なタイミングで Asset が解放されるよう制御する必要がある。

    Returns boolean

  • Parameters

    Returns void