BluesNovel タグリファレンス

実装状況は 🟡 実装中・機能未達／🔴 未実装のみ表示（無印＝実装済）。本家 SKYNovel との相違は各タグの囲みに記載。

変数操作

#[clearsysvar] システム変数の全消去

sys:変数を全消去。削除すると言うより、初期化する

属性なし

#[clearvar] ゲーム変数の全消去

save:変数を全消去。削除すると言うより、初期化する

属性なし

#[let_abs] 絶対値

絶対値を求める。結果を変数に代入する

#[let_char_at] 文字列から一字取得

文字列中の一文字を取り出す。結果を変数に代入する

#[let_index_of] 文字列で検索

文字列内を検索し、文字列内の start 以降で、最初に val が見つかった位置を返す。

#[let_length] 文字列の長さ

文字列の長さを求める。結果を変数に代入する

#[let_ml] インラインテキスト代入

[let_ml]〜[endlet_ml]で囲んだ複数行テキストを代入する

#[let_replace] 正規表現で置換

文字列を正規表現で検索し、マッチする箇所を文字列で置き換える。

#[let_round] 四捨五入

四捨五入する。結果を変数に代入する

#[let_search] 正規表現で検索

文字列内を正規表現で検索し、最初に val が見つかった位置を返します。

#[let_substr] 文字列から抜きだし

文字列の一部を取り出す。結果を変数に代入する

#[let] 変数代入・演算

変数に値を代入する

変数については「BluesNovel 組み込み変数」を参照して下さい

[let]を使わない、より簡潔な記述文法があります。
	※condのような条件分岐、「=aaa|0x0」のような省略記法はできません。
以下の記述は、
	[let name=a text=1]
	[let name="b" text=2]
	[let name=ret text="&a + b"]（文字列ではなく計算の場合、右辺に&をつける）
	[let name="&'ret'+ a" text="&1 + b"]（左辺で&を使える）
	以下のようにも書けます。（&から改行かタブまでを[let]文と解釈します）
	&a=1
	&b=2
	&ret = a + b（このように、右辺の&は省略します。常に&がついているイメージ）
	&&'tst' + a = 1+b（左辺で&を使える。&ret1 = 1 + b と同じ）
キャストも記述できます。（両者は同じ意味）
	[let name=ret text=&1+2 cast=int]（結果は3。1+2の計算結果が入る）
	&ret=1+2=int（同上）
キャスト動作そのものは、以下のとおり。
	&num = '0+1' = int（結果は0、文字列「0+1」を計算せず文字列のまま、数値に変換できないため）
	&num = 0+1 = int（結果は1、0+1という計算結果をintで変数へ）
	&txt = '0+1' = str（結果は文字列「0+1」、文字列をそのまま変数に）
	&txt = 0+1 = str（結果は文字列「1」、0+1を計算してから結果1を文字列「1」として変数に）

レイヤ共通

#[add_lay] レイヤを追加する

レイヤを追加する。

レイヤはページの裏表があり、文字レイヤや画像レイヤなどの種類があります。

レイヤの追加と同時に、[lay]に指定できる属性を指定できます。（内部的に[lay]を呼ぶ）
これにより、[add_lay visible=false ...]等とすると、非表示状態でレイヤ追加できます。

#[clear_lay] レイヤ設定の消去

画像や文字などレイヤ状態をクリアする。

alpha、blendMode、rotation、scaleX、scaleYを初期値にする
※背景や背景画像はクリアしません（b_color、b_alpha、b_alpha_isfixed） クリアしたい場合は、[lay back_clear=true]

#[finish_trans] トランス強制終了

[trans]で開始したトランスをすぐ終了させる

属性無し。

[trans]で開始したトランス終了を待たず、すぐ終了させる。
終了次第、スクリプト処理を次へ進める

#[lay] レイヤ設定(共通)

レイヤに各種設定を行う。

レイヤの種類ごとに使用できる属性もあるが、共通な属性をここで解説する

# blendModeの解説

分家はレイヤ合成を CSS の mix-blend-mode で行うため、CSS <blend-mode> 全種（＋ plus-lighter / plus-darker）を指定できます。本家は normal / add / multiply / screen の4種のみ。 add は CSS に同名が無いため plus-lighter（加算合成）に読み替えます。 CSS の mix-blend-mode に無い値（減算 subtract など、pixi の src_in ・ *_npm 等の合成オペレータ）はエラーになります。

#[lay] 文字レイヤ設定

#[lay] 画像レイヤ設定

#[trans] ページ裏表を交換

裏ページを表ページとクロスフェードする。

クロスフェードを開始すると、終了を待たずに次のタグへと処理を進める。
終了を待ちたい場合は[wt]を使用する。

クロスフェード終了後は元・裏ページから元・表ページに内容をコピーし、同じ内容になる。
演出中に次の[trans]を実行すると、まず前の演出を終わらせてから改めて開始する。

ルール画像は白黒かグレースケールを推奨。（見た目と動きが一致する）
また[trans]～[wt]間で文字表示や[ch]は動作未定義、非推奨。
[trans]終了を待たず何かをするのは避けた方がよいでしょう。

#[wt] トランス終了待ち

[trans]で開始したトランスの終了を待つ。

終了次第、スクリプト処理を次へ進める。

また[trans]～[wt]間で文字表示や[ch]は動作未定義、非推奨。
[trans]終了を待たず何かをするのは避けた方がよいでしょう

#[add_filter] フィルター追加

レイヤにフィルターを追加する。

以下はフィルターごとに指定できる属性説明です。
項目ごとの説明は煩雑なので、pixijs の動くサンプルをお試しください。
（bluesnovel）multiply属性は全フィルター共通で無視される（指定してもしなくても結果は同じ）。

フィルター「blur」に指定できる属性

