鱧天リファレンス

鱧天で追加されるマクロや独自KAGタグのリファレンスです。
使い方はKAGタグやKAGマクロと同様です。

説明文中のパス表記については次のルールに従っています：

システム操作

actcancel ユーザーの操作を一時的に禁止
finishload ローディング表示終了
sceneprep マクロ：シーン呼び出し前の共通処理

メッセージ操作

blname マクロ：会話ウィンドウにキャラクター名を表示
cinemaer マクロ：シネマットモード中の拡張er
lr マクロ：改行付き拡張l
xl 拡張l
xp 拡張p

ラベル・ジャンプ操作

exlink 選択肢の作成
scbegin 再生シーン設定
sccall シーン内容呼び出し
scenejump マクロ：シーンジャンプ
scfinish シーン終了宣言
screturn シーン内容からディレクションファイルへの復帰
scskip シーン内のスキップ可否設定
show_endlistitem マクロ：エンディングリストの選択項目作成

レイヤ操作

bcimage 暗幕レイヤに画像を読み込む
beginpict マクロ：シネマットの字幕を非表示にする
beginstory マクロ：シネマットの字幕を全画面にする
begintalk マクロ：シネマットの字幕を会話風にする
bgimage マクロ：背景画像読み込み
change_speaker マクロ：会話ウィンドウ変更
cinemat シネマットの開口部の表示設定
endcinema マクロ：シネマットモードを終了
evimge マクロ：イベントCG読み込み
exbacklay マクロ：拡張backlay
exbutton マクロ：効果音付きグラフィカルボタンの作成
hide_selection マクロ：選択肢ウィンドウを消去
hide_speaker マクロ：会話ウィンドウを消去
hsclear 立ち絵オブジェクトのリセット
hsimage 立ち絵オブジェクトへの画像設定
hsmove 立ち絵の自動移動
hsoption 立ち絵の表示設定変更
hsreset マクロ：立ち絵の消去
init_persons マクロ：会話ウィンドウと立ち絵のリセット
prepare_selection マクロ：選択肢ウィンドウの準備
prepcinema マクロ：シネマットモードの準備
prep_speaker マクロ：会話ウィンドウの準備
setcinemacolor シネマットのマスク色設定
sceneout マクロ：シーン終了後の共通処理
set_blackcinema マクロ：シネマットを半透明黒にする
set_tpcinema マクロ：シネマットを透明にする
show_selection マクロ：選択肢ウィンドウの表示
show_speaker マクロ：会話ウィンドウ表示
startcinema マクロ：シネマットの表示設定
startcinema_15lines マクロ：字幕全画面のシネマットを表示
startcinema_6lines マクロ：字幕6行のシネマットを表示
startcinema_0lines マクロ：字幕のないシネマットを表示
start_speak マクロ：本文表示開始宣言
trans_change マクロ：汎用的な短時間トランジション
trans_scene マクロ：汎用的な長時間トランジション
trans_show マクロ：イベントCGの表示等に使用するトランジション
trans_summon マクロ：立ち絵の表示等に使用するトランジション
trans_wipe マクロ：汎用的なワイプトランジション
xwt マクロ：拡張wt

効果音・BGM・ビデオ操作

explaybgm マクロ：拡張playbgm
fadeinenvsound マクロ：環境音のフェードイン再生
fadeoutenvsound マクロ：環境音のフェードアウト
loadmovie マクロ：動画読み込み
playenvsound マクロ：環境音再生
playmovie マクロ：読み込み済みの動画を再生
wfenvsound マクロ：環境音のフェード待ち
xws マクロ：拡張ws

栞・通過記録操作

qsstate クイックセーブメニューの表示等設定
scenario_over マクロ：エンディングからタイトルに戻る

actcancel（ユーザーの操作を一時的に禁止）

システム操作
属性 必須？ 値 説明
enabled no false（デフォルト）または true 操作禁止を有効にするかどうかを指定します。省略するとfalseが指定されたと見なされます。

右クリック等も含めた入力を受け付けないようにします。
このタグはexbacklayマクロ等で内部的に使用するもので、通常単独では記述しません。

▲リストに戻る

bcimage（暗幕レイヤに画像を読み込む）

レイヤ操作
属性 必須？ 値 説明
storage yes 画像ファイル名 鱧天付属の画像を使って暗転させる場合は「blackmat」、暗転状態から元に戻すには「clearmat」を指定します。もちろん他の画像も指定できます。例えば他の鱧天付属画像では画面を真っ白にする「whitemat」も有用です。
page no back（デフォルト）またはfore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。

鱧天では「暗幕レイヤ」と呼ばれる、すべてのレイヤより上位に表示されるレイヤがあり、これを使って画面を暗転させたりさせなかったりします。
このタグは、暗幕レイヤに画像を読み込むために使用します。
通常はexbacklayしてから記述します。

▲リストに戻る

beginpict（マクロ：シネマットの字幕を非表示にする）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットモードの字幕を非表示にします。
背景やイベントCGを全画面で見せたいときにあらかじめこのマクロを記述しておきます。
このマクロはトランジションまで行いますので、exbacklayせずに記述します。

▲リストに戻る

beginstory（マクロ：シネマットの字幕を全画面にする）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットモードの字幕を全画面に変更します。
このマクロはトランジションまで行いますので、exbacklayせずに記述します。

▲リストに戻る

begintalk（マクロ：シネマットの字幕を会話風にする）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットモードの字幕を会話風（画面下3行程度）に変更します。
このマクロはトランジションまで行いますので、exbacklayせずに記述します。

