Call(シーンの呼び出し)
シーンからシーンへ――話の流れを操る術を、授けて差し上げますわ。
ですが Pasta には、if も while も無いと伺っております。
ご心配には及びませんわ。Pasta は宣言的な言語ですもの。シーン定義と Call だけで、十分に豊かな会話の分岐が描けますのよ。
Call 行(> / >)は、台本の流れを別の場面へ渡すト書きである。指定したシーンを呼び出し、そのシーンが終わると元の場所へ戻る。Pasta DSL は宣言的言語であり、命令型の制御構文(if / while 等)を持たない。話の流れは、シーン定義と Call で組み立てる。
この章は、基本、候補の選ばれ方、戻り方、条件分岐、引数、失敗したとき、名前の照合と別名、特殊な呼び出しの順に進む。
Call の基本
Call 行はインデントした行頭に >(または >)を置き、呼び出すターゲットを続ける。呼び出したシーンの出力は呼び出し元の出力に続けて連結され、呼び出したシーンが終わると Call 行の次の行へ戻る。
*メイン
ぱすた:自己紹介を始めます
>自己紹介
ぱすた:自己紹介が終わりました
・自己紹介
ぱすた:私はぱすたです
Call 行は暗黙の開始ブロックとローカルシーンに置ける。行末にはコメントを書ける(コメント)。
Call ターゲットの形式
Call のターゲットは 2 つの形式をとる。
| 形式 | 構文 | 説明 |
|---|---|---|
| シーン名 | >シーン名 | 書いた名前を検索キーにする |
| 動的ターゲット | >式 | 式を評価し、その値を検索キーにする |
検索キーからシーンを選ぶ手順は、どちらの形式でも同じである(シーン名の照合・スコープ解決アルゴリズム)。
> の直後が識別子ならシーン名、そうでなければ式として解釈される。動的ターゲットには変数に限らず任意の式(変数参照・関数呼び出し・文字列・数値・算術・連結)を書ける。
*スタート
$target=「挨拶」
$*topic=「天気話」
>次のステップ
>$target
>$*topic
>@話題を選ぶ()
>「挨拶」
・次のステップ
ぱすた:次のステップに来ました
>次のステップ: シーン名次のステップを検索する。>$target: ローカル変数targetの値(挨拶)を検索キーにする。>$*topic: グローバル変数topicの値(天気話)を検索キーにする。>@話題を選ぶ(): 関数話題を選ぶの戻り値を検索キーにする。関数呼び出しには括弧が必要で、>@話題を選ぶのように括弧を省くとパースエラーになる。>「挨拶」: 文字列挨拶を検索キーにする。
式の値から検索キーを作る規則と、値が検索キーにならない場合の扱いは 動的ターゲットの値 で扱う。
動的ターゲットの連結
動的ターゲットには、括弧で囲まずに連結演算子 & を書ける。連結した文字列が検索キーになり、ほかの動的ターゲットと同じ規則で検索される。連結の評価のされ方は 連結の評価 で扱う。
*OnTalk
$種類=「朝」
>$種類&「_挨拶」
>「挨拶」&$種類
・朝_挨拶
ぱすた:おはよう
・挨拶朝
ぱすた:おはようございます
>$種類&「_挨拶」:$種類の値と_挨拶をつないだ朝_挨拶を検索キーにする。>「挨拶」&$種類:挨拶朝を検索キーにする。
式の & の直後に置けるのは、被演算子の開始文字($・@・数字・-・文字列の開き 「・"・括弧の開き (・()で始まるものだけである。名前(識別子)で始まるものは置けない。また、シーン名(> の直後の識別子)は文字列の値ではないため、連結の被演算子にならない。次の Call 行はいずれもパースエラーになる。
| パースエラーになる Call 行 | 理由 |
|---|---|
>挨拶&$種類 | シーン名の直後に & を書いている。連結したシーン名で呼ぶときは >「挨拶」&$種類 のように式で書く |
>シーン名&k=v | シーン名の直後に & を書き、その後ろが名前で始まっている |
>$名前&k=v | & の直後が名前で始まっている |
前方一致によるターゲット解決
シーンの検索は前方一致で候補を列挙する。次のシーンがあるとき:
*挨拶朝
ぱすた:おはよう
*挨拶昼
ぱすた:こんにちは
>挨拶→ 「挨拶朝」「挨拶昼」の両方が候補>挨拶朝→ 「挨拶朝」のみが候補
候補が複数あれば、そこから 1 つが選ばれる。選び方は 候補の選択 で扱う。
候補の選択
前方一致で候補が複数見つかったときは、候補をシャッフルして並べ、呼び出しのたびに並びの順に 1 つずつ使う。全候補を使い切ると並べ直して最初から使う。単語の選び方と同じ方式である(シャッフル&順次消費)。同名のグローバルシーンを複数定義した場合も、同じ方式で 1 つが選ばれる。
*OnTalk
>雑談
*雑談
ぱすた:今日はいい天気だね。
*雑談
ぱすた:お腹がすいたな。
*雑談 &$*好感度≧10
ぱすた:実は、あなたと話すのが楽しいの。
3 本の *雑談 を、上から「天気」「空腹」「本音」と呼ぶ。$*好感度 が 0 の間に >雑談 を 3 回呼び、10 にしてからさらに 2 回呼ぶと、たとえば次のようになる。
| 呼び出し | 動作 | 結果 |
|---|---|---|
| 1 回目 | 3 本をシャッフルして 本音, 天気, 空腹 と並べる。「本音」は条件を満たさないので飛ばし、次を選ぶ | 天気 |
| 2 回目 | 次を選ぶ(使い切り) | 空腹 |
| 3 回目 | 並べ直して 空腹, 本音, 天気 と並べ、先頭を選ぶ | 空腹 |
4 回目($*好感度 は 10) | 次の「本音」が条件を満たすので選ぶ | 本音 |
| 5 回目 | 次を選ぶ(使い切り) | 天気 |
- 候補を一巡するまで、同じシーンは繰り返し選ばれない(
&重みのあるシーンは、後に書くとおり重みの回数だけ選ばれる)。 - 一巡の境目では、前の巡の最後と次の巡の最初が同じシーンになることがある(表の 2 回目と 3 回目)。
- 複数の候補から選ぶのは、スコープ解決アルゴリズムの 2 段目(ローカルシーン)と 5 段目(グローバルシーン)である。
候補に条件があるとき(条件で候補を絞る)も、並びは条件で絞らずに、名前に合う候補の全部で作る。条件は、並びから取り出すときにだけ見る。
- 今の巡でまだ見ていない候補を並びの順に見て、条件を満たした最初の候補を選ぶ。
- 見て条件を満たさなかった候補も、選んだ候補も、その巡ではもう見ない。
- 今の巡の候補を全部見終えたら、新しい巡を始めて並べ直し、続けて見る。1 回の選択で新しい巡を始めるのは 1 回までで、新しい巡でも条件を満たす候補が無ければ条件漏れになる(条件に合うシーンが無いとき)。
- そのため、
&優先の無い条件つきの話は、条件を満たしてから出るまでに、最大で 1 巡待つことがある。すぐ出したい話には&優先を付ける。&優先のある名前では、条件を満たした候補のうち、優先のいちばん高い段の候補だけから選ぶ。優先の高い候補が条件を満たすようになると、巡を待たずに、その次の選択でその段から選ぶ(優先)。 - 名前に合う候補のどれにも条件・
&優先・&重み・&順番が無いときは、シャッフルした並びの順に選ぶだけである。
&重み:N のシーンは、並びに N 回乗る(重み)。並びからの取り出し方は上のとおりで、重み N のシーンは 1 巡の中で N 回出る。続けて出ることもある。&重み を書かないシーンは 1 回乗る。
抽出した候補(条件を満たし、&優先 のいちばん高い段にある候補。条件も &優先 も無ければ名前に合う候補の全部)の全部に &順番 があるときは、並びを使わず、番号の順に選ぶ(順番)。
- 前に選んだ番号より大きい番号のうち、いちばん小さい番号の候補を選ぶ。そういう候補が無いときと、まだ順番で選んでいないときは、いちばん小さい番号の候補を選ぶ。条件で外れた番号は飛ばされる。
- 最後に選んだ番号は、探した名前ごとに、並びの記録と同じくメモリの中に覚える。ゴーストの終了と辞書の再読み込みで消える。
- 抽出した候補に
&順番の有る候補と無い候補が混ざっているとき、または前方一致で別の名前から同じ番号が集まったときは、注意のログを出し、並びから選ぶ(重みも効く)。 - チェイントーク の続きは選び直さない。途中で変数の値が変わって条件を満たさなくなっても、続きが出る。
スコープ解決アルゴリズム
Call は検索キーに対応するハンドラーを次の 5 段の順に探し、最初に見つかったものを呼び出す。
| 段 | 探す対象 | 一致の仕方 |
|---|---|---|
| 1 | 実行中のグローバルシーンのシーンテーブル(Lua ブロックで function SCENE.名前(act) と定義した関数など) | 完全一致 |
| 2 | 実行中のグローバルシーンの配下のローカルシーン | 前方一致 |
| 3 | act のメソッド(wait など) | 完全一致 |
| 4 | GLOBAL テーブル(>チェイントーク・>ゴースト終了・>自動トーク停止 など) | 完全一致 |
| 5 | すべてのグローバルシーン | 前方一致 |
- 別のグローバルシーンの配下のローカルシーンは候補にならない。
- ローカルシーンの候補が 1 つでもあれば、2 段目で決まる。グローバルシーンの候補とは合わせない。ローカルシーンの候補が無いときだけ、3 段目以降へ進む。
- 段 1 は 2 段目より、段 3・4 は 5 段目より先に探される。たとえば Lua ブロックで定義した関数は前方一致するローカルシーンより、
GLOBALの関数は前方一致するグローバルシーンより優先される。 - 2 段目・5 段目では、名前に合うシーンがあっても、条件を満たす候補が 1 本も無ければ(条件漏れ)、その段では見つからなかったものとして次の段へ進む(条件で候補を絞る)。どの段でも選べず、2 段目か 5 段目が条件漏れだったときだけ、Call は条件漏れで止まる(条件に合うシーンが無いとき)。
*OnTalk
ぱすた:[
>挨拶
ぱすた:]
・挨拶ローカル
ぱすた:ローカル
*挨拶グローバル
ぱすた:グローバル
この例の >挨拶 は、ローカルシーン「挨拶ローカル」が候補になるため、毎回「ローカル」を出力する。グローバルシーン「挨拶グローバル」は選ばれない。
1 段目・2 段目の「実行中のグローバルシーン」は、その Call 行を書いたグローバルシーンである。別のグローバルシーンを Call で呼んで戻った後の行でも変わらない(Call から戻った後の名前解決)。
5 段のどこにも見つからない場合、Call は失敗する。警告 act:call - handler not found: key='検索キー', mode='scene', via=act をログに出し、Call 行の位置に失敗表記を出力して、Call 行の次の行へ進む(Call が失敗したとき)。シーン名・値のある動的ターゲットのどちらでも同じである。
単語参照との違い
単語参照(@単語)も同じ 5 段で探すが、2 段目と 5 段目で探す対象が異なる。Call はローカルシーン・グローバルシーンを探し、単語参照はローカル単語辞書・グローバル単語辞書を探す。そのため、Call で単語辞書の単語は呼べず、単語参照でシーンは呼べない。同じ名前の単語とシーンがあるとき、@挨拶 は単語を、>挨拶 はシーンを使う(作例は Call との分離)。段 1・3・4 は両者で共通であり、Lua ブロックで定義した関数や GLOBAL の関数はどちらからも見つかる。単語参照の詳細は 単語定義 で扱う。
Call から戻った後の名前解決
Call 行の次の行は、Call 行を書いたグローバルシーンを実行中のグローバルシーンとして名前を解決する。呼ばれた別のグローバルシーンが実行されている間は、そのグローバルシーンが実行中のグローバルシーンになるが、戻った後の行の単語参照・Call・関数呼び出しは、呼び出し元のグローバルシーンのシーンテーブル(1 段目)と配下のローカルシーン・ローカル単語(2 段目)を探す。
*OnTalk
>挨拶
>雑談
>挨拶
・挨拶
ぱすた:こんにちは。
*雑談
>挨拶
・挨拶
ぱすた:ところで。
この例は「こんにちは。ところで。こんにちは。」を出力する。*雑談 の中の >挨拶 は *雑談 のローカルシーンを呼び、*雑談 から戻った後の >挨拶 は *OnTalk のローカルシーンを呼ぶ。
- 呼ばれたシーンの中でさらに別のグローバルシーンを呼んだ場合も同じである。どの深さでも、Call から戻った行は、その行を書いたグローバルシーンとして解決される。
- 呼んだものがシーン以外(Lua ブロックの関数・
GLOBALの関数・act のメソッド)の場合も、その関数の中から別のグローバルシーンが呼ばれた場合も、Call が失敗した場合も、Call 行の次の行は呼び出し元のグローバルシーンとして解決される。 - 呼ばれたシーンが チェイントーク で中断した場合は、再開して最後まで実行された後に Call 行の次の行へ戻り、呼び出し元のグローバルシーンとして解決される。
- ローカルシーン(暗黙の開始ブロックを含む)の最後の行の Call は、呼ばれた側へ移ったまま戻る行が無い。最後の行の Call でシーンをつないでいく限り、何回つないでも呼び出しは深くならない。そのローカルシーンが別の Call 行から呼ばれていた場合は、その Call 行の次の行が、その行を書いたグローバルシーンとして解決される。
- 関数呼び出し(アクション行・式の中の
@名前(…)・@*名前(…)・@$名前(…)、単語参照で見つかった関数)が、中で別のグローバルシーンを実行した場合も同じである。その行の残りと次の行以降は、その行を書いたグローバルシーンとして解決される。 - 選択肢は、その選択肢行を出したグローバルシーンの配下から先にジャンプ先を探す。呼ばれたシーンが出した選択肢は呼ばれたシーンの、戻った後に出した選択肢は呼び出し元のローカルシーンへジャンプする(選択肢行)。
条件分岐の実現
条件分岐は、分岐先のシーンに条件を書いて実現する(条件で候補を絞る)。
*メイン
$スコア=75
>判定
・判定&優先:2&$スコア≧90
ぱすた:優秀です!
・判定&優先:1&$スコア≧50
ぱすた:合格です
・判定
ぱすた:不合格です
>判定 は 3 つのローカルシーン「判定」を候補にし、条件を満たした候補のうち、優先のいちばん高いものを選ぶ(優先)。この例では「合格です」を出す。$スコア が 90 以上なら「優秀です!」、50 より小さければ、条件の無い(優先 0 の)「不合格です」を出す。
引数リスト
Call には括弧で囲んだ引数リストを付けられる。シーン名・動的ターゲットのどちらにも付けられる。
*OnTalk
>紹介(「ぱすた」、3)
>紹介(「ラザニア」,2+3)
*紹介
ぱすた:$0は$1歳です
- 引数どうしは読点
、・全角カンマ,・半角カンマ,で区切る。空白で区切るとパースエラーになる。 - 各引数は式である。数値・文字列・変数参照・関数呼び出し・算術・連結・括弧を書ける。
- 引数は書いた順に位置で渡される。
名前:値の形も受理されるが、名前は捨てられ、値だけが位置で渡される。 ()のように空の引数リストも書ける。- 呼び出されたシーンは、受け取った引数を
$0・$1… で参照する(変数・スコープ)。
Call は、明示した引数の後ろに、呼び出し元のシーンが受け取った引数をすべて付け足して渡す。引数リストを書かない >シーン名 は、呼び出し元の引数をそのまま渡す。動的ターゲットでも同じである。
アクション行や式の中の関数呼び出し(@関数(引数))の引数も、同じ規則で書く(アクション行)。
Call が失敗したとき
Call は、検索キーに対応するものが 5 段のどこにも見つからない場合(スコープ解決アルゴリズム)と、動的ターゲットの値が検索キーにならない場合(動的ターゲットの値)に失敗する。失敗した Call はエラーにならず、次のように動く(名前に合うシーンはあるが条件を満たす候補が無いときは、これとは別に止まる。条件に合うシーンが無いとき)。
- ログに Call の警告を 1 行出す(ターゲットの関数呼び出しが失敗した場合(関数が見つからない・動的参照の値が名前にならない)は、その失敗だけを報告し、Call の警告は出さない。ターゲットの連結・算術に変換できない値があった場合は、その前に連結・算術の警告も出る)。
- Call 行の位置に、失敗表記をバルーンに見える文字列として出力する。
- Call 行の次の行へ進む。最後の行の Call が失敗した場合は、そのシーンをそのまま終える。
*OnTalk
ぱすた:今日は
>$話題
ぱすた:……あれ?
$話題 に値を代入していない場合、この例は「今日は【名前にならない値:$話題(値なし)】……あれ?」と表示し、ログに act:call - undefined variable: 'var.話題' を出す。
失敗表記の文言と出る位置は 実行時の失敗の出力 を参照する。
動的ターゲットの値
動的ターゲットの式の値は、次のように検索キーになる。上の例の >$話題 は、表の「値なし」の行に当たる。
| 式の値 | 検索キー |
|---|---|
| 空でない文字列 | その文字列。文字列 nil(>「nil」 や、値が文字列 nil の変数)も、ほかの文字列と同じくそのまま検索キーになる |
| 数値 | アクション行で表示したときと同じ表記の文字列(3 なら 3、7/2 なら 3.5) |
| 値なし・空文字列・文字列と数値以外(真偽値・テーブルなど) | 検索キーにならない |
値が検索キーにならない場合、Call はシーンを探さずに失敗する。ログに警告を出し、Call 行の位置に失敗表記を出力して、Call 行の次の行へ進む(Call が失敗したとき)。値なしになるのは、値を代入していない変数・値を返さない関数呼び出し・見つからない関数の呼び出しを、演算子なしで 1 つだけ書いたときである。連結・算術の式は値なしにならない(値が無いときの扱い)。値なしのときは何も探さないため、nil で始まる名前のシーンや関数があっても呼ばれない。
ログの警告は、式の形と値によって次のようになる。失敗表記は 実行時の失敗の出力 を参照する。
| 式の形 | 値 | 警告 |
|---|---|---|
変数参照 1 つ(>$名前・>$*名前・>$0) | 値なし | act:call - undefined variable: 'var.名前' |
| 〃 | 空文字列 | act:call - empty variable: 'var.名前' |
| 〃 | 文字列・数値以外 | act:call - unsupported value type: 'var.名前' (boolean) |
関数呼び出し 1 つ(>@名前(…)・>@*名前(…)・>@$名前(…)) | 値なし | act:call - key is not a string or number: operand='@名前()', value=nil |
| 〃 | 空文字列・文字列と数値以外 | act:call - key is not a string or number: operand='@名前()', value=true (boolean) |
| それ以外の式(文字列・算術・連結など) | 空文字列 | act:call - key is not a string or number: value='' (string) |
- 警告の中では、変数は Lua での書き方で示される。
$名前はvar.名前、$*名前はsave.名前、$0はargs[1]である。関数は@名前(…)が@名前()、@*名前(…)が@*名前()、@$名前(…)が@$var.名前()になる。動的単語参照・連結の警告と同じ表記である(値が使えないとき・見つからないとき・被演算子の値ごとの扱い)。 - 括弧で囲んだだけの式(
>($名前))は、囲まれた変数参照・関数呼び出し 1 つと同じに扱われる。 - 型名(
boolean・table・functionなど)は値の型である。 - 関数呼び出し 1 つの行の警告は、関数が見つかって呼んだときのものである。関数が見つからないとき・動的参照の値が名前にならないときは、関数側の失敗だけが報告され、この表の警告は出ない(Call が失敗したとき)。
- 連結・算術のターゲットは、被演算子に値の無いものがあっても、値が無いときの扱い のとおりに評価した結果を検索キーにする。
>$時間帯&「の挨拶」は、$時間帯が未代入ならの挨拶を探す。見つからなければ、ほかの検索キーと同じくシーンが見つからない失敗になる(スコープ解決アルゴリズム)。 - 評価した結果が空文字列なら、検索せずに失敗する。
>$未代入&$未代入2は、どちらも未代入なら空文字列になり、表のとおりact:call - key is not a string or number: value='' (string)の警告が出る。 - 引数リストが付いていても、引数の式は書いた順に評価され、Call だけが行われない。失敗表記は、引数の式(関数呼び出しなど)が出力するものより前に出る。
条件に合うシーンが無いとき
名前に合うシーンはあるが、条件を満たす候補が 1 本も無いこと(条件漏れ)は、名前に合うシーンが無いこととは別に扱う。
| 呼ぶ所 | 名前に合うシーンが無い | 条件漏れ |
|---|---|---|
Call >名前 | 失敗表記 【シーンが見つからない:>名前】 を出し、Call 行の次の行へ進む | 失敗表記 【条件に合うシーンが無い:>名前(*止まったシーン)】 を出して止まる |
| 選択肢の飛び先 | 何も返さない(204) | 失敗表記 【条件に合うシーンが無い:OnChoiceSelectEx >ジャンプ先の名前】 を出して止まる |
| イベント・ランダムトーク・時報 | 何も返さない(204)。時報は次の名前を試す | 何も返さない(204)。時報は次の名前を試す。失敗表記は出さない |
*OnMouseDoubleClick
ぱすた:あのね。
>秘密
ぱすた:(この行は出ない)
*秘密 &$*鍵=1
ぱすた:秘密の話です。
$*鍵 が 1 でないとき、この例は「あのね。【条件に合うシーンが無い:>秘密(*OnMouseDoubleClick)】」と出して止まる。
- Call と選択肢の飛び先の条件漏れは、止まるエラーである(止まるエラーの表記)。Call 行の後の行は出ず、チェイントークの続きも捨てられる。
- 名前の書き間違いは「シーンが見つからない」、条件の書き忘れ(どれにも当たらなかったときの場面が無い)は「条件に合うシーンが無い」と、表記で見分けられる。どれにも当たらなかったときの場面は、優先の使い所の「Call の受け皿」で書ける。
- イベントは、どれにも合わなければ何も返さない。
*OnUpdateComplete &$r0=「changed」だけを書けば、ほかの値のときは何も話さない。 - 条件漏れは、trace のログに探した名前と一緒に出る。ふだんのログには出ない。
シーン名の照合
シーン名には識別子に書ける文字を使える(識別子)。*挨拶・朝 の ・ のような記号も、識別子に書ける文字であれば使える。
シーンの検索では、検索キーとシーン名をどちらも照合用の名前に揃え、照合用の名前どうしで前方一致させる。照合用の名前とは、名前の中の文字と数字(平仮名・カタカナ・漢字・英字・数字など)と _ 以外の文字を、1 文字ずつ _ に置き換えた名前である。たとえば 挨拶・朝 の照合用の名前は 挨拶_朝 である。
*挨拶・朝
ぱすた:おはよう
>挨拶・朝・>「挨拶・朝」→ どちらも照合用の名前挨拶_朝で探し、「挨拶・朝」が候補>挨拶・→ 照合用の名前挨拶_で前方一致し、「挨拶・朝」が候補
照合用の名前が同じになる名前は区別されない。*挨拶・朝 と *挨拶_朝 を両方定義すると、どちらの名前で呼んでも両方が同じ名前の候補になり、同名のグローバルシーンを複数定義した場合と同じく 1 つが選ばれる(候補の選択)。
照合用の名前に揃えるのは、シーンを探す段(スコープ解決アルゴリズムの 2 段目・5 段目)だけである。1・3・4 段は、書いた名前のまま完全一致で探す。Call のほか、SHIORI イベントに対応するシーンや選択肢のジャンプ先を探すときも、同じ照合をする。
シーン名の別名
グローバルシーンの名前は、別名表で別の名前に置き換えられる。別名表には既定の表があり、pasta.toml の [scene.alias] に書いた行で変えられる(pasta.toml リファレンス)。
既定の表は次の 7 件である。
| 置き換え先(キー) | 別名 | 使いどころ |
|---|---|---|
OnTalk | 会話 | *会話 がランダムトークのシーンになる(OnTalk) |
sakura.recommendsites | おすすめメニュー | 本体側のおすすめのメニューのシーン(おすすめメニュー) |
kero.recommendsites | 相方おすすめメニュー | 相方側のおすすめのメニューのシーン |
sakura.portalsites | ポータルメニュー | ポータルのメニューのシーン |
sakura.recommendbuttoncaption | おすすめボタン名 | 本体側のおすすめのボタンの名前の単語 |
kero.recommendbuttoncaption | 相方おすすめボタン名 | 相方側のおすすめのボタンの名前の単語 |
sakura.portalbuttoncaption | ポータルボタン名 | ポータルのボタンの名前の単語 |
[scene.alias] は、書いたキーの既定の別名だけを置き換える。
[scene.alias]
OnBoot = ["起動"]
OnTalk = ["会話", "おしゃべり"]
"sakura.recommendsites" = []
- 書いたキーは、既定の別名を捨てて書いた配列にする。この例では
*起動がOnBootのシーンになり、*会話・*おしゃべりがランダムトークのシーンになる。 - 空の配列を書いたキーは、既定の別名を消す。この例では
*おすすめメニューはメニューのシーンにならず、書いたとおりの名前のふつうのシーンになる。 - 書かなかったキーの既定の別名は残る。この例では
相方おすすめメニュー・ポータルメニューとボタンの名前の 3 つが残る。 - 見出しの
[scene.alias]だけを書いて行を 1 つも書かないときは、既定の表をそのまま使う。 - 書いた別名が、残っている既定の別名と同じ名前のときは、読み込みエラーになる。たとえば
OnBoot = ["会話"]だけを書くと、既定のOnTalk = ["会話"]とぶつかる。エラーの文に相手の既定のキーが出るので、OnTalk = []を書き足して既定を消せば読み込める。
実際に使う別名表(既定と書いた行を合わせた結果)は、読み込みのたびに info のログ Scene alias table に出る。
置き換えは次の規則で行う。
- 完全一致: 書いた名前(照合用の名前に揃える前の名前)が別名と完全に一致するときだけ置き換える。
会話・朝・会話2のように、別名で始まるだけの名前は置き換えない。 - 1 段だけ: 置き換えは 1 回だけ行う。置き換えた後の名前を、さらに置き換えることはない。
- グローバルシーン名だけ: 置き換えるのはグローバルシーンの名前だけである。ローカルシーン(
・会話)・単語(@会話)・アクター・変数の名前は置き換えない。 - 置き換え後は前方一致: 置き換えた後の名前を照合用の名前に揃え、ほかの名前と同じく前方一致で探す。
置き換えは、宣言と検索の両方で行う。
- 宣言: グローバルシーンの宣言
*名前(名前を書かない単独の*行が受け継ぐ名前を含む)は、名前が別名に一致すると、置き換え先の名前のシーンとして登録される(グローバルシーン)。 - 検索: スコープ解決アルゴリズムの 5 段目(すべてのグローバルシーン)に進んだ検索は、すべて検索キーを置き換えてから探す。2 段目(実行中のグローバルシーンの配下のローカルシーン)と 1・3・4 段は、書いた名前のまま探す。そのため、実行中のグローバルシーンに
・会話のローカルシーンがあれば、>会話はそのローカルシーンを呼ぶ。
検索キーを置き換える入口は次のとおりである。
| 入口 | 例 |
|---|---|
| Call のシーン名・文字列・動的ターゲットの値 | >会話・>「会話」・>$話題(値が 会話) |
| 選択肢のジャンプ先 | @?会話 |
| SHIORI イベントに対応するシーンの検索・仮想イベント(OnTalk・OnHour) | シーン関数フォールバック |
Lua の検索 API(範囲を指定しない SEARCH:search_scene・SCENE.co_exec・act:call) | @pasta_search |
範囲を指定した SEARCH:search_scene(第 2 引数あり)と、登録名(OnTalk_1 など)を直接受け取る入口は置き換えない。
既定の表のもとで、次のシーンがあるとき:
*会話
ぱすた:今日はいい天気だね。
*OnTalk朝
ぱすた:おはよう。
*会話・朝
ぱすた:朝の話をしよう。
*会話はOnTalkという名前で登録される。*OnTalk朝とともにランダムトークの候補になる。*会話・朝は別名と完全一致しないため、会話・朝という名前のまま登録される。ランダムトークの候補にはならない。>会話→OnTalkに置き換えて前方一致で探し、「会話」と「OnTalk朝」が候補。「会話・朝」は候補にならない。>OnTalk→ 「会話」と「OnTalk朝」が候補(「会話」はOnTalkの名前で登録されているため)。>会話・朝・>会話・→ 置き換えずに照合用の名前会話_朝・会話_で前方一致し、「会話・朝」が候補。
置き換えた後の名前でも見つからない場合、Call の失敗表記には書いた名前(>会話)が出る(実行時の失敗の出力)。ログには、書いた名前と置き換えた後の名前の両方を記した警告も出る。
特殊な呼び出し
あらかじめ用意された次の名前を Call で呼ぶと、シーン以外の動作を起こせる。これらも 5 段の検索で解決される。
| 構文 | 動作 |
|---|---|
>チェイントーク / >yield | ここまでの出力を返してシーンの実行を中断し、残りを次の自然なおしゃべりの機会に出力する |
>ゴースト終了 / >ゴースト終了(ミリ秒) | ゴーストを終了させる |
>自動トーク停止 / >pause_auto_talk | ランダムトーク・時報などの自動トークを止める |
>自動トーク再開 / >resume_auto_talk | 止めていた自動トークを再開する |
>おすすめ項目(名前、URL、選んだときのシーン、バナー) / >recommend_item(…) | おすすめメニューに項目を 1 つ加える(おすすめメニュー) |
>おすすめ区切り / >recommend_separator | おすすめメニューに区切り線を加える |
>シーン数(名前) / >scene_count(名前) | >名前 が選ぶ候補のシーンの数を数える(シーン数・シーン数完全一致) |
>シーン数完全一致(名前) / >scene_count_exact(名前) | 名前がちょうどその名前のシーンの数を数える |
アクション行の中に @yield・@チェイントーク・@ゴースト終了・@自動トーク停止・@自動トーク再開 と書いても、>yield・>チェイントーク・>ゴースト終了・>自動トーク停止・>自動トーク再開 と同じ動作になる。単語参照の形(直後に空白を置く)でも、関数呼び出しの形(@yield()・@ゴースト終了(1500) など)でもよい。アクション行の中の @シーン数(「雑談」)・@シーン数完全一致(「雑談」) は、数をその位置の台詞の文字として出す。
*OnTalk
ぱすた:ねえ、聞いて。@チェイントーク 昨日面白いことがあったの。
この例は、@チェイントーク の前後で 2 回の OnTalk に分けて出力される。
チェイントーク
>チェイントーク(または >yield)を書くと、それより前の出力がそのイベントの応答として返され、シーンの実行はそこで中断する。残りは、次の自然なおしゃべり(仮想ディスパッチャが起こす OnTalk)の機会に、新しい OnTalk シーンの代わりに出力される。
続きが出るのは、仮想ディスパッチャが一定の間隔で起こす自然なおしゃべりの機会だけである。外から起こした OnTalk(\![raise,OnTalk] や開発用パレットなど)では続きは出ず、新しいトークが始まる。そのトークのシーンも、ほかのイベントのシーンと同じく、台詞を出したときだけ待っていた続きを捨てる(続きが捨てられるとき・OnTalk)。
*OnTalk
ぱすた:ねえ、聞いて。
>チェイントーク
ぱすた:昨日面白いことがあったの。
>yield
ぱすた:……やっぱり内緒。
ぱすた:またね。
>チェイントークを複数回書くと、出力を 3 回以上に分けられる。この例は 3 回の OnTalk に分けて出力される。- 最後の部分を出力し終えると、次の自然なおしゃべりからは通常どおりシーンが選ばれる。
- OnTalk 以外のイベント(
*OnBootなど)のシーンで使った場合も、残りは次の自然なおしゃべりの機会に出力される。 - 残りが出力されるのを待っている間に、別のイベントでシーンが実行されても(時報のシーンを含む)、そのシーンが台詞を出さなければ、残りはそのまま待つ。台詞を出したときは、待っていた残りは捨てられる(続きが捨てられるとき)。
- 中断している間もローカル変数は保たれ、再開後のシーンから同じ値を参照できる。
- 何も出力していないところで区切ったとき(
>チェイントークの直後の>チェイントークなど)は、応答を返さずにその場で続きを再開する。1 つのイベントの中でこれが 10,000 回を超えて続くと、シーンはエラーで止まり、止まるエラーの表記(【スクリプトのエラー:*シーン名(何も出さない区切りが 10000 回続いた)】)が出て、続きは捨てられる。何も出さずに区切り続けるループでベースウェアが固まらないためである。 >チェイントークはGLOBAL["チェイントーク"](4 段目)で、>yieldは act のメソッドyield(3 段目)で解決される。どちらも同じ動作である。GLOBAL["チェイントーク"]を Lua で定義し直すと>チェイントークの動作を変えられる。
Note: 自動トークを止めた区間の中で
>チェイントーク(>yield・@チェイントーク、Lua のact:yield()も同じ)を使うのはスクリプトの誤りである。止めている間は続きを出す機会が来ないためである。使った場合は、ログに警告が出て、止めている状態が解ける(>自動トーク再開と同じ)。区切りそのものは通常どおり行われる。止めた区間を区切るには、選択肢やイベントを使う。
続きが捨てられるとき
続きを待っている間に、続きとは別のシーンがイベントで実行されたとき、待っていた続きを捨てるのは、そのシーンがその回の出力で台詞を出したときだけである。台詞を出さなかったときは、続きはそのまま待ち、次の自然なおしゃべりの機会に出る。イベントの種類(撫で・つつき・マウスの出入り・選択肢・時報・外から起こした OnTalk など)によらず、同じ決まりである。自動トークを止めている間に届いたイベントのシーンにも、同じ決まりが当たる。
台詞に数えるのは、次の 2 つだけである。
- 字のある台詞(
ぱすた:こんにちは。など) - 選択肢(
@?案内を聞く「聞く」など)
次のものだけを出す回は、台詞に数えない。
- 表情の切り替え(
ぱすた:@笑顔など) - さくらスクリプト(
\![bind,…]・\s[…]など)。字を表示するタグも数えない - ウェイト・改行・クリア・立ち位置の切り替え
- 失敗表記(実行時の失敗の出力)。バルーンには表記が出るが、台詞には数えない
- 字の無い台詞(空の文字列だけの台詞)。バルーンに字が出ないため
- 何も出さない回
*OnTalk
ぱすた:昔々、あるところに……。
>チェイントーク
ぱすた:おじいさんとおばあさんが住んでいました。
*OnMouseMove
ぱすた:@笑顔
*OnMouseDoubleClick
ぱすた:なあに?
この例で昔話の前半が出た後にマウスを動かすと、*OnMouseMove は表情を変えるだけなので、後半はそのまま待ち、次の自然なおしゃべりの機会に出る。ダブルクリックすると、*OnMouseDoubleClick が「なあに?」と台詞を出すので、後半は捨てられ、出ない。
- 台詞を出さずに
>チェイントークで区切ったシーンは、前から待っている続きを残す。そのシーンが区切った残りは捨てられる。 - 台詞を出したシーンが
>チェイントークで区切ったときは、前から待っている続きは捨てられ、そのシーンの残りが新しい続きになる(チェイントーク中断 の台詞が出たときを除く)。 - get_property などのコールバック待ちに台詞を出さずに入ったシーンは、続きを残す。待ちから戻った回に台詞を出せば、ほかのシーンと同じく続きを捨てる。
- 捨てた続きを、後から再開する仕組みは無い。
次の場合は、台詞の有無にかかわらず待っていた続きを捨て、*チェイントーク中断 も実行しない。
- VSCode のシーン再生で再生したシーン
- OnPastaScene・OnPastaSceneAt で再生したシーン
- エラーで止まったシーン。止まるまでに台詞を出していたかは問わない。応答は止まるエラーの表記になる。再開した続き自身がエラーで止まったときも、その続きは捨てられる
再生したシーンが >チェイントーク で区切れば、その残りが新しい続きになる。シーンが見つからないときなど、シーンを再生しなかったときは、待っている続きに触れない。
チェイントーク中断
*チェイントーク中断 という名前のシーンを書いておくと、台詞を出したシーンが待っていた続きを捨てたときに、そのシーンの出力の代わりに *チェイントーク中断 の出力が出る。話の途中で割り込まれたときだけ出る台詞を書ける。
*OnTalk
ぱすた:昔々、あるところに……。
>チェイントーク
ぱすた:おじいさんとおばあさんが住んでいました。
*OnMouseDoubleClick
ぱすた:なあに?
*チェイントーク中断
ぱすた:あ、お話の途中だったのに。まあ、いいか。
この例で昔話の前半が出た後にダブルクリックすると、「あ、お話の途中だったのに。まあ、いいか。」だけが出る。*OnMouseDoubleClick の「なあに?」も、昔話の後半も出ない。続きを待っていないときにダブルクリックすると、「なあに?」だけが出る。
- 中断の台詞を、割り込んだシーンの出力に添えると会話がうまくつながらないため、中断の台詞を優先する。割り込んだシーンのその回の出力は、表情の切り替えや立ち位置も含めて出さず、次の応答へも持ち越さない。
- 割り込んだシーンが出力を作るまでに書き換えた変数は、そのまま残る。シーンを動かした後で、台詞を出したかが分かるためである。
- 中断の台詞が出た回は、待っていた続きが無くなる。割り込んだシーンが
>チェイントークで区切っていても、その残りも捨てられる。 - メニュー(ダブルクリック)やゴーストの終了(
*OnClose)のように、反応そのものに役目があるイベントでも同じである。中断の台詞が出た回は、メニューは開かず、ゴーストは終了しない。続きはもう無いので、もう一度操作すれば、ふだんどおり反応する。 *チェイントーク中断を書いていないときは、割り込んだシーンの出力がそのまま出て、待っていた続きは黙って捨てられる。*チェイントーク中断の出力が空のときも同じである(割り込んだシーンが区切っていれば、その残りが続きになる)。- 台詞を出さないシーンや、続きを待っていないときに台詞を出したシーンでは、
*チェイントーク中断は実行されない。シーン再生・OnPastaScene・OnPastaSceneAt・エラーで止まったシーンでも実行されない(続きが捨てられるとき)。 *チェイントーク中断は、特別な書き方の要らないふつうのシーンである。名前の完全一致で探し、*チェイントーク中断ごっこのように、この名前で始まるだけのシーンは使わない。同じ名前で複数書くと、ふだんの同じ名前のシーンと同じ選び方で、その中から 1 つが選ばれる。*チェイントーク中断の中で>チェイントークを使うと、ふつうのシーンと同じく出力の無い区切りを飛ばし、最初に出力のある区切りまでの出力だけが使われる。残りは捨てられ、続きにならない。中断の中でコールバック待ちに入ったときは、中断の台詞は付かない。*チェイントーク中断自身の出力は、割り込みに数えない。*チェイントーク中断がエラーで止まったときは、ほかのシーンのエラーと同じく止まるエラーの表記が出て、待っていた続きは捨てられる。止まった場所は*チェイントーク中断として示される。
ゴースト終了
>ゴースト終了 は、ゴーストを終了させるさくらスクリプト \- を出力に加える。引数にミリ秒の数値を渡すと、その時間だけ待ってから終了する(\_w[ミリ秒]\- を出力する)。
*OnClose
ぱすた:またね。
>ゴースト終了(1500)
自動トーク停止・自動トーク再開
>自動トーク停止 は、ゴーストの方から始まる自動トークを止める。>自動トーク再開 は、止めていた自動トークを再開する。選択肢やイベントで区切りながら進むトーク(初回起動の案内など)の途中に、ランダムトークや時報が割り込まないようにするために使う。
*OnFirstBoot
>自動トーク停止
ぱすた:はじめまして。少し案内させてね。
@?案内を聞く「聞く」
@?案内を飛ばす「あとで」
・案内を聞く
ぱすた:右クリックでメニューが開くよ。
>案内の終わり
・案内を飛ばす
>案内の終わり
・案内の終わり
>自動トーク再開
ぱすた:これからよろしくね。
この例では、選択肢を出してから選ばれるまでの間に、ランダムトークや時報は始まらない。>自動トーク再開 の後からは、通常どおりランダムトークや時報が出る。
- どちらも呼ばれた時点ですぐに効く。シーンの出力が表示されるのを待たない。
- どちらも出力には何も加えない。
- 止めている間は、次のものが始まらない。
- ランダムトーク(
OnTalkのシーン) - 時報(
OnHourのシーン) - 止まっているシーンの続き(チェイントーク で中断したシーンの残りなど)。待っている続きは、止めているという理由では捨てられない。
- ふだんのつつき・撫での反応(名前の候補の 1〜8 段のシーン)
- ランダムトーク(
- 止めている間も、次のものは通常どおり動く。
- ベースウェアから届くイベント(選択肢の選択・起動や終了など)への応答
- get_property のコールバック(OnPastaCallBack)の待ち時間切れへの応答
- 仮想時刻の読み取り
- つつき・撫での 9 段目のイベント名のシーン(
*OnMouseDoubleClick・*OnMouseMove)。止めた区間の区切りに、つつきや撫でを使える。 - ゴーストが
REG.OnMouseDoubleClick・REG.OnMouseMoveに置いた自前のハンドラ - シーン再生で求めたシーンの最初の出力
- 再開すると、次のランダムトークまでの間隔は再開した時点から数え直される。止めている間に過ぎた正時の時報は、再開した後にも出ない。次の正時からは通常どおり時報が出る。
- 止める回数は数えない。
>自動トーク停止を何回呼んでも、>自動トーク再開を 1 回呼べば解ける。止めていないときに>自動トーク再開を呼んでも、何も変わらない。 - 止めている状態は、ゴーストを起動している間だけ保たれる。保存データには残らず、ゴーストを起動し直すと止めていない状態から始まる。時間が経っても自動では解けないので、選択肢が選ばれずに閉じられたときなど
>自動トーク再開まで進まなければ、起動し直すまで止めたままになる。
>自動トーク停止 は GLOBAL["自動トーク停止"](4 段目)で、>自動トーク再開 は GLOBAL["自動トーク再開"] で解決される。Lua からは GLOBAL.pause_auto_talk(act)・GLOBAL.resume_auto_talk(act) で同じ動作を呼べる(>pause_auto_talk・>resume_auto_talk とも書ける)。これらの名前は main.lua の後に読み込まれるランタイムが登録するため、main.lua で同じ名前に代入しても元に戻る。
おすすめメニュー
SSP の右クリックメニューの「おすすめ」「相方おすすめ」「ポータル」の中身とボタンの名前は、決まった名前のシーンと単語で書ける。pasta.toml は書かなくてよい。
*おすすめメニュー
>おすすめ項目(「カクヨム」、「https://kakuyomu.jp/」、「おすすめ_カクヨム」)
>おすすめ項目(「青空文庫」、「https://www.aozora.gr.jp/」)
*おすすめメニュー
>おすすめ項目(「小説家になろう」、「https://syosetu.com/」)
>おすすめ区切り
>おすすめ項目(「青空文庫」、「https://www.aozora.gr.jp/」)
*相方おすすめメニュー
>おすすめ項目(「IPA セキュリティ」、「https://www.ipa.go.jp/security/」)
*おすすめ_カクヨム
ぱすた:小説を探しに行くのね。いってらっしゃい。
@おすすめボタン名:本棚、おすすめ
- メニューを開くたびに、2 つの
*おすすめメニューのどちらかの並びが出る。同じ名前のシーンは、ほかのシーンと同じく、その中から 1 つが選ばれる(候補の選択)。 - カクヨムを選ぶと、SSP がその URL をブラウザで開き、
*おすすめ_カクヨムが話す。 - 本体側のメニューのボタンの名前が「本棚」か「おすすめ」になる。
- メニューを開いても、待っているチェイントークの続きは消えない。
メニューのシーン
SSP はメニューを開くたびに、その中身をゴーストに問い合わせる。pasta は、問い合わせに結びついたシーン(メニューのシーン)をその場で最後まで動かし、その中で >おすすめ項目・>おすすめ区切り を呼んだ順に項目を並べて答える。
| シーン名 | メニュー | 結びつくリソースの ID |
|---|---|---|
*おすすめメニュー | 本体側のおすすめ | sakura.recommendsites |
*相方おすすめメニュー | 相方側のおすすめ | kero.recommendsites |
*ポータルメニュー | ポータル | sakura.portalsites |
- 結びつきはシーン名の別名の既定の表による。名前を変えるときや、3 人目からのキャラクターのおすすめ(
char2.recommendsitesなど)を書くときは、pasta.toml の[scene.alias]に行を足す(例:"char2.recommendsites" = ["三人目おすすめメニュー"])。 - メニューのシーンは名前の完全一致で探す。
*おすすめメニュー_秋のように、この名前で始まるだけのシーンは使わない。 - メニューを開くたびにシーンを動かし直す。同じ名前のシーンの選び直しも、シーンの中の単語・変数の値も、そのつど効く。
- メニューのシーンも、ふつうのシーンと同じく Call で呼べる。メニューのシーンの外で
>おすすめ項目・>おすすめ区切りを呼んでも、何も出力せず、トークは変わらない。 - メニューのシーンが Call で呼んだシーンの中の
>おすすめ項目・>おすすめ区切りも、同じメニューに並ぶ。共通の項目を 1 つのシーンにまとめて呼べる。 - メニューのシーンに書いた台詞(アクション行・表情の指定・さくらスクリプト)はメニューに入らず、捨てられる。
pasta_check validateは、メニューのシーンの台詞をrecommend-menu-talkの注意として知らせる(辞書の検査)。 - メニューのシーンが項目を 1 つも並べなかったときや、メニューのシーンが無いときは、SSP のメニューは空になる。
*おすすめメニュー
>よく行く場所
>おすすめ区切り
>おすすめ項目(「青空文庫」、「https://www.aozora.gr.jp/」)
*ポータルメニュー
>よく行く場所
*よく行く場所
>おすすめ項目(「カクヨム」、「https://kakuyomu.jp/」、「おすすめ_カクヨム」)
>おすすめ項目(「小説家になろう」、「https://syosetu.com/」)
この例では、おすすめとポータルのどちらのメニューにも *よく行く場所 の 2 つの項目が並ぶ。Call で呼ぶ共通のシーンには、引数を付けずに呼ぶ。
おすすめ項目・おすすめ区切り
>おすすめ項目(名前、URL、選んだときのシーン、バナー) は、メニューに項目を 1 つ加える。
| 引数 | 内容 | 省略 |
|---|---|---|
| 名前 | メニューに出る項目の名前 | できない |
| URL | 選んだときに SSP が開く URL。script: で始まる URL は、SSP がそのさくらスクリプトを走らせる | できない |
| 選んだときのシーン | 選んだ後に話すシーンの名前(選んだ後のトーク) | できる |
| バナー | 項目に出すバナー画像のパス | できる |
- 各引数は式である。単語・変数・式の値を、名前・URL・シーン名・バナーに使える。数値は文字列にして使う。
- 空の文字列を渡した引数は、省いたのと同じに扱う。3 つ目を省いてバナーだけを渡すときは、3 つ目に
「」を書く。 - 値は書いたまま SSP に渡す。台詞の加工(ウェイト・改行など)は通らず、バナーのパスも変換しない。
- 名前か URL が無い・空である・文字列や数値でないとき、また値にバイト値 1・2 が含まれるときは、その項目だけを加えず、ログに警告を出す。ほかの項目はメニューに並ぶ。5 つ目から後の引数は使わず、ログに警告を出す。
>おすすめ区切り は、メニューに区切り線を加える。引数は要らない。
*おすすめメニュー
$よく読む=「https://www.aozora.gr.jp/」
>おすすめ項目(「青空文庫」、$よく読む、「」、「aozora.png」)
>おすすめ区切り
>おすすめ項目(「カクヨム」、「https://kakuyomu.jp/」、「おすすめ_カクヨム」)
この例の 1 つ目の項目は、URL を変数から渡し、3 つ目を 「」 で省いてバナーだけを付ける。メニューには、青空文庫・区切り線・カクヨムの順に並ぶ。
>おすすめ項目 は GLOBAL["おすすめ項目"]、>おすすめ区切り は GLOBAL["おすすめ区切り"](どちらも 4 段目)で解決される。英語の名前は >recommend_item・>recommend_separator である。
ボタンの名前
メニューのボタンの名前は、次の名前の単語で書く。単語が無ければ、SSP の既定のボタンの名前のままになる。
| 単語の名前 | ボタン | 結びつくリソースの ID |
|---|---|---|
@おすすめボタン名 | 本体側のおすすめ | sakura.recommendbuttoncaption |
@相方おすすめボタン名 | 相方側のおすすめ | kero.recommendbuttoncaption |
@ポータルボタン名 | ポータル | sakura.portalbuttoncaption |
@おすすめボタン名:本棚、おすすめ
@相方おすすめボタン名:ぼくのおすすめ
@ポータルボタン名:よく行く場所
この例では、本体側のボタンの名前が、メニューを開くたびに「本棚」か「おすすめ」のどちらかになる。
- 単語は、グローバルな単語辞書から名前の前方一致で引く。シーンの中のローカルな単語は引かない。別名が複数あるときは、別名を辞書順に試し、単語が見つかった最初の名前を使う。候補が複数あれば、メニューを開くたびにその中から 1 つが選ばれる。値は加工せずにボタンの名前にする。
- 結びつきはメニューのシーンと同じく、シーン名の別名の表による。3 人目からのキャラクターのボタンの名前は、
[scene.alias]に"char2.recommendsites.caption" = ["三人目ボタン名"]のように書く。
選んだ後のトーク
メニューの項目を選ぶと、SSP が項目の URL を開く。あわせて、項目の 3 つ目の引数に書いたシーンが話す。
*おすすめメニュー
>おすすめ項目(「カクヨム」、「https://kakuyomu.jp/」、「おすすめ_カクヨム」)
>おすすめ項目(「青空文庫」、「https://www.aozora.gr.jp/」)
*おすすめ_カクヨム
ぱすた:小説を探しに行くのね。
*OnRecommendsiteChoice
ぱすた:いってらっしゃい。
この例でカクヨムを選ぶと「小説を探しに行くのね。」、3 つ目の引数の無い青空文庫を選ぶと「いってらっしゃい。」と話す。
- 選んだときのシーンは、名前の完全一致で探す。
- 選んだ項目は、そのメニューを開いたときの並びから探す。メニューのシーンを動かし直さないため、同じ名前のシーンで並びを変えていても、選んだ項目のシーンが話す。
- 3 つ目の引数が無い項目を選んだときは、
OnRecommendsiteChoiceで始まる名前のシーン(*OnRecommendsiteChoiceなど)が話す。そのシーンも無ければ、何も話さない。ゴーストを読み直した後に、読み直す前に開いたメニューから選んだときも同じである。 - 3 つ目の引数に書いた名前のシーンが辞書に無いときは、
*OnRecommendsiteChoiceへは回さず、シーンが見つからないことを示す失敗表記が出る(実行時の失敗の出力)。 - 選んだ後のトークは、ほかのイベントのシーンと同じく、台詞を出せば待っていたチェイントークの続きを捨てる。
*チェイントーク中断があれば、その台詞が代わりに出る(続きが捨てられるとき・チェイントーク中断)。
メニューを開いても変わらないもの
メニューを開くのは、話の流れとは別の操作である。メニューのシーンを動かしても、次のものは変わらない。
- 待っているチェイントークの続き。
*チェイントーク中断も出ない。続きは、メニューを開かなかったときと同じく次の自然なおしゃべりの機会に出る。 - 次のトークに持ち越す立ち位置と表情。
- ほかのシーンの get_property のコールバック待ち。
- 自動トークを止めた状態。
メニューのシーンの中で変数に代入した値は、ふつうのシーンと同じく残る。
- メニューのシーンが
>チェイントークに着くと、そこでシーンを打ち切り、それまでに並べた項目でメニューを作る。打ち切った残りは捨て、チェイントークの続きにはしない。 - メニューのシーンがコールバック待ち(
act:get_property)に着いたときも、そこで打ち切る。待ちは登録せず、ログに警告を出す。 - メニューのシーンがエラーで止まったときは、メニューの中身を返さずにエラーの応答を返し、エラーをログに出す。失敗表記は出ない。
*おすすめメニュー
$*開いた回数=$*開いた回数+1
>おすすめ項目(「青空文庫」、「https://www.aozora.gr.jp/」)
>チェイントーク
>おすすめ項目(「カクヨム」、「https://kakuyomu.jp/」)
この例のメニューには、青空文庫だけが並ぶ。$*開いた回数 は、メニューを開くたびに 1 ずつ増える。
REG["sakura.recommendsites"] など、Lua で受け手を書いたゴーストでは、その受け手が動く(SHIORI イベント)。
シーン数・シーン数完全一致
@シーン数(名前) は、>名前 が選ぶ候補のシーンの数を返す。@シーン数完全一致(名前) は、名前がちょうどその名前のシーンの数を返す。同じ名前のシーンをいくつ書いたかを、台詞や計算に使える。
*雑談
ぱすた:今日はいい天気だね。
*雑談
ぱすた:お腹がすいたな。
*雑談
ぱすた:何か面白いことないかな。
*雑談_朝
ぱすた:おはよう。
*雑談_朝
ぱすた:朝ごはんは食べた?
*OnMouseDoubleClick
ぱすた:話題は@シーン数(「雑談」)個、そのうち雑談そのものは@シーン数完全一致(「雑談」)個あるよ。
この例のダブルクリックでは、「話題は5個、そのうち雑談そのものは3個あるよ。」と出る。@シーン数(「雑談」) は *雑談 の 3 本と *雑談_朝 の 2 本を数えて 5、@シーン数完全一致(「雑談」) は *雑談 の 3 本だけを数えて 3 になる。
- 英語の名前
scene_count・scene_count_exactも、それぞれ同じ動作をする。 - 変数に代入すると数値が入り、計算に使える。
$n=@シーン数(「雑談」)の後、$n+1は 6 になる。Lua から読むact.var.nも数値の 5 である。 >シーン数(「雑談」)のように Call で呼ぶと、数えるだけで台詞を出さず、Call 行の次の行へ進む。
数え方は次のとおりである。
シーン数は>名前と同じ前方一致で数える。照合用の名前が、引数の名前で始まるシーンを数える(前方一致によるターゲット解決)。シーン数完全一致は、照合用の名前が引数の名前と等しいシーンだけを数える。- 数えるのはグローバルシーンだけである。ローカルシーンは、どのシーンの配下のものも数えない。どのシーンから呼んでも、同じ名前なら同じ数になる。Lua で定義したグローバルシーンも、
>名前で選べるものは数える。 - 引数の名前がシーン名の別名と完全に一致すれば、置き換え先の名前で数える。その後で照合用の名前に揃える。既定の別名表のもとでは、
@シーン数(「会話」)は>会話と同じくOnTalkで始まるシーンを数え、*会話_朝は数えない。@シーン数(「会話・朝」)は*会話・朝を数える。 - 当てはまるシーンが無ければ
0を返す。失敗表記も警告も出さない。 - 数は、定義されているシーンの全部の数である。シーンに書いた属性によって変わらない。条件の属性も見ず、今の変数の値で条件を満たすかどうかにかかわらず、名前に合うシーンを数える。数えても、
>名前の次の選び(候補の選択)は変わらない。
引数は次のように扱う。
- 引数が無い・値の無い変数・空の文字列・文字列でも数値でもない値(真偽値・表など)のときは、ほかの失敗と同じく失敗として報告し、
0を返す。呼んだ位置に失敗表記【名前にならない値:シーン数(値なし)】を出し、ログに警告シーン数: bad argument: name=nilを 1 行出す。表記とログには、呼んだ関数の名前と値の種類が出る(実行時の失敗の出力)。 - 引数が数値のときは、失敗表記も警告も出さずに
0を返す。シーン名は数字で始まらないので、当てはまるシーンは無い。 - 2 つ目より後の引数は使わない。警告も出さない。Call の形では、呼び出し元のシーンが受け取った引数が後ろに付け足されて渡るためである(引数リスト)。
>シーン数 は GLOBAL["シーン数"](4 段目)で解決される。*シーン数 という名前のシーンを書いても、>シーン数(…) は組み込みの関数を呼ぶ。Lua からは GLOBAL.scene_count(act, 名前)・GLOBAL.scene_count_exact(act, 名前) で同じ数を読める(GLOBAL)。
これで会話に「流れ」と「分岐」が生まれますわ。シーンを呼び合うだけで物語が動く――なかなか痛快でしょう?
文法の章は、これでひととおりでございます。あとは、お好きな台本をお書きになるだけでございますね。