（bluesnovel）ぼかしは CSS filter: blur()／SVG feGaussianBlur のネイティブ実装。エッジの外を透明として扱う方向は本家（pixi）と同じだが、カーネルや端の畳み込みまでは揃わず縁のにじみ方は完全一致しない。quality／resolution／kernel_size は WebGL 内部パラメータで相当が無く無視、repeat_edge_pixels は true のみ未対応（凍結）

フィルター「noise」に指定できる属性

（bluesnovel）pixi の NoiseFilter を SVG の feTurbulence で近似。value ノイズのため ピクセル一致はしない（不透明部でおおむね一致。半透明の縁はノイズ量がずれる）

フィルター「color_matrix」に指定できる属性

フィルター「black_and_white」に指定できる属性

時間をかけて白黒へ変化させたいときは [add_fx] fx=grayscale（black_and_white ＝ grayscale 既定値）。

フィルター「brightness」に指定できる属性

フィルター「browni」に指定できる属性

フィルター「color_tone」に指定できる属性

（bluesnovel）pixi の ColorMatrixFilter シェーダが純粋な4x5アフィン変換でない（トーン値をRGBへ 乗せ戻す非線形な補正が入る）ため、SVG feColorMatrixでは再現できずピクセル一致はしない （暗部は近いが、明部で青チャンネルの出方が食い違う）。使用頻度が低いため凍結

フィルター「contrast」に指定できる属性

フィルター「grayscale」に指定できる属性

フィルター「hue」に指定できる属性

フィルター「kodachrome」に指定できる属性

フィルター「night」に指定できる属性

フィルター「predator」に指定できる属性

フィルター「saturate」に指定できる属性

フィルター「technicolor」に指定できる属性

フィルター「tint」に指定できる属性

時間をかけて色合いへ変化させたいときは [add_fx] fx=tint color=…（色反転は fx=negative）。

フィルター「vintage」に指定できる属性

その他のフィルターに指定できる属性

#[clear_filter] フィルター全削除

レイヤのフィルターを全削除する。

#[enable_filter] フィルター個別切替

個別にフィルター有効・無効を変更する。

シェーダエフェクト（bluesnovel独自）

#[def_fx] シェーダプリセット定義

独自の生フラグメントシェーダをユーザープリセットとして事前定義する。

定義したシェーダは [add_fx fx=プリセット名] で使える。テンプレ起動時に必ず通る処理 （[call fn=ext_*] 等）で [def_fx] を毎回再実行しておく必要がある （[add_face]による差分名定義と同じ思想）。

シェーダの契約（[trans] の glsl= と名前を統一）

Shadertoy（mainImage＋i* uniform）はエンジンでは吸収しない。開発時に上表で手変換する（1本 ~5行の機械置換）。

#[add_fx] シェーダエフェクト追加

grpレイヤにシェーダエフェクトを重ねる。

プリセット「wave」に指定できる属性

プリセット「rgbShift」に指定できる属性

プリセット「snow」に指定できる属性（背景レイヤ向け）

プリセット「rain」に指定できる属性（背景レイヤ向け）

指定例：
[add_fx layer=bg fx=rain] …… 弱雨（既定）
[add_fx layer=bg fx=rain freq=5] …… 中くらい
[add_fx layer=bg fx=rain amp=3 freq=8 shift=18] …… 豪雨
[add_fx layer=bg fx=rain freq=8 speed=1.5] …… 豪雨＋speed=（tick倍率）でさらに加速 snow / rain は透明部にも降るので不透明な背景（bg）レイヤへ積む想定。立ち絵に積むと箱の形に降る。

プリセット「fireworks」に指定できる属性（背景レイヤ向け）

指定例：
[add_fx layer=bg fx=fireworks] …… 約4秒周期で無限に開く（既定）
[add_fx layer=bg fx=fireworks amp=1.6 freq=1.4] …… 明るく・枝を増やす
[add_fx layer=bg fx=fireworks p2=0.35] …… 少し右で開く
[add_fx layer=bg fx=fireworks color=0x66ccff] …… 青白い光に固定
[add_fx layer=bg fx=fireworks loop=false] …… 1発だけ開いて余韻ごと消える（約4秒）
[add_fx layer=bg fx=fireworks loop=false p1=0.5 time=2000] …… p1=で周期を変えるときはtime=（ms。周期と一致させた値）も指定
火の粉の余韻を引きながら枝垂れ落ちる「冠菊（かむろ）」。透明部にも描くので不透明な背景（bg）レイヤ向け。 参考にした公開シェーダ shadertoy tfXSWr（物理の下敷きのみ・コードの写しではない＝MIT）。

プリセット「blur」に指定できる属性（初のランプ型）

time=の尺いっぱいかけて progress が 0→1 に進み、元絵→ガウスぼかしへ変化する。 周期系プリセットと違い「変化して終わる」ので loop=false（尺 800ms）か time= と併せて使う。 keepは既定true（ぼけたまま保持。keep=falseで経過後に元絵へ戻る）。 サンプリングは40タップのディスク近似（回転・半径を画素ごとにディザ）なので、強くぼかすとごく細かい 網点が出る——写真背景ではまず気にならないが、さらに滑らかにしたいときは同じ [add_fx fx=blur]を2枚重ねる（[add_fx]のスタックがそのままマルチパスになる）。 静的なぼかし（変化不要）は[add_filter] filter=blurの方が軽い（CSS/SVGのネイティブ合成）。

指定例：
[add_fx layer=bg fx=blur loop=false] …… 800msで元絵→ブラー、そのまま保持
[add_fx layer=bg fx=blur loop=false time=1500 amp=14] …… 1.5秒かけて強めに
[wait_fx layer=bg] …… ぼけ切るまで待つ
[add_fx layer=bg fx=blur loop=false reverse=true] …… ブラー→元絵（ピントが戻る）
[add_fx layer=bg fx=blur loop=false][add_fx layer=bg fx=blur loop=false] …… 2枚重ねで滑らかに