▲リストに戻る

bgimage（マクロ：背景画像読み込み）

レイヤ操作
属性 必須？ 値 説明
grayscale no false（デフォルト）または true グレイスケールで読み込むかどうかを指定します（フルカラーの画像もグレイスケールに変換・表示されます）。省略するとfalseが指定された（そのまま読み込む）と見なされます。
page no back（デフォルト）または fore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。
storage yes ファイル名 読み込む画像ファイルを指定します。

背景レイヤ（base）に画像を読み込むためのマクロです。
通常はstorage属性のみを指定し、exbacklayマクロの呼び出し後に記述します。

このマクロで読み込む画像の幅はウィンドウ幅と一致していなければなりません。
また、背景として使用する画像は「/graph/bgimage」フォルダに格納し、そこからの相対パスで指定してください。
（例）/graph/bgimage/home.pngを背景として読み込むには [bgimage storage="home"] と記述します。

▲リストに戻る

blname（マクロ：会話ウィンドウにキャラクター名を表示）

メッセージ操作
属性 必須？ 値 説明
name yes 文字列 キャラクターの名前を指定します。

話しているキャラクターの名前を表示します。
フキダシモード、シネマットモード共通です。

xpマクロの後は消去されますので、都度記述してください。

▲リストに戻る

change_speaker（マクロ：会話ウィンドウ変更）

レイヤ操作
属性 必須？ 値 説明
marginl no 0以上の数値 会話ウィンドウ左側から実際に文字が表示される領域までのマージンを指定します。省略すると50が指定されたと見なされます。
marginr no 0以上の数値 会話ウィンドウ右側から実際に文字が表示される領域までのマージンを指定します。省略すると200が指定されたと見なされます。
margint no 0以上の数値 会話ウィンドウ右側から実際に文字が表示される領域までのマージンを指定します。省略すると47が指定されたと見なされます。
page no back（デフォルト）または fore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。
type no ファイル名 会話ウィンドウの画像ファイルを指定します。省略するとbltalkが指定されたと見なされます。

フキダシモードで使用する会話ウィンドウを変更します。
通常は裏画面に読み込んでトランジションで表示させますので、exbacklayした後に記述します。

prep_speakerマクロやshow_speakerマクロのマージン値を変更した場合は、このマクロのデフォルトマージン値も一緒に変更しておくと良いでしょう（マクロ定義は前二者と同じ辺りにあります）。

このマクロでは、f.mainMessageLayerに指定されたメッセージレイヤを使用します。
鱧天のデフォルト値はmessage1です。

▲リストに戻る

cinemaer（マクロ：シネマットモード中の拡張er）

メッセージ操作
属性 必須？ 値 説明
size no 0以上の整数値 文字サイズを指定します。省略するとKAGのデフォルト値（Config.tjsやdeffontで指定した値）が指定されたと見なされます。

KAGのerタグ（メッセージレイヤの文字の消去）をまとめ、シネマット中の文字消去に特化したマクロです。
文字消去後、文字色を白にし、size指定がある場合はそのサイズにします。
シネマットモード中はこちらを使用してください。
また、文字色等をカスタマイズする場合は/data/scenario/KagRoutines/setmacro_text.ksを開き、cinemaerのマクロ定義を編集してください。

▲リストに戻る

cinemat（シネマットの開口部の表示設定）

レイヤ操作
属性 必須？ 値 説明
height no 0以上の整数値 開口部の縦幅を指定します。
layer no back（デフォルト）または fore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。
left no 数値 ウィンドウ左端を基準とした水平方向の開口部開始位置を指定します。
top no 数値 ウィンドウ上端を基準とした垂直方向の開口部開始位置を指定します。
op no clear シネマットを消去します。設定変更の場合は空欄にするか、属性を付けないでください。
width no 0以上の整数値 開口部の横幅を指定します。

鱧天には、一見映画風の見栄えにする「シネマットモード」というものがあります（どんな感じになるかは二月のコラムをご覧ください）。
シネマットは、シネマットモードに使用するマスクレイヤです。

このタグはシネマットでマスクされない部分の開始位置と幅を設定しますが、直接記述するより、startcinemaなどのマクロ経由で間接的に使用する機会の方が多いでしょう。

▲リストに戻る

endcinema（マクロ：シネマットモードを終了）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットモードを終了します。
このマクロは表裏の両方の画面に作用しますので、通常は暗転中に記述します。

▲リストに戻る

evimage（マクロ：イベントCG読み込み）

レイヤ操作
属性 必須？ 値 説明
grayscale no false（デフォルト）または true グレイスケールで読み込むかどうかを指定します（フルカラーの画像もグレイスケールに変換・表示されます）。省略するとfalseが指定された（そのまま読み込む）と見なされます。
layer no 0以上の整数値（デフォルト値：1） 読み込み先のレイヤ番号を指定します。省略すると1が指定されたと見なされます。
page no back（デフォルト）または fore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。
storage yes ファイル名 読み込む画像ファイルを指定します。

イベントCGを読み込むためのマクロです。
通常はstorageのみ、またはlayerとstorageのみを指定して、exbacklayマクロの後に記述します。

layer 属性の最大値はKAGのlaycountタグで指定されたレイヤ数に依存します。
鱧天標準では、フキダシモードのときは最大1、シネマットモードのときは4まで指定できます。
最大値を変更したい場合はprepcinemaマクロやendcinemaマクロの後にlaycountタグを記述してください。
いちいち指定するのが面倒な場合は、/data/scenario/KagRoutines/setmacro_text.ksを開いて、prepcinemaやendcinemaのマクロ定義を編集してみてください。

