Class AssetAccessor

アセットへのアクセスを提供するアクセッサ群。

実態は AssetManager のいくつかのメソッドに対するラッパーである。 このクラスにより、パス・アセットID・パターン・フィルタから、対応する読み込み済みアセットを取得できる。

通常、ゲーム開発者はこのクラスのオブジェクトを生成する必要はない。 g.Scene#asset に代入されている値を利用すればよい。

Hierarchy

  • AssetAccessor

Constructors

Properties

_assetManager: AssetManager

Methods

  • 与えられたパターンまたはフィルタにマッチするパスを持つ、読み込み済みの全オーディオアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 引数の仕様については AssetAccessor#getAllImages() の仕様を参照のこと。 ただしオーディオアセットに限り、拡張子を省いたものでなければならない。(e.g. "/audio/bgm*")

    Parameters

    • Optional patternOrFilter: string | ((path: string) => boolean)

      取得するオーディオアセットのパスパターンまたはフィルタ。省略した場合、読み込み済みの全て

    Returns AudioAsset[]

  • 与えられたパターンまたはフィルタにマッチするパスを持つ、読み込み済みの全画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    ここでパスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスである。

    パターンは、パス文字列、またはパス中に0個以上の **, *, ? を含む文字列である。 ここで ** は0個以上の任意のディレクトリを、 * は0個以上の / でない文字を、 ? は1個の / でない文字を表す。 (e.g. "/images/monsters??/*.png")

    フィルタは、パスを受け取ってbooleanを返す関数である。 フィルタを与えた場合、読み込み済みの全アセットのうち、フィルタが偽でない値を返したものを返す。

    Parameters

    • Optional patternOrFilter: string | ((path: string) => boolean)

      取得する画像アセットのパスパターンまたはフィルタ。省略した場合、読み込み済みの全て

    Returns ImageAsset[]

  • 与えられたパターンまたはフィルタにマッチするパスを持つ、読み込み済みの全スクリプトアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 引数の仕様については AssetAccessor#getAllImages() の仕様を参照のこと。

    Parameters

    • Optional patternOrFilter: string | ((path: string) => boolean)

      取得するスクリプトアセットのパスパターンまたはフィルタ。省略した場合、読み込み済みの全て

    Returns ScriptAsset[]

  • 与えられたパターンまたはフィルタにマッチするパスを持つ、読み込み済みの全テキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 引数の仕様については AssetAccessor#getAllImages() の仕様を参照のこと。

    Parameters

    • Optional patternOrFilter: string | ((path: string) => boolean)

      取得するテキストアセットのパスパターンまたはフィルタ。省略した場合、読み込み済みの全て

    Returns TextAsset[]

  • 与えられたパターンまたはフィルタにマッチするパスを持つ、読み込み済みの全ベクタ画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 引数の仕様については AssetAccessor#getAllImages() の仕様を参照のこと。

    Parameters

    • Optional patternOrFilter: string | ((path: string) => boolean)

      取得するベクタ画像アセットのパスパターンまたはフィルタ。省略した場合、読み込み済みの全て

    Returns VectorImageAsset[]

  • パスから読み込み済みのオーディオアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 さらにオーディオアセットに限り、拡張子を省いたものでなければならない。(e.g. "/audio/bgm01")

    当該のオーディオアセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      取得するオーディオアセットのパス

    Returns AudioAsset

  • アセットIDから読み込み済みのオーディオアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 当該のオーディオアセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      取得するオーディオアセットのID

    Returns AudioAsset

  • パスから読み込み済みの画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該の画像アセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      取得する画像アセットのパス

    Returns ImageAsset

  • アセットIDから読み込み済みの画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 当該の画像アセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      取得する画像アセットのID

    Returns ImageAsset

  • パスから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得し、その内容をJSONとしてパースした値を返す。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      内容のJSONを取得するテキストアセットのパス

    Returns any

  • アセットIDから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得し、その内容をJSONとしてパースして返す。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      内容のJSONを取得するテキストアセットのID

    Returns any

  • パスから読み込み済みのスクリプトアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該のスクリプトアセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      取得するスクリプトアセットのパス

    Returns ScriptAsset

  • アセットIDから読み込み済みのスクリプトアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 当該のスクリプトアセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      取得するスクリプトアセットのID

    Returns ScriptAsset

  • パスから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      取得するテキストアセットのパス

    Returns TextAsset

  • アセットIDから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      取得するテキストアセットのID

    Returns TextAsset

  • パスから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得し、その内容の文字列を返す。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      内容の文字列を取得するテキストアセットのパス

    Returns string

  • アセットIDから読み込み済みのテキストアセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得し、その内容の文字列を返す。 当該のテキストアセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      内容の文字列を取得するテキストアセットのID

    Returns string

  • パスから読み込み済みのベクタ画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。

    パスはgame.jsonのあるディレクトリをルート (/) とする、 / 区切りの絶対パスでなければならない。 当該のベクタ画像アセットが読み込まれていない場合、エラー。

    Parameters

    • path: string

      取得する画像アセットのパス

    Returns VectorImageAsset

  • アセットIDから読み込み済みのベクタ画像アセット(現在のシーンで読み込んだ、またはグローバルなアセット)を取得する。 当該のベクタ画像アセットが読み込まれていない場合、エラー。

    Parameters

    • assetId: string

      取得するベクタ画像アセットのID

    Returns VectorImageAsset

Generated using TypeDoc