マクロ・プラグイン

sub.sn の定義マクロ

#[sys_scenario_start] シナリオ開始時共通処理

タイトルからゲーム本編を開始する際の処理を行なう。

引数無し。
シナリオファイル冒頭に記述するべき。

#[sys_title_start] タイトル開始共通処理

ゲーム本編を開始する際の処理を行なう。

引数無し。
タイトルから本編、あるいはしおりロードから本編を開始する際に呼ぶ。

クリック待ち記号、フォント、セーブロード・設定画面などを準備する。

#[wc] 文字数分のウェイトを入れる

文字数分のウェイトを入れる

#[plc] 改ページ

改ページと関連処理を行なう。

改ページ記号を表示する前に「自動読み進み状態で」「音声が再生中」なら音声再生終了を待つ。
改ページ記号を表示しクリックを待ち、
押下後[er]（テキストを消去）し[record_place]（ゲーム状態をバッファに退避）する。

「履歴画面で選択位置から再開する」機能は配布状態では無効になっている。
『; [h_ss_upd] ; 〜』
『; [h_save] ; 〜』
のコメントを外し、シナリオファイル最初の[grp]直後に[h_save]を置くと有効になる。

#[after_choice] 選択肢直後処理

[link]など選択肢直後にコールする。

引数無し。
[record_place]などを呼んでいます。

#[sys_resume_load] レジューム処理

前回終了ポイントからの再開（レジューム）を行なう。

引数無し。
sys:doResume が false なら何もせず抜ける。
autoResume が false のときは [ask_ync] で「前回終了ポイントから再開しますか？」と確認し、「いいえ」なら抜ける。
再開する場合は _archive.sn の *do_load_resume へジャンプする。

テンプレでは main.sn の起動処理末尾で [sys_resume_load cond=!const.sn.key.escape] として呼んでいる（Esc 押下起動でレジュームを飛ばせる）。

#[sys_resume_save] レジューム退避処理

現在のゲーム状態をレジューム用スロットへ退避する。

引数無し。
_archive.sn の *do_save_resume を [call] する。
テンプレでは [plc]（改ページ）と [after_choice]（選択肢直後）から呼ばれる。

#[txt_lay_v_left] テキストレイヤ縦書き左設定

文字レイヤを設定する。サンプルゲーム「櫻の樹の下には」の縦書き設定。

このマクロで文字レイヤ（page=back）に設定しておき、
[grp]で場面転換と共に文字レイヤの設定を変えるような使い方をする

#[txt_lay_v_center] テキストレイヤ縦書き中設定

文字レイヤを設定する。「txt_lay_v_left（テキストレイヤ縦書き左設定）」を画面中央に移動したもの。

「txt_lay_v_left（テキストレイヤ縦書き左設定）」の設定に加え以下指定を行なったもの

#[txt_lay_v_center_wide] テキストレイヤ縦書きWide中設定

文字レイヤを設定する。「txt_lay_v_center（テキストレイヤ縦書き中設定）」を画面中央に移動し、幅を広げたもの。

「txt_lay_v_center（テキストレイヤ縦書き中設定）」の設定に加え以下指定を行なったもの

#[txt_lay_fullscreen] テキストレイヤ全画面設定

文字レイヤを設定する。全画面を覆うような設定

#[txt_lay_h_bottom_wide] テキストレイヤ横書きWide下設定

文字レイヤを設定する。「txt_lay_fullscreen（テキストレイヤ全画面設定）」を画面下に移動し、幅を広げたもの。

実体は [txt_lay_fullscreen * t=472 h=266 max_row=6]。引数（layer / page / visible / fcol / b_color / b_alpha / style / r_style / r_align など）は [txt_lay_fullscreen] と同じで、指定すればそのまま渡される。

#[txt_lay_window_top] テキストレイヤ横書き上小窓設定

画面上端に寄せた横書きの小窓テキストレイヤ。

実体は [txt_lay_fullscreen] を座標指定つきで呼ぶラッパー（各座標は 1.28 倍でスケール、sysmenu_top=-200 でシステムメニューを窓の上へ寄せる）。引数は [txt_lay_fullscreen] と同じ（layer / page / visible / fcol / b_color / b_alpha / style / r_style / r_align など）。

#[txt_lay_window_bottom] テキストレイヤ横書き下小窓設定

画面下端に寄せた横書きの小窓テキストレイヤ。

実体は座標指定つきの [txt_lay_fullscreen] ラッパー。引数は [txt_lay_fullscreen] と同じ。

#[txt_lay_window_middle] テキストレイヤ横書き中央小窓設定

画面中央に寄せた横書きの小窓テキストレイヤ。

実体は座標指定つきの [txt_lay_fullscreen] ラッパー。引数は [txt_lay_fullscreen] と同じ。