プリセット「grayscale」「sepia」「negative」「tint」に指定できる属性（blurと同じランプ型・色系）

time=の尺いっぱいかけて元絵→モノクロ／セピア／色反転／色合いへ寄る。blurと同じく loop=false（尺 800ms）で単発、keep既定true（変化しきったら保持）、reverse=trueで戻る。 1タップだけ＝周期系より軽い。式は [add_filter] filter=grayscale／sepia／negative／tint と同一なので、 「fx で演出 → 落ち着いたら [add_filter] へ差し替えて [clear_fx]」が自然。 変化が要らない静的な色調整は [add_filter] の方が軽い（CSS/SVGのネイティブ合成）。 black_and_white は grayscale（既定 amp=1）と同じなので専用の fx 名は無い。 指定例：
[add_fx layer=bg fx=grayscale loop=false] …… 0.8秒で背景がモノクロになり保持（回想の入り等）
[add_fx layer=bg fx=grayscale loop=false reverse=true] …… モノクロ→カラー（回想明け）
[add_fx layer=bg fx=sepia loop=false amp=0.7 time=2000] …… 2秒かけて7割セピア
[add_fx layer=me fx=negative loop=false time=120][add_fx layer=me fx=negative loop=false time=120 reverse=true] …… 一瞬だけ色反転（ショック・被弾）
[add_fx layer=bg fx=tint loop=false color=0x3366ff] …… 背景が青く染まっていく（夜・水中）

生シェーダを使うには

独自の生フラグメントシェーダは[def_fx name= glsl=] でユーザープリセットとして先に定義し、 [add_fx fx=その名前] で使う（契約表は [def_fx]）。

[add_fx]自体は待たない（[tsy]と同じ）。記述子は store 経由なので [add_filter]同様、しおり（[save]／[load]）と [trans]の両ページ複製に自動追随する。単発（time>0）が自然経過した記述子は その旨が[save]に載り、別ページで[load]したときは頭から再生し直さず 最終状態で復元される（keepなら最終フレーム、それ以外は元絵）。[load]先と 同じページにある[add_fx]タグ自体が演じ直しで再実行される場合は、通常どおり頭から再生する。

#[clear_fx] シェーダエフェクト撤去

grpレイヤに重ねたシェーダエフェクトを撤去する。

#[wait_fx] シェーダ変化終了待ち

[add_fx time>0] の one-shot エフェクトが経過するまで待ち、再開する。

layer=／name=は最低どちらか一方が必須（両方指定でAND）。一致するセレクタの [add_fx time>0]が全部経過するまで待つ。一致が無ければ待たずに続行（[wait_tsy]と同じ）。
time=0（無限＝常時ゆらぎ）は終わりが無いので待ちの対象外。page=は受けない。
実際に待つのは ScriptMng（[add_fx]のtime=をそのままタイマーにする。[wait_tsy]と 同じ設計で、WebGLランナーからの終了通知は作らない）。[clear_fx]／[clear_lay]／ ページ演じ直しでタイマーも畳む。[pause_fx]で止めている間はこのタイマーも止まる（残時間を保持）。

#[pause_fx] シェーダ変化一時停止

#[resume_fx] シェーダ変化再開

fx の描画（rAF）を止める／止めた続きから戻す。記述子は残る（[pause_tsy]／[resume_tsy]と同型）。

layer=／name=は最低どちらか一方が必須。[pause_fx]＝停止、[resume_fx]＝再開。 止めても記述子（aFx）は残る（<canvas>のまま）＝[save]／[trans]に追随。撤去は[clear_fx]。
パスごとに tick を凍結して描画自体は続ける（前段パスが動いていれば入力は変わるため）。全パスが 停止／経過したら rAF ごと止めて凍結。page=は受けない（両ページの同名 fx に効く）。

トゥイーンアニメ

#[pause_tsy] 一時停止

レイヤーやフレームのトゥイーンアニメを一時停止させる

「layer（とpage）」を指定した場合はレイヤーの操作、
「id」を指定した場合はフレームの操作を行なう。

#[resume_tsy] 一時停止再開

レイヤーやフレームのトゥイーンアニメ一時停止を再開させる

「layer（とpage）」を指定した場合はレイヤーの操作、
「id」を指定した場合はフレームの操作を行なう。

#[stop_tsy] トゥイーン中断

レイヤーやフレームのトゥイーンアニメを中断、終了する。

「layer（とpage）」を指定した場合はレイヤーの操作、
「id」を指定した場合はフレームの操作を行なう。

#[tsy] トゥイーン開始

レイヤーにトゥイーンアニメ（変形・移動・回転アニメーション）を加える。

「目標値」を設定する時、相対値あるいは絶対値を指定できる。

注：フレームのトゥイーンアニメは[tsy_frame]で行なう。

#[wait_tsy] トゥイーン終了待ち

レイヤーやフレームの終了を待ち、再開する。

[event]などでイベントが登録されていても、イベント発生待ちを行わない。 繰返し回数が0（無限ループ）の場合、何もせず終了する

「layer（とpage）」を指定した場合はレイヤーの操作、
「id」を指定した場合はフレームの操作を行なう。

文字・文字レイヤ

#[autowc] 文字ごとのウェイト

特定の文字の直後に自動的にウェイトを入れる。

textに指定した文字に対し、timeに指定した数値が対応する。
通常の文字表示速度にtimeの数値を掛け算する。

