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

    クラス AddEffect

    add の1命令(対象プロパティへ加減算する)。

    階層 (一覧を見る)

    インデックス
    amount: number
    target: PropertyPath
    • get destroysInstrument(): boolean

      運ばれてきた相手(instrument)を丸ごと消すか(destroy、9.3節)。

      入り切らない端数の行き先を決める側が読む(9.5.1節)——相手が消えるなら、出どころへ残した分は 相手ごと失われる。destroyを書ける場所のうち相手が居るのは操作だけなので、読むのもそこ(parseInteractions)。

      戻り値 boolean

    • get movesFromInstrumentKeepingRemainder(): boolean

      相手(instrument)から移す輸送のうち、入り切らない分を出どころへ残すもの(allow_overflow が 既定のfalse)を含むか(9.5節)。

      相手を消す操作でこれを含むのは、端数を黙って捨てる形なので、ロード時に落とす側が読む (parseInteractions)——捨てるならallow_overflow: trueと名乗る(9.5.1節)。

      戻り値 boolean

    • transfer(9.5節)のlinked_add用: amount*numerator/denominatorにスケールした量を加減算する。 スケール後が0なら何もしない。

      パラメータ

      戻り値 void

    • 今この文脈で、この効果が行き先を持たないために、宣言している操作そのものが成立しないか(9.9節)。 成立しない操作は候補に出さない——落とせるのに何も起きない、を作らないため。

      既定はfalse=妨げない。 repeatLimitingVesselCountと同じく、取りこぼしても安全側(操作は出る)に 倒れるので抽象にしない。

      パラメータ

      戻り値 boolean

    • この効果が何を宣言しているかを読み上げる(EffectReader参照)。抽象なのは取りこぼしを防ぐため ——既定を持たせると、動詞を1つ足したときに読み手が黙って何も受け取らなくなる。

      パラメータ

      戻り値 void

    • まとめて実行するとき、回数の上限を決める器がいくつあるか(allow_multiple、12.4節)。 undefinedは「繰り返すと意味が変わるので数えられない」。

      既定は0=数に影響しない。 取りこぼしても「まとめられない」に倒れるだけで安全側なので、readByと 違い抽象にしない。数を決められるのは、単調に埋まる器へ入れる効果だけ。

      戻り値 number | undefined