このマクロで読み込む画像の幅に制限はありませんので、0番レイヤを仮想的な背景レイヤと見なして、幅広な背景をパンするような用途にも使用します。
使用する画像は「/pict」フォルダに格納し、そこからの相対パスで指定してください。
（例）/pict/1-1.pngを読み込むには、[evimage storage="1-1"]と記述します。

▲リストに戻る

exbacklay（マクロ：拡張backlay）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

KAGのbacklayタグ（レイヤ情報の表ページから裏ページへのコピー）を拡張し、立ち絵オブジェクトなどの情報もコピーします。
鱧天ではbacklayの代わりにこちらを使用してください。

▲リストに戻る

exbutton（マクロ：効果音付きグラフィカルボタンの作成）

レイヤ操作
属性 必須？ 値 説明
graphic yes ファイル名 グラフィカルボタンに使用する画像ファイルを指定します。
hint no 文字列 選択状態になったときに表示されるヒントテキストを指定します。
target yes 文字列 ジャンプする先のラベルを指定します。

KAGのbuttonタグ（グラフィカルボタン）を簡易的にまとめた効果音付きグラフィカルボタンマクロです（メニュー関係効果音がある場合のみ音が鳴ります）。
graphicに指定する画像ファイルは「/graph/image」フォルダに格納してください。

このマクロで作成したボタンで別のシナリオファイルに直接ジャンプすることはできません。
ジャンプした先のラベルにscenejumpマクロを記述して任意のディレクションファイルへ飛ぶか、jumpタグを記述して任意のファイルへ飛ぶようにしてください。

▲リストに戻る

explaybgm（マクロ：拡張playbgm）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
start no 開始位置 ループチューナの再生開始位置を指定します。
loop no true（デフォルト）または false ループ再生するかどうかを指定します。省略するとtrueが指定されたと見なされます。
storage yes ファイル名 再生するBGMファイルを指定します。

KAGのplaybgmタグ（BGM の演奏）をまとめたマクロです。
このマクロは、読み込まれたタイミングで現在再生中のBGMファイルをチェックし、異なるファイルなら再生を開始するが同じファイルならplaybgmタグを無視する、という動作をします。

▲リストに戻る

fadeinenvsound（マクロ：環境音のフェードイン再生）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
buf no 0以上の整数値 再生に使用する効果音バッファを指定します。省略すると鱧天のデフォルト値（1）が使用されます。
loop no true（デフォルト）または false ループ再生を行うかどうかを指定します。省略するとtrueが指定されたと見なされます。
storage yes ファイル名 再生する音声ファイルを指定します。
time no 時間（ミリ秒） フェードイン時間を指定します。省略すると1500msが指定されたと見なされます。

KAGのfadeinseタグ（効果音のフェードイン再生）をまとめ、環境音（風の音など）の再生に特化させたマクロです。
explaybgmマクロと同様の働きをします。
このマクロはフェードインの終了を待ちませんので、必要に応じてwfenvsoundマクロを記述してください。

効果音バッファにデフォルト値以外を指定した場合は、sceneoutマクロでフェードアウトさせる環境音のバッファにも同じ値を指定するのを忘れないようにしましょう。

▲リストに戻る

fadeoutenvsound（マクロ：環境音のフェードアウト）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
buf no 0以上の整数値 再生に使用する効果音バッファを指定します。省略すると鱧天のデフォルト値（1）が使用されます。
time no 時間（ミリ秒） フェードイン時間を指定します。省略すると1500msが指定されたと見なされます。

KAGのfadeoutseタグ（効果音のフェードアウト）をまとめたマクロです。
働きはほぼ同じですが、環境音の再生バッファに鱧天のデフォルト値を指定している場合はこれを使う方が手間がかかりません。

▲リストに戻る

finishload（ローディング表示の終了）

システム操作
属性 必須？ 値 説明
auto no false（デフォルト）または true 自動的に非表示にするかどうかを指定します。falseにするとロード完了のダイアログが表示され、それをクリックしてからローディング表示が消えます。省略するとfalseが指定されたと見なされます。

最近のPCは速くなったのであまり目にする機会はないと思いますが、鱧天ではセーブデータのロード中に「now loading」の表示を行っています。
このタグはその表示を終了するものです。

多くの場合マクロなどで使用しているので、直接記述する機会は少ないと思いますが、title.ksをカスタマイズするときだけはちょっと注意してください（吉里吉里の「最初に戻る」が実質的にはロード処理のため）。

hide_selection（マクロ：選択肢ウィンドウを消去）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

show_selectionマクロで表示された選択肢ウィンドウを非表示にします。
通常はlinkタグで飛んだ先で呼び出します。
消去方法等をカスタマイズしたい場合は/data/scenario/KagRoutines/commonfunc.ksを開き、*hide_selectionサブルーチンを編集してください。

▲リストに戻る

hide_speaker（マクロ：会話ウィンドウを消去）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） フェードアウト時間を指定します。省略すると300msが指定されたと見なされます。

会話ウィンドウをクロスフェードで消去します。
このマクロはトランジションまで処理しますので、exbacklayせずに記述します。

▲リストに戻る

hsclear（立ち絵オブジェクトのリセット）

