UnmappedIsland ソースリファレンス - v0.1.0
    検索インデックスを準備しています...

    クラス AssetPack

    読み込み済みのアセットパック1つ(AssetPack.md)。

    中身の置き方は同梱ぶん(src/assets/)と同じで、ZIPのトップがそこに相当する(同3節)。 このクラスは在庫表——何が入っているかへの問い合わせ窓口であり、絵のURLもYAMLの中身も ここから引く。読み込みに成功した時点で全エントリの在処が分かっているので、 「あるかどうか」を取得しに行って確かめる必要はない(同4節)。

    名乗りは中身から読む。 取得元のURLやファイル名からは採らない——ミラーやリネームで 変わる名前では、同じパックが別物になる(同3.2節)。

    インデックス
    files: ReadonlyMap<string, Uint8Array<ArrayBufferLike>>
    name: string

    パックが名乗った識別子。出所の表示(エラーメッセージと、定義の出所に使う)。

    urls: Map<string, string> = ...

    作ったBlobのURL。同じ絵を2度要求されても1つで済ませる。

    version: string

    パックが名乗った版。大小の順序は持たず(AssetPack.md 3.2節)、書くのは文字列(同 3.5節)。

    • 1つのフォルダ直下の絵。名前は拡張子を落としたファイル名で、同梱ぶんの規約と同じ。

      パラメータ

      • prefix: string

      戻り値 ReadonlyMap<string, string>

    • 背景の絵。ファイル名(拡張子なし) → URL(backgrounds/<持ち主>_<スロット>_<用途>.png)。

      戻り値 ReadonlyMap<string, string>

    • 表示文字列(locale/<言語>.yaml)の中身。持っていなければundefined。

      パラメータ

      • language: string

      戻り値 string | undefined

    • 型ごとの絵。object_defの識別子 → URL(objects/<識別子>.png)。

      戻り値 ReadonlyMap<string, string>

    • 届いた配布物1つを読む。ZIPとして読めない配布物・pack.yaml を名乗れない配布物は、パックに ならない(ZipReadError・YamlLoadError)。読めなかった配布物をどう扱うかは受け取る側が決める (AssetPack.md 6.1節、install)。

      パラメータ

      • archive: ArrayBuffer

      戻り値 Promise<AssetPack>

    • 1つの絵のURL。実体はBlobで、パックを読み込んだ時点のバイト列を指す。

      パラメータ

      • path: string

      戻り値 string

    • 定義YAML(world-codex/ 以下)の中身。キーは出所として出すファイル名。

      戻り値 ReadonlyMap<string, string>