選択肢の表示の実装

[HidetoshiKawaguchi]

• [x] 1. 仕様兼Wikiのドキュメントの作成
• [x] 2. テストケースの作成
• [x] 3. 実装
• [x] 4. ヘルプ文への組み込み

wikiドキュメント案

(1) 選択肢の表示

「選択肢の表示」は以下の記法で組み込むことができます。

<ShowChoices: 背景, ウィンドウ位置, デフォルト, キャンセル>
<When: 選択肢1の文>
選択肢1を選んだ時の処理
<When: 選択肢2の文>
選択肢2を選んだ時の処理
.
.
.
<When: 選択肢6の文>
選択肢6を選んだ時の処理
<WhenCancel>
選択肢をキャンセルした時の処理
<End>

必須の引数はありません。 全ての引数はオプションとして設定でき、指定しない場合はデフォルト値が設定されます。 引数を設定しない場合、<ShowChoices>でも<ShowChoices: >でも記述できます。 Whenタグが上から順に選択肢1, 選択肢2と対応しています。

ShowChoicesは選択肢の表示かSHCで代替できます。また、Whenは選択肢で、Endは分岐終了で、WhenCancel>は<キャンセルのとき>で代替できます。

引数(オプション)の指定方法を述べる前に、いくつか具体例を示します。

• 例1: 以下の設定で、選択肢を2つ表示する場合

  • 背景: ウィンドウ
  • ウィンドウ位置: 右
  • デフォルト: 選択肢 ＃1
  • キャンセル: 選択肢 ＃2

    長老に会って挨拶は済ませてきたかい？
    <ShowChoices: Window, Right, 1, 2>
    <When: はい>
    そうか。それならよかった。
    早速長老の依頼のとおり、北に向かってくれないかい。
    <When: いいえ>
    それはいけない。
    長老は君のような若者を探しているんだ。
    挨拶に行って話を聞いてくれないかい。
    <End>

    また、例1の引数は全てデフォルト値なので、以下のようにも記述できます。2行目だけ異なります。

    長老に会って挨拶は済ませてきたかい？
    <ShowChoices>
    <When: はい>
    そうか。それならよかった。
    早速長老の依頼のとおり、北に向かってくれないかい。
    <When: いいえ>
    それはいけない。
    長老は君のような若者を探しているんだ。
    挨拶に行って話を聞いてくれないかい。
    <End>

• 例2: 以下の設定で、選択肢を3つ表示する場合

  • 背景: 透明
  • ウィンドウ位置: 真ん中
  • デフォルト: 選択肢 ＃1
  • キャンセル: 分岐

    他にも話したいことがあるんだ。
    何が聞きたい？
    <ShowChoices: Transparent, Middle, 1, Branch>
    <When: 勇者ノーゼンの伝説>
    勇者ノーゼンは〜〜（省略
    <When: 魔王に挑む冒険者の現状>
    魔王に挑む冒険者は〜〜（省略
    <When: 魔王について判明している点>
    魔王について判明している点は〜〜（省略
    <WhenCancel>
    ・・・え、僕の話、長すぎた？ごめんごめん。
    <End>

それぞれの引数に設定できる項目は以下の通りです。ツクールの選択肢に対応しています。

• 背景は以下のリストから指定します。
  • ウィンドウ: Window or ウィンドウ
  • 暗くする: Dim or 暗くする
  • 透明: Transparent or 透明
• ウィンドウ位置は以下のリストから指定します。
  • 左: Left or 左
  • 中: Middle or 中
  • 右: Right or 右
• デフォルトは以下のリストから指定します。
  • なし: None or なし
  • 選択肢 ＃1: 1
  • 選択肢 ＃2: 2
  • ...
  • 選択肢 ＃6: 6
• キャンセルは以下のリストから指定します。
  • 分岐: Branch or 分岐
  • 禁止: Disallow or 禁止
  • 選択肢 ＃1: 1
  • 選択肢 ＃2: 2
  • ...
  • 選択肢 ＃6: 6

マニュアルにはない仕様

• ツクール上からは7個以上の選択肢を作れないが、JSONを直接触れば実現でき、ゲームも問題なく動作する。ユーザが7個以上の選択肢を設定できそうだと感じ設定する可能性を考慮して、選択肢7以上でも動くようにすること。（６個できるように実装する過程で７個以上にも対応しているとは思うが）

メモ

• 選択肢の表示のJSONパラメータはかなり癖があるよう. 順番も表記通りでない[キャンセル, デフォルト, 位置, 背景]の順
• キャンセル時の処理を「分岐」に設定したけど、その分岐処理がない場合はスルーし、キャンセル時の処理にそのままその数値(-2)を代入する。ツクール本体からではこれらの整合が崩れることはないが、直接JSONをいじって整合を壊しても問題なく処理が進んだ.（空のイベントが進むだけ)
• 背景のデフォルト設定は、プラグインコマンドで設定されたメッセージのデフォルト値に沿うか悩んでいる
  • → 沿わなくていいか。通常メッセージほどの頻度で使うことはないだろうし。とりあえずシンプルな実装にしよう
• 引数なし時に、コロンなし記法はなくてもいいか悩んでいる
  • → あった方が便利か。引数がない他のタグはコロンがないので、そちらとの一貫性を優先することにする。