レイヤ操作
属性 必須？ 値 説明
on yes lead / left / center / rightのいずれか どの立ち絵を操作対象とするかを指定します。「lead」は主人公立ち絵（デフォルトは画面右下）、「left」「center」「right」はそれぞれいわゆる立ち絵の左、中央、右です。

指定された立ち絵の表示をリセットし、画面から消去します。
このタグは表裏両方の立ち絵オブジェクトに作用しますので、基本的には暗転後に使用してください。
トランジションを使って立ち絵を消したい場合はhsresetマクロを使用してください。

▲リストに戻る

hsimage（立ち絵オブジェクトへの画像設定）

レイヤ操作
属性 必須？ 値 説明
body no ファイル名 体の基本画像を指定します。省略可能ですが、すくなくとも最初の呼び出しのときは指定した方が良いでしょう。
exp1 no ファイル名 表情の上に乗る追加画像を指定します。
exp2 no ファイル名 表情の上に乗る追加画像を指定します。
face no ファイル名 表情画像を指定します。表情画像は基本的にアニメーション前提で呼び出されますが、「face1/01_a」という画像を呼び出す場合は「face1/01」と記述してください。
mat no ファイル名 立ち絵の上に重ねる特殊効果マットを指定します。このレイヤは一番上に乗算で重ねられます。
on yes lead / left / center / rightのいずれか どの立ち絵を操作対象とするかを指定します。「lead」は主人公立ち絵（デフォルトは画面右下）、「left」「center」「right」はそれぞれいわゆる立ち絵の左、中央、右です。
ware no ファイル名 表情の上に乗る装飾画像を指定します。
who yes フォルダ名 「/graph/fgimage」内に置いたキャラクター別フォルダを指定します。「/graph/fgimage/fujikawa」というフォルダなら「fujikawa」になります。

目パチをする立ち絵オブジェクトに画像を設定するタグです。
各画像は内部的に別のレイヤに読み込まれますが、重なりは、下からbody、face、ware、exp1、exp2の順です。
このタグは裏画面のオブジェクトにアクセスしますので、exbacklayした後に書いてください。

立ち絵の素材画像の作り方は二月のコラムをご参照ください。

▲リストに戻る

hsmove（立ち絵の自動移動）

レイヤ操作
属性 必須？ 値 説明
accel no -1 未満の数または 0(デフォルト) または 1 より大きい数 加速度的に動作させるかどうかを指定します。KAGのmoveタグのaccel属性と同じです。
on yes lead / left / center / rightのいずれか どの立ち絵を操作対象とするかを指定します。「lead」は主人公立ち絵（デフォルトは画面右下）、「left」「center」「right」はそれぞれいわゆる立ち絵の左、中央、右です。
path yes (x1,y1,opacity1) (x2,y2,opacity2) ... 移動パスを指定します。KAGのmoveタグのpath属性と同じです。
time yes 時間（ms単位） 移動時間を指定します。KAGのmoveタグのtime属性と同じです。

moveタグと同じように、立ち絵を自動移動させます。
移動終了を待つにはwmタグを使用してください（canskipをfalseにした方が安全です）。

▲リストに戻る

hsoption（立ち絵の表示設定変更）

レイヤ操作
属性 必須？ 値 説明
height no 0以上の整数 表示縦幅をピクセルで指定します。
index no 0以上の整数 レイヤの前後関係を指定します。
left no 整数 ウィンドウ左からの表示位置をピクセルで指定します。
on yes lead / left / center / rightのいずれか どの立ち絵を操作対象とするかを指定します。「lead」は主人公立ち絵（デフォルトは画面右下）、「left」「center」「right」はそれぞれいわゆる立ち絵の左、中央、右です。
opacity no 0～100の整数 不透明度を指定します。
top no 整数 ウィンドウ上からの表示位置をピクセルで指定します。
visible no true または false 表示するかどうかを指定します。
width no 0以上の整数 表示横幅をピクセルで指定します。

立ち絵オブジェクトの表示設定を変更します。
このタグは表裏両方のオブジェクトに作用します。

▲リストに戻る

hsreset（マクロ：立ち絵の消去）

レイヤ操作
属性 必須？ 値 説明
on no lead / left / center / rightのいずれか どの立ち絵を操作対象とするかを指定します。「lead」は主人公立ち絵（デフォルトは画面右下）、「left」「center」「right」はそれぞれいわゆる立ち絵の左、中央、右です。省略するとcenterが指定されたと見なされます。

hsimageタグをまとめ、指定した立ち絵を消去するマクロです。
正確には、指定した立ち絵オブジェクトの全レイヤに透明な画像（clearmat）を読み込むという動作をします。

このマクロは常に裏画面の立ち絵オブジェクトを操作しますので、通常はexbacklayマクロの後に記述します。

▲リストに戻る

init_persons（マクロ：会話ウィンドウと立ち絵のリセット）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

会話ウィンドウを消去し、すべての立ち絵オブジェクトをリセットします。
このマクロは表画面にも即反映されますので、通常はbcimageで画面を暗転させてから記述します。

▲リストに戻る

loadmovie（マクロ：動画読み込み）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
storage yes ファイル名 読み込む動画を指定します。この属性では拡張子まで含めて記述してください。

動画を読み込み、再生の準備をします。
このマクロが行うのは準備までで、再生はしません。
再生はplaymovieマクロで開始します。

動画はすべて「/movie」フォルダに格納してください。
また、playmovieの直前ではなく、クリックふたつ分くらい前に記述する方が無難です。

吉里吉里2は標準で複数の動画レイヤを扱うことができますが、このマクロでは常にひとつの動画のみを扱います。

