行とブロック構造
台本でいう「柱」――場面の見出しのお話ですわ。行が積み重なって「ブロック」を作り、シーンという大きな器の中に、台詞やト書きがきちんと収まりますの。その仕組みを見ていきましょう。
器に収めると申しますと、お屋敷の食器棚のようなものでございますね。
まあ、うまいことを言いますわね! 構造を掴めば、辞書ファイル全体が手に取るように分かりますわよ。
グローバルシーン(*)とローカルシーン(・)は、台本の柱(場面の見出し)にあたる。柱の下に、インデントした台詞とト書きの行が並ぶ。この章は、ファイルの中に柱がどう並び、柱の中にどの行を置けるかを扱う。
ブロック構造
次の例は、1 つのファイルに置ける主な行をひととおり並べたものである。
&作者:Alice
@天気:晴れ、くもり、雨
%ぱすた
@通常:\s[0]
@笑顔:\s[1]
*会話&季節:春
&話題:天気
@相づち:いいね、そうだね
%ぱすた
```lua
local count = 0
function SCENE.回数(act)
count = count + 1
return tostring(count)
end
```
ぱすた:@通常 今日の天気は@天気 だよ。
:この話は@回数()回目だね。
>続き
・続き
ぱすた:@笑顔 @相づち 。
| 例の行 | 行の種類 | 台本の言葉 |
|---|---|---|
&作者:Alice | ファイルレベル属性行 | 柱に付く(この行より後の、同じファイルのグローバルシーン) |
@天気:晴れ、くもり、雨 | グローバル単語定義 | (台本に無い) |
%ぱすた とその配下 | アクター辞書 | 登場人物 |
*会話&季節:春 | グローバルシーン(属性を付記) | 柱 |
&話題:天気・%ぱすた(インデントあり) | 初期部の属性行・アクター指定行 | 柱に付く |
@相づち:いいね、そうだね | 初期部のローカル単語定義 | (台本に無い) |
```lua から ``` まで | Lua ブロック | (台本に無い) |
ぱすた:@通常 今日の天気は…・:この話は… | アクション行・継続行 | 台詞 |
>続き | Call | ト書き |
・続き | ローカルシーン | 柱 |
ファイルは、ファイルレベルの行(ファイルレベル属性行・グローバル単語定義)・アクター辞書・グローバルシーンを任意の順に並べたものである。グローバルシーンが 0 個のファイル(単語定義やアクター辞書だけのファイル)も有効である。
グローバルシーン
グローバルシーンは行頭が *(または *)で始まる。シーン本体はインデントした行で記述する。
*挨拶
ぱすた:こんにちは!
ラザニア:ごきげんよう!
同名のグローバルシーンを複数定義できる。呼び出し時に前方一致で候補が列挙され、候補はシャッフルされたうえで呼び出しのたびに 1 つずつ順に使われる(全候補を使い切ると並べ直す)。詳細は Call で扱う。
*挨拶
ぱすた:おはよう!
*挨拶
ぱすた:こんばんは!
名前を書かない単独の * 行は、同じファイルで直前に宣言したグローバルシーンと同じ名前の、別のグローバルシーンを開始する。前のシーンへ統合されるのではなく、同名シーンの候補が 1 つ増える。ローカル単語定義・ローカルシーン・属性は前のシーンと共有しない(属性は *&重み:5 のようにその行に付記できる。属性)。ファイルの先頭(それより前にグローバルシーンが無い位置)の単独の * 行はパースエラーになる。
*OnTalk
ぱすた:最初の候補です。
*
ぱすた:2 つめの候補です(*OnTalk と同じ名前)。
グローバルシーンの名前が pasta.toml の別名表の別名に完全一致すると、そのシーンは置き換え先の名前で登録される。既定の表には OnTalk = ["会話"] があり、*会話 はランダムトーク(OnTalk)のシーンになる(既定の表のほかの別名は シーン名の別名 で扱う)。*OnTalk と書いた場合と同じく OnTalk の候補になり、登録名も置き換え先の名前から作られる(*OnTalk の無いゴーストの 1 つ目の *会話 は OnTalk_1)。名前を書かない単独の * 行は、置き換えた後の名前を受け継ぐ。
*会話
ぱすた:今日はいい天気だね。
*
ぱすた:お腹がすいたな(*会話 と同じ名前で、これも OnTalk の候補)。
置き換えるのは名前全体が別名に一致するときだけで、*会話・朝 のように別名で始まるだけの名前は書いたとおりの名前で登録される。置き換えの規則と検索での扱いは シーン名の別名、別名表の書き方は pasta.toml リファレンス で扱う。
グローバルシーンの内部構造
グローバルシーンは、宣言行に続いて次の要素をこの順で持つ。
- グローバルシーン行:
*名前(または単独の*) - 初期部: 属性行(
&名前:値)・ローカル単語定義(@名前:値)・アクター指定行(%名前)を 0 個以上、任意の順で - Lua ブロック: 0 個以上
- 暗黙の開始ブロック(
__start__): ローカルシーン宣言なしで書くコンテンツ行(アクション行・継続行・変数代入・Call・選択肢行・キューコマンド行)を 0 個以上と、その後ろに Lua ブロックを 0 個以上 - ローカルシーン: 0 個以上の明示的ローカルシーン(
・名前)
グローバルシーンが Call の対象になると、暗黙の開始ブロック(__start__)が実行される。コンテンツ行が 0 個でもよい。
ブロック構造 の冒頭の例の *会話 に当てはめると、次のとおりである。
| 要素 | 冒頭の例の行 |
|---|---|
| 1. グローバルシーン行 | *会話&季節:春 |
| 2. 初期部 | &話題:天気・@相づち:いいね、そうだね・%ぱすた |
| 3. Lua ブロック | ```lua から ``` まで |
| 4. 暗黙の開始ブロック | ぱすた:@通常 今日の天気は… から >続き まで |
| 5. ローカルシーン | ・続き とその配下の行 |
ローカルシーン
ローカルシーンは親のグローバルシーンの中でのみアクセス可能で、インデント+・(または -)で始まる。
*メインメニュー
ぱすた:何をしますか?
>選択肢1
・選択肢1
ぱすた:選択肢1が選ばれました
・選択肢2
ぱすた:選択肢2が選ばれました
ローカルシーンは、宣言行・コンテンツ行(アクション行・継続行・変数代入・Call・選択肢行・キューコマンド行)0 個以上・Lua ブロック 0 個以上で構成される。ローカルシーンには属性行・単語定義・アクター指定行を置けない。属性は宣言行への付記(・名前&名前:値)としてだけ書ける。
アクター辞書
アクター辞書は行頭の %名前 で始まり、インデントした単語定義・属性行・変数代入と、Lua ブロックを配下に持つ。構文と用途は アクター辞書 で扱う。
行の種類
行の種類を、置ける場所とあわせてまとめる。行はインデントの有無で大きく二分される。
インデント不要の行
行頭にインデントを置かない行(グローバルレベル)。
| 行種 | 形 | 説明 |
|---|---|---|
| グローバルシーン | *名前 / *名前 | グローバルシーンを開始する |
| 名前なしグローバルシーン | * / *(単独) | 直前のグローバルシーンと同じ名前の、別のグローバルシーンを開始する |
| グローバル単語定義 | @名前:値、値 | 全辞書ファイル共通で参照できる単語を定義する |
| アクター辞書 | %名前 | アクター単位の単語辞書を開始する |
| ファイルレベル属性行 | &名前:値 | ファイル単位の属性(属性を参照) |
| Lua ブロックのフェンス | 3 個以上のバッククォート | グローバルシーンまたはアクター辞書に属する複数行のコード(Lua ブロックの配置を参照) |
| コメント行・空行 | # / # | 処理されない(コメント・空行を参照) |
インデントが必要な行
行頭にインデントを置く行(下層レベル)。置ける場所が行の種類ごとに決まっている。
| 行種 | 形 | 置ける場所 |
|---|---|---|
| 属性行 | &名前:値 | グローバルシーンの初期部、アクター辞書の配下 |
| 単語定義(インデントあり) | @名前:値、値 | グローバルシーンの初期部(ローカル単語)、アクター辞書の配下(アクターの単語) |
| アクター指定行 | %名前、名前 | グローバルシーンの初期部 |
| ローカルシーン | ・名前 / -名前 | グローバルシーンの配下 |
| アクション行 | アクター:台詞 | 暗黙の開始ブロック・ローカルシーン |
| 継続行 | :台詞 | 暗黙の開始ブロック・ローカルシーン |
| 変数代入 | $名前=式 | 暗黙の開始ブロック・ローカルシーン(アクター辞書の配下でも受理されるが、何も起きない) |
| Call | >シーン名 | 暗黙の開始ブロック・ローカルシーン |
| 選択肢行 | @?名前「表示」 | 暗黙の開始ブロック・ローカルシーン |
| キューコマンド行 | !コマンド名(引数) | 暗黙の開始ブロック・ローカルシーン |
グローバルシーンの初期部とは、グローバルシーン宣言の直後、最初のアクション行などのコンテンツ行より前の部分を指す。属性行・単語定義・アクター指定行は初期部にだけ置け、アクション行などの後に置くとパースエラーになる。各行の構文は、アクション行・継続行は アクション行、変数代入は 変数・スコープ、Call は Call、単語定義は 単語定義、アクター辞書とアクター指定行は アクター辞書 で扱う。
Note: コメント行と空行はインデントの有無にかかわらず、どの位置にも置ける。
コメント
# または # から行末までがコメントとして扱われ、構造・セマンティクスに影響しない。行全体がコメントの行(コメント行)は、インデントの有無にかかわらずどの位置にも置ける(Lua ブロックの内容の中を除く)。
*テスト
# これはコメントです
ぱすた:これは実行されます
# 全角シャープでもOK
行の後ろに置く行末コメントは、次の行で書ける。
- グローバルシーン宣言・単独の
*行・ローカルシーン宣言 - アクター辞書の宣言(
%名前)・アクター指定行(%名前、名前) - 属性行・変数代入・Call・キューコマンド行・選択肢行
- 値を
「」または"で囲んだ単語定義 - Lua ブロックの閉じフェンス
次の行では行末コメントを書けない。#・# 以降も台詞・値の一部になる。
- アクション行・継続行(
#・#以降も台詞として出力される) - 値を囲んでいない単語定義(
@w:あ、い #cの候補はあとい #c)
*OnTest # 行末コメント
$回数=1 # 行末コメント
さくら:本文 #これも台詞として出力される
空行
空行(空白だけの行を含む)はどの位置にも置け、無視される。アクション行の継続(: で始まる継続行)の途中に空行を挟んでも、改行などは出力されない。
文字コード
辞書ファイル(.pasta)は UTF-8 で保存する。
- ファイル先頭の BOM(U+FEFF)は読み飛ばされる。BOM 付きの UTF-8 で保存してもよい。
- UTF-8 として読めないファイル(Shift_JIS など)は読み込めない。
インデントの判定
インデントは「有るか・無いか」のバイナリ判定のみで扱われ、深さは判定されない。インデントレベルが一貫している必要もない。インデントに使える文字は キーワード・マーカー の空白の文字である。
*会話 ← インデントなし(グローバルレベル)
&author:Alice ← インデントあり(下層レベル)
・選択肢1 ← インデントあり(下層レベル)
Alice:こんにちは ← インデントあり(下層レベル)
選択肢行
選択肢行は、プレイヤーに提示する選択肢を定義する。インデントした行で @?(または @?)に続けてジャンプ先の名前を書き、必要なら表示テキストを 「」 で囲んで続ける。
@?ジャンプ先
@?ジャンプ先「表示テキスト」
@?と@?は同等で、@?や@?のように全角・半角を混ぜてもよい。- 表示テキストを省略すると、ジャンプ先の名前がそのまま表示テキストになる。
- 表示テキストは 1 重の
「」で囲む。"や「「…」」のような多重の囲みは使えず、表示テキストに」は含められない。 - ジャンプ先の名前は識別子である。ジャンプ先の名前と
「の間に空白は置けない(@?挨拶 「挨拶する」はパースエラー)。 - 行末にコメントを書ける。
選択肢行は、選択肢をさくらスクリプトの \![*]\q[表示テキスト,ジャンプ先,グローバルシーン名] として、その行の位置に出力する。
- 3 番目の引数は、その選択肢行を出したグローバルシーンの登録名(シーン名の照合用の名前の後ろに
_と通し番号を付けた名前。1 つ目の*メインならメイン_1)である。 - ジャンプ先の名前が
Onまたはscript:で始まるときは、3 番目の引数を付けずに\![*]\q[表示テキスト,ジャンプ先]を出力する。これらの ID では、ベースウェアがOnChoiceSelectExを送らず、3 番目以降の引数を別の意味に使うためである。
選択肢は、バルーンの 1 行に 1 つずつ表示される。Pasta が、選択肢の直前と、選択肢の後に続く台詞の直前に、行を区切る改行を出力するためである。出力する改行は、1 回のトークの出力(さくらスクリプト 1 本)の中で、同じスポット(バルーン)に最後に表示したものによって決まる。
| 出力するもの | そのバルーンに最後に表示したもの | 直前に出力する改行 |
|---|---|---|
| 選択肢 | まだ何も表示していない | 出力しない |
| 選択肢 | 台詞 | \n[N](pasta.toml の choice_newlines で決まる幅。既定では \n[150]) |
| 選択肢 | 選択肢 | \n または \n[N](pasta.toml の after_choice_newlines で決まる幅。既定では \n) |
| 台詞 | 選択肢 | \n または \n[N](after_choice_newlines で決まる幅。既定では \n) |
choice_newlines・after_choice_newlinesの書き方とNの決まり方は choice_newlines・after_choice_newlines で扱う。- 話すアクターが切り替わって、すでに台詞を出したバルーンへ戻ったときは、戻ってから最初に出す台詞の前に
spot_newlinesの改行が出力される(spot_newlines)。この台詞の前では、そのバルーンに最後に表示したものが選択肢でも、spot_newlinesの改行だけが出力され、表の選択肢の後の改行は重ならない。戻った直後に出す選択肢の前の改行は表のとおりに決まり、spot_newlinesの改行は、その後の最初の台詞の前に出力される。 - 選択肢の前と、選択肢の後の台詞の前には、同じ話し手の行の改行(line_newlines)を重ねて出力しない。表の改行だけが出力される。
- アクション行に書いた
\cでバルーンを消去すると、そのバルーンは、まだ何も表示していない状態に戻る。消去した直後の選択肢の前には改行を出力しない。引数つきの\c[…]と\xは、バルーンの消去に数えない。 - 表情の切り替え・ウェイト・
!selectのように文字を表示しないものは、台詞にも選択肢にも数えない。台詞と選択肢の間や、選択肢と選択肢の間に書いても、出力する改行は変わらない。 - 台詞に書いた改行(
\n)は、そのまま出力される。表の改行も省かれず、両方が出力される。 - 1 回の出力の中で、どのアクション行よりも前に出力される選択肢は、スポット 0 のバルーンに表示したものとして数える。アクター指定行(
%行)の後で、どのアクション行よりも前に出力される選択肢も同じである。 - アクター指定行(
%行)を実行すると、すべてのバルーンを、まだ何も表示していないものとして数え直す。同じ出力の中で先に台詞を出していても、その直後の選択肢の前には改行を出力しない。
並びごとの出力は、既定値では次のとおりである。(甲)・(乙) は選択肢のタグ \![*]\q[…] を表す。
| 並び | 出力 |
|---|---|
| 台詞 → 選択肢 → 選択肢 | \p[0]どれ\n[150](甲)\n(乙)\e |
| 選択肢だけ | \p[0](甲)\e |
台詞 → \c → 選択肢 → 選択肢 | \p[0]まえおき\c(甲)\n(乙)\e |
| 台詞 → 選択肢 → 台詞 → 台詞 | \p[0]選んで\n[150](甲)\nつづきおわり\e |
| スポット 0 の台詞と選択肢 → スポット 1 の台詞 → スポット 0 へ戻った台詞 | \p[0]どれ\n[150](甲)\p[1]はやく\p[0]\n[150]うーん\e(最後の \n[150] は spot_newlines の改行) |
選択肢が選ばれると、ジャンプ先の名前を選択 ID、3 番目の引数を Reference2 として SHIORI イベント OnChoiceSelectEx が発生する。既定の自動ルーティングは、ジャンプ先を、選択肢を出したグローバルシーンの配下のローカルシーンから先に探し、無ければグローバルシーンを探す。そのため、Call で呼んだ別のグローバルシーンが出した選択肢はそのシーンのローカルシーンへ、Call から戻った後に出した選択肢は呼び出し元のローカルシーンへジャンプする(Call から戻った後の名前解決)。選択後に実行されるシーンの決まり方は、SHIORI イベントとハンドラ で扱う。
選択肢の制限時間は、キューコマンド !select(秒数) で設定する(キューコマンド行を参照)。
*メニュー
ぱすた:何をしますか?
@?挨拶「挨拶する」
@?自己紹介
!select(30)
・挨拶
ぱすた:こんにちは!
・自己紹介
ぱすた:私はぱすたです。
この例の *メニュー の出力は、既定値では次のとおりである(ぱすた を spot 0 とした場合)。台詞の後の 1 つ目の選択肢の前に \n[150] が、2 つ目の選択肢の前に \n が入る。
\p[0]何をしますか?\_w[450]\n[150]\![*]\q[挨拶する,挨拶,メニュー_1]\n\![*]\q[自己紹介,自己紹介,メニュー_1]\![set,choicetimeout,30000]\e
キューコマンド行
キューコマンド行は、演出の指示をコマンドの形で書く行である。インデントした行で !(または !)に続けてコマンド名を書く。
!コマンド名
!コマンド名@スコープ
!コマンド名(引数、引数、…)
!コマンド名@スコープ(引数、引数、…)
- マーカー(
!/!)・スコープの@/@・括弧(()/())・引数の区切り(、,,)は全角・半角のどちらでもよい。 - マーカー・コマンド名・スコープ・引数リストの間には空白を入れない(
!select (10)はパースエラー)。 - コマンド名は識別子である。
- スコープは
@名前または@アクター名:名前(コロンは全角・半角どちらでもよい)の形で書く。 - 行末にコメントを書ける。
引数には次の型のトークンを書ける。
| 型 | 例 |
|---|---|
| 識別子(区切り文字・括弧・空白を含まない文字列) | normal、actor:さくら、morning.ogg |
| 文字列 | 「はい」 |
| 整数 | 30、-5 |
| 浮動小数点数 | 10.0、-5.5 |
| @参照 | @名前 / @名前 |
構文として受理されるのはすべてのコマンド名だが、生成される Lua コードに反映されるのは select だけであり、他のコマンドは何もしない。
| コマンド | 動作 |
|---|---|
!select(秒数) | 選択肢の制限時間を設定する。最初の引数が数値なら、その秒数をミリ秒に換算した \![set,choicetimeout,ミリ秒] をその行の位置に出力する |
!select(引数なし、または最初の引数が数値でない) | \![set,choicetimeout,0] を出力する |
select 以外 | 何もしない(何も出力されない) |
*起動挨拶
!emote@普通(normal) # 構文は受理されるが何もしない
さくら:こんにちは!
@?はい「はい」
@?いいえ「いいえ」
!select(10) # 選択肢の制限時間 10 秒
Lua ブロックの配置
Lua ブロックは、行頭に置いた 3 個以上のバッククォート(開始フェンス)で始まり、同じ本数のバッククォート(閉じフェンス)で終わる複数行のコードである。
- 開始フェンスは行頭に置く。インデントしたフェンスはパースエラーになる。
- 開始フェンスの後ろには任意の識別子(
lua・textなど)を 1 つ書いてもよい。書かなくてもよい。フェンスと識別子の間、識別子の後ろには空白を置けない(``` luaや、末尾に空白のある```luaはパースエラー)。グローバルシーンの Lua ブロックでは、この識別子は出力に影響しない。 - 閉じフェンスは開始フェンスと同じ本数のバッククォートで書く。閉じフェンスの後ろにはコメントを書ける。
- ブロックの内容には、開始フェンスの本数以上連続したバッククォートを含められない。含める必要がある場合は、より多い本数のフェンスで囲む。
*会話
```lua
local count = 0
function SCENE.counter(act)
count = count + 1
return tostring(count)
end
```
ぱすた:@counter()回目の会話です。
Lua ブロックを置ける位置は次の 2 つである。
- グローバルシーンの初期部の後(暗黙の開始ブロックのコンテンツ行より前)。この後に暗黙の開始ブロックのコンテンツ行を続けられる(上の例)。
- 暗黙の開始ブロック・ローカルシーンの末尾。この後に同じブロックのコンテンツ行は続けられず、次に置けるのはローカルシーン宣言、または次のグローバルシーン・アクター辞書・ファイルレベルの行である。
Lua ブロックの内容は検証されず、そのまま生成される Lua コードに出力される。
- グローバルシーンの Lua ブロックは、ブロックを置いた位置にかかわらず、そのグローバルシーンのシーン関数の定義すべての後に出力され、辞書の読み込み時(ロード時)に一度評価される。シーンの実行時に評価されるのではない。
- 関数定義以外の文(
local変数の宣言・代入・requireなど)も書ける。これらはロード時に実行される。 - 出力先はグローバルシーンごとの Lua のブロック(
do〜end)の中であり、SCENEはそのグローバルシーンを指す。localで宣言した変数は、同じグローバルシーンの Lua ブロックの中だけで有効である。 - Lua としての誤りは、ロード時の Lua エラーになる。
function SCENE.名前(act) で定義した関数は、シーンの中から @名前 や @名前() で呼び出せる。関数の書き方は Lua セクションで扱う。アクター辞書の配下の Lua ブロックの扱いは アクター辞書 で扱う。
属性
属性は &名前:値 の形で、シーンに名前と値の組を書く構文である。書いた属性はシーンごとに書いた順の並びとして記録され、実行時に Lua の SCENE.attrs で読める(スクリプト API)。条件の形の項目と &優先・&重み・&順番 は、名前で候補を選ぶときに効く(条件で候補を絞る・優先・重み・順番)。そのほかの属性は、今のところシーンの選択・出力を変えない。
この節の前半(構文 から「名前なしの * とローカルシーン」まで)は属性の書き方を、後半(条件の形 から)は候補の選び方を扱う。
構文
- 1 つの属性は
&名前:値(&/&、:/:は全角・半角どちらでもよい)。 - 1 行に複数の属性を並べられる(
&作者:Alice&ジャンル:comedy)。 - 値は整数・小数・引用文字列(
「…」/"…")・引用なし文字列のいずれか(値の型)。引用なし文字列には:・&・#(半角の:・&・#も同じ)と空白を含められない。 $で始まる項目は条件の形になる(条件の形)。
置ける場所
| 置き方 | 例 | 属性が付くシーン |
|---|---|---|
| ファイル属性の行(インデントなし・シーンの外) | &作者:Alice | その行より後の、同じファイルのグローバルシーン(ファイル属性) |
| グローバルシーン宣言行への付記 | *会話&作者:Alice | そのグローバルシーン |
名前なしの * 行への付記 | *&順番:20 | その行で始まるグローバルシーン |
| グローバルシーンの初期部の属性行 | &作者:Alice | そのグローバルシーン |
| ローカルシーン宣言行への付記 | ・選択肢&優先:3 | そのローカルシーン |
| アクター辞書の配下の属性行 | &作者:Alice | どのシーンにも付かない(受理されるが記録されない) |
ローカルシーン宣言の次の行に属性行を置くこと、アクション行・変数代入などのコンテンツ行の後に属性行を置くことはできず、パースエラーになる。ローカルシーンに属性を書くには、宣言行に付記する。
&作者:Alice
*会話&ジャンル:comedy
&温度:暑い
ぱすた:こんにちは!
・選択肢&優先:3
ぱすた:どれにしますか?
この例のグローバルシーン *会話 の属性は 作者:Alice・ジャンル:comedy・温度:暑い の順、ローカルシーン ・選択肢 の属性は 優先:3 である。
ファイル属性
ファイル属性は 1 行にまとめて書く。間にグローバルシーンを挟まずにファイル属性の行が 2 行続くと、パースエラーになる(「ファイル属性の行が続いています。ファイル属性は 1 行にまとめて書きます(前の行: N 行目)」)。空行・コメント行・アクター辞書・グローバル単語定義を挟んでも、続いているとみなされる。
グローバルシーンの後にもう一度ファイル属性の行を書くと、それより後のグローバルシーンには新しい行の属性だけが付く。前の行の属性に足されるのではなく、丸ごと置き換わる。ファイル属性は別のファイルへは持ち越されない。
&季節:春&作者:Alice
*会話
ぱすた:春ですね。
&季節:夏
*会話
ぱすた:夏ですね。
1 つめの *会話 の属性は 季節:春・作者:Alice、2 つめの *会話 の属性は 季節:夏 だけである。
並びと重なり
グローバルシーンの属性は、ファイル属性 → 宣言行の付記 → 初期部の属性行の順に、同じ行の中では左から右の順に並ぶ。
同じ名前の属性が重なったときは、名前は 1 つだけ残り、位置は先に書いた位置、値は後に書いた値になる(書いた順で後が勝つ)。条件の形の項目は、同じ変数のものが重なっても畳まれず、書いた順にすべて残る。
&季節:春&作者:Alice
*会話&季節:夏
ぱすた:夏ですね。
この *会話 の属性は 季節:夏・作者:Alice の順である。
値の型
値の型は、書いた場所(ファイル属性・宣言行・初期部)や項目の種類によらず、同じ規則で決まる。
| 書いた値 | 記録される値 |
|---|---|
&重み:5・&重み:5 | 整数 5(全角の数字も同じ) |
&率:0.5 | 小数 0.5 |
&率:1.0 | 整数 1(整数の値になる小数は整数として扱う) |
&作者:Alice・&作者:「Alice」 | 文字列 Alice(引用の有無は区別しない) |
&メモ:「」・&メモ:"" | 空文字列(属性は無くならない) |
&背景:教室、夕方 | 文字列 教室、夕方(1 つの値で、読点では分けない) |
整数に収まらない数は小数になる(リテラル型)。
名前なしの * とローカルシーン
名前なしの * 行は、直前のグローバルシーンの名前だけを受け継ぎ、属性は受け継がない。そのシーンの属性は、その位置のファイル属性・その行への付記・初期部の属性行からなる。* と & の間には空白を置いてよい(* &重み:5)。
ローカルシーンは、ファイル属性も親のグローバルシーンの属性も受け継がない。ローカルシーンの属性は、その宣言行への付記だけからなる。
&季節:春
*会話&重み:3
ぱすた:1 つめの候補です。
*&重み:5
ぱすた:2 つめの候補です。
・続き&優先:1
ぱすた:続きです。
1 つめの *会話 の属性は 季節:春・重み:3、名前なしの * で始まる 2 つめの *会話 の属性は 季節:春・重み:5、ローカルシーン ・続き の属性は 優先:1 だけである。
条件の形
$ で始まる項目は、宣言(&名前:値)ではなく条件の形になる。
| 形 | 例 |
|---|---|
条件 &$名前 演算子 値・&$*名前 演算子 値 | &$hour>5・&$*経験値≧500・&$r0=「changed」 |
フラグ &$名前・&$*名前 | &$*初回待ち |
$名前はローカル変数、$*名前はグローバル変数を指す(変数・スコープ)。シーン引数($0など)は書けず、パースエラーになる。- 演算子は
≧・≦・>・<・=・≠(半角は>=・<=・>・<・=・!=)の 6 種で、全角・半角は同じ演算子として記録される。属性の中では、=は代入ではなく、>は Call ではなく、比較の演算子である(属性の中の比較演算子)。 - 右辺には値(数・文字列)だけを書ける。
&$r0=$r1のように変数を書くとパースエラーになる。 - 置ける場所・並び・受け継ぎは宣言の属性と同じである(重なっても畳まれない)。
*会話
&$*経験値≧500&$*経験値<1500
&$*初回待ち
ぱすた:こんにちは!
条件の形は記録され、Lua からも読める。名前で候補を選ぶときに評価される(条件で候補を絞る)。
条件で候補を絞る
名前で候補を選ぶとき、pasta.dll は各候補の条件とフラグを、その時点の変数の値で評価する。条件を満たさない候補は選ばれない。
*会話
>雑談_
*雑談_今の部屋 &$*経験値≧500 &$*会えた日数≧3
ぱすた:この部屋、窓が開かないんですよね。
*雑談_天気
ぱすた:今日はいい天気ですね。
この例のランダムトークは、$*経験値 が 500 以上で、$*会えた日数 が 3 以上のときだけ「今の部屋」の話を候補にする。それまでは「天気」の話だけが出る。
- 1 つの候補に条件とフラグが複数あるときは、全部を満たすときだけ候補に残る(かつ)。受け継いだファイル属性の条件も同じである。
$*名前はグローバル変数、$名前はローカル変数を読む。- 条件が効くのは、名前で候補を選ぶ所すべてである。Call
>名前(ローカルシーン・グローバルシーンのどちらも)、イベントと同じ名前のシーン(ランダムトーク・時報を含む)、選択肢の飛び先で効く。 - Call で呼ばれる側の条件は、呼び出し元と同じローカル変数を読む。
- イベントのシーンでは、Reference と日時の変数が選ぶ前に入っている(エンジンが値を入れる変数)。そのため、イベントのシーンそのものの条件に
$r0や$hourを書ける。 - 外から 1 本を名指しして出すシーン(
OnPastaScene、撫で・つつきのショートカット、*チェイントーク中断、おすすめメニューで選んだ項目のシーン)では、条件を見ない。選択肢の行そのものの表示と、単語の選択にも、条件は効かない。
*OnMouseDoubleClick
$気分=「高」
>告白
*告白 &$気分=「高」
ぱすた:大好きです!
*告白 &$気分=「低」
ぱすた:……ふつうです。
この例の >告白 は、呼び出し元が入れた $気分 で絞り、「大好きです!」を出す。
条件を満たす候補が 1 本も無いときの動きは、呼ぶ所によって違う(条件に合うシーンが無いとき)。候補の並びと、条件を満たしてから出るまでの待ちは 候補の選択 で扱う。
比べ方
| 書き方 | 満たすとき |
|---|---|
フラグ &$*初回待ち | 値があり、0 でも空文字列でもない |
両辺が数の条件 &$*経験値≧500 | 数の大小・等しさが演算子のとおり。1.0 と 1 は等しい |
片方が数でない =・≠ の条件 &$r0=「changed」 | 両辺を文字列として比べて、演算子のとおり |
片方が数でない大小の条件(≧・≦・>・<) | 満たさない。注意のログを出す |
- 値の無い変数は、数の比較では 0、文字列の比較では空文字列とみなす。失敗表記も注意も出さない。
- 真偽値は、true を 1、false を 0 として扱う。フラグでも比較でも同じである。
- 半角の十進の数の形の文字列(Reference の
"5"、右辺の「500」など)は、左辺・右辺とも数として扱う。全角の数字の文字列(「3」)は数として読まない。 - 文字列の
"0"は数の 0 なので、フラグとしては立っていない。 - 打ち消しの記号は無い。「まだ立っていない」は
&$*開示_段2済み=0と書く。値の無い変数と false も、この条件を満たす。
外れた候補は、trace のログに、探した名前・外れた候補のシーン・外れた条件・そのときの変数の値と一緒に出る。pasta.toml の [logging] に filter = "info,pasta_lua::search=trace" と書くと、このログだけを足して読める([logging])。
優先
&優先:数 は、条件を満たした候補のうち、優先のいちばん高い候補だけから選ぶ属性である。優先の高い候補が条件を満たしている間は、それより低い候補は出ない。
*ボール巡回 &優先:1 &$*経験値≧1500 &$*開示_段2済み=0
ぱすた:(段 2 に上がる一本。一度だけ出る)
$*開示_段2済み=1
*ボール巡回
ぱすた:ボール、繋がってますね。
この例の >ボール巡回 は、$*経験値 が 1500 に届くと、次の 1 回で優先 1 の場面を出す。その場面が $*開示_段2済み に 1 を入れると、優先 1 の場面は条件を満たさなくなり、次からは優先 0 の場面が出る。
&優先を書かない候補の優先は 0 である。- 値は整数で書く。負の数も書ける。
1.0のように整数の値になる小数は、整数と同じに扱う。整数でない値(&優先:高い・&優先:1.5)は、辞書の読み込みエラーになる。 - 英語の名前
&priorityも同じ意味である。 &優先は宣言の属性である。ファイル属性の受け継ぎ・重なり(後の値が勝つ)は、ほかの宣言と同じである。- いちばん高い段の候補を今の巡で使い切っても、低い段へは下りない。新しい巡を始めて、同じ段から選ぶ。
- 優先の高い候補が条件を満たすようになると、その次の選択で、その段から選ぶ(候補の選択の巡を待たない)。
使い所は次のとおりである。
| 使い所 | 書き方 |
|---|---|
| 初回起動の挨拶 | *OnBoot &優先:1 &$*起動済み=0 の本文で $*起動済み=1 を入れ、ふつうの *OnBoot と並べる |
| 記念日の上書き | *OnBoot &優先:1 &$month=12 &$day=25 を、ふつうの *OnBoot と並べる |
| Call の受け皿 | 条件つきの場面に &優先:1 を付け、条件の無い場面を並べる。どれにも当たらないときは、条件の無い場面が出る |
| 一度だけの話 | 上の *ボール巡回 のように、条件で出し、本文でその条件を外す |
&優先 は、出やすさの調整には使わない。優先の高い場面が条件を満たしている間は、低い場面がまったく出なくなるためである。出やすさの調整は &重み の仕事である(重み)。
条件もフラグも無い場面に &優先 を付けると、それより低い優先の同じ名前の場面は出なくなる。pasta_check validate は、この場面に注意を出す(辞書の検査)。
重み
&重み:数 は、同じ名前の候補の出やすさの比率を決める属性である。名前で候補を選ぶとき、抽出した候補(条件と &優先 で絞った後の候補)を並び(候補の選択)に乗せる回数が、重みになる。重み 3 のシーンは 3 回乗る。同じシーンを 3 つ書いたときと同じ動きである。
*OnTalk &重み:5
>通常トーク
*OnTalk &重み:2
>スキット
*OnTalk
>季節トーク
この例のランダムトークは、8 回のひとまわり(巡)の中で、通常トークを 5 回、スキットを 2 回、季節トークを 1 回出す。
&重みを書かない候補の重みは 1 である。- 値は 1 以上の整数で書く。全角の数字(
&重み:5)と、5.0のように整数の値になる小数は、整数と同じに扱う。上限は無い。 - 1 以上の整数でない値(
&重み:0・&重み:-1・&重み:1.5・&重み:多め・&重み:「5」)は、辞書の読み込みエラーになる。 - 英語の名前
&weightも同じ意味である。 &重みは宣言の属性である。ファイル属性の受け継ぎ・重なり(後の値が勝つ)は、ほかの宣言と同じである。- 並びからの選び方(シャッフル&順次消費)は変わらない。重みのあるシーンは、1 巡の中で重みの回数だけ出るので、続けて出ることもある。
- 重みが効くのは、条件と同じく、名前で候補を選ぶ所すべてである(Call
>名前・イベントと同じ名前のシーン・選択肢の飛び先。ローカルシーンも同じ)。外から 1 本を名指しして出すシーンには関わらない。 - シーンの数(シーン数・シーン数完全一致)は、重みで増えない。重み 5 のシーンも 1 つと数える。
順番
&順番:番号 は、同じ名前の候補を、シャッフルの代わりに番号の小さい順に 1 本ずつ出す属性である。いちばん大きい番号の次は、いちばん小さい番号へ戻る。
*ボール巡回 &順番:10
ぱすた:(1 本目)
*&順番:20
ぱすた:(2 本目)
*&順番:30
ぱすた:(3 本目)
*OnMouseClick
>ボール巡回
この例のクリックは、1 本目 → 2 本目 → 3 本目 → 1 本目 → …… の順に出す。
- 選ぶたびに、前に選んだ番号より大きい番号のうち、いちばん小さい番号の候補を選ぶ。そういう候補が無いとき(最後まで出たとき)と、その名前でまだ順番で選んでいないときは、いちばん小さい番号の候補を選ぶ。
- 番号は飛んでいてよい。
10と20の間に、後から15の候補を足せる。 - 出す順は番号だけで決まる。ファイルを読む順や定義の順には左右されない。
- 抽出した候補だけを番号の順に出す。条件で外れた候補は選ばれず、その番号は飛ばされる。
&優先のある名前では、いちばん高い段の候補だけを番号の順に出す。 - 最後に選んだ番号は、探した名前ごとに、シャッフルの続きと同じくメモリの中に覚える。ゴーストの終了と辞書の再読み込みで消え、次はいちばん小さい番号から出る。保存ファイルには書かない。
- 最後で止める書き方は無い。最後の次は、いつも最初へ戻る。
- 値は整数で書く。0 と負の数も書ける。全角の数字と、整数の値になる小数は、整数と同じに扱う。整数でない値(
&順番:1.5・&順番:最初・&順番:「1」)は、辞書の読み込みエラーになる。 - 英語の名前
&indexも同じ意味である。 &順番は宣言の属性である。ファイル属性の受け継ぎ・重なり(後の値が勝つ)は、ほかの宣言と同じである。- 同じ名前のシーンに同じ番号が 2 つ以上あると、辞書の読み込みエラーになる。グローバルシーンは別名(シーン名の別名)を畳んだ同じ名前、ローカルシーンは同じグローバルシーンの中の同じ名前で比べる。ファイル属性の行の
&順番を、同じ名前の複数のシーンが受け継いだときも、このエラーになる。 - 同じシーンに
&重みと&順番の両方があると、辞書の読み込みエラーになる。ファイル属性から受け継いだ方も数える。 - 順番が効く所は、重みと同じである。
抽出した候補に、&順番 の有る候補と無い候補が混ざっているとき、または前方一致で別の名前から同じ番号が集まったときは、順番を使わず、ふつうのシャッフル&順次消費(重みを含む)で選ぶ。このとき、注意のログ(pasta_lua::search)に、探した名前と理由(順番の有るものと無いものが混ざっている・同じ番号 10 が 2 つ以上ある)を出す。名前が決まった Call の混ざりは、pasta_check validate も知らせる(辞書の検査)。
優先・重み・順番の書き分け
| 属性 | 役目 | 使い所 |
|---|---|---|
&優先 | 独占。条件を満たした候補のうち、いちばん高い段の候補だけから選ぶ | 初回起動の挨拶・記念日の上書き・一度だけの話 |
&重み | 出やすさ。抽出した候補を並びに乗せる回数 | 通常トーク・スキット・季節トークを 5:2:1 で出す |
&順番 | 並べ方。抽出した候補を、シャッフルの代わりに番号の順に出す | 決まった順の巡回 |
選ぶときは、まず名前・条件・&優先 で候補を抽出する。抽出した候補の全部に &順番 があれば番号の順に、そうでなければ重みの回数だけ乗せた並びから選ぶ。
*OnBoot &優先:1 &$*起動済み=0
ぱすた:はじめまして!
$*起動済み=1
*OnBoot &重み:3
ぱすた:おはようございます。
*OnBoot
ぱすた:また会えましたね。
この例の初めての起動では、優先 1 の場面だけが出る。2 回目からは、優先 0 の 2 つの場面が 3:1 の比率で出る。
よくある間違い
| 書き方 | 結果 | 正しい書き方 |
|---|---|---|
ファイル属性を 2 行に分ける(&作者:Alice の次の行に &季節:春) | パースエラー | 1 行にまとめる(&作者:Alice&季節:春) |
| ローカルシーン宣言の次の行に属性行を置く | パースエラー | 宣言行に付記する(・選択肢&優先:3) |
| アクション行などのコンテンツ行の後に属性行を置く | パースエラー | 初期部(最初のコンテンツ行より前)に置くか、宣言行に付記する |
条件の右辺に変数を書く(&$r0=$r1) | パースエラー | 右辺には数か文字列を書く |
名前なしの * が前のシーンの属性を受け継ぐと考える | 受け継がれない | その * 行に付記する(*&重み:5) |
&優先 に整数でない値を書く(&優先:高い) | 読み込みエラー | 整数を書く(&優先:1) |
&重み に 1 以上の整数でない値を書く(&重み:0・&重み:多め) | 読み込みエラー | 1 以上の整数を書く(&重み:1) |
&順番 に整数でない値を書く(&順番:最初) | 読み込みエラー | 整数を書く(&順番:1) |
同じシーンに &重み と &順番 を書く | 読み込みエラー | どちらか 1 つにする |
ファイル属性の行に &順番:1 を書き、その後に同じ名前のシーンを並べる | 読み込みエラー(番号の重なり) | 番号はシーンごとに宣言行へ付記する |
同じ名前の一部のシーンにだけ &順番 を書く | 注意を出し、シャッフルで選ぶ(名前が決まった Call は pasta_check validate が誤りにする) | 同じ名前の全部の候補に番号を振る |
構造が見えてくると、辞書ファイルがぐっと書きやすくなりますでしょう? 次は、柱の下に並ぶ台詞――「アクション行」ですわ。熱く参りますわよ!
食器棚も、片付いておりますと探し物が早うございます。