変数・スコープ
記憶を持つゴーストと、持たないゴースト……その差を生むのが変数ですわ。
記憶と申しましても、いろいろと種類がございましょう。
一時的なもの、永続するもの、ベースウェアと共有するもの――この三種を使い分けますの。スコープを制する者がゴーストを制する、と申しておきましょう。
変数は $(または $)マーカーで代入・参照する。代入行($名前=値)は、台詞を出さずに値を覚えさせるト書きである。Pasta の変数には、有効範囲(スコープ)の異なる 3 種類と、Call で渡された値を読むシーン引数がある。代入の値には式や関数呼び出しも使える。
変数の種類とスコープ
| 種類 | 代入 | 参照 | 有効範囲 |
|---|---|---|---|
| ローカル | $名前=値 | $名前 | 1 回のイベント処理の間(ローカル変数) |
| グローバル | $*名前=値 | $*名前 | 永続(ゴーストを終了しても保存される) |
| プロパティ | $%prop.path=値 | $%prop.path | ベースウェアのプロパティ(ベースウェアが管理) |
| シーン引数 | 代入できない | $0・$1… | そのシーンの呼び出し 1 回(シーン引数) |
代入は変数代入行で、代入演算子 =(または =)だけを使う。$score:100 のようにコロンで代入するとパースエラーになる。値として書けるものは 式(Expression)のサポート のとおりである。真偽値のリテラル(true・false)は無い(リテラル型)。変数名に Lua の予約語(end・local など)は使えない(Lua 予約語の制約)。
*初期化
$score=100
$ユーザー=「太郎」
$*最高点=$score*2
変数代入行はシーンの中に置く。アクション行の中では変数を参照できるが、代入はできない(アクション行)。
ローカル変数
$名前 は Lua の var.名前 になる。ローカル変数は 1 回のイベント処理ごとに空の状態から始まり、イベント処理が終わると消える。
- Call で呼び出したシーンは、呼び出し元と同じローカル変数を読み書きする。
>チェイントークなどで中断したシーンは、次のイベントで再開したあとも、中断前と同じローカル変数を使い続ける。値はそのシーンが最後まで実行されるまで残る(チェイントーク)。
%Alice
*OnTest
$ローカル変数=10
Alice:値は$ローカル変数 です
グローバル変数
$* 修飾子を付けると、グローバル変数になる。Lua 側では save.名前 になり、ゴーストを終了しても値が保存されて、次の起動時に元に戻る(グローバル変数の保存先)。ゴーストの外から値を代入するときは、OnPastaSetSaveVariable を使う。
%Bob
*OnTest
$*グローバル変数=100
Bob:値は$*グローバル変数 です
プロパティ変数
$% でベースウェアのプロパティ(SSP のプロパティシステム)を読み書きする。プロパティ名は ASCII 英字で始まり、ASCII 英数字・_・.・(・) が続く。sakura.name や currentghost.scope(0).name のような名前をそのまま書ける。全角文字や空白でプロパティ名が終わるため、名前の直後に半角の ( を書くと名前に含まれる。
%さくら
*OnTest
$%sakura.name=「Alice」
$name=$%sakura.name
さくら:$%sakura.name です
- 書き込みは
$%名前=値、読み込みは代入の右辺に単独で置く$x=$%名前と、アクション行のインライン参照である。 - プロパティ変数は式の中(演算・関数の引数・Call ターゲット)には書けず、トランスパイルエラーになる。式で使うときは、いったんローカル変数に代入してから使う。
シーン引数
$0・$1…(数字だけの変数名)は、Call でシーンに渡された引数を参照する。$n は、そのシーンが受け取った n+1 番目の引数である。
%ぱすた
*OnTest
>紹介(「ぱすた」、3)
*紹介
ぱすた:$0 は$1 歳です
- 数字は全角でも半角でもよい(
$0と$0は同じ)。 - シーン引数には代入できない。
$0=1はパースエラーになる。 - イベントで直接起動されたシーン(Call されていないシーン)では値が無い。アクション行で参照すると値の無い変数の失敗になる(実行時の失敗の出力)。式の中での扱いは 値が無いときの扱い のとおりである。
- 番号は 0〜255 である。256 以上を書くと、番号の位置のパースエラーになる。
- 引数の渡し方(明示した引数の後ろに呼び出し元の引数が付け足されること)は 引数リスト で扱う。
ベースウェアから届く Reference0 などは、シーン引数とは別の変数で読む(リクエスト変数(Reference))。
変数参照の空白ルール
アクション行の中で変数を展開するには、$変数名 の直後に1 文字以上の空白を置く。この空白は区切りとして消え、出力されない。
%ぱすた
*表示
$ユーザー=「太郎」
ぱすた:$ユーザー さん、こんにちは!
重要: 空白がないと最長一致で変数名を解釈し、後続の文字まで変数名に取り込んでしまう。意図しない動作を避けるため、変数参照の直後には必ず空白(または識別子に含まれない記号)を置く。
補足: 値を代入していない変数・存在しない単語(
@未定義)・見つからない関数(@未定義()・@*未定義())を参照したとき、および動的参照(@$名前・@$名前(…))の変数が未代入・空文字列・文字列と数値以外のときは、実行時の失敗としてバルーンに失敗表記、ログに警告が出て、その参照は空(式では値なし)として続く(実行時の失敗の出力)。
式(Expression)のサポート
変数代入の右辺には式を書ける。書けるものは次のとおり。
| 値の種類 | 構文例 | 説明 |
|---|---|---|
| リテラル値 | $score=100・$name=「太郎」 | 数値・文字列(リテラル型) |
| 単語参照 | $value=@word_name | 単語を 1 つ選んだ結果(単語定義) |
| 動的単語参照 | $value=@$種類 | 変数 $種類 の値を単語キーとして単語を 1 つ選んだ結果(動的単語参照) |
| 変数参照 | $new=$old・$n=$0 | 他の変数・シーン引数の値をコピー |
| 算術式 | $result=$a+$b*2 | 算術の評価 |
| 連結式 | $表示=「合計」&$n&「個」 | 文字列をつないだ結果(連結の評価) |
| ローカル関数呼び出し | $r=@calculate() | 5 段の検索で見つけた関数の戻り値 |
| グローバル関数呼び出し | $r=@*calculate() | GLOBAL テーブルの関数 calculate の戻り値 |
| 関数呼び出し(引数付き) | $sum=@add(10、20) | 引数は読点・カンマで区切り、位置で渡す |
| 動的関数呼び出し | $r=@$計算(10、20) | 変数 $計算 の値を関数名として探した関数の戻り値(動的関数呼び出し) |
関数呼び出しの引数の書き方は Call の引数リストと同じである(引数リスト)。演算子の一覧は キーワード・マーカー を参照。
計算や条件判定を関数にまとめたいときは、Lua ブロックでシーンテーブルに関数を定義し、@名前(引数) で呼び出す。関数は第 1 引数に act を受け取り、その後ろに DSL で書いた引数を受け取る。
%ぱすた
*計算
$result=@add(10、20)
ぱすた:合計は$result です
```lua
function SCENE.add(act, x, y)
return x + y
end
```
算術の評価
式は数値の算術として評価される。
*・/・%が+・-より先に計算される(優先順位)。同じ優先順位の演算子は左から順に計算される。1+2*3は 7、10-4-3は 3 になる。/は整数どうしでも小数の結果になる。7/2は 3.5 になる。- 負の符号は数値リテラルにだけ付けられる(
-5)。変数に付ける-$xはパースエラーになる。 +などの算術演算子はすべて数値の演算であり、文字列をつなぐことはない。文字列をつなぐ演算子は&である(連結の評価)。- 数字だけの文字列は数値に変換されて計算される。
「1」+2は 3 になる。全角数字だけの文字列(「12」)は数値に変換されない。 - 値の無い被演算子は 0 とみなして計算する。ログは出ない。値が無いのは、値を代入していない変数・値なしを代入した変数・渡されていないシーン引数・値を返さない関数呼び出しである。
$*回数=$*回数+1は、$*回数が未代入なら 1 になる。見つからない関数の呼び出しも 0 とみなし、呼び出しの時点の失敗(補足)だけが報告される。 - 0 とみなした被演算子が
/・%の右(除数)なら、0 での除算・剰余と同じ結果になる。1/$未代入はinf、1%$未代入は非数になる。実行時エラーにはならない。 - 数値にできない被演算子(数字でない文字列・全角数字だけの文字列・空文字列・真偽値、Lua の関数が返したテーブル・関数など)は、ログに警告(
act:arith - operand is not a number)とバルーンに失敗表記(実行時の失敗の出力)を出して 0 とみなす。警告は数値にできなかった被演算子ごとに 1 行出て、演算子と、その被演算子の値(変数の場所・関数名があればそれも)が含まれる。「a」+「b」も連結にはならず、警告が 2 行出て 0 になる。 - 空文字列は値の無いものではなく、数値にできない値である。
$x=「」のあとの$x+1は、警告が 1 行出て 1 になる。 - 算術の演算の結果は必ず数値になり、値なしにはならない。括弧の中の演算の結果は、そのまま外側の演算に使われる。
%ぱすた
*計算
$x=$未代入+1
$y=(「abc」*2)+1
ぱすた:結果は$x と$y です
この例の $x は、$未代入 を 0 とみなして 1 になる。ログは出ない。$y は、「abc」 を 0 とみなして括弧の中が 0 になり、外側の +1 で 1 になる。警告は 「abc」 の 1 行だけ出て、台詞の前に失敗表記 【数にできない値:"abc"】 が出る。アクション行は「結果は1と1です」と表示される。
連結の評価
連結演算子 &(または &)は、左右の被演算子を文字列にしてつなぐ。
%ぱすた
*連結
$n=3
$表示=「合計」&$n&「個」
$半分=「半分は」&7/2
ぱすた:$表示 、$半分 です
アクション行は「合計3個、半分は3.5です」と表示される。
&の前後の空白は結果に含まれない。被演算子のあいだに区切りの文字や空白は入らない。「a」 & 「b」はabになる。- 3 つ以上の被演算子は左から順につなぐ。
「a」&「b」&「c」はabcになる。 - 被演算子に書けるものは算術と同じである。文字列・数値のリテラル、変数・シーン引数の参照、ローカル・グローバル・動的の関数呼び出し、括弧で囲んだ式、算術式を書ける。単語参照(
@単語名・@$種類)は被演算子にならない。$x=@単語名&「a」や$x=@単語名&category=foodはパースエラーになる。 &の直後に置けるのは、被演算子の開始文字($・@・数字・-・文字列の開き「・"・括弧の開き(・()で始まるものだけである。名前(識別子)で始まるものは置けず、$x=「a」&nameはパースエラーになる。&の左右どちらかの被演算子が欠けている式($x=「a」&・$x=&「a」・$x=「a」&&「b」)や、括弧の対応が取れていない式は、算術と同じくパースエラーになる。- 式を書ける位置(変数代入の右辺・式文・関数呼び出しの引数・Call の引数・動的ターゲット)なら、どこでも
&を使える。アクション行の台詞に書いた&は連結にならず、文字のまま出力される(台詞と連結演算子)。
優先順位と括弧
& は算術演算子より後に計算される。優先順位は *・/・% → +・- → & の順で、同じ優先順位の演算子は左から順に計算される。括弧で囲んだ部分は先に計算され、その結果が 1 つの被演算子になる。
| 式 | 計算のされ方 | 結果 |
|---|---|---|
「合計」&$a+$b | $a+$b を計算してから 「合計」 とつなぐ | $a が 1、$b が 2 なら 合計3 |
「x」&1+2*3 | 1+2*3 を計算してからつなぐ | x7 |
(「1」&「2」)+1 | 括弧の中の連結が先で、その結果 12 を算術の被演算子にする | 13 |
%ぱすた
*優先順位
$a=1
$b=2
$s=「合計」&$a+$b
$t=「x」&1+2*3
$n=(「1」&「2」)+1
ぱすた:$s 、$t 、$n です
アクション行は「合計3、x7、13です」と表示される。
1 行の中で閉じていない括弧を重ねられるのは 64 段まで、1 つの式に書ける演算子は 256 個までである。超えると構文の誤りになる。数えるのは、台詞・文字列・コメント・Lua ブロックの中を含む、その行のすべての括弧である。
連結の結果を算術の被演算子にしたときは、算術の評価 の規則どおりに扱われる。数字だけの文字列は数値に変換され、数値にできなければ警告を出して 0 とみなす。
被演算子の値ごとの扱い
| 被演算子の値 | 扱い |
|---|---|
| 文字列 | そのままつなぐ。空文字列は空のまま。数字だけの文字列も数値の表記に直さない(「01」&「2」 は 012) |
| 数値 | アクション行で表示したときと同じ表記の文字列にしてつなぐ(「合計」&3 は 合計3、「半分は」&7/2 は 半分は3.5) |
| 値が無い | 空文字列とみなしてつなぐ。ログは出ない |
| 真偽値など、文字列と数値以外 | ログに警告とバルーンに失敗表記を出し、空文字列とみなしてつなぐ |
- 数値の表記はアクション行の表示と同じである。整数の値に小数点は付かない。有効桁(14 桁)を超える数は指数表記(
1e+15)になり、1/3は0.33333333333333、0 での除算はinfになる。 - 値が無いのは、算術と同じく、値を代入していない変数・値なしを代入した変数・渡されていないシーン引数・値を返さない関数呼び出しである。見つからない関数の呼び出しも空文字列とみなし、呼び出しの時点の失敗だけが報告される。
- 真偽値や、Lua の関数が返したテーブル・関数などは連結できない。警告(
act:concat - operand is not a string or number)は、連結できなかった被演算子ごとに 1 行出る。警告には演算子&と、その被演算子の値(変数の場所・関数名があればそれも)が含まれる。真偽値を返す関数@真()をつなぐとact:concat - operand is not a string or number: op='&', operand='@真()', value=true (boolean)が出る。 - 連結の演算の結果は必ず文字列になり、値なしにはならない。括弧の中の演算の結果は、そのまま外側の演算に使われる。括弧の中の算術は算術の規則で計算され、その数値がつながれる。
%ぱすた
*未代入の連結
$x=「合計」&$未代入&「個」
$y=「合計」&($未代入+1)
ぱすた:結果は$x と$y です
この例の $x は、$未代入 を空文字列とみなして 合計個 になる。$y は、括弧の中の $未代入 を 0 とみなして 合計1 になる。どちらもログは出ない。アクション行は「結果は合計個と合計1です」と表示される。
値が無いときの扱い
変数には型の宣言が無く、同じ変数に数値も文字列も入る。そのため、値が無いときの扱いは変数では決まらず、書いた場所で決まる。
| 書いた場所 | 値が無いときの扱い | 例($x が未代入のとき) |
|---|---|---|
| 算術の被演算子 | 0 とみなす。ログは出ない | $x+1 は 1 |
| 連結の被演算子 | 空文字列とみなす。ログは出ない | 「a」&$x は a |
| アクション行の台詞 | 何も展開せず、値の無い変数の失敗として報告する(実行時の失敗の出力) | 前$x 後 は 前【値の無い変数:$x】後 |
%ぱすた
*値なし
$n=$x+1
$s=「a」&$x
ぱすた:$n と$s と$x です
$x に何も代入していないので、アクション行は「1とaと【値の無い変数:$x】です」と表示される。
- 台詞は文字列の場所なので、失敗表記を除けば連結と同じく空として続く。
- 演算子の被演算子でない場所では、値が無いまま扱われる。
$y=$xの$yは値を代入していない状態になり、関数呼び出しの引数に$xを 1 つだけ渡すと、関数には値の無い引数が届く。Call のターゲットに書いたときは 動的ターゲットの値 で扱う。 - 算術・連結の演算は値なしを作らない。演算子を含む式の結果は、必ず数値か文字列になる。式の結果が値なしになるのは、値の無い変数や、値を返さない関数呼び出し(
$x=@f())を演算子なしで書いたときである。
式文(ExprStmt)
代入を伴わず、式の評価(副作用)だけを行うには $=式 と書く。変数名を省略し、結果を捨てる。
*OnTest
$=@副作用関数()
$=@*グローバル副作用()
1 行目は act:expr_fn("副作用関数")、2 行目は act:global_fn("グローバル副作用") を呼び、戻り値を使わない。変数代入行(ローカル・グローバル・プロパティ・式文)はすべて $ で始まる。
エンジンが値を入れる変数
ここまでの変数はすべて辞書側で代入するものだった。これとは別に、pasta.dll(実行時エンジン)が値を入れる変数がある。文法上は普通のローカル変数・グローバル変数と同じで、$変数名 で参照する。
| 種類 | 変数 | 値が入る条件 |
|---|---|---|
| 日時変数 | $年・$時12 など(下表) | イベントのシーンでは自動(イベントのシーンを選ぶ前の転記) |
| リクエスト変数 | $r0〜$r9・$req_id など(下表) | イベントのシーンでは自動(イベントのシーンを選ぶ前の転記) |
| 予約グローバル変数 | $*pasta_ で始まる名前(下表) | 辞書側で代入すると、エンジンの動作が変わる |
注意: イベントのシーンでは、日時変数とリクエスト変数の全部が、シーンを選ぶ前に毎回入る。
$日・$時・$季節・$節句・$祝日・$行事といった名前の変数には、イベントのシーンの始めに、エンジンの値が入っている。本文で代入すれば、代入した値が勝つ。自分の変数には、これらと同じ名前を使わないこと。
イベントのシーンを選ぶ前の転記
SHIORI のイベントを受けると、pasta.dll はシーンを選ぶ前に、リクエスト変数(下表)と日時変数(下表)の全部をローカル変数に入れる。イベントの種類によらず、入る変数の組は同じである。
そのため、イベントのシーンでは、何も書かずに $r0 や $季節 を参照できる。イベントのシーンそのものの条件にも使える(条件で候補を絞る)。
*OnUpdateComplete &$r0=「changed」
女の子:@笑顔 更新できたよ。
*OnBoot &$hour≧5 &$hour<12
女の子:@笑顔 おはよう!
- 入れるのは、シーンを選ぶ前の 1 回だけである。本文で同じ名前の変数に代入すると、代入した値が勝つ。
- チェイントークの続きには、続きを出すときのイベントの値は入らない。続きは、最初に出た部分と同じ値を読む。
>transfer_req_to_var・>transfer_date_to_varは、途中で取り直したいときの道具である。たとえば、チェイントークの続きの中で今の時刻が欲しいときは、続きの中で>transfer_date_to_varを呼ぶ。
日時変数
イベントのシーン(時報・ランダムトーク・クリック反応など)には、イベントを受けた時点の日時が自動で入る(イベントのシーンを選ぶ前の転記)。時報シーン(*時報14・*時報その他・*OnHour14・*OnHourOther。数字は半角 2 桁)には、発火した時点の日時が入る。
日時変数の値は、SSP の仮想時刻(開発用パレットの「現在時刻の仮想的変更」などで進めた時刻)に従う。仮想時刻を使っていなければ OS の時計の日時になる。リクエストに X-Pasta-Time ヘッダがあれば、仮想時刻よりも優先して、その日時が入る。Lua の act.req.date が仮想時刻に従うかどうかは SSP によって違うが、日時変数はどちらの場合も仮想時刻に従う(act.req)。仮想時刻の読み取り方は OnPastaClock を参照する。
| 変数 | 内容 | 例 |
|---|---|---|
$年 $月 $日 | 年・月・日(単位付きの文字列) | 2026年 9月 26日 |
$時 $分 $秒 | 時(24 時間制)・分・秒(単位付きの文字列) | 14時 5分 0秒 |
$時12 | 12 時間制の時刻 | 午後2時 |
$曜日 | 曜日 | 土曜日 |
$季節 | 季節(3〜5 月 春・6〜8 月 夏・9〜11 月 秋・12〜2 月 冬) | 秋 |
$節句 | 五節句の日だけ 人日(1/7)・上巳(3/3)・端午(5/5)・七夕(7/7)・重陽(9/9)。ほかの日は なし | なし |
$祝日 | 国民の祝日の日だけ、その名前(成人の日 など。振替休日・国民の休日 も入る)。ほかの日は なし(祝日の決め方) | 成人の日 |
$行事 | calendar.csv に書いた、今日の行事の名前(お正月 など)。ほかの日は なし(行事の表) | お正月 |
$year $month $day | 年・月・日(数値) | 2026 9 26 |
$hour $min $sec | 時(0〜23)・分・秒(数値) | 14 5 0 |
$wday | 曜日番号(0=日曜〜6=土曜) | 6 |
$week | 曜日(英語) | Saturday |
$時12 は、0 時が 深夜0時、1〜11 時が 午前N時、12 時が 正午、13〜23 時が 午後N時 になる。12 は全角数字で書く。
$季節 と $節句 を連結して Call すると、季節や節句ごとのシーンへ振り分けられる。季節のシーンは春・夏・秋・冬の 4 つとも書いておく。節句でない日は $節句 が なし になるので、*節句_なし を書いておく(中身は空でもよい)。書かないと、節句でない日に Call が失敗する。
日本語名の変数はアクション行での表示向けである。英語名の変数($year〜$wday)は数値のまま入るため、シーンの条件(&$hour≧5)で大小を比べられる。
*OnMouseDoubleClick
女の子:@通常 今日は $曜日 、いまは $時12 だよ。
*OnMouseDoubleClick
>「季節_」&$季節
>「節句_」&$節句
*季節_秋
女の子:@通常 そろそろ衣替えの季節だね。
*節句_七夕
女の子:@通常 今日は七夕。お願いごと、した?
*節句_なし
$祝日 と $行事 も、同じ形で振り分けられる。祝日でない日は $祝日 が、行事でない日は $行事 が なし になるので、*祝日_なし・*行事_なし を書いておく。書かないと、祝日でない日・行事でない日に Call が失敗する。
*OnMouseDoubleClick
>「祝日_」&$祝日
>「行事_」&$行事
*祝日_成人の日
女の子:@通常 今日は成人の日だね。
*行事_お正月
女の子:@通常 あけましておめでとう。
*祝日_なし
*行事_なし
祝日の決め方
$祝日 は、今の法律(国民の祝日に関する法律)の規則で決まる。祝日のほか、振替休日 と 国民の休日 の日にも名前が入る。
- 2021 年以前に限った特例(その年だけ動いた祝日など)は再現しない。その年の
$祝日は、今の規則に当てはめた結果になる - 先の年の春分の日・秋分の日は、計算による見込みの日付である。官報で決まった日と違うことがある
- 法律が変わったときは、pasta の更新で追いつく
行事の表(calendar.csv)
$行事 は、ghost/master/ に置く calendar.csv から決まる。ファイル名の大文字・小文字は問わない(Calendar.CSV でもよい)。ファイルが無いときは、いつも なし になる。
1 行に 日付,名前 を書く。日付の書き方は 3 つである。
| 日付の形 | 当たる日 | 例 |
|---|---|---|
MMDD | 毎年その日(0229 も書ける。うるう年にだけ当たる) | 0214 |
MMDD-MMDD | 毎年その期間。年をまたいでもよい | 1231-0103 |
YYYYMMDD | その年のその日だけ | 20271110 |
# 行事の表
0101-0103,お正月
0214,バレンタイン
1224-1225,クリスマス
20271110,十周年
#で始まる行と空行は読み飛ばす- 同じ日に当たる行が複数あるときは、先に書いた行が勝つ(日付の書き方による優先は無い)
- UTF-8 で保存する。Excel で作るときは「CSV UTF-8(コンマ区切り)」で保存する
- 次の書き方は、読み込みのエラーになる: 引用符(
")を使った行、カンマで 2 つに分かれない行、日付の形に合わない日付、存在しない日付(0230など)、名前が空の行、UTF-8 でないファイル、大文字・小文字だけが違うcalendar.csvが 2 つあるとき $行事の名前でシーンを呼ぶと、前方一致で探される(前方一致によるターゲット解決)。クリスマスとクリスマスイブのように、一方がもう一方の頭になる名前を別々の行に書くと、*行事_クリスマスの呼び出しが*行事_クリスマスイブにも当たってしまう。続く日は、1224-1225,クリスマスのように 1 行にまとめる- 「第 n 曜日」のような決まりは、日付の形では書けない。シーンの条件で候補を絞る節(条件で候補を絞る)を参照する
見本は、入門の 13 段目にある。
リクエスト変数(Reference)
ベースウェアはイベントごとに Reference0、Reference1… という付加情報を送ってくる(ダブルクリックされた部位、選択肢の ID など)。イベントのシーンでは、これらが次の変数に自動で入っている(イベントのシーンを選ぶ前の転記)。
| 変数 | 内容 |
|---|---|
$r0〜$r9 | Reference0〜Reference9 の値(文字列)。r と数字は全角 |
$r0〜$r9 | 同じ値の半角名 |
$req_id | イベント名(例: OnMouseDoubleClick) |
$req_base_id | リクエストの BaseID ヘッダの値(送られてきた場合のみ) |
*OnMouseDoubleClick
女の子:@通常 $r4 を触ったね?
触られた部位やキャラクターごとに反応を変えるだけなら、$r4 を読まずに、*つっつき反応女の子Head のような名前のシーンで書ける(つつき・撫でのショートカット)。
各 Reference に何が入るかはイベントごとに異なる。UKADOC の SHIORI Event 一覧で確認できる。たとえば OnMouseDoubleClick では Reference4 がダブルクリックされた部位の名前になる。Reference10 以降は変数に入らないため、Lua から act.req.reference[10] で読む(scripts/ の記述パターンを参照)。
$r0(Reference0)と $0(シーン引数)は別物である。イベントで直接起動されたシーンの $0 には値が入らない。
予約グローバル変数(pasta_ で始まる名前)
$*pasta_ で始まるグローバル変数はエンジンが予約している。辞書側で代入すると、エンジンの動作が変わる。自分の変数に pasta_ で始まる名前を使わないこと。試験の間だけ間隔を縮めるなど、ゴーストの外から代入するときは、OnPastaSetSaveVariable を使う。
| 変数 | 用途 | 既定値 |
|---|---|---|
$*pasta_talk_interval_min | ランダムトークの最小間隔(秒) | 180 |
$*pasta_talk_interval_max | ランダムトークの最大間隔(秒) | 300 |
*OnBoot
$*pasta_talk_interval_min=60
$*pasta_talk_interval_max=120
間隔は、この変数 → pasta.toml の [ghost] にある talk_interval_min / talk_interval_max → 既定値、の順に決まる。値は数値で代入すること(数値以外は無視される)。10 秒未満を指定したときは 10 秒になり、最小間隔が最大間隔を上回ったときは最大間隔が最小間隔にそろえられる。代入した値は、次にトーク間隔を計算するときから反映される。
グローバル変数の保存先
グローバル変数($*名前、Lua の save.名前)は、save テーブルごと TOML のファイルに保存される。
- 既定の保存先は、ゴーストのフォルダからの相対パス
profile/pasta/save/save.tomlである。 - 保存は Lua ランタイムの終了時(ゴーストの終了・辞書の再読込)に自動で行われ、起動時に読み込まれる。
- 保存先のパスと難読化(gzip 圧縮した
.datでの保存)は、pasta.toml の[persistence]で変えられる。 - Lua から明示的に保存・読み込みする方法は
@pasta_persistenceモジュールで扱う(@pasta_persistence)。
Lua 予約語の制約
変数名は Lua の識別子としてそのまま var.名前・save.名前 に出力される。そのため、Lua の予約語を変数名にすると、パースとトランスパイルは通るが、生成された Lua が構文エラーになり、辞書の読み込み全体が失敗する。
使えない名前は次の 22 語である(大文字・小文字を区別する。End は使える)。
and break do else elseif end false for function goto if
in local nil not or repeat return then true until while
$end=1・$*local=1・アクション行の $end のいずれも同じ失敗になる。単語名・シーン名・@関数() の関数名は文字列として扱われるため、この制約を受けない。
関数スコープの展開先
| DSL 構文 | Lua 展開先 | 説明 |
|---|---|---|
@func(…) | act:expr_fn("func", …) | 実行中のシーンから 5 段の順に探して呼ぶ |
@*func(…) | act:global_fn("func", …) | GLOBAL テーブルの関数だけを探して呼ぶ |
@$名前(…) | act:expr_fn_var(var.名前, "var.名前", …) | 変数の値を関数名として、@func(…) と同じ段から探して呼ぶ(act のメソッドの段は探さない) |
*計算
$r=@add(1、2)
$g=@*total()
$名前=「add」
$d=@$名前(3、4)
```lua
function SCENE.add(act, x, y)
return x + y
end
```
この例の 3 つの呼び出しは、順に次の Lua になる。
var.r = act:expr_fn("add", 1, 2)
var.g = act:global_fn("total")
var.d = act:expr_fn_var(var.名前, "var.名前", 3, 4)
@func(…) の 5 段の検索は Call と同じである(シーンテーブル → ローカルシーン → act のメソッド → GLOBAL → グローバルシーン。スコープ解決アルゴリズム)。最初に見つかった関数を (act, 引数…) で呼び、その戻り値を使う。アクション行の中(アクター:@func(…))では act:actor_proxy("アクター"):expr_fn("func", …) を経由するが、探す段も関数の第 1 引数(act)も変わらない。@* のグローバル関数は、変数の $* → save. と対称の書き方である。
@$名前(…) は、変数の値と、警告に使う変数の場所("var.名前")を渡す。@$*名前(…) は save.名前、@$0(…) は args[1] を渡す。アクション行の中では act:actor_proxy("アクター"):expr_fn_var(…) を経由し、@func(…) と同じく関数の第 1 引数は act である。静的な @func(…) と検索が異なる点は 動的関数呼び出し で扱う。
DSL から呼ばれた関数が第 1 引数に受け取るものは、関数の置き場所で決まる。
| 関数の置き場所 | 第 1 引数 |
|---|---|
アクション行のアクターの表(A1。アクター辞書の Lua ブロックで ACTOR に入れた関数など) | そのアクターのアクタープロキシ(コードブロック) |
それ以外(シーンテーブル・ローカルシーン・act のメソッド・GLOBAL・グローバルシーン) | act |
- 第 1 引数は呼ばれ方では変わらない。アクション行の中か外か、
@*を付けるか、単語参照@名前か関数呼び出し@名前(…)かにかかわらず、同じ置き場所の関数は第 1 引数に同じものを受け取る。 - アクターの表を探すのは、アクター付きのアクション行の単語参照(
アクター:@名前・アクター:@$名前)だけである。関数呼び出し(@名前(…)・@$名前(…))はアクターの表を探さないため、見つかる関数は常に act を受け取る。 - アクターの外の関数は、話者(どのアクターの行から呼ばれたか)を受け取らない。
@名前・@名前(…)・@$名前・@$名前(…)・@*名前(…)で呼んだ関数が、先頭の戻り値として act かアクタープロキシ(どのアクターのものでも)そのものを返した場合は、アクション行の中でも外でも値なしとして扱い、何も出力しない。それ以外の戻り値(文字列・数値・nil・複数の値)は、そのまま使われる。
DSL と Lua の対応表
変数と関数呼び出しは、次の Lua に変換される。Lua ブロックの関数からは、local save, var = act:init_scene(SCENE) で同じ save・var を取り出して読み書きできる。
| DSL 構文 | Lua 変換後 | 値の寿命 |
|---|---|---|
$名前 | var.名前 | 1 回のイベント処理 |
$*名前 | save.名前 | 永続(終了時に保存) |
$%prop=値 | act:set_property("prop", 値) | ベースウェアが管理 |
$x=$%prop | var.x = act:get_property("prop") | ベースウェアが管理 |
$0・$1 | args[1]・args[2] | そのシーンの呼び出し 1 回 |
$x=@単語 | var.x = act:word("単語") | — |
$x=@$y | var.x = act:word(var.y, "var.y") | — |
@関数(…) | act:expr_fn("関数", …) | — |
@*関数(…) | act:global_fn("関数", …) | — |
@$y(…) | act:expr_fn_var(var.y, "var.y", …) | — |
$x=$a+1 | var.x = (PASTA.num("+", var.a, "var.a") + 1) | — |
$x=「a」&$b | var.x = ("a" .. PASTA.str(var.b, "var.b")) | — |
たとえば、次のシーンの 4 行は、その下の Lua の 4 行になる。
*買い物
$n=3
$x=$a+1
$表示=「合計」&$n&「個」
$=@記録する()
var.n = 3
var.x = (PASTA.num("+", var.a, "var.a") + 1)
var.表示 = (("合計" .. PASTA.str(var.n, "var.n")) .. "個")
act:expr_fn("記録する")
算術・連結の 1 回の演算は、Lua の演算子(+・-・*・/・%・..)を括弧で囲んだ (左 演算子 右) になる。被演算子は、算術では PASTA.num(演算子, 値, 説明) で数値に、連結では PASTA.str(値, 説明) で文字列にしてから演算子に渡す。値の無い被演算子を 0・空文字列にし、変換できない値の警告と失敗表記を出すのはこの 2 つの関数である(実行時の失敗の出力)。説明は警告と失敗表記に使う被演算子の場所(変数の場所・関数名)で、リテラルなどでは省かれる。
- 算術では、数値のリテラルと算術の演算の結果を
PASTA.numに通さない。 - 連結では、文字列のリテラルと連結の演算の結果を
PASTA.strに通さない。 - 優先順位や括弧は、括弧の入れ子で表される(
1+2*$yは(1 + (2 * PASTA.num("*", var.y, "var.y"))))。
| DSL 構文 | Lua 変換後 |
|---|---|
$表示=「合計」&$n&「個」 | var.表示 = (("合計" .. PASTA.str(var.n, "var.n")) .. "個") |
$s=「合計」&$a+$b | var.s = ("合計" .. PASTA.str((PASTA.num("+", var.a, "var.a") + PASTA.num("+", var.b, "var.b")))) |
$n=(「1」&「2」)+1 | var.n = (PASTA.num("+", (("1" .. "2"))) + 1) |
スコープを使い分ければ、ゴーストは過去を覚え、世界と繋がりますわ。次は、書いた値の正体を見極める「リテラル型」へ参りましょう。
記憶と申せば、私もお嬢様の昨夜のおやつまで覚えております。
……あれは味見と申しますのよ。今すぐお忘れなさい。