▲リストに戻る

lr（マクロ：改行付き拡張l）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

xlマクロの後に改行するようにしたマクロです。

▲リストに戻る

playenvsound（マクロ：環境音再生）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
buf no 0以上の整数値 再生に使用する効果音バッファを指定します。省略すると鱧天のデフォルト値（1）が使用されます。
loop no true（デフォルト）または false ループ再生を行うかどうかを指定します。省略するとtrueが指定されたと見なされます。
storage yes ファイル名 再生する音声ファイルを指定します。

KAGのplayseタグ（効果音の再生）をまとめ、環境音（風の音など）の再生に特化させたマクロです。
explaybgmマクロと同様の働きをします。

効果音バッファにデフォルト値以外を指定した場合は、sceneoutマクロでフェードアウトさせる環境音のバッファにも同じ値を指定するのを忘れないようにしましょう。

▲リストに戻る

playmovie（マクロ：読み込み済みの動画を再生）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
afterimage no ファイル名 再生終了後に暗幕レイヤに配置しておく画像ファイルを指定します。省略した場合はblackmatが指定されたと見なされます。
canskip no true（デフォルト）または false 再生終了待ちをスキップするかどうかを指定します。既読シーンでない場合、この属性は無視され、常にスキップ不可となります。
sensitive no false（デフォルト）または true このマクロでは、既読シーンでメッセージスキップしている最中の再生指定は無視されますが、この属性をtrueにしておくと、無視されないようになります。

loadmovieマクロであらかじめ読み込まれている動画を再生します。
音声付きの動画の場合は、ユーザーがコンフィグで指定したBGM音量設定にボリュームが揃えられます。
なお、動画が読み込まれていない状態でこのマクロを記述するとエラーとなります。

再生終了後は暗幕レイヤに何らかの画像が表示されている状態になります。
鱧天のデフォルトでは、afterimageが省略されるとblackmatが表示され、画面が暗転した状態となりますので、bcimageで暗転解除してから続きへ進む形になります。

吉里吉里2は標準で複数の動画レイヤを扱うことができますが、このマクロでは常にひとつの動画のみを扱います。

▲リストに戻る

prepare_selection（マクロ：選択肢ウィンドウの準備）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

選択肢ウィンドウを準備します。
実際にどのようにして選択肢を作成するかは、二月のコラムをご覧ください。
また、背景画像として/graph/image/selectpanelを用意しておいてください。

このマクロはmessage0を使用します。

▲リストに戻る

prepcinema（マクロ：シネマットモードの準備）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットモードの準備をします。
このマクロは表裏の両方の画面に作用しますので、通常は暗転中に記述します。

このマクロでは、メッセージレイヤとしてf.mainMessageLayerに設定されたものを使用します。
鱧天のデフォルト値はmessage1です。

▲リストに戻る

prep_speaker（マクロ：会話ウィンドウの準備）

レイヤ操作
属性 必須？ 値 説明
marginr no 0以上の数値 会話ウィンドウ右側から実際に文字が表示される領域までのマージンを指定します。省略すると200が指定されたと見なされます。
page no back（デフォルト）または fore 表（fore）画面を対象とするか、裏（back）画面を対象とするかを指定します。省略すると裏画面が指定されたものと見なされます。
type no ファイル名 会話ウィンドウの画像ファイルを指定します。省略するとbltalkが指定されたと見なされます。

フキダシモードで使用する会話ウィンドウを準備します。
通常は裏画面に読み込んでトランジションで表示させますので、exbacklayした後に記述します。

会話ウィンドウはひとつのゲームでたくさん用意するようなものでもありませんので、マージンは右を除き固定になっています。
自分で会話ウィンドウ画像を作成した場合は、/data/scenario/KagRoutines/setmacro_text.ksを開き、prep_speakerのマクロ定義を適宜編集してください。
また、デフォルトの会話ウィンドウ画像（bltalk）は必ず/graph/imageフォルダに格納しておいてください。

このマクロでは、f.mainMessageLayerとf.mainNameLayerに指定されたメッセージレイヤを使用します。
鱧天のデフォルト値は、mainMessageLayerがmessage1、mainNameLayerがmessage2です。

▲リストに戻る

qsstate（クイックセーブメニューの表示等設定）

栞・通過記録操作
属性 必須？ 値 説明
enabled no true または false クイックセーブ機能を有効にするかどうかを設定します。
visible no true または false クイックセーブメニューを表示するかどうかを設定します。

本文を読んでいる間にクイックセーブを有効にするかどうか、また、クイックセーブメニューを画面に表示するかどうかを設定します。
このタグによる設定如何に拠らず、メッセージスキップ中は非表示となります。

xpマクロなどに組み込まれているため、基本的にはあまり意識する必要はありません。

▲リストに戻る

scbegin（再生シーン設定）

ラベル・ジャンプ操作
属性 必須？ 値 説明
chapter no 0以外の整数値 章番号を設定します。エンディングの場合は-1、それ以外の場合は1～を設定します。省略すると1章と見なされます。
scene yes 1以上の整数値 シーン番号を設定します。

鱧天ではシナリオを「ディレクションファイル」と「コンテンツファイル」に分けて管理します。
ディレクションファイルでシナリオの進行を規定し、実際の内容はコンテンツファイルに記述して呼び出す形です。
それぞれ、「/data/scenario/direction」フォルダと、「/data/scenario/content」フォルダに格納されます。

