AIRNovel(テンプレート専用の)マクロ リファレンス
はじめに
- サンプルゲームのソースとして配布しているマクロは全てMIT Licenseです。自由に改変してご活用ください。
- マクロは組み込みタグを組み合わせたものです。自由に改変・追加することができますが、アップデート時に上書きしないようバックアップを推奨します。
- 「sub.an内で定義」とあるマクロは一度「[call fn="sub"]」とする事で定義し、使用できるようになります。「_yesno.an内で定義」なら同様に「[call fn="_yesno"]」です。
- sub.an冒頭の定数はシステム画面などのボタン押下効果音です。ご自分のゲームによって変更してください。立ち絵配置位置定数も同様です。
- (タグと同じく)全てのマクロには属性condが指定でき、指定した場合は「評価結果が真(true)の時のみタグを処理する」という条件分岐が可能です。
- その他はタグリファレンスの「はじめに」と同様です。
- 【2013/01/16追記】サンプルゲームの「再起動時に元の場所から再開する機能」はマクロにより実現しています。最初から再開したい場合は【タイトルへ戻って終了→アプリ再起動】か【どこでも終了→アプリ再起動時にESCキーを押しっぱなし】して下さい。
フレームワーク
プレイヤーに「はい」「いいえ」等の二択で確認を行なう。
プレイヤーが押下した結果をtmp:_yesnoに「y」か「n」で返す。
ボタン素材としてファイル名がMnu_btnOK・Mnu_btnCancelの画像ファイルと、
ダイアログ素材としてファイル名が_yesnoの画像ファイルを使用する
プレイヤーが押下した結果をtmp:_yesnoに「y」か「n」で返す。
ボタン素材としてファイル名がMnu_btnOK・Mnu_btnCancelの画像ファイルと、
ダイアログ素材としてファイル名が_yesnoの画像ファイルを使用する
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
mes | y | String | プレイヤーに質問したい文言 |
引数無し。
タイトルからゲーム本編を開始する際の処理を行なう。
シナリオファイル冒頭に記述するべき。
タイトルからゲーム本編を開始する際の処理を行なう。
シナリオファイル冒頭に記述するべき。
引数無し。
ゲーム本編を開始する際の処理を行なう。
タイトルから本編、あるいはしおりロードから本編を開始する際に呼ぶ。
クリック待ち記号、フォント、セーブロード・設定画面などを準備する。
ゲーム本編を開始する際の処理を行なう。
タイトルから本編、あるいはしおりロードから本編を開始する際に呼ぶ。
クリック待ち記号、フォント、セーブロード・設定画面などを準備する。
システム
アプリ開始時やゲーム本編からタイトルに戻る際の処理を行なう
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
time | y | 整数値 | 0.0〜 | 指定した文字数 x 文字表示ウェイト 分のウェイトを行なう |
文字・文字レイヤ
改ページと関連処理を行なう。
改ページ記号を表示する前に「自動読み進み状態で」「音声が再生中」なら音声再生終了を待つ。
改ページ記号を表示しクリックを待ち、
押下後[er](テキストを消去)し[record_place](ゲーム状態をバッファに退避)する。
「履歴画面で選択位置から再開する」機能は配布状態では無効になっている。
『; [h_ss_upd] ; 〜』
『; [h_save] ; 〜』
のコメントを外し、シナリオファイル最初の[grp]直後に[h_save]を置くと有効になる。
改ページ記号を表示する前に「自動読み進み状態で」「音声が再生中」なら音声再生終了を待つ。
改ページ記号を表示しクリックを待ち、
押下後[er](テキストを消去)し[record_place](ゲーム状態をバッファに退避)する。
「履歴画面で選択位置から再開する」機能は配布状態では無効になっている。
『; [h_ss_upd] ; 〜』
『; [h_save] ; 〜』
のコメントを外し、シナリオファイル最初の[grp]直後に[h_save]を置くと有効になる。
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
no_voice_stop | n | false | Boolean | trueなら改ページ後、音声(バッファ名「音声」の効果音)をフェードアウトしない |
no_se_stop | n | false | Boolean | trueなら改ページ後、効果音(バッファ名「SE」の効果音)をフェードアウトしない |
visible | n | true | Boolean | trueで改ページ記号を表示、falseで非表示 |
文字レイヤを設定する。サンプルゲーム「櫻の樹の下には」の設定。
このマクロで文字レイヤ(page=back)に設定しておき、
[grp]で場面転換と共に文字レイヤの設定を変えるような使い方をする
このマクロで文字レイヤ(page=back)に設定しておき、
[grp]で場面転換と共に文字レイヤの設定を変えるような使い方をする
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
layer | n | mes | レイヤ名 | 処理対象の文字レイヤ |
page | n | back | fore、back | ページの裏表 |
visible | n | true | Boolean | true:表示、false:非表示 |
l | n | 40 | 整数値 | テキストウインドウの左端横座標 |
w | n | 292 | 整数値 | テキストウインドウの横幅 |
pl | n | 属性l + 26 | 整数値 | テキストウインドウの左端から内側方向への、文字表示領域との間隔 |
pt | n | 66 | 整数値 | テキストウインドウの上端から内側方向への、文字表示領域との間隔 |
pr | n | 画面横幅 -(属性l +属性w ) + 26 | 整数値 | テキストウインドウの右端から内側方向への、文字表示領域との間隔 |
pb | n | 66 | 整数値 | テキストウインドウの下端から内側方向への、文字表示領域との間隔 |
fcol | n | 0xffffff | 色指定。0x000000など | テキスト色 |
b_color | n | 0x000000 | 色指定。0x000000など | テキストウインドウの背景色 |
b_alpha | n | sys:TextLayer.Back.Alpha | 0.0〜1.0(実数) | テキストウインドウの背景の透過度。 0(完全透明)〜0.5(半透明)〜1(不透明) |
文字レイヤを設定する。「txt_lay_v_left(テキストレイヤ縦書き左設定)」を画面中央に移動したもの。
「txt_lay_v_left(テキストレイヤ縦書き左設定)」の設定に加え以下指定を行なったもの
「txt_lay_v_left(テキストレイヤ縦書き左設定)」の設定に加え以下指定を行なったもの
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
l | n | 366 | 整数値 | テキストウインドウの左端横座標 |
文字レイヤを設定する。「txt_lay_v_center(テキストレイヤ縦書き中設定)」を画面中央に移動し、幅を広げたもの。
「txt_lay_v_center(テキストレイヤ縦書き中設定)」の設定に加え以下指定を行なったもの
「txt_lay_v_center(テキストレイヤ縦書き中設定)」の設定に加え以下指定を行なったもの
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
l | n | 294 | 整数値 | テキストウインドウの左端横座標 |
w | n、固定 | 436 | 整数値 | テキストウインドウの横幅 |
文字レイヤを設定する。全画面を覆うような設定
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
layer | n | mes | レイヤ名 | 処理対象の文字レイヤ |
page | n | back | fore、back | ページの裏表 |
visible | n | true | Boolean | true:表示、false:非表示 |
l | n | 16 | 整数値 | テキストウインドウの左端横座標 |
w | n | 画面横幅 -16 *2 | 整数値 | テキストウインドウの横幅 |
pl | n | 28 | 整数値 | テキストウインドウの左端から内側方向への、文字表示領域との間隔 |
pt | n | 42 | 整数値 | テキストウインドウの上端から内側方向への、文字表示領域との間隔 |
pr | n | 639 | 整数値 | テキストウインドウの右端から内側方向への、文字表示領域との間隔 |
pb | n | 479 | 整数値 | テキストウインドウの下端から内側方向への、文字表示領域との間隔 |
fcol | n | 0xffffff | 色指定。0x000000など | テキスト色 |
b_color | n | 0x000000 | 色指定。0x000000など | テキストウインドウの背景色 |
b_alpha | n | sys:TextLayer.Back.Alpha | 0.0〜1.0(実数) | テキストウインドウの背景の透過度。 0(完全透明)〜0.5(半透明)〜1(不透明) |
文字レイヤ mes_sysmenu に表示するシステムメニューを設定する。
このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。
このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
no_sysmenu_draw | n | なにもしない | Boolean | trueを指定すると、次の[grp]などでの文字レイヤ[trans]などでシステムメニューを表示しない |
文字レイヤ mes_sysmenu に表示するシステムメニューを設定する。
このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。
このマクロを改造し、ボタンの画像変更・位置変更・増減を行える。
画像・画像レイヤ
(拡張機能になり、解説は拡張機能ギャラリー【クロスフェードでレイヤ画像を変更】に移動しました)
文字レイヤをフェードアウトし、
クロスフェードしながら背景画像(レイヤ名baseの画像レイヤ)を変更、
前景レイヤ(レイヤ名0〜2の画像レイヤ)をクリアor画像変更し、
文字レイヤをフェードインする。
クロスフェードしながら背景画像(レイヤ名baseの画像レイヤ)を変更、
前景レイヤ(レイヤ名0〜2の画像レイヤ)をクリアor画像変更し、
文字レイヤをフェードインする。
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
bg | y | 何もしない | 画像ファイル名 | 背景レイヤに対する画像ファイルを指定する |
fb | n | 何もしない | [add_face]で登録した差分画像(半角カンマ区切りで複数可能) | 背景レイヤに対する差分画像ファイルを指定する |
l0 | n | クリアする | 画像ファイル名 | 前景レイヤ0に対する画像ファイルを指定する |
f0 | n | 何もしない | [add_face]で登録した差分画像(半角カンマ区切りで複数可能) | 前景レイヤ0に対する差分画像ファイルを指定する |
pos0 | n | c | c、横座標 | 前景レイヤ0に対する横座標を指定する。 |
left0 | n | 0(pos指定が優先) | 画面左上を(0, 0)とする座標 |
前景レイヤ0に対する表示座標を指定する。 ※left使用時はtopも必須です |
top0 | ||||
o0 | n | 何もしない | 0.0〜1.0(実数) |
前景レイヤ0に対するレイヤの透過度。 0(完全透明)〜0.5(半透明)〜1(不透明) |
l1 | n | クリアする | 画像ファイル名 | 前景レイヤ1に対する画像ファイルを指定する |
f1 | n | 何もしない | [add_face]で登録した差分画像(半角カンマ区切りで複数可能) | 前景レイヤ1に対する差分画像ファイルを指定する |
pos1 | n | c | c、横座標 | 前景レイヤ1に対する横座標を指定する。 |
left1 | n | 0(pos指定が優先) | 画面左上を(0, 0)とする座標 |
前景レイヤ1に対する表示座標を指定する。 ※left使用時はtopも必須です |
top1 | ||||
o1 | n | 何もしない | 0.0〜1.0(実数) |
前景レイヤ1に対するレイヤの透過度。 0(完全透明)〜0.5(半透明)〜1(不透明) |
l2 | n | クリアする | 画像ファイル名 | 前景レイヤ2に対する画像ファイルを指定する |
f2 | n | 何もしない | [add_face]で登録した差分画像(半角カンマ区切りで複数可能) | 前景レイヤ2に対する差分画像ファイルを指定する |
pos2 | n | c | c、横座標 | 前景レイヤ2に対する横座標を指定する。 |
left2 | n | 0(pos指定が優先) | 画面左上を(0, 0)とする座標 |
前景レイヤ2に対する表示座標を指定する。 ※left使用時はtopも必須です |
top2 | ||||
o2 | n | 何もしない | 0.0〜1.0(実数) |
前景レイヤ2に対するレイヤの透過度。 0(完全透明)〜0.5(半透明)〜1(不透明) |
rule | n | 画面全体ピクセルで同時にクロスフェードする | 画像ファイル名(swf不可) | [trans]と同じ |
その他[trans]と同じ属性 | ||||
time | n | 1000 | ミリ秒 | 背景・前景の画像レイヤ変化にかける時間 |
txt_time | n | 300 | ミリ秒 | 文字レイヤ変化にかける時間 |
nofo_txt | n | false | Boolean | trueなら文字レイヤをフェードアウトしない |
nofi_txt | n | false | Boolean | trueなら文字レイヤをフェードインしない |
se | n | 何もしない | 効果音ファイル名 | 場面転換と同時に再生する効果音 |
BGM・効果音
BGMをクロスフェードする。
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
fn | y | BGM音声ファイル名 | 再生する音声ファイル名 | |
time | n | 再生中の曲を瞬時に停止し、指定曲を即座に再生する | ミリ秒 | 変化にかける時間 |
効果音を再生
[playse]に引数省略時音声停止機能を付けたもの。
属性 | 必須 | 省略時 | 値域・型 | コメント |
---|---|---|---|---|
fn | n | 音声停止 | 音声ファイル名 | 再生する音声ファイル名 |
buf | n | 音声 | 効果音を識別するトラック名 | トラック名を変えれば同時に複数の音を操作することが出来ます |
履歴画面
引数無し。
履歴画面、台詞クリックで再度音声再生する機能を提供する。タグで台詞を囲む。
例)
[voice fn="音声ファイル"]
[h_voice]「はい」[end_h_voice]@
履歴画面、台詞クリックで再度音声再生する機能を提供する。タグで台詞を囲む。
例)
[voice fn="音声ファイル"]
[h_voice]「はい」[end_h_voice]@
引数無し。
履歴画面、台詞クリックで再度音声再生する機能を提供する。タグで台詞を囲む。
例)
[voice fn="音声ファイル"]
[h_voice]「はい」[end_h_voice]@
履歴画面、台詞クリックで再度音声再生する機能を提供する。タグで台詞を囲む。
例)
[voice fn="音声ファイル"]
[h_voice]「はい」[end_h_voice]@