#[sysmenu_draw_v] システムメニュー描画処理（縦書き）

文字レイヤ mes_sysmenu に表示する縦書き用システムメニューを設定する。

このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。
[txt_lay_v_left] 系の縦書きテキストレイヤ設定から呼ばれる。useSysMenu が false なら何もしない。

#[sysmenu_draw_h] システムメニュー描画処理（横書き）

文字レイヤ mes_sysmenu に表示する横書き用システムメニューを設定する。

[sysmenu_draw_v] の横書き版。ボタンを回転させず横一列に並べる。
[txt_lay_fullscreen] / [txt_lay_h_bottom_wide] 系の横書きテキストレイヤ設定から呼ばれる。useSysMenu が false なら何もしない。

#[sys_menu] システムメニュー表示切り替え

文字レイヤ mes_sysmenu のシステムメニューを表示／非表示する。

このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。

#[grp] 場面転換

画面を暗転し背景を変更する。

文字レイヤをフェードアウトし、
クロスフェードしながら背景画像（レイヤ名baseの画像レイヤ）を変更、
前景レイヤ（レイヤ名0〜2の画像レイヤ）をクリアor画像変更し、
文字レイヤをフェードインする。

#[bgm] ＢＧＭ切り替え

BGMをクロスフェードする。

#[se] 効果音を再生

[playse]に引数省略時音声停止機能を付けたもの。

_yesno.sn の定義マクロ

#[ask_ync] プレイヤー意志確認

プレイヤーに「はい」「いいえ」等の二択で確認を行なう。

プレイヤーが押下した結果をtmp:_yesnoに「y」か「n」で返す

ext_fg.sn の定義マクロ

#[fg] レイヤ画像を変更

クロスフェードしながらレイヤ画像を変更する

#[img] 画像レイヤ設定サブ

背景レイヤに画像を設定する

#[fg_fi] フェードイン

フェードインしながらレイヤ画像を出現させる

#[fg_fo] フェードアウト

フェードアウトしながらレイヤ画像を消去する

#[fg_squat] レイヤを屈伸させる

クロスフェードしながらレイヤ画像を変更する

#[fg_shake] レイヤを震わせる

クロスフェードしながらレイヤ画像を変更する

#[fg_sidestep] レイヤを反復横跳びさせる

クロスフェードしながらレイヤ画像を変更する

#[zoom_tsy] ズームイン・アウトのトゥイーン

レイヤをレイヤ中心を軸にズームさせながら出現／退場させる。

visible=true なら拡大率 0.5→1 で出現、false なら 1→0.5 で退場（退場後 visible=false）。トゥイーンは Back.InOut で行ない、[wait_tsy] で終了を待つ。

ext_fg2.sn の定義マクロ

立ち絵を【名前】で扱う簡易 [fg]。表示中の立ち絵を画面幅で自動的に均等配置し、add／del／swap で出し入れする。const.fg2_attention_filter を立てると「最後に動いた立ち絵」を目立たせ、他を暗くできる（フィルタ名は sn.fg2.attention_filter）。同時表示できるレイヤ数はレイヤ 0〜2（自動調査で増やせる）。

#[fg2] 立ち絵の扱いが簡単な[fg]

レイヤ画像を変更する。立ち絵の扱いが簡単な [fg]。

画像ファイル名は【名前_表情やポーズ】形式。同じ【名前】を再指定すると既存レイヤの差分だけ差し替え、未登場なら空きレイヤへ [tsy] で移動＋フェードインする。

#[fg2_squat] 立ち絵を屈伸させる

【名前】で指定した立ち絵を屈伸させる。[fg_squat] を名前引きで呼ぶラッパー。

#[fg2_shake] 立ち絵を震わせる

【名前】で指定した立ち絵を震わせる。[fg_shake] を名前引きで呼ぶラッパー。

#[fg2_sidestep] 立ち絵を反復横跳びさせる

【名前】で指定した立ち絵を反復横跳びさせる。[fg_sidestep] を名前引きで呼ぶラッパー。

ext_voice.sn の定義マクロ

#[voice] 音声を再生

音声を再生する。[se] を join=true で再生し、最後に再生した音声名を lastVoice に保存したもの。

fn 省略時はサウンドバッファを停止する。引数は [playse] とほぼ共通。

#[repeat_voice] あの素晴らしい声をもう一度

直前に [voice] で再生した音声（lastVoice）を再生し直す。

引数無し。lastVoice が空なら何もしない。テンプレでは v キーにグローバルイベントとして割り当てられている。

#[voice_ex] 連番ファイル名の音声を再生

連番ファイル名の音声を手軽に再生する。括弧マクロ〔〕でさらに簡略化できる。