このタグはディレクションファイルに記述し、何章の何番シーンを再生するかを指定します。
例えば1章シーン1を再生するには、/data/scenario/direction/chapter1/1.ksに、[scbegin chapter="1" scene="1"]と記述します。
その後、sccallタグを記述すると、/data/scenario/contents/chapter1/1.ks に記述されたシナリオが呼び出されます。

▲リストに戻る

sccall（シーン内容呼び出し）

ラベル・ジャンプ操作
属性 必須？ 値 説明
chapter no 0以外の整数値 章番号を指定します。デフォルトではscbeginタグで指定された章番号が使われます。
scene no 1以上の整数値 シーン番号を指定します。デフォルトではscbeginタグで指定されたシーン番号が使われます。

ディレクションファイルに記述し、指定されたシーンの内容を呼び出します。
通常はscbeginタグとセットで使用し、属性値は記述しません。

呼び出されるコンテンツファイルは必ず*scene-startラベルから始まらなければなりません。
また、コンテンツファイルの末尾にはscreturnタグを記述し、元のディレクションファイルに戻ってこなければなりません。

▲リストに戻る

scenario_over（マクロ：エンディングからタイトルに戻る）

栞・通過記録操作
属性 必須？ 値 説明
指定可能な属性はありません

エンディングシーンのディレクションファイル末尾に記述し、タイトル画面へ戻るマクロです。
現バージョンではKAGのgotostartタグ（最初に戻る）を記述しているだけなので、そちらを使用しても構いません。

▲リストに戻る

scenejump（マクロ：シーンジャンプ）

ラベル・ジャンプ操作
属性 必須？ 値 説明
storage yes ファイル名 ジャンプするシーンを指定します。

KAGのjumpタグ（シナリオのジャンプ）をまとめ、指定したシーンのディレクションファイルへジャンプするマクロです。
ターゲットラベルを指定することはできません。

ジャンプ先は「/data/scenario/direction」フォルダからの相対パスで指定します。
（例）/data/scenario/direction/chapter1/1.ksへジャンプするには、[scenejump storage="chapter1/1.ks"]と記述します。

▲リストに戻る

sceneout（マクロ：シーン終了後の共通処理）

レイヤ操作
属性 必須？ 値 説明
bftime no 時間（ミリ秒） BGMのフェードアウト時間を指定します。省略すると3000msが指定されたと見なされます。
contbgm no false（デフォルト）または true シーン終了時にBGMをフェードアウトさせたくないときにtrueを指定します。省略するとfalseが指定されたと見なされます。
contse no false（デフォルト）または true シーン終了時に環境音をフェードアウトさせたくないときにtrueを指定します。省略するとfalseが指定されたと見なされます。
force no false（デフォルト）または true 選択後フラグが立っている（コンテンツファイルが選択肢で終了した）場合、通常このマクロは無視されますが、この属性をtrueにしておくと無視されなくなります。省略するとfalseが指定されたと見なされます。
mat no ファイル名 暗転に使用する画像ファイルを指定します。省略するとblackmatが指定されたと見なされます。指定できる画像はbcimageで使用できるものと同じです。
nolayerreset no false（デフォルト）または true trueを指定すると暗転後のinit_personsマクロとendcinemaマクロの実行を抑制します。省略するとfalseが指定されたものと見なされます。
sbuf no 0以上の整数値 環境音の鳴っている効果音バッファを指定します。省略すると鱧天のデフォルト値（1）が使用されます。
sftime no 時間（ミリ秒） 環境音のフェードアウト時間を指定します。省略すると2000msが指定されたと見なされます。
time no 時間（ミリ秒） クロスフェードトランジション時間を指定します。省略すると2000msが指定されたと見なされます。

ディレクションファイルのscfinishの後に記述し、画面の暗転やBGMのフェードアウトなど、シーンの後処理を行います。
コンテンツファイルが選択肢で終了した場合は、マクロ自体の実行が抑制されます。

▲リストに戻る

sceneprep（マクロ：シーン呼び出し前の共通処理）

システム操作
属性 必須？ 値 説明
設定可能な属性はありません

ディレクションファイルのscbeginとsccallの間に記述し、呼び出し前の共通処理を行います。
具体的には、バックログの有効化・クイックセーブの有効化・選択済みフラグの除去を行っています。

▲リストに戻る

scfinish（シーン終了宣言）

ラベル・ジャンプ操作
属性 必須？ 値 説明
設定可能な属性はありません

このタグはディレクションファイルに記述し、再生中のシーンの終了を宣言します。
通常はsccallタグよりも後に*scene-endラベルを置き、その直後に記述します。
このタグが読み込まれた時点で、そのシーンが既読に設定されます（次回以降シーンスキップが可能となります）。

▲リストに戻る

screturn（シーン内容からディレクションファイルへの復帰）

ラベル・ジャンプ操作
属性 必須？ 値 説明
chapter no 0以外の整数値 章番号を指定します。デフォルトでは現在再生中の章番号が使われます。
scene no 1以上の整数値 シーン番号を指定します。デフォルトでは現在再生中のシーン番号が使われます。

コンテンツファイルの末尾に記述し、呼び出し元のディレクションファイルへ戻ります。
通常は属性値無しで使用します。
このタグより後に記述された内容は再生されません。

戻り先のディレクションファイルには、sccallタグよりも後に、必ず*scene-endラベルが無ければなりません（そこへ戻る形になります）。

▲リストに戻る

scskip（シーン内のスキップ可否設定）

