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

    クラス CodexView

    読み込んだ定義を人間向けのHTMLに変換する窓口。

    定義の中身をどう言い表すかはdescribe*(describe/)が知っているので、ここが担うのは見せ方 だけ——表示名を引く、リンクを張る、識別子と表示名を切り替える。

    インデックス
    defNames: DefNames | undefined
    namingMode: NamingMode
    source: CodexSource
    • 定義自身にwriterへ書かせ、その結果をリストへ(呼び出し側がwriterを持ち回らずに済む近道)。

      パラメータ

      戻り値 string

    • 消し方の名乗り(9.3節のdestroyのreason)の文言。死亡ダイアログに出るのと同じ言葉。

      パラメータ

      • name: string

      戻り値 string

    • objectNameの型がpropertyNameのプロパティを持つか。

      パラメータ

      • objectName: string
      • propertyName: string

      戻り値 boolean

    • 操作の表示名。オブジェクトのメンバーなので持ち主とセットで引く。

      パラメータ

      • objectName: string
      • name: string

      戻り値 string

    • 表示名が対応表に無いか。識別子がそのまま出ている状態を「未翻訳」とみなす目安で、 翻訳の抜けを見つける手掛かりとして印を付けるためだけに使う。

      パラメータ

      戻り値 boolean

    • 見出しに出るのが識別子そのものか(識別子表示モード、または未翻訳)。そのとき識別子を脇や下へ 添えると、同じ文字列が2つ並ぶだけになる。

      パラメータ

      戻り値 boolean

    • 一覧に出すobject_defを、グローバルIDの順(=宣言順)に返す。

      製作中オブジェクト(RecipeSystem.md 1節)は含めない。 レシピから自動生成された型で、 中身は完成品のrecipesの節にそのまま出ている——一覧に並べても、作りかけの姿という同じ物の 別の顔が増えるだけで、読み手には重複にしか見えない。識別子で名指しすれば個別のページは開ける。

      戻り値 readonly ObjectDef[]

    • 土地の型(TerrainGeneration.md 1節)は表示名をlocation_textsが持つ(object_textsではない)ため、 object_textsに宣言が無ければそちらを見る。宣言があればそちらが優先。

      パラメータ

      • name: string

      戻り値 string

    • propertyNameという名前のプロパティを持つobject_defの識別子(宣言順)。

      パラメータ

      • propertyName: string

      戻り値 readonly string[]

    • slotNameという名前のスロットを持つobject_defの識別子(宣言順)。

      パラメータ

      • slotName: string

      戻り値 readonly string[]

    • タグ(4.1節)を持つobject_defの識別子(宣言順)。一覧に出さない型は含まない(listedObjectDefs参照)。

      パラメータ

      • tagName: string

      戻り値 readonly string[]

    • パラメータ

      • objectName: string
      • propertyName: string

      戻り値 string

    • プロパティの名乗り。表示名は持ち主ごとに変えられる(Localization.md)ので、持ち主とセットで引く。

      パラメータ

      • objectName: string | undefined
      • propertyName: string

      戻り値 DisplayIdentity

    • プロパティの表示名。同じ名前でもobject_defごとに文字列を変えられる(Localization.md)ため、 持ち主が分かっていればそれを使い、分からなければdefaultエントリだけで引く。

      パラメータ

      • objectName: string | undefined
      • propertyName: string

      戻り値 string

    • プロパティ参照のリンク先。持ち主が分かっていればそのページ、分からなければ同名のプロパティを 持つobject_defを探し、1つなら直接、複数なら候補一覧へ向ける(実行時にどのインスタンスが 相手になるかは、定義だけからは決まらないため)。

      パラメータ

      • objectName: string | undefined
      • propertyName: string

      戻り値 string | undefined

    • 参照1つのHTML。識別子は常に吹き出し(title)へ残し、表示名で見ていても元の名前を辿れるようにする。 prefixは名前の前に置くHTML(型の絵など。リンクの内側に入れて、絵からも辿れるようにする)。

      パラメータ

      • kind: string
      • identifier: string
      • label: string
      • href: string | undefined
      • prefix: string = ''

      戻り値 string

    • 告げる出来事(9.8節のsignal)の文言。札の上に出るのと同じ言葉。

      パラメータ

      • name: string

      戻り値 string

    • タグの行き先はタグ別の一覧(1ページ)の中のその節。タグごとにページを分けない。

      パラメータ

      • name: string

      戻り値 string

    • object_defのタグ(4.1節)。ここは識別子をそのまま出す——tag_texts(Localization.tag)は 在るが、ビューアはタグを見出しではなく分類の鍵として並べるため、引き当てていない。

      パラメータ

      • name: string

      戻り値 string

    • 宣言されているobject_defのタグ(4.1節)を、宣言順(グローバルIDの順)に返す。

      戻り値 readonly string[]

    • 説明の断片1つをHTMLへ。selfObjectNameはselfが指すobject_def(この説明を宣言している型)で、 self.温度のような参照のリンク先を決めるのに要る。

      パラメータ

      戻り値 string