アクター辞書
キャラクターごとに表情の引き出しを用意する――それがアクター辞書ですわ。
引き出しごとに名札を付けておく、ということでございますか。
ええ。「ぱすたの通常顔」「ラザニアの刮目」を名前で呼び出せる、なんとも優雅な仕組みですの。台本でいえば登場人物の欄、しっかり仕上げて差し上げますわよ。
アクター辞書(ActorScope)は、台本の登場人物にあたる。%(または %)マーカーでアクターを定義し、その人物だけが使う言葉(表情など)を持たせる。持たせた言葉は、そのアクターの台詞(アクション行)から @名前 で引ける。
この章は、登場人物の定義に続けて、場面に出る人と立ち位置を決めるアクター指定行(% 行。柱に付く)と、立ち位置ごとの外見の扱いを扱う。
グローバルアクター辞書定義
ファイルレベル(インデントなし)で %アクター名 を書き、その直下にインデントした @単語名:値 行を並べると、そのアクターに属する単語(アクター単語)になる。
%ぱすた
@通常 :\s[0]、\s[100]
@照れ :\s[1]
@驚き :\s[2]
@ぐんにょり:\s[3]
@怒り :\s[4]
%ラザニア
@通常、普通:\s[10]
@刮目 :\s[11]
- アクター名には識別子(日本語・英語)を使う。
%アクター名を定義すると、その名前をアクション行のアクター名に使える(pasta.toml の[actor."名前"]に登録した名前も使える。アクション行)。 - 配下の行はインデント(全角空白
または半角空白)で始める。 - 単語値の書き方はグローバル単語と同じである(単語定義)。値は読点・カンマで区切り、さくらスクリプトを値にできる(配置ルール)。
- コロンの左側に複数のキーを並べられる(
@通常、普通:\s[10]。複数キー単語定義)。 - 同じ名前の
%アクター名を複数書くと(別のファイルでも)、1 つのアクターにまとまり、単語は合算される。 - アクター名には、
%さくら・改のように記号(識別子に書ける文字)も使える。アクター辞書は、アクター名を照合用の名前(シーン名の照合。さくら・改ならさくら_改)に揃えて照合するため、記号を含むアクター名でも、そのアクターのアクション行(さくら・改:@通常)からアクター単語を引ける。 - 照合用の名前が同じになるアクター名(
さくら・改とさくら_改)は区別されず、同じアクター辞書を共有する。どちらのアクターのアクション行からも、両方のアクター単語が候補になる。
アクター辞書の配下に置ける行は、単語定義・属性行・変数代入行・Lua ブロック・空行である。このうち属性行(&…)と変数代入行($x=…・$*x=…・$=…・$%p=…)は構文として受理されるが、何も起きない(値は代入されない)。Lua ブロックの扱いは コードブロック で扱う。
シーンスコープ内でのアクター指定
グローバルシーンの初期部(宣言の直後、最初のアクション行より前)に %アクター名、アクター名… の行(% 行)を置くと、アクターの立ち位置(スポット番号)を設定する。立ち位置は、アクターの台詞をどのキャラクター・バルーンに出すかを決める(バルーン連携)。
*OnBoot
%ぱすた、ラザニア
ぱすた:@通常 こんにちは
ラザニア:@刮目 目を見開くラザニア
%行は、シーンの最初(台詞より前)に、それまでのすべてのアクターの立ち位置を消してから、並べたアクターに番号を付ける。上の例では「ぱすた」が 0、「ラザニア」が 1 になる。- 番号は先頭が 0 で、並べた順に 1 ずつ増える。
名前=数字と書くと、そのアクターの番号を指定できる(全角数字も可)。番号を省いたアクターは直前の番号+1 になる。%さくら、うにゅう=5、まりかは 0・5・6 になる。番号は 0〜4294967295 で、これを超える番号は構文の誤りになる。 - 同じグローバルシーンに複数の
%行を書くと、番号は前の行から続けて付けられる。末尾の読点と、同じ番号の重複も受理される。 - 設定した立ち位置は、次に
%行が実行されるまでイベントをまたいで保たれる。%行の無いシーンは、直前の立ち位置のまま話す。 %行に並べなかったアクターは、立ち位置が無くなる(スポット 0 で話す)。- アクター辞書にも pasta.toml の
[actor]にも無い名前を並べた場合、その名前は無視される。 - アクター単語の参照(
ぱすた:@通常)は、%行が無くても働く。%行は立ち位置だけを決める。
SHIORI ゴーストでは、*OnBoot で一度設定して固定する使い方が基本である。ノベルゲームのように場面ごとに配置を変える場合は、シーンごとに % 行を書いて切り替える。
アクタースコープと単語参照の統合
アクター付きのアクション行の単語参照(アクター名:@単語名)は、次の順に探し、最初に見つかったものを使う。アクター辞書の 2 段(A1・A2)を探してから、通常の単語参照と同じ 5 段(スコープと優先順位)を探す。
| 段 | 探す対象 | 一致の仕方 |
|---|---|---|
| A1 | アクターの表(pasta.toml のアクター設定の値、name、Lua ブロックで ACTOR に入れた値) | 完全一致 |
| A2 | そのアクターのアクター辞書(アクター単語) | 前方一致 |
| 1 | 実行中のグローバルシーンのシーンテーブル | 完全一致 |
| 2 | 実行中のグローバルシーンのローカル単語辞書 | 前方一致 |
| 3 | act のメソッド | 完全一致 |
| 4 | GLOBAL テーブル | 完全一致 |
| 5 | グローバル単語辞書 | 前方一致 |
- アクター単語はローカル単語・グローバル単語より先に探される。アクター辞書に無い単語は、ローカル単語辞書 → グローバル単語辞書の順に探される。
- アクター単語の検索も、グローバル単語・ローカル単語と同じ前方一致である。
- A1 の例として、pasta.toml にそのアクターの
spotやsurfaceを書くと、@spot・@surfaceは設定値になる(副作用: トーク中の @surface)。@nameはアクター名になる。 - アクター辞書を探すのは、アクター付きのアクション行の単語参照だけである。アクション行の関数呼び出し(
@名前())や変数代入の右辺($x=@名前)は、A1・A2 を探さずに 1〜5 段だけを探す。 - 動的単語参照(
アクター名:@$名前)も、変数の値を単語キーとして A1・A2 から探し、見つからなければ 1・2・4・5 段を探す。3 段目(act のメソッド)は探さず、A1 と 1 段目は作者が定義したもの(アクターの設定値・name・ACTORに入れた値、Lua ブロックで定義したシーン関数)だけに一致する(動的単語参照)。 - 動的関数呼び出し(
アクター名:@$名前())と変数代入の右辺の動的単語参照($x=@$名前)は、静的と同じく A1・A2 を探さない。
%ぱすた
@通常:\s[0]
@照れ:\s[1]
*表情
$顔=「照れ」
ぱすた:@$顔 えへへ
この例の @$顔 は、ぱすた:@照れ と書いた場合と同じくアクター辞書から見つかり、\s[1] を出力する。
シャッフル&順次消費
アクター単語も、グローバル・ローカル単語と同じシャッフル&順次消費で選ばれる(シャッフル&順次消費)。
- 複数の値を持つ単語(例:
@通常:\s[0]、\s[100]、\s[200])は、シャッフルされた後、参照のたびに順に使われる。 - 全候補を使い切ると、シャッフルし直して最初から使う。
- 値が 1 つの単語(例:
@照れ:\s[1])は常に同じ値を返す。
バルーン連携
アクターの立ち位置(スポット番号)は、そのアクターの台詞をどのキャラクター(スコープ)とバルーンに出すかを決める。Pasta は、話すアクターが切り替わるたびに \p[スポット番号] を出力してから台詞を出力する。
| スポット | 出力先 |
|---|---|
0 | sakura 側(メインキャラクター)とそのバルーン |
1 | kero 側(サブキャラクター)とそのバルーン |
2 以上 | 3 人目以降のキャラクター(ベースウェアとシェルが対応している場合) |
立ち位置は次のように決まる。
- 起動時の立ち位置は、pasta.toml の
[actor."名前"]に書いたspotの値である。 %行を実行すると、その行の設定に置き換わる(シーンスコープ内でのアクター指定)。- どちらでも立ち位置が決まっていないアクターは、スポット 0 で話し、ログに警告が出る。登録していないアクター名は、この警告の代わりに未登録アクターの失敗として報告される(実行時の失敗の出力)。
[actor."女の子"]
spot = 0
[actor."男の子"]
spot = 1
%女の子
@笑顔:\s[0]
@通常:\s[1]
%男の子
@笑顔:\s[10]
@通常:\s[11]
*OnBoot
%女の子、男の子
女の子:@笑顔 おはよう!
男の子:@通常 さあ、始めようか。
*OnTalk
女の子:@通常 今日はいい天気だね。
男の子:@笑顔 そうだね。
この例の *OnTalk には % 行が無いが、pasta.toml と *OnBoot の設定により、女の子は \p[0]、男の子は \p[1] に出力される。
同一スポット共有時の外見の復旧
SSP はサーフェスと着せ替えをスポット(\p[N])単位で保持する。そのため複数のアクターを同じスポット(同じ spot 値、または spot 未設定によるスポット 0 へのフォールバック)に割り当てて交代で話させると、直前に話したアクターの立ち絵が残ってしまう。pasta はアクターごとの外見を記録し、交代時に切替先アクターの外見を自動で復旧する。
復旧の振る舞い
- 記録: アクターの発話中に出力されたサーフェス変更(
\s[ID]・\sN。アクター辞書の単語由来も含む)と着せ替え指定(\![bind,カテゴリ名,パーツ名,数値])を、そのアクターの外見として記録する。あわせて、そのスポットに表示中の外見も記録する。サーフェス ID は数値・エイリアス・-1のいずれも、出力されたとおりの値で扱う。 - 復旧: アクターが切り替わったとき、切替先アクターの記録とスポットに表示中の外見が食い違えば、
\p[spot]の直後(発話内容の前)に\s[ID]、続けて\![bind-noevent,...]を出力する。一致していれば何も出力しない。 - 着せ替えの比較単位: 着せ替えはカテゴリ単位で比べ、食い違うカテゴリはそのアクターが記録した順に丸ごと再出力する。アクターが一度も指定していないパーツ(直前のアクターが着けたアクセサリなど)は外さない。交代時に確実に外したいパーツは、後述の
dressupに0で書いておく。カテゴリ全脱衣\![bind,カテゴリ名,,0]を記録したアクターへ戻るときは、全脱衣から復旧する。 - 冗長な復旧の省略: 発話の先頭(最初の本文の文字より前)に
\s[ID]を書いた場合、サーフェスの復旧は出力しない(直後に上書きされるため)。先頭に数値とパーツ名を明示した bind を書いた場合も、そのパーツの復旧だけを出力しない。 - 継続時は復旧しない: 同じアクターが同じスポットで話し続ける場合は復旧しない。各アクターが専用スポットで話す構成では、
surface・dressupを設定しない限り出力は変わらない。 - 記録の寿命: 記録はゴースト起動中のトークをまたいで保持し、ゴーストの再読込で破棄する。セーブデータには保存しない。
[actor."女の子"]
spot = 0
[actor."男の子"]
spot = 0
%女の子
@通常:\s[0]
%男の子
@通常:\s[10]
*会話
%女の子、男の子
女の子:@通常 \![bind,帽子,麦わら,1]こんにちは。
男の子:@通常 \![bind,帽子,リボン,1]やあ。
女の子:いい天気ね。
3 つ目の発言(女の子:いい天気ね。)で女の子に戻るとき、スポット 0 には男の子の \s[10] とリボンが残っている。pasta は女の子の \p[0] の直後に \s[0]\![bind-noevent,帽子,麦わら,1] を補い、女の子の外見を復旧する。
任意キー surface・dressup
pasta.toml のアクター設定に、記録がまだ無いときに使う既定の外見を書ける。
| キー | 型 | 意味 |
|---|---|---|
surface | 整数 または 文字列(エイリアス) | 既定サーフェス。そのアクターがまだサーフェス変更を出力していないときの復旧値 |
dressup | テーブル(カテゴリ名 → パーツ名 → 0 または 1) | 既定着せ替え。そのアクターがまだ指定していないパーツの復旧値(1=着衣 / 0=脱衣) |
[actor."女の子"]
spot = 0
surface = 0
[actor."女の子".dressup."帽子"]
"リボン" = 1
"麦わら" = 0
- いずれも任意である。未設定のアクター・パーツについては、既定値による出力を一切行わない。
dressupの入れ子の順(カテゴリ名 → パーツ名 → 数値)は bind タグの引数順と同じである。値は数値0・1のみ有効で、trueなどそれ以外の値は無視される。- 既定値は記録が無いときのフォールバックであり、発話中に出力した
\s[ID]・bind の記録が優先される。 - pasta は起動直後の SSP の表示を知らないため、
surface・dressupを設定したアクターは、起動・再読込後に最初に話すときにも既定値を出力する(専用スポットでも同様)。
上の設定の女の子が起動後に最初に話すとき、pasta は \p[0] の直後に次のタグを補う。サーフェスが先で、着せ替えはパーツ名の昇順に並ぶ。
\s[0]\![bind-noevent,帽子,リボン,1]\![bind-noevent,帽子,麦わら,0]
着せ替え復旧の動作要件(SSP 2.8.23 以上)
着せ替えの復旧タグは、SSP の着せ替え変更イベント(OnDressupChanged など)を発生させない \![bind-noevent,...] で出力する。復旧は見た目の再現であり、作者が明示した着せ替え操作ではないためである。このタグは SSP 2.8.23 以上で動作し、それより古いベースウェアでは着せ替えの復旧が効かない(サーフェスの復旧は効く)。pasta はベースウェアのバージョンによって出力を切り替えない。
記録できない指定
pasta は自分が出力したさくらスクリプトだけから外見を記録する。結果を確定できない指定は「不明」として扱い、出力そのものは変えない。
- スコープ切替タグ: 発話中に
\0\1\h\u\p[N]などを出力すると、全スポットの表示中の外見を不明とし、そのタグ以降(次にアクターが切り替わるか、次のトークが始まるまで)のサーフェス変更・bind はアクターの記録に含めない。 - アクター未指定の生さくらスクリプト(
act:raw_script()など): サーフェス変更・bind・スコープ切替タグを含むと、全スポットの表示中の外見を不明とする。アクターの記録は変えない。 - パーツ名を明示し数値を省略した bind(トグル): スポットのそのパーツの状態が分かっていれば反転した値として記録し、分からなければそのカテゴリを不明とする。
- パーツ名が空の bind(カテゴリ単位の着衣・トグル)、
0・1以外の数値の bind: そのカテゴリを不明とする。ただしカテゴリ全脱衣\![bind,カテゴリ名,,0]は記録する。
*会話
女の子:\![bind,帽子,リボン,1]かぶって、\![bind,帽子,リボン]ぬいだ。
女の子:\1こちらは相方の吹き出しに出る。\s[10]
この例の 1 行目は、リボンを着けた直後にトグルしているので、女の子のリボンは脱衣として記録される。2 行目の \1 はスコープ切替タグなので、その後ろの \s[10] は女の子の記録に含めず、全スポットの表示中の外見を不明とする。
不明になったスポットでは、次にアクターが交代したとき、切替先アクターの記録があれば再出力される。ただし同じアクターが同じスポットで話し続ける場合は、不明でも復旧しない(作者がスコープ切替タグや生さくらスクリプトで直接変えた表示を巻き戻さないため)。また、トグルなどでアクター自身の記録が不明になったカテゴリには、明示指定で記録し直すまで dressup の既定値も使わない。
非対応事項
- SSP 側だけで起きた変化(ユーザーの着せ替えメニュー操作、シェル変更、起動時の既定サーフェスなど)は検知しない。
- 名前に
,]"\を含むカテゴリ・パーツは追跡・復旧の対象外である(bind 引数のクォート・エスケープを解釈しないため、正しく記録されない)。dressupに書いた名前もエスケープせずに出力するため、これらの文字を含めないこと。 - 必ず 1 つ選択(
mustselect)のカテゴリで最後の 1 パーツを外す指定を SSP が拒否した場合、pasta の記録と実際の表示がずれる(descript.txtを読まないため検知しない)。
副作用: トーク中の @surface
surface・dressup は spot と同様にアクターの設定値としてアクター単語の検索対象にもなる。アクター単語の検索はアクター設定の値(キー名の完全一致)を最優先するため、そのアクターの会話行で @surface と書くと、同名のアクター単語・グローバル単語よりも先に設定値(surface = 0 なら文字 0)が出力される。サーフェスを変えるタグ \s[0] にはならない。@spot・@dressup も同様に設定値に解決されるため、これらの名前の単語は別の名前にすること。
*会話
女の子:サーフェスは@surface 番です。
surface = 0 を書いた女の子のこの台詞は、「サーフェスは0番です。」と表示される。
装いの font も同じである。font を書いたアクターの会話行で @font と書くと、単語ではなく設定値(装いのタグ列。font = { color = "90,110,140" } なら \f[color,90,110,140])が出力される。font という名前の単語も作らないこと。
1 つのスポットを複数のアクターで共有する
シェル(立ち絵)の無い相手役も、シェルのあるアクターと同じスポットに置いて、同じ吹き出しで交代に話させられる。誰の台詞かは、相手役に装い(文字の色など。装い(font))を付けて見分けられるようにする。
# シェルのあるアクター
[actor."ぱすた"]
spot = 0
surface = 0
# シェルの無い相手役。surface も dressup も書かない
[actor."おじさん"]
spot = 0
font = { color = "90,110,140" }
[actor."ギャル"]
spot = 0
font = { color = "255,0,128", bold = true }
*会話
おじさん:やあ。
ぱすた:こんにちは。
ギャル:おはよ!
ぱすた:またね。
起動後の最初のトークとしてこの例を出すと、出力は次のようになる(spot_newlines は既定の 1.5)。
\p[0]\f[color,90,110,140]やあ。\_w[950]
\p[0]\s[0]\f[default]\n[150]こんにちは。\_w[950]
\p[0]\f[default]\f[color,255,0,128]\f[bold,1]\n[150]おはよ!\_w[450]
\p[0]\f[default]\n[150]またね。\_w[950]\e
見やすさのため話者ごとに行を分けたが、実際の出力は 1 行につながる。
- 改行: 同じスポットで話者が替わり、その吹き出しに字が出ているときは、次の字の直前に
spot_newlinesの幅の改行(\n[150])が出る(spot_newlines)。 - 立ち絵の復旧:
surfaceもdressupも書かず、サーフェス変更も出していない相手役への切り替えでは、立ち絵の復旧タグは出ず、ぱすたの立ち絵はそのまま残る。ぱすたへ戻るときは、スポットに表示中のサーフェスがぱすたの記録と一致していれば何も出ない。上の例の\s[0]は、起動後にまだ表示が分からないスポットへぱすたが初めて戻ったときの既定サーフェスの出力で、4 つ目の発言では出ない(同一スポット共有時の外見の復旧)。 - 装いの出し入れ: 装いのタグは
\p[0]と立ち絵の復旧タグの後、改行より前に出る。装いのあるアクターを離れるとき、またはこの吹き出しですでに話者が話した後に装いのあるアクターへ替わるときは、\f[default]で既定の表示へ戻してから切り替え先の装いを付ける。この吹き出しですでに装いのあるアクターが話していれば、装いの無いアクターどうしの切り替えでも\f[default]が出る(装いの無いアクターの台詞の\cで吹き出しを消した後は数えない)。おじさんの後のぱすたは既定の表示に戻り、ギャルのboldはぱすたの台詞に残らない。 - 装いのタグは字に数えないので、改行の出る位置と立ち絵の復旧は、装いを書かないときと変わらない。
コードブロック
アクター辞書の配下には Lua ブロックを置ける。フェンスはシーン内の Lua ブロックと同じく行頭に書く(インデントしたフェンスはパースエラーになる。Lua ブロックの配置)。
%さくら
@通常:\s[0]
```lua
ACTOR.口癖 = "なのです"
function ACTOR.自己紹介(proxy)
return proxy.actor.name .. "です"
end
```
*OnTalk
さくら:@通常 @自己紹介 、よろしく@口癖 。
この例の *OnTalk は「さくらです、よろしくなのです。」と話す(表情は \s[0])。
- 出力される条件: フェンスの識別子が小文字の
luaちょうどのブロックだけが Lua として出力される。識別子が無いブロックや、text・Luaなどのブロックは何も出力されない(シーン内の Lua ブロックが識別子を問わず出力されるのとは異なる)。 - 実行の時期: ブロックは、そのアクターの単語定義の後に置かれ、辞書の読み込み時に 1 回だけ実行される。
- ACTOR: ブロックの中では、変数
ACTORでそのアクターの表を使える。ACTOR.名前に値や関数を入れると、アクタースコープと単語参照の統合 の A1(完全一致)で最優先に見つかる。 - 参照のされ方: そのアクターのアクション行の単語参照
アクター名:@名前で使われる。値が関数なら、アクタープロキシを唯一の引数として呼ばれ、戻り値が出力される。アクタープロキシの.actorはアクターの表、.actはイベント処理中の act である。関数以外の値は文字列に変換して出力される。アクタープロキシを受け取るのはアクターの表の関数だけで、同じ行から呼ばれてもアクターの外(シーンテーブル・GLOBALなど)の関数は act を受け取る(関数スコープの展開先)。 - 届かない経路: アクション行の関数呼び出し
@名前()、変数代入の右辺$x=@名前などアクターを伴わない単語参照、SHIORI イベントからは、ACTORに入れた値や関数に届かない。
柱に台詞、そして登場人物。これで台本の骨組みは、すっかりあなたの手の中ですわ。
次は、台詞の中で表情や間を操る「さくらスクリプト」でございます。
ふふん、ここから先は細部の磨き込みですの。気を抜かずについていらっしゃいまし。