ラベル・ジャンプ操作
属性 必須？ 値 説明
enabled yes true または false type属性で指定された種別のスキップが可能かどうかを指定します。
type no scene（デフォルト）または message スキップの種別を指定します。省略するとシーンスキップ（scene）が指定されたと見なされます。

シーンスキップとメッセージスキップは、どちらも既読シーンでのみ有効となります。
このタグは、各スキップが有効なシーン中に、意図的にスキップを無効化したり、有効な状態に戻したりするために使用します。

▲リストに戻る

set_blackcinema（マクロ：シネマットを半透明黒にする）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットのマスクを半透明の黒にします。
通常は暗転中に記述します。

▲リストに戻る

setcinemacolor（シネマットのマスク色設定）

レイヤ操作
属性 必須？ 値 説明
color yes 0xから始まるアルファ値付き16進カラーコード（0xaarrggbb） マスク色を指定します。デフォルトは0x55000000（不透明度30%くらいの黒）です。

シネマットのマスク部分の色と透明度を指定します。
都度指定するより、first.ksで最初に指定するか、マクロでいくつかのバリエーションを用意しておくと良いでしょう。

鱧天標準ではset_blackcinemaマクロとset_tpcinemaマクロを用意しています。

▲リストに戻る

set_tpcinema（マクロ：シネマットを透明にする）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

シネマットのマスクを透明にします。
通常は暗転中に記述します。

▲リストに戻る

show_endlistitem（マクロ：エンディングリストの選択項目作成）

ラベル・ジャンプ操作
属性 必須？ 値 説明
hint no 文字列 選択状態になったときに表示されるヒントテキストを指定します。
id yes 1以上の整数値 エンディングのファイル番号を指定します。
number yes 整数値 エンディングの見かけ上の番号を指定します。
title yes 文字列 エンディング名を指定します。

KAGのlinkタグ（ハイパーリンク）をまとめ、エンディングリストの選択項目を作成します。
idとnumberの両方を指定するのは、制作上の都合でエンディングのファイル番号と見かけ上の番号が異なることが（Studio F#では）よくあるためです。
一致しているならもちろん同じ数値を指定しても問題ありません。

エンディングシナリオは、ディレクションファイル、コンテンツファイル共に「ending/1.ks」のような形で格納してください。
また、ここで挙げたエンディングの選択項目を作るには、id属性に1を指定します。

▲リストに戻る

show_selection（マクロ：選択肢ウィンドウの表示）

レイヤ操作
属性 必須？ 値 説明
設定可能な属性はありません

prepare_selectionマクロで用意した選択肢ウィンドウを表示します。
表示位置等をカスタマイズしたい場合は/data/scenario/KagRoutines/setmacro_test.ksを開き、show_selectionのマクロ定義を編集してください。

▲リストに戻る

show_speaker（マクロ：会話ウィンドウ表示）

レイヤ操作
属性 必須？ 値 説明
marginr no 0以上の数値 会話ウィンドウ右側から実際に文字が表示される領域までのマージンを指定します。省略すると200が指定されたと見なされます。
type no ファイル名 会話ウィンドウの画像ファイルを指定します。省略するとbltalkが指定されたと見なされます。

フキダシモードで使用する会話ウィンドウを表示します。
このマクロは指定した画像を裏画面に読み込み、トランジションまで行いますので、exbacklayせずに記述します。

会話ウィンドウはひとつのゲームでたくさん用意するようなものでもありませんので、マージンは右を除き固定になっています
自分で会話ウィンドウ画像を作成した場合は、/data/scenario/KagRoutines/setmacro_text.ksを開き、show_speakerのマクロ定義を適宜編集してください。
また、デフォルトの会話ウィンドウ画像（bltalk）は必ず/graph/imageフォルダに格納しておいてください。

このマクロでは、f.mainMessageLayerとf.mainNameLayerに指定されたメッセージレイヤを使用します。 鱧天のデフォルト値は、f.mainMessageLayerがmessage1、f.mainNameLayerがmessage2です。

▲リストに戻る

startcinema（マクロ：シネマットの表示設定）

レイヤ操作
属性 必須？ 値 説明
height no 0以上の数値 シネマット開口部の縦幅を指定します。省略すると400が指定されたと見なされます。
left no 0以上の数値 シネマット開口部の左の開始位置を指定します。省略すると0が指定されたと見なされます。
top no 0以上の数値 シネマット開口部の上の開始位置を指定します。省略すると50が指定されたと見なされます。
width no 0以上の数値 シネマット開口部の横幅を指定します。省略すると800が指定されたと見なされます。
theight no 0以上の数値 字幕部分の縦幅を指定します。省略すると145が指定されたと見なされます。
tleft no 0以上の数値 字幕部分の左の開始位置を指定します。省略すると84が指定されたと見なされます。
ttop no 0以上の数値 字幕部分の上の開始位置を指定します。省略すると470が指定されたと見なされます。
twidth no 0以上の数値 字幕部分の横幅を指定します。省略すると664が指定されたと見なされます。

シネマットの表示設定と、字幕部分の表示設定を同時に行うマクロです。
このマクロはprepcinemaマクロを前提として裏画面を操作しますので、通常はprepcinema及びexbacklayした後に記述します。
いくつかあるバリエーションも同様です。

もしウィンドウサイズを変更した場合は、/data/scenario/KagRoutines/setmacro_text.ksを開き、startcinemaのマクロ定義を適宜編集してください。

▲リストに戻る

startcinema_15lines（マクロ：字幕全画面のシネマットを表示）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

