さくらスクリプト
表情も間(ま)も演出も、ひとつの記法で添えられる――それがさくらスクリプトですわ。
解釈もせずに通すだけとは、Pasta も少々手抜きでございますね。
あら、浅いですわね。「解釈せず、そのまま通す」のが Pasta の流儀。だからこそ自由が利きますの。おほほ、賢いやり方でしょう?
さくらスクリプトは、半角 \ から始まるコマンドである。台詞に表情や間(ま)を添える、ベースウェア向けのト書きにあたる。アクション行のインライン要素として書けるほか、単語定義の値にも書ける(配置ルール)。Pasta はコマンドの意味を解釈しない。字句構造(どこからどこまでが 1 つのコマンドか)だけを見て切り出し、そのまま透過して出力する。コマンドの意味はベースウェア(SSP など)が解釈する。
使用例
%ぱすた
%Bob
*表情変更
ぱすた:\s[0]こんにちは!
ぱすた:\s[4]元気だよ
ぱすた:\s[1]\w8それで\w8ね...
*改行とウェイト
ぱすた:最初の行\n次の行\n\w9最後の行
*引数付きのコマンド
ぱすた:\![raise,OnTest,"100,2"]イベントを送ったよ。
*コマンドのみ
Bob:\![happy]了解しました。
配置ルール
さくらスクリプトは次の 2 か所に書ける。
| 書ける場所 | 例 |
|---|---|
| アクション行のインライン要素 | ぱすた:\s[1]こんにちは |
| 単語定義の値 | @照れ:\s[1] |
アクター辞書の表情(@通常:\s[0])は、単語値にさくらスクリプトを書けることを使っている(アクター辞書)。
単語値の形には次の制約がある(詳細は 単語定義)。
- さくらスクリプトで始まる引用なしの値は、そのコマンド 1 個で終わる。
@w:\s[0]こんにちはや@w:\s[0]\w8のように後ろへ続けて書くとパースエラーになる。コマンドの名前は 1 文字で終わるため、@w:\nOKも\nの後ろに字が続く形になり、パースエラーになる。 - 囲み(
\_?…\_?)は全体で 1 個のコマンドとして数える。@w:\_?\s[1]\_?の値は\_?\s[1]\_?である。 - コマンドの後ろに文字や別のコマンドを続けたい値は、文字で始めるか(
こんにちは\s[0])、値全体を「」で囲む(「\s[0]\w8こんにちは」)。囲んだ値の中のさくらスクリプトもそのまま出力される。
主要タグ早見
よく使うタグを示す。タグの意味と全一覧はベースウェアの仕様であり、UKADOC のさくらスクリプト一覧で確認できる。Pasta はここに無いタグも同じように透過する。
| タグ | 用途 | 例 |
|---|---|---|
\s[ID] | サーフェス(表情)の変更 | \s[0] |
\n | 改行 | 最初の行\n次の行 |
\w数字 | ウェイト(数字 × 50 ミリ秒。数字は 1〜9 の 1 桁) | \w8(400 ミリ秒) |
\_w[ミリ秒] | ウェイト(ミリ秒で指定) | \_w[1000] |
\![...] | イベントの発生・特殊コマンド | \![raise,OnTest] |
\_s | 全員が同時に話す(同期) | \_s |
\p[N] | 話すキャラクター(スコープ)の切り替え | \p[1] |
\b[ID] | バルーンの変更 | \b[2] |
\f[属性,値] | 文字の装飾(色・太字など) | \f[color,255,0,0] |
%ぱすた
*早見の例
ぱすた:\s[0]こんにちは。\w8\n\_w[1000]\f[bold,1]大事な話\f[bold,0]があるの。
この例は、表情を変えて「こんにちは。」と話し、400 ミリ秒待って改行し、さらに 1 秒待ってから、「大事な話」だけを太字にして続きを話す。
アクターの切り替えに伴う \p[N] は Pasta が自動で出力する(バルーン連携)。台詞の中に \p[N] や \0 \1 などのスコープ切り替えタグを書くと、アクターの外見の記録にも影響する(記録できない指定)。
エスケープ文字
さくらスクリプトの開始文字は半角バックスラッシュ \ のみである。全角の \ はコマンドの開始にならず、通常の文字として扱われる。
コマンドの字句構造
sakura_command ::= "\" ( digit_name | name arguments? )
digit_name ::= ( "s" | "p" | "b" ) [0-9] | "w" [1-9]
name ::= "_"{0,2} name_char
name_char ::= [a-zA-Z0-9!\-+*?&]
arguments ::= "[" argument ( "," argument )* "]"
argument ::= quoted arg_rest | arg_rest (* 2 つ目の形は '"' で始まらない *)
arg_rest ::= ( "\" any_char | [^\]\\,] )*
quoted ::= '"' ( '""' | [^"] )* '"'
- コマンドの名前は、
_を 0〜2 個付けた 1 文字である。名前の文字は ASCII 英数字と!-+*?&のどれかである。\n・\_w・\__w・\-・\0はそれぞれ 1 つのコマンドになる。 - 名前が
s・p・bのときは直後の数字 1 桁(0〜9)を、wのときは直後の数字 1 桁(1〜9)を名前に含める(\s3・\p1・\b2・\w8)。この形は引数を取らない。\w10は\w1と字0、\w0は\wと字0、\s12は\s1と字2、\s3[x]は\s3と字[x]になる。 - 名前の後ろに続けて書いた字はコマンドに含まれず、台詞になる。
ぱすた:\nHelloは改行\nと台詞Hello、ぱすた:\w9OKはウェイト\w9と台詞OKになる。 - 名前(数字付きの形を除く)の直後に半角
[があれば、角括弧の引数が続く。角括弧は半角の[]だけが対象で、全角の括弧は引数の括弧にならない。 - 引数は
,で区切られ、エスケープも引用もされていない最初の]で閉じる。角括弧は入れ子にならない(角括弧内のエスケープと引用)。 - 引数が閉じないとき(閉じる
]が無いとき、引数の先頭で開いた引用が閉じないとき)は、名前までがコマンドになり、[以降は台詞になる。ぱすた:\s[0はコマンド\sと台詞[0になる。 - アクション行では、引数・引用・囲みを 1 行の中で読む。その行の中で閉じなければ、後ろの行に
]があっても、名前までがコマンドになる。 - 角括弧の中身は解析しない。名前の形に合えば、未知のコマンドも受理される。
\\と\%はコマンドではなくエスケープである(タグの外のエスケープ)。- アクション行では、
\の後ろがコマンドにもエスケープにも囲みにもならない書き方(\あ、名前の文字が続かない\_、行末の\)はパースエラーになる。
次のシーンの各行は、表のようにコマンドと台詞に分かれる。
%ぱすた
*字句の切れ目
ぱすた:\nHello
ぱすた:\w9OK
ぱすた:\w10秒
ぱすた:\s3です
ぱすた:\s[0
| 書いた台詞 | コマンド | 台詞になる字 |
|---|---|---|
\nHello | \n | Hello |
\w9OK | \w9 | OK |
\w10秒 | \w1 | 0秒 |
\s3です | \s3 | です |
\s[0 | \s | [0 |
タグの外のエスケープ
\\ は \ を、\% は % を 1 文字表示するエスケープである。どちらも 2 文字で 1 つの単位として読まれ、後ろの文字とつながってコマンドにはならない。C:\\new は \n の改行を含まず「C:\new」と表示され、100\%です は「100%です」と表示される。アクション行での書き方は インライン要素 で扱う。
タグをそのまま表示する囲み
\_? から次の \_? までは、全体で 1 つのさくらスクリプトになる。旧式の \_! から次の \_! までも同じである。\_? の囲みは \_? でだけ、\_! の囲みは \_! でだけ閉じる。
- 囲みの中の文字は、ベースウェアがタグとして解釈せず、書いたとおりに表示する。
- アクション行では、囲みの中の
@単語・$変数・関数呼び出し・エスケープは展開されず、そのまま出力される。ウェイトの自動挿入や改行位置の推定で、囲みの中に何かが入ることもない。 - 同じ行の中に閉じが無い
\_?(\_!)は、ただの 1 つのコマンドになる。後ろの字は通常どおり読まれる。
%ぱすた
*タグの紹介
ぱすた:表情は\_?\s[1]\_?で変えるよ。
ぱすた:単語は\_?@名前\_?と書くよ。
この例の 1 行目は「表情は\s[1]で変えるよ。」、2 行目は「単語は@名前と書くよ。」と表示される。
角括弧内のエスケープと引用
角括弧の中では、ベースウェアのエスケープと引用の規則がそのまま使える。Pasta は次の 2 つを字句として認識し、中身を変えずに透過する。
\と続く 1 文字は組として読む。続く文字が]でも角括弧は閉じない。ぱすた:\s[a\]b]は 1 つのコマンドである。- 引数の先頭(
[の直後、または区切りの,の直後)の"は引用を開き、次の"で閉じる。引用の中の]・,・\は普通の文字として読む。- カンマを含む引数は
"で囲む:\![raise,OnTest,"100,2"] - 囲んだ引数の中に
"を含めるときは""と 2 つ重ねる:\![call,ghost,"the ""Name"""]
- カンマを含む引数は
引用は引数全体を囲む書き方である。
- 引用が閉じた後ろは、次の
,か]まで普通に読む。 - 引数の途中(先頭以外)の
"は引用を開かず、普通の文字になる。\q[5"フロッピー,OnX]は 1 つのコマンドである。ぱすた:\![raise,X,a"]b]は、コマンド\![raise,X,a"]と台詞b]に分かれる。 - 引数の先頭で開いた引用が閉じないときは、引数が閉じないものとして読む(コマンドの字句構造)。
ぱすた:\q["abc,OnX]yは、コマンド\qと台詞["abc,OnX]yに分かれる。
%ぱすた
*引数の書き方
ぱすた:\![raise,OnTest,"100,2"]カンマを含む引数。
ぱすた:\![call,ghost,"the ""Name"""]引用符を含む引数。
ぱすた:\s[a\]b]閉じ括弧を含む引数。
この例の 3 行は、どれも角括弧の閉じまでが 1 つのコマンドになり、その後ろの字が台詞になる。
台詞に書いた文字の装飾とアクターの装い
台詞に書いた \f[…] も、ほかのタグと同じく書いたとおりの位置にそのまま出力される。特定の語だけを強調するときは、台詞に \f[…] を書く。
%ぱすた
*強調
ぱすた:今日は\f[bold,1]大事な日\f[bold,0]だよ。
アクターの台詞全体にいつも同じ装いを付けるときは、台詞ごとに書かずに、pasta.toml のアクター設定の font に書く(装い(font))。両方を使うときの関係は次のとおりである。
- 台詞に書いた
\f[…]の文字列は変わらない。同じアクターが話し続ける間は、その効果が残り、Pasta はその後に装いのタグを差し込まない(\c・\xの後に装いを出し直す場合を除く)。 - 話者が替わるとき、切り替え先の吹き出しで、そのトークの中ですでに装いのあるアクターが話していれば、Pasta は
\f[default]で既定の表示へ戻す。台詞に書いた\f[…]の効果も、ここで消える。切り替え先が装いのあるアクターで、その吹き出しですでに話者が話していたときも、同じく戻してから装いを付ける。どちらも、装いの無いアクターの台詞の\cで吹き出しを消して既定の表示に戻った後は数えない。 - 装いのあるアクターが関わらない切り替えでは、Pasta は装いのタグを差し込まない。台詞に書いた
\f[…]の効果は、同じ吹き出しで次に話すアクターの台詞にも残る。
複雑なケースの方針
Pasta はさくらスクリプトの複雑な構文(入れ子、特殊な引数構成、高度なエスケープの組み合わせ)を検出・解釈しない。複雑なコマンドが必要な場合は、Lua 関数でさくらスクリプトを含む文字列を作り、アクション行から呼び出す。
%ぱすた
*複雑な演出
ぱすた:@emit_complex_sakura()どうぞ
```lua
function SCENE.emit_complex_sakura(act)
return "\\![embed,OnTalk]"
end
```
@emit_complex_sakura() が返した文字列 \![embed,OnTalk] が、その位置に出力される(Lua の文字列リテラルの中では \ をエスケープして書く)。関数の書き方は 変数・スコープ と Lua セクションで扱う。
解釈をベースウェアに任せる潔さ、お分かりいただけまして? 次は会話に彩りを添える「単語定義」へ参りますわよ。
手抜きではなく、分業でございましたか。