以下のように指定する。
[autowc enabled=true text="４５６" time="50,100,150"]
[autowc enabled=true text="４５６" time="100,100,100"]
[autowc enabled=false] 以下はエラーとなる。
;x [autowc enabled=true text="４５６" time="100,100"]
;x [autowc enabled=true text="４５６" time="100,100,100,100"]
;x [autowc enabled=true text="４５６"]
;x [autowc enabled=true time="100,100,100"]
;x [autowc enabled=true]
;x [autowc enabled=true text="" time=""]
;x [autowc text="" time=""]

#[ch] 文字を追加する

文字レイヤに文字を出力する

#[ch_in_style] 文字出現演出定義

文字出現演出アニメを定義する

[lay][span]などの ch_in_style属性で指定すると、定義どおりの文字出現演出アニメを行なう

bluesnovel：x／yの相対指定（'=0.3'）の単位は0.3em。 全角文字では本家の30%指定と同じ値になるが、半角文字だけ本家とずれる。
easeはCSSの<easing-function>構文をそのまま渡せる （cubic-bezier()／steps()も使える）。無効な値を指定した場合はease-outになる。
1文字あたりの遅れ（文字表示ウェイト）は[autowc]の表 → sys:sn.tagCh.msecWait （既読なら_Kidoku側）の順に決まる。待ちはその文字が出る「前」に入るので、[autowc]に載せた文字自身と それ以降が後ろへずれる

#[ch_out_style] 文字消去演出定義

文字消去演出アニメを定義する

[lay][span]などの ch_out_style属性で指定すると、定義どおりの文字消去演出アニメを行なう。
文字消去演出は、次ページの文字出現演出と同時に行なわれる。文字消去演出を待ちたい場合は、[wait]などで待つ。

bluesnovel：本家 TxtStage.#clearText() の移植。消えていく文字を React 管理外の ゴースト span へ移して Element.animate() でアニメし、終わったら捨てる。 wait=0（既定）はゴーストを作らず即座に消える（本家と同じ）。 [trans] のクリックキャンセルで消えかけの文字も即座に終端へ送られる

#[clear_text] 文字消去

文字のみをクリアする

#[current] デフォルト文字レイヤ設定

デフォルト文字レイヤを設定する

#[endlink] ハイパーリンクの終了

[link]（ハイパーリンク）で開始したリンク区間を終了する

#[er] ページ両面の文字消去

デフォルト文字レイヤの裏と表の両方に対して[clear_lay]を行う。

#[graph] インライン画像表示

文字レイヤに画像を文字として表示する。ルビは同時に設定する。

フォントにない外字やアニメpng画像表示に使える。 [span]は強制的に解除される。

#[link] ハイパーリンク

指定した文字レイヤの表ページに、ハイパーリンクを作成する。

[link]から[endlink]（ハイパーリンクの終了）までで囲った範囲をリンク区間と呼び、
その区間の文字や縦中横がハイパーリンクになる。（リンク区間は入れ子に出来ません）
※選択肢として使用する場合、ジャンプ先のラベル直後には必ず[record_place]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。

#[r] 改行

指定した文字レイヤの表ページに、改行を出力する。

#[rec_ch] 履歴書き込み

履歴に文字や付加情報を出力する。

「現在のページ」のテキストに文字を追加する。
「現在のページ」に対する、任意の属性も自由に追加できる。その属性はconst.sn.log.jsonにも含まれ、フレームに渡しJavaScriptなどで（JSON.parse()して）利用できる。
文字列内では[r]で改行できる。
→参考（機能ギャラリー・履歴と機能追加）

bluesnovel：text／style／r_style／任意属性すべて対応 （ルビ文法と[r]も効く）。
本家はdisplay: none;を付けた[ch]として本文へ流し、履歴側でだけ見せる作りだが、 bluesnovelは履歴の蓄積が表示と別物なので、style／r_styleは[ch]と同じ 「本文ストリームへ埋め込む命令」の形で履歴にだけ積む。
text以外の属性（style／r_style含む）は、本家同様「現在のページ」の メタデータとしてconst.sn.log.jsonの各要素へそのまま乗る。 同一ページ内で複数回[rec_ch]を呼んだ場合は直近の指定が丸ごと勝つ（本家と同じ）。
そのためsave:sn.doRecLogがfalseでも記録される（明示的な書き込みなので）

#[rec_r] 履歴改行

履歴に改行を出力する。

属性無し。

#[reset_rec] 履歴リセット

履歴をクリアする。

応用として、履歴に加工した文字列を設定し、履歴画面に機能を追加する事も。

#[ruby2] 文字列と複数ルビの追加

親文字列とルビ文字列のセットで文字を追加する

【参考】ルビ記法

#[set_focus] フォーカス移動

[button][link]やフレーム内HTML要素などのフォーカスを移動する。

[button][link]が文字レイヤに追加された順番、あるいは逆順に「マウスオーバー」表示を移動し、選択する。Enter(Return)キーでボタンクリックと同じ動作をする。
フレーム内HTML要素も[event key='dom=（略）']で自動的にフォーカス移動対象に加えられる。
キーボードやゲームパッド、スイッチコントロールなどの操作を補助する。

「data-focus="false"」指定したHTML要素は、一時的にフォーカスさせなく出来る。"true"指定か属性削除で再度有効化。

#[span] インラインスタイル設定

この指定以降の文字のレイアウト（フォントや文字色など）を指定する。

一時的に文字レイヤのlayout属性への指定を上書きするイメージ。 文字レイヤをクリア（[clear_text]、[clear_lay]）するとリセット、以降は元通り文字レイヤのlayout属性に従う
【参考】ルビ記法

#[tcy] 縦中横を表示する

縦中横文字を追加する。ルビは同時に設定する

画像・画像レイヤ

#[add_face] 差分名称の定義

差分名称を定義する。

本タグだけでは差分画像を表示しない。画像レイヤの[lay]タグface属性で指定する差分名称を登録するのみ。

#[wv] 動画再生終了待ち