startcinemaマクロをまとめ、字幕が15行（全画面）あるシネマットを表示します。
全画面に字幕が乗っている感じになります。

▲リストに戻る

startcinema_6lines（マクロ：字幕6行のシネマットを表示）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

startcinemaマクロをまとめ、字幕が6行あるシネマットを表示します。
およそ画面下部の1/3くらいが字幕になっている感じです。

▲リストに戻る

startcinema_0lines（マクロ：字幕のないシネマットを表示）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

startcinemaマクロをまとめ、字幕の無いシネマットを表示します。
背景やイベントCGが全面に表示されている状態で暗転解除し、その後begintalkマクロやbeginstoryマクロで字幕を表示させるようなときに使用します。

▲リストに戻る

start_speak（マクロ：本文表示開始宣言）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

本文表示の開始を宣言するマクロです。
コンテンツファイルの最初のトランジション直後や、選択肢後に本文を表示する前に記述します。
フキダシモード、シネマットモード共通です。

▲リストに戻る

trans_change（マクロ：汎用的な短時間トランジション）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） トランジションにかける秒数を指定します。デフォルトは200msです。

KAGのクロスフェードトランジションの指定をまとめ、統一的に呼び出せるようにしたマクロです。
立ち絵の表情変更のときなどに使用します。

▲リストに戻る

trans_scene（マクロ：汎用的な長時間トランジション）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） トランジションにかける秒数を指定します。デフォルトは1200msです。

KAGのクロスフェードトランジションの指定をまとめ、統一的に呼び出せるようにしたマクロです。
シーン中での軽めの場面転換や、フキダシモードとシネマットモードの切り替え時などに使用します。

▲リストに戻る

trans_show（マクロ：イベントCGの表示等に使用するトランジション）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） トランジションにかける秒数を指定します。デフォルトは300msです。
rule no ファイル名 ユニバーサルトランジションに使用するルール画像を指定します。デフォルトはsplite_lrです。

KAGのユニバーサルトランジションの指定をまとめ、主にイベントCGの表示に使用するマクロです。
rule属性で指定するルール画像は「/graph/rule」フォルダに格納してください。

鱧天のデフォルト設定はあくまで一例ですので、/data/scenario/KagRoutines/setmacro_image.ksを開き、trans_showのマクロ定義を編集して、お好みな感じにすると良いでしょう。

▲リストに戻る

trans_summon（マクロ：立ち絵の表示等に使用するトランジション）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） トランジションにかける秒数を指定します。デフォルトは300msです。
rule no ファイル名 ユニバーサルトランジションに使用するルール画像を指定します。デフォルトはsplite2です。

KAGのユニバーサルトランジションの指定をまとめ、主に立ち絵の表示に使用するマクロです。
rule属性で指定するルール画像は「/graph/rule」フォルダに格納してください。

鱧天のデフォルト設定はあくまで一例ですので、/data/scenario/KagRoutines/setmacro_image.ksを開き、trans_summonのマクロ定義を編集して、お好みな感じにすると良いでしょう。

▲リストに戻る

trans_wipe（マクロ：汎用的なワイプトランジション）

レイヤ操作
属性 必須？ 値 説明
time no 時間（ミリ秒） トランジションにかける秒数を指定します。デフォルトは700msです。

wipe_lrをルール画像に使用したユニバーサルトランジションをまとめ、統一的に呼び出せるようにしたマクロです。
左から右に向けてワイプします。
シーン中の場面転換などに使用します。

▲リストに戻る

wfenvsound（マクロ：環境音のフェード待ち）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
buf no 0以上の整数値 再生に使用する効果音バッファを指定します。省略すると鱧天のデフォルト値（1）が使用されます。

KAGのwfタグ（効果音フェードの終了待ち）をまとめたマクロです。
働きはほぼ同じですが、環境音の再生バッファに鱧天のデフォルト値を指定している場合はこれを使う方が手間がかかりません。

▲リストに戻る

xl（マクロ：拡張l）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

KAGのlタグ（行末クリック待ち）をまとめ、コンフィグで文字表示速度を最速にしている場合にクリック待ちを無視するようにしたマクロです。
お好みに応じて使用してください。

▲リストに戻る

xp（マクロ：拡張p）

メッセージ操作
属性 必須？ 値 説明
設定可能な属性はありません

KAGのpタグ（改ページクリック待ち）をまとめ、クイックセーブメニューの表示などいくつかの記述をまとめたマクロです。
鱧天ではpの代わりにこちらを使用してください。

▲リストに戻る

xws（拡張ws）

効果音・BGM・ビデオ操作
属性 必須？ 値 説明
buf no 0以上の整数値 対象となる効果音バッファを指定します。
canskip no true（デフォルト）または false 再生終了待ちをスキップ可能とするかどうかを指定します。省略するとtrueが指定されたと見なされます。

KAGのwsタグ（効果音再生の終了待ち）をまとめ、canskipのデフォルト値をtrueにしたマクロです。

▲リストに戻る

xwt（マクロ：拡張wt）

レイヤ操作
属性 必須？ 値 説明
canskip no true（デフォルト）または false クリックでトランジションの終了待ちをスキップ可能かどうかを指定します。詳細はKAG リファレンスのwtの項目をご覧ください。

KAGのwtタグ（トランジションの終了待ち）を拡張し、トランジション後に立ち絵レイヤ等の処理を追加します。
鱧天ではwtタグの代わりにこちらを使用してください。

▲リストに戻る