変数操作

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

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

引数無し

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

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

具体的には、save:変数を全消去してから、
&save:const.sn.mesLayer = ''
&save:sn.doRecLog = false
&save:const.sn.sLog = ''

[let] 変数代入・演算

変数に値を代入する。

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

[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」として変数に）

[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] 文字列から抜きだし

文字列の一部を取り出す

レイヤ共通

[add_lay]レイヤを追加する

レイヤを追加する。

レイヤはページの裏表があり、文字レイヤや画像レイヤなどの種類があります。
レイヤの追加と同時に、[lay]に指定できる属性を指定できます。（内部的に[lay]を呼ぶ）
これにより、[add_lay visible=false ...]等とすると、非表示状態でレイヤ追加できます。

[clear_lay]レイヤ設定の消去

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

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

[finish_trans] トランス強制終了

引数無し。

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

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

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

レイヤの種類ごとに使用できる属性が違う

blendModeの解説

暫定版です、SKYNovelで指定できる値については追って記述します（_ _）

[lay]レイヤ設定(文字レイヤ)

[lay]レイヤ設定(画像レイヤ)

[trans]ページ裏表を交換

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

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

クロスフェード終了後は元・裏ページから元・表ページに内容をコピーし、同じ内容になる。

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

[wt]トランス終了待ち

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

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

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

トゥイーンアニメ

[pause_tsy]一時停止

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

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

[resume_tsy]一時停止再開

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

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

[stop_tsy]トゥイーン中断

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

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

[tsy]トゥイーン開始

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

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

[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]を使わない、より簡潔な記述文法があります。
以下の記述は、
[ch text=&test]
[ch text=test]
[ch text="&a + b"]

以下のようにも書けます。&から&までを[ch]文と解釈します。
&test&
&'test'&
&a + b&

では「&（半角）」を表示するには？（これらの文法のせいで普通に書けない）
[ch text="&'&'"]として下さい。

[ch_in_style]文字出現演出定義

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

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

[ch_out_style]文字消去演出定義

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

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

[clear_text]文字消去

文字のみをクリアする

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

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

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

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

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

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

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

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

フォントにない外字やアニメpng画像表示に使える。

※省略時は画像サイズになるが、ロード完了直後に文字配置を決めるのでちらつく。それを嫌う際に指定する
※特にモバイルなどでゲーム画面が自動で拡大縮小される場合、省略したらその時の本文文字サイズとして扱われる。なるべくサイズ指定を推奨。

[link]ハイパーリンク

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

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

[r] 改行

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

[rec_ch]履歴書き込み

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

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

[rec_r]履歴改行

履歴に改行を出力する。

引数無し。

[reset_rec]履歴リセット

履歴をクリアする。

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

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

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

[set_focus] 未作成：フォーカス移動

[button]フォーカスを移動する。

説明に「フォーカス順」とある場合は、[button]が文字レイヤに追加された順番。
先頭は最初に追加された[button]。

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

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

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

[tcy]縦中横を表示する

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

画像・画像レイヤ

[add_face]差分画像の追加

差分画像を登録する。

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

例えば同じ画像で差分表示位置やブレンドモードが違う登録をしたい場合、
[add_face name="a_normal" fn="画像" dx=0 dy=0]
[add_face name="a_10_10" fn="画像" dx=10 dy=10]
[add_face name="a_screen" fn="画像" dx=0 dy=0 blendmode="screen"]
とnameを変えることで登録できます。

[wv]動画再生終了待ち

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

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

HTMLフレーム

[add_frame]フレーム追加

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

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

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

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

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

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

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

[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属性の値」は大文字小文字区別無し、どちらでもよい。
修飾キー（shiftなど）は、その前に追加していく。（追加順は決まっており、以下を参照。ABC順）

[l] 行末クリック待ち

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

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

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

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

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

[s] 停止する

引数無し。

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

[set_cancel_skip] スキップ中断予約

引数無し。 ページ末まで一気に読み進むモード、自動読みすすみモードなどの開始に備え、クリックなどで処理を中断できるような特殊イベントを予約する。 クリックやキー押下が発生した場合、処理を再開する。

※例えば自動読み進みモードだと[l][p]などで停止しないため、予約イベントが処理されない。その為のタグ。

[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や効果音を指定した音量にする。

[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]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。

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

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

ジャンプ先での[return]により本タグの次の位置に戻る事が出来る。 ※あらゆるタグの中で唯一「通常、既読としない」タグですが、普通に使う分には気にしなくて良いです。

[jump]シナリオジャンプ

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

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

*aaa
無限ループ
[jump label=*aaa]
; =======================

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

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

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

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

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

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

最後に積んだスタックを一つ破棄する。

マクロ

[bracket2macro] 括弧マクロの定義

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

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

[break_macro]マクロから脱出

マクロ内の途中で、マクロから脱出したい際に使用する。

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

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

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

[endmacro]マクロ定義の終了

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

[macro]マクロ定義の開始

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

定義したマクロは既存のタグと同様に使用できる。 渡した引数は、マクロ側で「mp:」スコープにより参照できる。

しおり

[copybookmark]しおりの複写

しおりデータを複写する

[erasebookmark] しおりの消去

しおりデータを削除する

[load]しおりの読込

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

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

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

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

[reload_script] スクリプト再読込

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

トまで戻って再開する。 引数無し。 ※スクリプトを大幅に変えた後だと、正常に再開できない場合があります。

[save]しおりの保存

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

トの位置は最後に[record_place]をコールした位置。 [record_place]がゲーム状態（レイヤ状態など）をバッファに退避し、 [save]は指定しおりに書き出す機能。

画面揺らし

[quake]画面を揺らす

画面全体を揺らす

[stop_quake]画面揺らし中断

画面揺らしを中断する

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

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

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

システム

[close]アプリの終了

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

※Flash 上では動作しません。タグを呼んでも何もしません。

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

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

[naviate_to]ＵＲＬを開く

[snapshot]スナップショット

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

文字の表示とスナップショットは、厳密には同じではないので注意。

※fnを「userdata:/」で始まるファイル名にするとセーブデータと同じフォルダに保存します。
【暫定版】（2019/12/09）以下は不正確です

[title]タイトル指定

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

[toggle_full_screen] 全画面状態切替

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

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

[update_check] 更新チェック機能

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

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

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

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

デバッグ・その他

[dump_lay]レイヤのダンプ

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

[dump_val]変数のダンプ

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

[dump_script] スクリプトのダンプ

[dump_stack]スタックのダンプ

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

[log] ログ出力

引数をデスクトップにテキスト出力する（追記ではなく上書き。追記する。出力日時・分・スクリプト名や行番号やプロジェクト名も出力

[stats]パフォーマンス表示

FPSやメモリ使用量をチェックするStatsを表示する。（見方）。

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

引数をデバッグ表示する