音声ファイル名は【人物名_000.???】形式。呼ぶたびに人物ごとの内部カウンター（save:db_v_cnt）が進む。
下準備が必要：const.db（人物名→ファイル名対応）と save:db_v_cnt を JSON などで初期化しておく。一本道でない作品はスクリプト冒頭で [voice_ex_set] によりカウンターを合わせる。

#[voice_ex_set] 内部カウンターを変更する

[voice_ex] が次に再生する音声ファイル名カウンターを変更する。

ext_for_call.sn の定義マクロ

#[for_call] 変数の値を増やしながら[call]する

for文のように変数を変化させながら[call]を繰り返す。

for文が無いのを補助するマクロ。
※ギャラリーの【for文を使える】を参照。（後述）

【for文を使える】より、抜粋すると以下になる。

ギャラリーで実行すると、「012345」という文字表示がなされる。

テンプレの【prj/other/ext_fg2.sn】でも使用されているので、使用法のご参考にどうぞ。（多少複雑な例ですが）

#[for_call_break] ループを中断する

内側一つだけ脱出する

[for_call]呼び先サブルーチンで使用すると、ループを終了し[for_call]の次に戻る。
[for_call_break]の直後に[return]が必要。
引数無し。

※使用例は[for_call]を参照。

main.sn の定義マクロ

#[lr] クリック待ち改行

音声・クエリ待ちを挟んでからクリック待ち改行する。行末クリック待ちの定型。

引数無し。処理は次の順。
1. 自動読み進み中かつ Skip 中でないなら、サウンドバッファ VOICE の再生終了を待つ（[ws] canskip=true）。
2. [wq]（クエリ待ち）。
3. [l]（クリック待ち改行）。

テンプレでは [char2macro char=@ name=lr] により @ がこのマクロの別名になっている（本文で @ と書けば [lr]）。あわせて [char2macro char=\ name=plc] で \ が [plc]（改ページ）の別名になっている。

add_fx プリセット拡張（ギャラリー add_fx サンプル）

#[add_fx fx=stand_aura] スタンドのオーラ

立ち絵の輪郭から外へ滲み出る、いわゆる「スタンドのオーラ」。ext_fx_aura.sn。

立ち絵（顔差分つきでよい）の grp レイヤへ直接掛ける（オーラ専用の別レイヤは不要）。透過画素にだけオーラを描き、立ち絵のピクセルには乗らない。プリセットは [def_fx pad=0.28] 宣言つきで、fx キャンバスが基本画像の枠外へ広がる。レイヤごと [tsy] / Moveable してもオーラは追従する。amp=-1 でオフ（記述子は残る）、撤去は [clear_fx]。

#[add_fx fx=fire_floor / fire / fire_b / fire_c] 炎 4種

炎のシェーダエフェクト 4 種を 1 ファイルで定義。ext_fx_fire.sn。

不透明な背景（grp）レイヤへ掛ける。炎は加算合成し、背景は shift ぶん露出を落として返す。amp 負値でオフ、撤去は [clear_fx]、一時停止は [pause_fx] / [resume_fx]。

共通属性

プリセットごとの違い

#[add_fx fx=hanafubuki] 桜が舞い散る

桜の花びらが舞い散る、イメージ重視の情景エフェクト。ext_fx_hanafubuki.sn。

不透明な背景（grp）レイヤへ掛ける。花びらを重ね、shift で情景の仕上げ（淡い発光・光のかすみ・彩度・周辺減光。背景自体はぼかさない）を掛ける。amp=-1 でオフ。

#[add_fx fx=rain_window] 窓ガラスを流れ落ちる雨

窓ガラスを蛇行しながら垂れて尾を引く雨滴。ext_fx_rain_window.sn。

不透明な背景（grp）レイヤへ掛ける。color=0x991418 で「血の雨」アレンジ（水滴・尾を赤く）。amp=-1 で水滴なし＝素通し（ガラスの曇りだけ残る）。

#[add_fx fx=tile] タイル無限スクロール

別画像をタイル状に敷き詰め、一定方向へ無限スクロールさせる汎用エフェクト（棚引く霧・煙・雨脚の帯など）。ext_fx_tile.sn。

tex= で対象レイヤの基本画像とは別の画像を渡す（[add_fx] の uTex2 口）。対象レイヤ自身の画像はそのまま表示され、tex= の画像だけをタイル＋スクロールして重ねる＝専用の重ねレイヤが要らない（[add_fx layer=bg fx=tile tex=…] でよい）。タイル画像は端がシームレスに継げるものを使う。撤去は [clear_fx] だけで元通り。

humaneプラグイン

プラグインは core/plugin/ 下に配置し使用します。

#[notice] humane.js 通知パネル

humane.jsにより通知を表示する。

humane.js·見た目のカスタマイズも可能なWeb通知ライブラリ MOONGIFT

humaneフォルダを配置すれば使用できます。
サンプルプロジェクト「桜の樹の下には」では最初から配置されています。