[lay]で開始したムービー再生の終了を待つ

何かしらの画像レイヤで再生している動画の終了を待つ

HTMLフレーム

#[add_frame] フレーム追加

HTMLファイルをベースとする「フレーム」を追加する

注：これは HTML要素の iframe（インラインフレーム要素）で、フレームは全てのレイヤの手前に表示され、互い違いに重ねられない。
const.sn.frm.（フレーム名）系の値もセットする。

#[frame] フレームに設定

フレームそのものの属性を設定する

#[let_frame] フレーム変数を取得

フレーム内の変数から、値を取得する

関数名を指定した場合は関数を実行し、その戻り値を取得する。
【const.sn.frm.（id名）.（var_name名）】に値がセットされる。

#[set_frame] フレーム変数に設定

フレーム内の変数に、値を設定する

#[tsy_frame] フレームトゥイーン開始

フレームのトゥイーンアニメを行なう

フレームのトゥイーンアニメを開始したあと、id属性指定により以下のタグを使用できる。
[pause_tsy]（一時停止）
[resume_tsy]（一時停止再開）
[stop_tsy]（トゥイーン中断）
[wait_tsy]（トゥイーン終了待ち）

イベント

#[clear_event] イベントを全消去

イベント予約を全て削除する

#[enable_event] イベント有無の切替

文字レイヤごとのイベント発生有効無効を設定する。

無効にするとマウスイベントが無効になり、[s]待ちなどでイベントが発生しなくなるが、イベント予約は別の話であり、削除などされない。 有効にすればマウスイベントが発生するようになり、再びイベント待ちされるようになる

#[event] イベントを予約

次の[s]などのイベント待ちに向けてイベント処理を予約する。

あるイベントが発生した際、global=falseのイベント予約は全て削除（予約破棄）される

※1 イベント名は以下の表を参考に。

技術的な話をすると、値は JavaScriptでの keydownイベントの keyプロパティの値（Key Values - Web APIs | MDN）を基本とする。
（keyCode（非推奨）・codeプロパティとは違うので注意）
重要な点として、「key属性の値」は大文字小文字区別無し、どちらでもよい。
ただし【dom=【フレーム名】:【ボタン系 HTML要素の id名】】系はHTML要素名なども含むので、大小区別あり。
修飾キー（shiftなど）は、その前に追加していく。（追加順は決まっており、以下を参照。ABC順）

#[l] 行末クリック待ち

シナリオファイルの順次処理を停止し、クリックやキー押下（→詳細は[waitclick]）を待つ。

「breakline」という画像やアニメpngファイルが用意されていれば、行末クリック待ちマークとして表示する。
クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。
吉里吉里仕様【スキップできない】記述から、スキップや自動読みさせない

#[p] 改ページクリック待ち

シナリオファイルの順次処理を停止し、クリックやキー押下（→詳細は[waitclick]）を待つ。

「breakpage」という画像やアニメpngファイルが用意されていれば、改ページクリック待ちマークとして表示する。
クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。

#[s] 停止する

シナリオファイルの順次処理を停止する

シナリオファイルの順次処理を停止する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。

#[set_cancel_skip] スキップ中断予約

スキップ中断を予約

廃止、不要に

#[wait] ウェイトを入れる

指定時間スクリプト処理を待ち、再開する。

[event]などでイベントが登録されていても、イベント発生待ちを行わない。

#[waitclick] クリックを待つ

シナリオファイルの順次処理を停止し、クリックやキー押下※を待つ。

属性無し。

クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。

※クリックやキー押下とは、以下のイベントを差す。
click
downwheel（下方向へのマウスホイール）
enter
space
down（矢印キーの下）

ＢＧＭ・効果音

#[fadebgm] BGMのフェード

BGMを指定した音量に、段階的に変化させる。

#[fadeoutbgm] BGMのフェードアウト

BGMを無音に、段階的に変化させる。

#[fadeoutse] 効果音のフェードアウト

効果音を無音に、段階的に変化させる。

#[fadese] 効果音のフェード

効果音を指定した音量に、段階的に変化させる。

#[playbgm] BGM の演奏

BGMを再生する。

[playse]とは違い、キー押下Skip中でも必ず再生を行なう。（canskip = false固定）

#[playse] 効果音の再生

効果音を再生する。

#[stop_allse] 全効果音再生の停止

全てのサウンドを停止する。ぴたっと止める。

#[stopbgm] BGM 演奏の停止

BGM 演奏を停止する。ぴたっと止める。

#[stopfadese] 音声フェードの停止

音声フェードを停止する。

#[stopse] 効果音再生の停止

効果音再生を停止する。

#[volume] 音量設定

BGMや効果音の音量を指定

BGMや効果音を指定した音量にする。

#[wb] BGM フェードの終了待ち

BGM フェードの終了を待つ。

#[wf] 効果音フェードの終了待ち

効果音 フェードの終了を待つ。

#[wl] BGM 再生の終了待ち

BGM 再生の終了を待つ。

loop=true（[playbgm]のデフォルト値）なら待たない。
利用時は【音声再生[playbgm]がjoin=true(ちなみにデフォルト)であること】を必須条件とします。

#[ws] 効果音再生の終了待ち

効果音再生の終了を待つ。

loop=trueなら待たない。 利用時は【音声再生[playse]がjoin=true(ちなみにデフォルト)であること】を必須条件とします。

#[xchgbuf] サウンドバッファの交換

二つのバッファを交換する。未再生でも再生中でも良いが、フェード中は避けること。

条件分岐

#[else] その他ifブロック開始

プログラム言語における、条件分岐のelse文。

属性無し。

詳細は【開発ガイド：式の評価と条件分岐】をご覧下さい。

#[elsif] 別条件のifブロック開始

プログラム言語における、条件分岐のelsif文。

