単語定義
同じ挨拶を毎回繰り返すゴーストなんて、退屈ですわよね……。
私は毎朝、同じ「おはようございます」を申し上げておりますが。
それでしたら、あなたにもぜひ読んでいただきたい章ですわ。単語定義を使えば、候補の中からランダムに選ばれて、会話に彩りが生まれますの。これぞ里々ゆずりの真骨頂、たっぷり味わってくださいまし。
単語定義は、テキストのバリエーションを登録し、参照のたびに候補から 1 つを選んで使う機能である。選び方はシャッフル&順次消費で、候補を一巡するまで同じ値を繰り返さない(シャッフル&順次消費)。@(または @)マーカーで定義・参照する。紙の台本には無い、Pasta DSL ならではの道具である。
単語の定義
単語は @キー:値、値、… の形で定義する。定義できる場所は 3 つあり、場所によって参照できる範囲(スコープ)が決まる(スコープと優先順位)。
| 種類 | 定義する場所 | 書き方 |
|---|---|---|
| グローバル単語 | ファイルレベル(インデントなし) | @キー:値 |
| ローカル単語 | グローバルシーンの初期部(インデントあり) | @キー:値 |
| アクター単語 | アクター辞書 %名前 の配下(インデントあり) | @キー:値 |
同じスコープで同じキーの単語を複数回定義すると(別の行・別のファイルでも)、値はすべて同じキーの候補に合算される。
@天気:晴れ、曇り
@天気:雨
この例の @天気 の候補は「晴れ」「曇り」「雨」の 3 つである。
グローバル単語定義
ファイルレベル(インデントなし)で定義した単語は、すべての辞書ファイルのすべてのシーンから参照できる。
%ぱすた
@挨拶朝:おはよう、ハロー、Good morning
@挨拶昼:こんにちは
*メイン
ぱすた:@挨拶朝 !
値の書き方は次のとおり(単語定義の値は常に文字列になる。リテラル型)。
- 値どうしは読点(
、)・全角コンマ(,)・半角カンマ(,)で区切る。区切り文字の前後の空白は区切りとして消える。 - 区切り文字以外の空白は値に含まれる。
@w:a b、c dの候補はa bとc dである。行末側の空白も値に残る。 - 末尾に区切り文字を付けてもよい(
@w:a、b、)。 - 値は次のいずれかの形で書く。
「」・"で囲んだ文字列(囲みの中に区切り文字や」を含められる。単語値での引用符エスケープ)- さくらスクリプトのコマンド 1 個(
\s[0]など。囲み\_?…\_?は全体で 1 個) - それ以外の文字列(引用なし)
「」・""は空文字列の候補になる。@w:「」、あの候補は空文字列とあ、@w:""、あの候補も空文字列とあである。- 引用なしの値は
「・"で始められない。「・"で始めた値は、その行の中で引用文字列として閉じる。閉じていないとパースエラーになる。値の途中の「・"は値の一部になる(@w:あ「いの候補はあ「い)。 - 引用なしの値の中の
#・#は値の一部になり、行末コメントにならない(コメント)。@w:あ、い #cの候補はあとい #cである。 - 囲んだ文字列や、さくらスクリプトで始まる値は、そこで値が終わる(後ろに書けるのは重みの
@数だけである。値の重み)。@w:「a」bや@w:\s[0]こんにちはのように後ろへ続けて書くとパースエラーになる。コマンドの名前は 1 文字で終わるため、@w:\nOKも\nの後ろに字が続く形になり、パースエラーになる。さくらスクリプトを含む値は、文字で始めるか(こんにちは\s[0])、全体を「」で囲む(さくらスクリプトの配置ルール)。
ローカル単語定義
グローバルシーンの初期部(宣言の直後、最初のアクション行より前)にインデントして定義すると、そのグローバルシーンと配下のローカルシーンからだけ参照できる。初期部より後ろには置けない(行とブロック構造)。
%ぱすた
*メイン
@挨拶朝:Hello、Good morning
ぱすた:@挨拶朝 !
複数キー単語定義
コロンの左側に読点・カンマ区切りで複数のキーを並べると、同じ値のリストがそれぞれのキーに登録される。辞書の重複記述を減らせる。
@女性、水の妖精:水無灯里、アリス・キャロル
@挨拶、あいさつ、greeting:こんにちは、ハロー
%さくら
@通常、普通:\s[0]
- キー区切りには全角読点(
、)・全角コンマ(,)・半角カンマ(,)が使える。 - グローバル・ローカル・アクターのいずれのスコープでも使える。アクター辞書の例では、
さくら:@通常でもさくら:@普通でも\s[0]になる。 - 登録はキーごとに行われる。シャッフル&順次消費の巡回も、キーごとに別になる。
値の重み
値のすぐ後ろに @整数 を書くと、その値の出やすさの比率(重み)になる。重みの数だけ、その値を候補に乗せる。同じ値を重みの数だけ並べて書いたときと同じ動きである。
@挨拶:こんにちは@3、やあ
この例の @挨拶 は、4 回のひとまわり(巡)の中で、「こんにちは」を 3 回、「やあ」を 1 回出す(シャッフル&順次消費)。@挨拶:こんにちは、こんにちは、こんにちは、やあ と同じである。
- 重みを書かない値の重みは 1 である。
@は全角・半角のどちらでもよい(@・@)。数字も全角・半角のどちらでもよい(@3・@3)。- 重みは、どの形の値にも書ける。囲んだ文字列(
「こんにちは、」@3)、さくらスクリプトの値(\s[10]@2)、囲まない値(こんにちは@3)のどれでもよい。 - 囲まない値では、値の最後の
@数だけが重みになる。重みとして読むのは、後ろに空白と区切り文字・行末しか無いときだけである。それ以外の位置の@は、値の文字である。
| 書き方 | 値 | 重み |
|---|---|---|
@w:a@3 | a | 3 |
@w:a@3b | a@3b | 1 |
@w:a@3 #メモ | a@3 #メモ | 1 |
@w:a@2@3 | a@2 | 3 |
- 最後に
@3という文字を出したいときは、値を「」で囲む。@w:「a@3」の値はa@3(重み 1)である。 - 同じ値を重ねて書いた分は足し合わせる。
@w:A@2、Aの A は 3 回乗る。同じ値を何度も並べるより、重みで書くほうが比率を読み取りやすい。 - 重みは、グローバル単語・ローカル単語・アクター単語のどれにも効く。複数キー単語定義では、どのキーにも同じ重みで登録される。
- 前方一致で複数のキーの値を集めるとき(前方一致検索)は、集めた値をそれぞれの重みの回数だけ乗せる。
@挨拶:こんにちは@2と@挨拶_朝:おはようを@挨拶で参照すると、「こんにちは」が 2 回、「おはよう」が 1 回乗る。 - Lua の
WORD.create_*で作る単語には、重みの書き方は無い。値の@数はそのまま値の文字になる。
次の書き方は、パースエラーになり、そのファイルは読み込まれない。エラーの文には、単語のキーと書いた値が出る。
| 書き方 | エラーの文 |
|---|---|
重みが 0(@w:a@0・@w:a@00) | 単語 `w` の値 `a@0` の重みは 1 以上の整数で書きます(`@0` を文字として出すときは「」で囲みます) |
重みを除くと値が空になる(@w:@3・@w:「」@3) | 単語 `w` の値 `@3` は重みの `@数` を除くと空になります(`@3` を文字として出すときは「」で囲みます) |
重みが大きすぎる(@w:a@99999999999999999999) | 単語 `w` の値 `a@99999999999999999999` の重みが大きすぎます |
文字として @0・@3 を出したいときは、「」で囲む(@w:「a@0」・@w:「@3」)。
単語の参照
アクション行の中で @単語キー と書くと、一致する候補から 1 つが選ばれて出力される。@単語キー の直後には1 文字以上の空白を置く。この空白は区切りとして消え、出力されない。変数代入の右辺($x=@単語キー)にも書ける。Lua 側では act:word("単語キー")(アクター付きの行では act:actor_proxy("アクター"):word("単語キー"))になる。
%ぱすた
@挨拶朝:おはよう、ハロー
@挨拶昼:こんちわ
*メイン
ぱすた:@挨拶昼 。
重要: 空白がないと最長一致で単語キーを解釈し、後続まで取り込んでしまう。意図しない動作を避けるため、単語参照の直後には必ず空白(または識別子に含まれない記号)を置く。
前方一致検索
単語参照は前方一致で候補を検索する。参照したキーで始まるキーの単語がすべて候補になり、それらの値を合わせた中から 1 つが選ばれる。
%ぱすた
@挨拶:こんにちは、ハロー
@挨拶_朝:おはよう、グッドモーニング
@挨拶_夕:こんばんは、Good evening
*会話
ぱすた:@挨拶
ぱすた:@挨拶_朝
- 1 行目の
@挨拶は「挨拶」「挨拶_朝」「挨拶_夕」すべてに一致し、6 つの値から選ばれる。 - 2 行目の
@挨拶_朝は「挨拶_朝」だけに一致し、「おはよう」「グッドモーニング」から選ばれる。 @挨と書いても、上の 3 つのキーすべてに一致する。
シャッフル&順次消費
候補は毎回独立に抽選されるのではなく、シャッフル&順次消費で選ばれる。
- 初めて参照したとき、候補をシャッフルして並べ、先頭の 1 つを返す。
- 2 回目以降は、並べた順に次の 1 つを返す(再抽選しない)。
- 全候補を使い切ると、もう一度シャッフルして最初から使う。
@雑談:A、B、C を 6 回参照すると、たとえば次のようになる。
| 参照 | 動作 | 結果 |
|---|---|---|
| 1 回目 | シャッフルして C, A, B と並べる | C |
| 2 回目 | 次を返す | A |
| 3 回目 | 次を返す(使い切り) | B |
| 4 回目 | シャッフルし直して A, C, B と並べる | A |
| 5 回目 | 次を返す | C |
| 6 回目 | 次を返す(使い切り) | B |
- 候補を一巡するまで、同じ値は選ばれない。候補が 3 つなら、3 回の参照で 3 つとも 1 回ずつ使われる。
- 一巡の境目では、前の巡の最後と次の巡の最初が同じ値になることがある(上の表では 3 回目と 4 回目の間が境目)。
- 並び順は、スコープと参照に書いたキーの組ごとに記録される。
@挨拶と@挨拶_朝は別々に巡回する。 - 記録はゴーストの実行中、イベントをまたいで保たれ、辞書の再読込で消える。
- 同じ値を 2 回書くと(
@w:A、A、B)、その値は 1 巡で 2 回選ばれる。出やすさの比率は、重みで書ける(@w:A@2、B。値の重み)。
同名のシーンを複数定義したときの選び方も同じ方式である(候補の選択)。
スコープと優先順位
@単語キー は、次の順に探し、最初に見つかったものを使う。アクター付きのアクション行(アクター:@単語キー)では、この前にそのアクターのアクター辞書を探す(アクタースコープと単語参照の統合)。
| 段 | 探す対象 | 一致の仕方 |
|---|---|---|
| 1 | 実行中のグローバルシーンのシーンテーブル(Lua ブロックで定義した SCENE.名前 など) | 完全一致 |
| 2 | 実行中のグローバルシーンのローカル単語 | 前方一致 |
| 3 | act のメソッド | 完全一致 |
| 4 | GLOBAL テーブル | 完全一致 |
| 5 | グローバル単語 | 前方一致 |
ローカル単語の候補が 1 つでもあれば、2 段目で決まる。グローバル単語の候補とは合わせない。ローカル単語の候補が無いときだけ、3 段目以降へ進む。段の数え方は Call と同じである(スコープ解決アルゴリズム)。
%ぱすた
@挨拶:グローバル挨拶
*メイン
@挨拶:ローカル挨拶
ぱすた:@挨拶 !
この例の @挨拶 は、ローカル単語があるため、毎回「ローカル挨拶」になる。「グローバル挨拶」は選ばれない。
Call との分離
単語とシーンは別の辞書に登録される。単語参照(@)の 2 段目・5 段目は単語辞書を探し、Call(>)の 2 段目・5 段目はシーン辞書を探す。そのため、同じ名前の単語とシーンがあっても、@ は単語を、> はシーンを使う。
%ぱすた
@挨拶:こんにちは
*挨拶
ぱすた:やあ!
*メイン
ぱすた:@挨拶
>挨拶
この例の @挨拶 は単語「こんにちは」を出力し、>挨拶 はシーン「挨拶」を呼び出す。
1 段目(シーンテーブル)・3 段目(act のメソッド)・4 段目(GLOBAL)は両者で共通である。単語参照がここで関数を見つけた場合は、その関数を呼び出し、戻り値を単語として出力する(関数以外の値は文字列に変換して出力する)。たとえば Lua ブロックで function SCENE.f(act) を定義すると、@f は同じ名前のグローバル単語より先にこの関数を呼ぶ。これらの段で見つかった関数は、アクション行の中で参照した場合も第 1 引数に act を受け取る。アクタープロキシを受け取るのは、アクターの表(A1)で見つかった関数だけである(関数スコープの展開先)。Call 側の規則は 単語参照との違い で扱う。
動的単語参照
@ の後ろに単語キーの代わりに変数を書くと、その変数の値を単語キーとして単語を探す。これを動的単語参照と呼ぶ。参照するたびにその時点の値が使われるため、変数の値を変えれば同じ書き方で別の単語を引ける。
| 書き方 | 単語キーになる値 |
|---|---|
@$名前 | ローカル変数 $名前 の値 |
@$*名前 | グローバル変数 $*名前 の値 |
@$0・@$1… | シーン引数 $0・$1… の値 |
@・$・*は全角・半角のどちらでもよい(@$名前・@$名前・@$*名前も受理される)。- 静的な単語参照と同じく、アクション行と変数代入の右辺(
$x=@$名前。プロパティ代入$%名前=@$名前を含む)に書ける。 - 直後には 1 文字以上の空白を置く。この空白は区切りとして消え、出力されない(単語の参照 と同じ規則)。
- Lua 側では
act:word(var.名前, "var.名前")(アクション行ではact:actor_proxy("アクター"):word(var.名前, "var.名前"))になり、変数の値と、警告に使う変数の場所が渡される。
%ぱすた
@果物:りんご、みかん、ぶどう
@野菜:にんじん、たまねぎ
*メイン
$種類=「果物」
ぱすた:おすすめの$種類 は@$種類 です。
$種類=「野菜」
ぱすた:おすすめの$種類 は@$種類 です。
$品=@$種類
ぱすた:買うのは$品 です。
この例の 1 つ目の @$種類 は @果物 と同じく「りんご」「みかん」「ぶどう」から、2 つ目と $品 の右辺は @野菜 と同じく「にんじん」「たまねぎ」から選ばれる。
シーン引数も参照できる。
%ぱすた
@果物:りんご、みかん
*OnTest
>すすめる(「果物」)
*すすめる
ぱすた:@$0 はいかが?
探し方と選び方
動的単語参照は、変数の値を @ の後ろに書いた静的な単語参照と同じ探し方・選び方をする。
- 前方一致で候補を集め、シャッフル&順次消費で 1 つを選ぶ(前方一致検索・シャッフル&順次消費)。
- 巡回は静的な単語参照と共有される。
$xの値が「挨拶」のとき、同じスコープの@$xと@挨拶は 1 つの巡回を順に消費する。 - アクター付きのアクション行では、静的と同じくそのアクターのアクター辞書(A1・A2)を先に探す。変数代入の右辺ではアクター辞書を探さない(アクタースコープと単語参照の統合)。
- 段の途中で関数が見つかった場合は、静的と同じくその関数を呼び出し、戻り値を単語として出力する(Call との分離)。
%ぱすた
@挨拶:おはよう、こんにちは
*メイン
$x=「挨拶」
ぱすた:@$x 。
ぱすた:@挨拶 。
この例の @$x と @挨拶 は 1 つの巡回を順に消費する。2 行で「おはよう」と「こんにちは」が 1 回ずつ出て、同じ値が続くことはない(どちらが先かは巡ごとに変わる)。
スコープと優先順位 の段のうち、静的と異なるのは次の 2 点だけである。どちらも、変数の値によって act や表の組み込みの処理が意図せず呼ばれないようにするためである。
| 段 | 静的な単語参照 | 動的単語参照 |
|---|---|---|
| 3 段目(act のメソッド) | 探す | 探さない。値が act のメソッド名(talk・word など)と同じでもそのメソッドを呼ばずに、4 段目へ進む |
| 1 段目(シーンテーブル)・A1(アクターの表) | 表が組み込みで持つメソッド(create_word など)にも一致する | 作者が定義したもの(Lua ブロックで定義したシーン関数、アクターの設定値・name・ACTOR に入れた値)だけに一致し、組み込みのメソッドには一致しない |
2 段目・4 段目・5 段目と A2 は静的と同じである。4 段目の GLOBAL テーブルも探すため、GLOBAL に登録された関数は、変数の値が同じ名前なら静的と同じく呼び出される。
値の扱い
- 値が文字列なら、その文字列を単語キーにする。
- 値が数値なら、変数展開と同じ表記の文字列にして単語キーにする(
3なら「3」)。 - 値は DSL として読み直さない。値に
@・$・さくらスクリプトなどの記号が含まれていても、その文字列のまま単語キーにする。選ばれた単語をさらに単語キーとして探すこと(多段階参照)も無い。@@はエスケープ専用である(エスケープ)。
値が使えないとき・見つからないとき
次の場合、エラーにはならず、動的単語参照は何も展開せずに失敗として報告される(バルーンに失敗表記、ログに警告。実行時の失敗の出力)。行の残りの台詞と後続の行はそのまま実行される。変数代入の右辺では、静的な単語参照で未定義の単語を右辺に書いたときと同じ値が入る。
| 状況 | 警告 |
|---|---|
| 変数に値が代入されていない | act:word - undefined variable: 'var.名前' |
| 値が空文字列 | act:word - empty variable: 'var.名前' |
| 値が文字列・数値以外(真偽値・テーブル・関数など) | act:word - unsupported value type: 'var.名前' (boolean)(括弧の中は値の型) |
| 単語キーに一致するものがどの段にも無い | act:word - handler not found: key='単語キー', mode='word', via=act(静的と同じ) |
- 上の表は変数代入の右辺の場合である。アクション行では先頭が
proxy:wordになり、該当なしの警告はvia=proxy(アクター名)で終わる。 - 警告の変数は Lua での書き方で示される。
$名前はvar.名前、$*名前はsave.名前、$0はargs[1]である。 - 未代入・空・型不正の 3 つの場合は、単語を探さない。
%ぱすた
*メイン
ぱすた:今日は@$未代入 です。
$未代入 に何も代入していないので、この例は「今日は【名前にならない値:$未代入(値なし)】です。」と表示され、ログに proxy:word - undefined variable: 'var.未代入' が出る。
動的関数呼び出し
@$名前 の直後に括弧で引数を書くと(@$名前(引数、引数))、変数の値を関数名とする関数呼び出しになる。静的な @名前 と @名前(…) の関係と同じである。
%ぱすた
*メイン
$計算=「add」
ぱすた:合計は@$計算(10、20)です。
$result=@$計算(1、2)
ぱすた:答えは$result です。
```lua
function SCENE.add(act, x, y)
return x + y
end
```
@$*名前(…)・@$0(…)も書ける。引数の書き方・括弧の全角半角・書ける場所(アクション行・変数代入の右辺・式の中)は、静的な関数呼び出し@名前(…)と同じである(式(Expression)のサポート)。- 検索は静的な関数呼び出しと同じ段を探す(アクター辞書は探さない)。ただし動的単語参照と同じく、3 段目(act のメソッド)は探さず、1 段目(シーンテーブル)は作者が定義した関数だけに一致する。
- 見つかった関数を同じ引数で呼び、戻り値をアクション行では出力し、式の中では値として使う。アクション行でも、静的と同じく関数の第 1 引数は act である(関数スコープの展開先)。
- 変数が未代入・空・文字列と数値以外のときは関数を探さず、値の無い呼び出しになり、失敗として報告される。警告は動的単語参照と同じ 3 種で、先頭が
act:expr_fn(アクション行ではproxy:expr_fn)になる。 - 関数が見つからないときは、静的な関数呼び出しと同じく値の無い呼び出しになり、
handler not foundの警告と失敗表記が出る。 - 値の扱い(数値は文字列にする・DSL として読み直さない)は動的単語参照と同じである。
- 引数が式として正しくない場合は、静的と同じく関数呼び出しにならない。
@$名前の動的単語参照と本文「(…)」として解釈される(インライン要素)。
書けない形
次の形はパースエラーになり、そのファイルは読み込まれない。
- プロパティ変数を使う形(
@$%名前・@$%名前(…)) @*の後ろに変数を書く形(@*$名前(…))@$の後ろに変数名が無い形(@$$、@$の直後が空白や行末)- 単語定義のキーに変数を書く形(
@$名前:値)
未定義単語の参照
どこにも見つからない単語キーを参照すると、エラーにはならず、何も展開せずに単語が見つからない失敗として報告される(実行時の失敗の出力)。
%ぱすた
*テスト
ぱすた:@存在しない単語 です
この例は「【単語が見つからない:@存在しない単語】です」と表示される。
エスケープ
@エスケープ
@@ と書くと、文字の「@」が 1 文字出力される。全角と半角を混ぜた @@ も受理され、2 文字目が出力される。多段階参照(@@word で単語名を間接参照する、など)は無く、@@ はエスケープ専用である。
%ぱすた
*メール
ぱすた:メールは user@@example.com です
引用符エスケープ
単語値に区切り文字や 」 を含めたいときは、値を囲む括弧を重ねる。囲みの括弧は値に含まれない。
@会話:「「セリフ」」、"「セリフ」"
この単語の候補は セリフ と 「セリフ」 である。「「セリフ」」 の値は括弧を含まない セリフ であり、括弧ごと値にしたい場合は "「セリフ」" のように " で囲む。囲みの規則は リテラル型 で扱う。
ランダムの妙、堪能していただけまして? 単語ひとつで、会話が生き物になりますのよ。
では明朝から、挨拶を三通りご用意いたします。
おほほ、その意気ですわ! さあ、次は値を覚えておく「変数・スコープ」へ参りましょう!