26 December 2013 - by Don

今更ながら\![embed,…]の使い方を把握したので覚書です。

基本

単純な例

里々でやろうとするときは\![embed,…]の呼び出し先イベントは\eで閉じないよう留意しないといけない。

＊
：あいうえお\![embed,OnHoge]さしすせそ

＊OnHoge
：かきくけこ

＃これを実行すると以下のようになって「あいうえおかきくけこ」と表示された時点で再生が終わる
＃\0\s[0]\1\s[10]\0あいうえお\0\s[0]\1\s[10]\0かきくけこ\eさしすせそ\e

単語群なら前後に余計なスクリプトは付かない。

＊
：あいうえお\![embed,OnHoge]さしすせそ

＠OnHoge
かきくけこ

＃これを実行すると以下のようになる
＃\0\s[0]\1\s[10]\0あいうえおかきくけこさしすせそ\e

里々であれば以下のように書いても同じ結果が得られる。

＊
：あいうえお（OnHoge）さしすせそ

＠OnHoge
かきくけこ

＃これを実行すると以下のようになる
＃\0\s[0]\1\s[10]\0あいうえおかきくけこさしすせそ\e

これでは面白くないので、同じ結果が得られない例を挙げる。

SakuraScriptの再生と同期して呼び出しが実行される例

＊
：時計の秒針を一秒おきに数えてみよう！
（現在秒）、\_w[1000]（現在秒）、\_w[1000]（現在秒）…。

これは期待した動作にならない。「１３、１４、１５…。」みたいになってほしいが、「１３、１３、１３…。」となってしまう。里々が全ての括弧を展開した結果のSakuraScriptをSSPに渡しているだけなので、SSPに届く頃にはすべて１３になっている。

しかし、\![embed,…]を使えば期待した動作が可能となる。

＊
：時計の秒針を一秒おきに数えてみよう！
\![embed,OnGetSecond]、\_w[1000]\![embed,OnGetSecond]、\_w[1000]\![embed,OnGetSecond]…。

＠OnGetSecond
（現在秒）

この例だと「１３、１４、１５…。」みたいに再生される。SakuraScriptの再生と同期してイベント呼び出しが実行され、返されたScriptをその場で埋め込みながら再生を続ける。すごい。

応用

複雑な例

\![embed,…]とはどんなものか、ということについては上述の例さえわかれば十分である。それ以上でもそれ以下でもない。\![embed,…]はそんなに難しいものではない。

\![embed,…]ワカラナイ、というのは往々にして\![embed,…]以外のところに原因がある。例えば、UKADOCの説明には以下のように書いてある。

プロパティシステムの内容によって分岐など、イベントを実行して情報を取得する仕様を、1回のスクリプト実行で有効に使用するための仕様。

何言ってるかワカラナイ。

プロパティシステムというのは、SSPが知っている情報を教えてもらうための仕様だ。例えば現在時を教えてもらうには以下のように書く。

＊
\![get,property,OnGetHour,system.hour]

＊OnGetHour
：現在（R0）時です。

里々なら里々自身の力で（現在時）と書けば取得できるけど、簡単な例として。

ここで重要なのが、情報を取得するためには別イベントをコールする必要があるということだ。（R0）に入っている情報を（またはそれを使用／加工した文字列を）\![get,property]を実行した直後に埋め込んで再生したい場合もあるのかもしれない。そういうことができますよ、と\![embed,…]の説明には書いてある。

例えば以下のように書いてもkero側のScriptは再生されない。

＊
：\![get,property,OnGetHour,system.hour]
：もうそんな時間か。＃←これは再生されない

＊OnGetHour
：現在（R0）時です。

イベントを呼び出す系のSakuraScriptは、それが実行された時点でそのイベントにおける再生は強制終了されるのが特徴である。

…と思っていた。昨日までは。例外があったのだ。知らなかった。

\![get,property]した後もScriptの再生が続く例

答えを言ってしまうと、以下のように書けばUKADOCの説明にあるようなことが可能となる。

＊
：現在\![get,property,OnGetHour,system.hour]\![embed,OnShowHour]時です。
：もうそんな時間か。＃←これが再生される！

＊OnGetHour
＄現在の時間【タブ】（R0）

＠OnShowHour
（現在の時間）

\![get,property]した後もScriptの再生が続く条件は、呼び出したイベントで「何も返さない」ことである。

上記の例では（R0）の情報を変数に保存してはいるものの、再生するScriptは何もない。この場合、例外的に呼び出し元のScriptは再生を続けるのだ。知らなかった。

変数に保存したは良いが、再びSSPに処理が戻ってScriptの再生中である。保存した情報を再びSHIORI側で処理し、Scriptを生成し、呼び出し元に埋め込みたい。そこで\![embed,…]の登場だ。

\![embed,…]は極めて単純な仕様であり難しいことはない。\![get,property]の仕様が謎すぎるんだ。「何も返さない」場合のみScriptの再生を続けるとか誰が知ってるんだ。

補足

イベントを呼び出す系のSakuraScriptの代表と言えば\![raise,...]だ。きっと\![get,property]と同様な仕様となっているに違いない。

＊
：艦隊のアイドル、\![raise,OnNakachan1]那珂ちゃんだよー！\![raise,OnNakachan2]よっろしくー！

＊OnNakachan1
＃何も返さない

＊OnNakachan2
ｶｰﾝ...ｶｰﾝ...ｶｰﾝ...

予想通りOnNakachan2でScript再生が中断され、ｶｰﾝｶｰﾝとなる。

ちなみに\![raise,...]はMateriaでもサポートされており、Materiaで実行しても同じ結果となった。なので、SSPは本家の仕様を忠実に再現しているものといえる。