詳細は【開発ガイド：式の評価と条件分岐】をご覧下さい。

#[endif] ifブロックの終端

プログラム言語における、条件分岐のendif文。

属性無し。
詳細は【開発ガイド：式の評価と条件分岐】をご覧下さい。

#[if] ifブロックの開始

プログラム言語における、条件分岐のif文。

詳細は【開発ガイド：式の評価と条件分岐】をご覧下さい。

ラベル・ジャンプ

#[button] ボタンを表示

文字レイヤにボタンを配置する。

※選択肢として使用する場合、ジャンプ先のラベル直後には必ず[record_place]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。

 {"placement": "bottom"}

#[call] サブルーチンコール

スクリプト処理の現在位置をコールスタックに積み、ジャンプする。

ジャンプ先での[return]により本タグの次の位置に戻る事が出来る。
※マニアックな話ですが、あらゆるタグの中で唯一「通常、既読としない」タグです。

#[jump] シナリオジャンプ

指定位置のスクリプトにジャンプする

ラベルは例えば以下のように使います。

*aaa
無限ループ
[jump label=*aaa]
; =======================
さらにラベル名を考えるのが面倒なとき、「無名ラベル」ともいうべき機能が使えます。 「**after」は「そのタグ以降で最初に見つかった**ラベルに」 「**before」は「そのタグ以前で最初に見つかった**ラベルに」 ジャンプ・コールする、という指定です。次のように書きます。 ; ======================= [jump label=****after] *** ** も [jump label=**after] ;** っ ** [l] ぷ [jump label=**before] ** ＠[s] ** **** す [jump label=***before] ; ======================= この例では「すもぷぷぷ……」と文字が表示されます。 「**」とか「***」とかアスタリスクは二個以上の任意の数が使え、同じ数同士が対応するラベルとなります。 が、上記例で見るとおりあんまり複雑に使うと可読性が下がってしまう気がしますので、局所的な用途に限ったほうが良さげです。 

#[page] ページ移動

ページ移動状態に入り、[p]停止位置を一つ移動する

[p]などの停止位置を「ページ」とみなし、既読ページを戻ったり進んだりできる。
（レイヤの .page とページ移動の [page] の言葉混乱注意）
・save:sn.doRecLog の影響を受け、true の状態でのみページ移動履歴が記録される。
[l][p][s]など（[wait]は対象外）で停止した際にそのページ状態の記録を行う。
・save変数も復元する。
・前述二項の理由により、冒頭ページに &save:sn.doRecLog = true と [record_place]が必須。
（save変数復元で &save:sn.doRecLog = false になるケースがある）

ページ移動状態かは tmp:const.sn.isPaging（Boolean値）でわかる。

#[pop_stack] コールスタック破棄

コールスタックを一つ破棄する

極力使用しないコーディングを推奨します。

#[return] サブルーチンから戻る

コールスタックに積まれているジャンプ先に戻るようなジャンプをする。

最後に積んだコールスタックを一つ破棄する。
マクロ内で実行した場合はマクロを脱出する。
fn・label属性で戻り先を上書き指定できる。（マクロ内からジャンプしたいときなど）

マクロ

#[bracket2macro] 括弧マクロの定義

属性textを持つマクロやタグを、任意の二つの文字を括弧とし、括弧で囲った記述で代用できるよう

例 …… [bracket2macro name=title text=｟｠]
（訂正：「任意の二つの文字」は特定の半角文字じゃなくてもよいです）
※適用範囲について
本タグより前にロードされたスクリプトファイルには適用されません。
またスクリプトファイルに本タグが記述された場合、本タグより前に出現した半角文字にも適用されません。

#[char2macro] 一文字マクロの定義

属性無しのマクロやタグを、半角文字の記述で代用できるよう定義する

本タグより前にロードされたスクリプトファイルには適用されません。
またスクリプトファイルに本タグが記述された場合、本タグより前に出現した半角文字にも適用されません。

#[endmacro] マクロ定義の終了

[macro]と[endmacro]に囲まれた部分をマクロとして定義する。

#[macro] マクロ定義の開始

[macro]と[endmacro]に囲まれた部分をマクロとして定義する。

定義したマクロは既存のタグと同様に使用できる。
渡した属性は、マクロ側で「mp:」「%」スコープにより参照できる。
（ただし式では %a という記述はできず、mp:a 記述のみサポートする）

※1 マクロの概要や引数の説明や詳細説明を以下に表示する

・リファレンス検索パレット（【コマンドパレット】-【リファレンス検索パレットを開く】）
・アウトライン（アウトラインビューに表示）
・マウスホバー（タグ・マクロ名あたりにマウスカーソルを重ねる）
・コード補完機能（スクリプト中で [ や = や半角空白入力時に表示される入力候補）
・引数の説明（スクリプト中で [ や = や半角空白入力時に表示されるホバー）

※2 改行記述について

【\n】文字を入れると、
・一行しか表示できない状況（コード補完機能によるタグ選択中）では【\n】手前までの一行目だけ表示
・複数行表示可能なホバーチップスなどでは、改行して全て表示する

※3 引数説明記述について

書き方があるので、要素を分解して解説する。
例）%layer?='レイヤ名|mes|処理対象の文字レイヤ'

1. 【%】 この属性が引数説明記述であることを示す。
   • [macro]タグでのみ、「%」で始まる属性は、そのマクロ使用時引数の同名属性解説を示す
   • その見た目通り、マクロ定義時の変数名に沿っている。（mp:〜 と同様）
2. 【layer】 属性名
   • 【余談】SKYNovel 1.36.0 以降は漢字や平仮名なども属性名に使用できる
3. 【?】 省略記号
   • ? を書くと【省略可能な属性】であると示す。
   • ? を書かないと必須属性。 【余談】TypeScriptの省略可能なプロパティを意味する「?」と同様の意味合い
4. 【=】
5. 【レイヤ名|mes|trueなら〜】 属性値はその他の項目。値は | で区切られた複数の項目になっている
   • 【レイヤ名】
     • 一項目：値域・型
     • 例は「レイヤ名」が指定されているので、[add_lay] で追加したレイヤ名を指定できる
     • 他に【ブレンドモード名】【実数】など。タグリファレンスを眺めると参考になる。
   • 【mes】
     • 二項目：省略時の値
     • 例ではレイヤ名「mes」を指定したのと同じになる。この項目そのものも省略してもよいが、【||】表記にすると三項目の説明が書ける
   • 【処理対象の文字レイヤ】
     • 三項目：概要、マクロを使う人にわかりやすい説明文

しおり

#[copybookmark] しおりの複写

しおりデータを複写する

セーブデータパスに to, from 属性と同名のフォルダがあればコピーする

#[erasebookmark] しおりの消去

しおりデータを削除する

セーブデータパスに place 属性と同名のフォルダがあれば削除する

#[load] しおりの読込

しおりデータを読み込み、スクリプト処理を再開する

#[record_place] セーブポイント指定

本タグの位置を、スクリプト読み込み時に再開する位置として設定する。

本タグの位置を、スクリプト読み込み時に再開する位置として設定する。
本タグで「しおりを挟み」、[save]タグで実際にデータをセーブするイメージ。

※マクロやサブルーチン内に記述された場合、最初に積まれたコールスタック位置をセーブポイントとする。

#[reload_script] スクリプト再読込

現在処理中のスクリプトをリロードする。

属性無し。

現在処理中のスクリプトをリロードする。
実行位置は[record_place]によるセーブポイントまで戻って再開する。
テンプレの ext_lang.sn が「表示言語を変えたら本文を読み直す」のに使っている。
※スクリプトを大幅に変えた後だと、正常に再開できない場合があります。

bluesnovel：再開位置のスクリプトファイルは無条件でキャッシュを捨てて読み直すため、 派生ファイル（fn@）だけを狙い撃ちして捨てる本家の専用処理は不要（結果は同じ）。

#[save] しおりの保存

しおりデータを保存する。

しおりデータを保存する。
読み込み時に再開するスクリプトの位置は最後に[record_place]をコールした位置。
指定した place が sys:const.sn.save.place と同じ場合、const.sn.save.place を +1 する
。
[record_place]がゲーム状態（レイヤ状態など）をバッファに退避し、
[save]は指定しおりに書き出す機能。

画面揺らし

#[quake] 画面を揺らす

画面全体を揺らす

#[stop_quake] 画面揺らし中断

画面揺らしを中断する

#[wq] 画面揺らし終了待ち

画面揺らしの終了を待ち、再開する。

[event]などでイベントが登録されていても、イベント発生待ちを行わない。

システム

#[close] アプリの終了

アプリケーションを終了する

#[export] プレイデータをエクスポート

プレイデータをファイルとしてエクスポートする

ダウンロードフォルダにプレイデータファイルが保存される。
ブラウザならファイルをダウンロードする。
プレイデータ拡張子、ウェブ版は.swpd、アプリ版は.spdで互換性はない。
暗号化するプロジェクトの場合、出力するプレイデータファイルも暗号化される。
関連するデータファイル（[snapshot fn='userdata:/777/pic.jpg']などと保存したサムネイル画像など）も含む。 bluesnovelでは{sys, mark, kidoku, storage}を1つのファイルとして丸ごと暗号化するため、 本家と異なり関連データファイルも暗号化の対象になる。
エクスポート完了時には【sn:exported】というイベントを発火する。
【[event key='sn:exported' 〜]】という記述でジャンプできる。

#[import] プレイデータをインポート

プレイデータファイルをインポートする

読み込みダイアログが表示され、選択したプレイデータファイルをインポートする。
プレイデータ拡張子、ウェブ版は.swpd、アプリ版は.spdで互換性はない。

タグはダイアログを表示次第すぐ次の処理に移り、ユーザーの選択を待たない。
インポート完了時には【sn:imported】というイベントを発火する。
【[event key='sn:imported' 〜]】という記述でジャンプできる。
関連するデータファイル（[snapshot fn='userdata:/777/pic.jpg']などと保存したサムネイル画像など）も含む。

#[loadplugin] プラグインの読み込み

プラグインとして読み込む

#[navigate_to] ＵＲＬを開く

#[snapshot] スナップショット

アプリ表示部分全体を画像として保存する

画面スナップショットをダウンロードフォルダに保存する。
ファイル名にはプロジェクト名と日時どが追加される。

※ブラウザ版では限定的なサポートです。文字表示が正確ではないので注意。

※fnを「userdata:/」で始まるファイル名にするとセーブデータと同じフォルダに保存します。
・パッケージ済・非パッケージ（アプリ版を起動）
（Win）C:\Users\【ユーザー名】\AppData\Roaming\【アプリ名】\storage\
（Mac）/Users/【ユーザー名】/Library/Application Support/【アプリ名】/storage/
・非パッケージ（デバッガー起動）
｛プロジェクトルート｝/.vscode/storage/

#[title] タイトル指定

アプリウインドウのタイトル文字列を設定する。

#[toggle_full_screen] 全画面状態切替

呼び出す度にアプリの全画面／ウインドウモードを切り替えます。

現在の状態は文字列変数「tmp:const.sn.displayState」で分かる。trueならフルスクリーン

#[update_check] 更新チェック機能

ネットにアプリの更新を確認し、ダウンロードもサポートする

アプリの最新バージョンをネットで確認する。（アプリ版でのみ動作）
処理は非同期に行われ、更新があった時のみ更新確認ウインドウが表示される。
ダウンロードフォルダにアプリパッケージの dmg（インストーラー exe）をダウンロードする。

開発中はデバッグスイッチ devtool・debugLog を有効にすると処理状況やエラーメッセージなども見られて便利です

Webサーバーの準備方法を説明します。
現在二つの形式をサポートしていますが、前者の新しい方に移行して下さい。

【新】_index.json 方式

CPU アーキテクチャ違いにも対応し、latest.yml などを手変更する必要がなくなりました。

OSや CPU アーキテクチャごとの配布形式生成を押して、それぞれを生成します。
（各社のビジネス上の都合により、同じOSでも違う形式があります。どちらも生成してアップデート機能も準備してあげればよいと思います）

exeやdmgが build/package/ フォルダに生成されますが、いっしょに build/package/update フォルダが新たに生成され、「新しいアップデート機能」に必要なファイルがまとめられています。

_index.json は OS 違いや CPU アーキテクチャ違いでも一つのファイルです。
他はファイル名を暗号化したアプリファイル（OS + Arch + 乱数文字列）です。
（内容に変更なくても、生成するたびに乱数文字列とファイル名は変わります）

build/package/update フォルダ内のファイルすべてを Webサーバーにアップロードします。
シンプルなサンプルでは Github にアップロードしています。
例えば _index.json はブラウザからも見える状態です。念のため確認しておきましょう。

Githubの制限でファイルサイズの最大は 100MB 以内のため、
Mac は 空の dmg にしています。
Winは収まっているので実物です。
Linuxは 100MB 越えなので上げられていません。

シンプルサンプルのテンプレからなにか新規プロジェクトを生成してみましょう。
スクリプト冒頭で [update_check] を呼んでいます。URLは _index.json などをアップした URL です。
ご自身で使用する際はご自身で用意した Webサーバーの URL に変更するわけです。

そのままアプリ版を実行しても何も起こりませんが、

アプリのバージョンを「1.0.0」以外に変更してから終了 → アプリ版を実行すると、アプリの更新をうながすダイアログが表示されます。

Windows でも OS に即したダイアログ表示です。

ダウンロードフォルダに配布形式ファイルがダウンロードされます。
ia32 なら ia32、x64 なら x64。実行した旧アプリと同じ CPU アーキテクチャの新アプリファイルが選ばれます。

Windows ではこんな感じです。

ダウンロードフォルダに新しいインストーラーなど配布形式ファイルがダウンロードされます。

ただし旧アプリが x64 なのにサーバー上にない場合、とりあえず同じ OS のすべての CPU アーキテクチャのファイルをダウンロードします。
どちらかで配布して、あとで CPU アーキテクチャ別のアップデートという形が可能なわけです。
（上の画像は加工してあるのでちょっと変な表示です。「CPU = x64」が見つからないといいながら、2 個のファイルの内の一つが x64 ファイルです）

まとめると、
1．OSや CPU アーキテクチャごとの配布形式を生成する。
2．build/package/update フォルダ内のファイルすべてを Webサーバーにアップロード。
3．アプリ版で [update_check] を呼ぶ。
だけです。
CPU アーキテクチャ違いにも対応し、latest.yml などを手変更する必要がなくなりました。

【旧】.yml 方式

基本的に二つのファイルを変更し、アップロードするだけです。
・OS X
1.【exe作成】で build/ 下に「〜.dmg」と「latest-mac.yml」などが生成される。
2.「latest-mac.yml」を開き、書いてあるファイル名に合わせるように「〜.dmg」ファイル名を変える。（サーバーにアップしてから変えても良さげ）
3.上記二つを FTP などで Webサーバーにアップロードする。(httpsを大推奨)
「~.yml」がWebブラウザなどで開けるのを確認。
例) http://ugainovel.hiho.jp/famibee/sample/hatsune/latest-mac.yml
4. main.sn にある [update_check] の url属性に、二つのファイルをアップした「ディレクトリ名」を記述。
[update_check url='http://ugainovel.hiho.jp/famibee/sample/hatsune/']　5.【アプリ版を起動】して試してみる。バージョン番号が違う場合のみ、更新チェック機能によるダイアログが表示される。

・Windows
1.【exe作成】で build/ 下に「〜.exe」と「latest.yml」などが生成される。
2.「latest.yml」を開き、書いてあるファイル名に合わせるように「〜.exe」ファイル名を変える。（サーバーにアップしてから変えても良さげ）
3.上記二つを FTP などで Webサーバーにアップロードする。(httpsを大推奨)
「~.yml」がWebブラウザなどで開けるのを確認。URLをメモ。
例) http://ugainovel.hiho.jp/famibee/sample/hatsune/latest.yml
4. main.sn にある [update_check] の url属性に、二つのファイルをアップした「ディレクトリ名」を記述。
[update_check url='http://ugainovel.hiho.jp/famibee/sample/hatsune/']　5.【アプリ版を起動】して試してみる。バージョン番号が違う場合のみ、更新チェック機能によるダイアログが表示される。

#[window] アプリウインドウ設定

ゲームアプリのウインドウサイズや位置などを変更する

デバッグ・その他

#[dump_lay] レイヤのダンプ

レイヤの内容をデバッグ表示する

#[dump_script] 外部スクリプト連携

実行中スクリプトを外部の関数へ渡す

#[dump_stack] スタックのダンプ

[call]等によるコールスタックの内容をデバッグ表示する

#[dump_val] 変数のダンプ

変数の内容をデバッグ表示する

#[log] ログ出力

ダウンロードフォルダにテキスト出力する（追記ではなく上書き。追記する。出力日時・分・スクリプト名や行番号やプロジェクト名も出力

Web版でもログファイルをダウンロードします。ただし連続だと間隔が開いてないと失敗します。

#[trace] デバッグ表示へ出力

属性をデバッグ表示する