SKYNovel タグリファレンス

SKYNovel Tag Reference

変数操作

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

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

引数無し

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

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

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

[let] 変数代入・演算

変数に値を代入する。

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

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyStringセットする値
cast出来るだけ数値変換(コメントを参照)値をセットする際の型。
num……数値(実数)。「01」は数値の1となる。
int……数値(符合付き整数)
uint……数値(符合なし整数)
bool……Boolean
str……文字列。「01」は「01」のまま。
[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]絶対値

絶対値を求める

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyNumber絶対値を求める数
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

[let_char_at] 文字列から一字取りだし

文字列中の一文字を取り出す

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString元になる文字列
pos00(先頭)〜何番目の文字を取り出すか
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

[let_index_of]文字列で検索

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

属性必須省略時値域・型コメント
nameyString(変数名書式※)位置を代入する変数名。-1の場合は見つからなかった
textyString元になる文字列
valyString探す文字列
start00(先頭)〜検索を開始する位置
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

[let_length]文字列の長さ

文字列の長さを求める

属性必須省略時値域・型コメント
nameyString(変数名書式※)長さを代入する変数名
textyString長さを求める文字列。長さをセットする
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

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

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

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名

[let_replace]正規表現で置換

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

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString置換対象の文字列
regyString正規表現
flags(なし)String正規表現のフラグ
valyString置き換える文字列
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

[let_round]四捨五入

四捨五入する

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyNumber四捨五入する数
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

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

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString検索対象の文字列
regyString正規表現
flags(なし)String正規表現のフラグ
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

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

文字列の一部を取り出す

属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString元になる文字列
pos00(先頭)〜
または
〜-1(末尾)
何番目の文字から取り出すか。
負の値なら「後ろから何個目か」。-1が最後の文字。
【pos=-3 len=all】とすると、後ろから3文字を取り出す。
len1文字数、または all何文字取り出すか。all でpos以降の全て
cast出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

レイヤ共通

[add_lay]レイヤを追加する

レイヤを追加する。

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

属性必須省略時値域・型コメント
layeryStringレイヤ名を指定する。
未使用のレイヤ名でなければエラー&アプリ停止
classygrp(画像レイヤ)、
txt(文字レイヤ)、
またはプラグインで追加した値
レイヤの種類
(その他)[lay]に指定できる属性

[clear_lay]レイヤ設定の消去

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

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

属性必須省略時値域・型コメント
layer全てのレイヤレイヤ名(半角カンマ区切りで複数レイヤを指定可能)
pageforefore、back、bothページの裏表(both指定で両面)
filterfalseBooleantrue:フィルタもクリア

[finish_trans] トランス強制終了

引数無し。

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

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

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

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

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
visible現在値Booleantrue:表示、false:非表示
alpha1.00.0〜1.0(実数)レイヤの透過度。0(完全透明)〜0.5(半透明)〜1(不透明)
blendmode何もしないブレンドモード名("screen"など)このレイヤと下のレイヤとの重なりにおいて、
ドット単位で色のブレンド演算を行なう。
詳細はblendModeの解説を参照。
posc※c、l、r、横座標主に立ち絵に使う。横と縦座標を同時に設定する。
横座標は指定した値(文字cの場合は画面中央、lは左寄り、rは右寄り)に設定し、画像下端を画面下端に接するように自動計算する。
left0画面左上を(0, 0)とする横座標※レイヤやボタン左端の画面左端からの距離
center(↑と同じ)(↑と同じ)レイヤやボタン中央の画面左端からの距離
right(↑と同じ)(↑と同じ)レイヤやボタン右端の画面左端からの距離
s_right(↑と同じ)(↑と同じ)レイヤやボタン右端の画面右端からの距離
top0画面左上を(0, 0)とする縦座標※レイヤやボタン上端の画面上端からの距離
middle(↑と同じ)(↑と同じ)レイヤやボタン中央の画面上端からの距離
bottom(↑と同じ)(↑と同じ)レイヤやボタン下端の画面上端からの距離
s_bottom(↑と同じ)(↑と同じ)レイヤやボタン下端の画面下端からの距離
rotation0-180〜180回転角を度単位で指定。時計回りは0~180、反時計回りは0~-180を指定。 左上を中心に回る
scale_x1.0正負の実数値横方向を何倍に拡大/縮小するか。負の値ならレイヤを左右反転
scale_y(↑と同じ)(↑と同じ)縦方向を何倍に拡大/縮小するか。負の値ならレイヤを上下反転
float何もしないBooleantrue:レイヤを最前面に移動する。
※最前面とは、Flashのstage.addChildにおける重なり順
index何もしない0〜レイヤをindexで指定したインデックスに移動する。
※インデックスは、FlashのStage.setChildIndex()を参照。
dive何もしないレイヤ名レイヤをdiveで指定したレイヤのすぐ後ろに潜り込ませる。
「plg:プラグイン名」と記述する事でプラグインも指定できる。

blendModeの解説

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

Photoshop ブレンドモード名AIRNovel での blendmode 属性の値ActionScript での blendmode 値コメント
加算(使えない)add 表示オブジェクトの要素カラーの値を背景色に加算し、その際に上限 0xFF を適用します。
アルファ(使えない)alpha 表示オブジェクトの各ピクセルのアルファ値を背景に適用します。
比較 (暗)この値→darken 表示オブジェクトの要素カラーと背景色のうち暗い方(値が小さい方)の色を選択します。
差の絶対値この値→difference表示オブジェクトの各ピクセルのアルファ値を 背景に適用します。
消去(使えない)erase 表示オブジェクトのアルファ値に基づいて背景を消去します。
ハードライトこの値→hardlight 表示オブジェクトの暗さに基づいて、各ピクセルの色を調整します。
反転(使えない)invert 背景を反転します。
(なし)(使えない)layer 表示オブジェクトに関する透明度グループを強制的に作成します。
比較 (明)この値→lighten 表示オブジェクトの要素カラーと背景色のうち明るい方(値が大きい方)の色を選択します。
乗算この値→multiply 表示オブジェクトの要素カラーの値と背景色の要素カラーの値を乗算した後、0xFF で割って正規化し、色を暗くします。
標準この値→normal 表示オブジェクトは、背景の前に表示されます。(なにもしない)
オーバーレイこの値→overlay 背景の暗さに基づいて、各ピクセルの色を調整します。
スクリーンこの値→screen 表示オブジェクトの色の補数(逆)と背景色の補数を乗算して、ブリーチ効果を得ます。
(なし)(使えない)shader シェーダーを使用して、オブジェクト間のブレンドを定義します。
減算(使えない)subtract 結果の下限を 0 として、表示オブジェクトの要素カラーの値をその背景色の値から減算します。

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

属性必須省略時値域・型コメント
max_col現在値1〜ページあたりの表示列数(横書き時は上から下、縦書き時は右から左へ数える)
改行・禁則処理に使用。実際に文字が表示されるかは、フォントサイズや表示位置との兼ね合いによる。
初期値は 10
max_row現在値1〜ページあたりの表示行数。初期値は 10
bura_col現在値0〜禁則時ぶら下がり文字数。初期値は 2
chk_overrow現在値Booleantrue:カーソルがmax_rowを超えたらエラー&停止(初期値)
false:表示行数を越える直前に自動改ページ
b_left現在値画面左上を(0, 0)とする座標テキスト背後の矩形表示位置。
初期値はそれぞれ 16 16
b_top(↑と同じ)(↑と同じ)(↑と同じ)
b_width(↑と同じ)矩形表示縦横ピクセル数テキスト背後の矩形表示縦横サイズ。
初期値はそれぞれ(画面横幅 - b_left *2)(画面縦幅 - b_top *2)
b_height(↑と同じ)(↑と同じ)(↑と同じ)
b_color(↑と同じ)色指定。0x000000などテキスト背後の矩形色。初期値は 0x000000(黒)
b_alpha(↑と同じ)実数:0.0(透明)〜1.0(不透過)テキスト背後の矩形不透明度。
表示しない場合は0を指定。初期値は 0
b_pic(↑と同じ)画像ファイル名文字レイヤ背後の枠画像を指定する。b_top、b_left、b_alphaの影響を受ける。
(これを指定するとb_colorは無視される)
back_clear現在値Booleantrue:背景をクリアする
b_alpha_isfixed現在値Booleantrue:テキスト背後の矩形不透明度を、「b_alpha属性と sys:TextLayer.Back.Alpha の掛け算とせず」、b_alpha属性値そのものにする。(これは2017/2/13以前の仕様)
draggablefalseBooleantrue:テキスト背後の矩形をドラッグできる
drag_x0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_y0(↑と同じ)(↑と同じ)
drag_w画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_h画面縦幅(↑と同じ)(↑と同じ)
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label(↑と同じ)(↑と同じ)(↑と同じ)(↑と同じ)
dragmove_argString指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる
h_scrollピクセル数横スクロールさせる量
v_scrollピクセル数縦スクロールさせる量
mouse_wheel_enabledBooleanマウスホイールでスクロール許可するか否か
layout現在値String文字レイヤのレイアウトを指定する。
文法はFlex SDK 4のTLF (Text Layout Framework)・TextFlowのXML指定による。
※「TLFのXML指定」と言われても良く判らないでしょうし、こちらのサイト(Text Layout Editor Demo Application - Adobe Labs)で色々いじってみて、下の【Markup...】ボタンで出てくるXMLを参考にして下さい。

このlayoutという属性の中にTLF属性群を入れ子状に記述する。
例えば、blockProgressionで縦書き・横書きを指定できる。
設定しないTLF属性は現在値を継続する。
初期値は空(から)、全くの未指定。

駆使すると、「文字表示領域矩形内に自動で文字を並べる」事なども出来ます
onend現在値(コメントで解説)行末禁則処理を指定する。(全文字レイヤで設定を共有)
warning …… 行末禁則・Warning処理
nop …… 何もしない
enter …… 行末禁則・追い込み処理
leave …… 行末禁則・追い出し処理(初期値)
end現在値String行末禁則処理対象の文字群を指定する。(全文字レイヤで設定を共有)
初期値は……[({〈「『【〔“〝
bura現在値Stringぶら下がり処理対象の文字群を指定する。(全文字レイヤで設定を共有)
「、」「。」などを連結した文字列。
初期値は……
、。,.)]}〉」』】〕”〟ぁぃぅぇぉっゃゅょゎァィゥェォッャュョヮヵヶ!?!?‼⁉・ーゝゞヽヾ々
onsplit
dont_sprit現在値String分割禁止処理対象の文字群を指定する。(全文字レイヤで設定を共有)
初期値は「─(ダーシ)」「‥(二点リーダ)」「…(三点リーダ)」
r_color現在値色指定。0x000000などルビの文字色。初期値は 0xFFFFFF
r_size現在値1〜ルビ文字サイズ。初期値は 12
r_shift現在値正負の整数ルビ文字を親文字から何ピクセル離すか。
値の正負と縦書き横書きの関係は、TLFのBaselineShiftに従う。初期値は 0
r_align現在値(コメントで解説)ルビ揃えを指定する。
left ……(肩付き)先頭親文字から、ルビ間は密着
center ……(中付き)センター合わせ、〃
right ……(右/下揃え)末尾親文字から、〃
justify ……(両端揃え)先頭から末尾親文字間に、ルビ間は均等にあける
121 ……(1-2-1(JIS))ルビの前後を比率1、ルビ間を比率2であける
even ……(均等アキ)ルビの前後、ルビ間も均等にあける
1ruby ……(1ルビ文字アキ)ルビの前後をルビ一文字空け、ルビ間は均等にあける

初期値は center。

※leftやright以外において、親文字よりルビの方が長い場合は、親文字に対する「中付き」表示になる

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

属性必須省略時値域・型コメント
fny何もしない画像ファイル名基本画像ファイルを指定する
face何もしない[add_face]で登録した差分画像(半角カンマ区切りで複数可能)差分画像ファイルを指定する。
[fg fn="a" face="b,c,d"]なら「基本a」の上に「差分b」を重ね、「差分c」を重ね、「差分d」を重ねる。

【注意】fnは同じでface属性だけを指定→指定なしにした場合、表示が変わりませんが不具合ではありません。 「face属性指定なし」は「何もしない」、つまり変化させないからです。
[fg layer=upd fn="a" face="b"]
[l]
[fg layer=upd fn="a"]
[l]

差分画像を無くしたい場合、明確に空文字("")を指定します。
[fg layer=upd fn="a" face="b"]
[l]
[fg layer=upd fn="a" face=""]
[l]
draggablefalseBooleantrue:テキスト背後の矩形をドラッグできる
drag_x0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_y0(↑と同じ)(↑と同じ)
drag_w画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_h画面縦幅(↑と同じ)(↑と同じ)
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label.........(↑と同じ)
dragmove_argString指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる

[trans]ページ裏表を交換

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

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

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

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

属性必須省略時値域・型コメント
layer全てのレイヤ処理対象レイヤ名(カンマ区切りで複数可能)クロスフェードするレイヤ。指定以外のレイヤは変化させない
time0ミリ秒変化にかける時間
delay0ミリ秒変化する前に待機する遅延時間
rule画面全体ピクセルで同時にクロスフェードする画像ファイル名(swf不可)指定した場合はルール画像として、ピクセル単位でクロスフェードするタイミングをずらす。
ルール画像の黒いピクセル(と同じ位置にあるピクセル)が先に処理され、白が最後になる。
vague0.04トランジション期間全体を1とした値表レイヤと裏レイヤの境界を曖昧にぼかす度合い
lightfalseBoolean少々ギザギザだが処理が軽い方法でクロスフェードするか
c_plugin何もしない処理対象プラグイン名(カンマ区切りで複数可能)指定したプラグインの可視状態が[trans]で変化するようになる。表示非表示が切り替わる。ただしクロスフェード中はアニメが止まる

[wt]トランス終了待ち

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

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

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

属性必須省略時値域・型コメント
canskiptrueBooleantrueでクリックキャンセル可能にする。

レイヤトゥイーン

[pause_tsy]一時停止

[tsy]を一時停止させる

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
pluginプラグイン名処理対象のプラグイン

[resume_tsy]一時停止再開

[tsy]一時停止を再開させる

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
pluginプラグイン名処理対象のプラグイン

[stop_tsy]トゥイーン中断

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
pluginプラグイン名処理対象のプラグイン
arrivenfalseBooleantrueならクリックキャンセルでアニメ終端までSkip。
falseならその場で停止
backlaynfalseBooleantrueならトゥイーン終了時、fore→backへ属性をコピーする。
コピーする属性はalpha, height, rotation, scaleX, scaleY, width, x, y。
(rotationX〜Z、scaleZ、zは設定すると三次元方向の拡大縮小ルーチンが働き画像がぼやけるのでbacklayで設定しない方針)

[tsy]トゥイーン開始

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

「目標値」を設定する時、相対値あるいは絶対値を指定できる。「x=10」は絶対値、「x='=10'」は現在値からの相対値。 またある値域でランダムな絶対値を指定することも出来る。「x='250,500'」だと250から500までの間でランダムなXとする

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
pluginプラグイン名処理対象のプラグイン
delayn0ミリ秒数トゥイーンを始める前の、何もしない待ち時間
timeyミリ秒数トゥイーンを始める前の、何もしない待ち時間
alphaいずれかを指定何もしないミリ秒数同名属性の変化目標値。
詳細はDisplayObjectの解説を参照
height
rotation
rotationX
rotationY
rotationZ
scaleX
scaleY
scaleZ
width
xleftの変化目標値
ytopの変化目標値
z同名属性の変化目標値
easenイージング無し(同右)揺れのイージング(値の変化の仕方)を指定する。
イージングの変化はこちらの図が分かりやすい。
指定できる値は以下の通り。
Back.easeIn、Back.easeInOut、Back.easeOut
Bounce.easeIn、Bounce.easeInOut、Bounce.easeOut
Circular.easeIn、Circular.easeInOut、Circular.easeOut
Cubic.easeIn、Cubic.easeInOut、Cubic.easeOut
Elastic.easeIn、Elastic.easeInOut、Elastic.easeOut
Exponential.easeIn、Exponential.easeInOut、Exponential.easeOut
Linear.easeIn、Linear.easeInOut、Linear.easeNone、Linear.easeOut
Quadratic.easeIn、Quadratic.easeInOut、Quadratic.easeOut
Quartic.easeIn、Quartic.easeInOut、Quartic.easeOut
Quintic.easeIn、Quintic.easeInOut、Quintic.easeOut
Sine.easeIn、Sine.easeInOut、Sine.easeOut
repeatsn10(無限ループ)〜

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

[tsy]トゥイーンの終了を待ち、再開する。

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

属性必須省略時値域・型コメント
layeryレイヤ名処理対象のレイヤ
pageforefore、backページの裏表
pluginプラグイン名処理対象のプラグイン
arrivenfalseBooleantrueならクリックキャンセルでアニメ終端までSkip。
falseならその場で停止
backlaynfalseBooleantrueならトゥイーン終了時、fore→backへ属性をコピーする。
コピーする属性はalpha, height, rotation, scaleX, scaleY, width, x, y。
(rotationX〜Z、scaleZ、zは設定すると三次元方向の拡大縮小ルーチンが働き画像がぼやけるのでbacklayで設定しない方針)
canskipntrueBooleanクリックなど(→詳細は[waitclick])でウエイトをキャンセルできるか

文字・文字レイヤ

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

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

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

属性必須省略時値域・型コメント
enabled現在値Boolean自動ウェイトを有効にするか
text両方同時に指定、或いは省略現在値Stringウェイトを指定する文字の集まり
time(↑と同じ)現在値カンマ区切りの数値文字表示ウェイト倍数

 以下のように指定する。
[autowc enabled=true text="456" time="50,100,150"]
[autowc enabled=true text="456" time="100,100,100"]
[autowc enabled=false]

 以下はエラーとなる。
;x [autowc enabled=true text="456" time="100,100"]
;x [autowc enabled=true text="456" time="100,100,100,100"]
;x [autowc enabled=true text="456"]
;x [autowc enabled=true time="100,100,100"]
;x [autowc enabled=true]
;x [autowc enabled=true text="" time=""]
;x [autowc text="" time=""]

[ch]文字を追加する

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表
textyString表示したい文字列。ルビ文法(《》)も解析する。改行も [r] で出来る
recordtrueBoolean履歴に保存するか
wait現在の文字表示速度ミリ秒一時的な文字表示速度。0で瞬時。
何らかのキー押下やマウスクリックで全てを瞬時表示する
jointrueBooleantrueで読み込みを待って次のタグへ進む。

[ch]を使わない、より簡潔な記述文法があります。(ver 3.18以降)
以下の記述は、
[ch text=&test]
[ch text=test]
[ch text="&a + b"]

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

[clear_text]文字消去

文字のみをクリアする

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表

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

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

属性必須省略時値域・型コメント
layery文字レイヤ名デフォルトとするレイヤ

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表

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

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

属性必須省略時値域・型コメント
rec_page_breaktrueBoolean履歴を改ページするか

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

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

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表
picy画像ファイル名表示する画像やswf
rルビ無しStringルビ文字列(ただしあまりに他の文字サイズと大きく異なる場合は正しい位置に表示されない)
width画像の横サイズ(※)1〜表示する画像の横ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
height画像の縦サイズ(※)1〜保存する画像の縦ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。

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

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

[link]から[endlink](ハイパーリンクの終了)までで囲った範囲をリンク区間と呼び、
その区間の文字や縦中横がハイパーリンクになる。(リンク区間は入れ子に出来ません)
※選択肢として使用する場合、ジャンプ先のラベル直後には必ず[record_place]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。
ブラウザ実行時、ローカル版swfをブラウザで開いた場合はhref属性によるリンクジャンプが利きません。非ローカル版swfをサーバーに設置すれば動作します。

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pageforefore、backページの裏表
href何もしないURLクリック時にブラウザで指定URLを開く
target何もしないHTML タグのtarget属性hrefにてブラウザを開く際のtarget属性
f_color0x8888FF色指定。0x000000など(リンク上にマウスがない状態)文字色
f_alpha1.0(不透明)0.0〜1.0(実数)(リンク上にマウスがない状態)文字の透過度
f_ultrueBoolean(リンク上にマウスがない状態)trueの場合は文字に下線を引く
hf_color0xFFFF00色指定。0x000000など(リンク上にマウスがある状態)文字色
hf_alpha1.0(不透明)0.0〜1.0(実数)(リンク上にマウスがある状態)文字の透過度
hf_ulfalseBoolean(リンク上にマウスがある状態)trueの場合は文字に下線を引く
af_color0x8888FF色指定。0x000000など(リンクをマウス押下した状態)文字色
af_alpha1.0(不透明)0.0〜1.0(実数)(リンクをマウス押下した状態)文字の透過度
af_ultrueBoolean(リンクをマウス押下した状態)trueの場合は文字に下線を引く
b_color背景色なし色指定。0x000000などリンク背景色
b_alpha1.0(不透明)0.0〜1.0(実数)リンク背景の透過度
hintString設定した場合のみ、マウスカーソルを載せるとヒントをチップス表示する
clickse省略時は無音効果音ファイル名指定すると、クリック時に効果音を再生する
enterse省略時は無音効果音ファイル名指定すると、ボタン上にマウスカーソルが載った時に効果音を再生する
leavese省略時は無音効果音ファイル名指定すると、ボタン上からマウスカーソルが外れた時に効果音を再生する
clicksebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
entersebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
leavesebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
callfalseBooleantrueの場合は[call]、falseは[jump]。
ただしcall=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
fn.........クリック時にジャンプする先。
指定方法は[jump]と同様
label.........(↑と同じ)
onenter何もしないラベル名マウス重なり(フォーカス取得)時、指定したラベルをコールする。 必ず[return]で戻ること。
onleave何もしないラベル名マウス重なり外れ(フォーカス外れ)時、指定したラベルをコールする。 必ず[return]で戻ること。
globalfalseBoolean詳細は[event]と同様。
※ボタンを[trans]する場合はtrueにしておく
argString指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる

[r] 改行

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pageforefore、backページの裏表

[rec_ch]履歴書き込み

履歴に改行を出力する。自動で改行を付加する。

属性必須省略時値域・型コメント
textyString表示したい文字列。ルビ文法(《》)も解析する。
rtrueBooleantrueなら改行する

[rec_r]履歴改行

履歴に改行を出力する。

引数無し。

[reset_rec]履歴リセット

履歴をクリアする。

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

属性必須省略時値域・型コメント
text全てクリアString履歴に設定したい文字列

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

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pageforefore、backページの裏表
tyString親文字列
ryStringルビ文字列

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

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

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

属性必須省略時値域・型コメント
toy(コメントで解説)prev……フォーカス順で前の[button]に移動
next……フォーカス順で次の[button]に移動
null……どの[button]にもフォーカスがない状態にする
数値……数値をフォーカス順の番号(0〜)として移動

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

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

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表
layoutリセットString文字のレイアウトを指定する。文法は[lay]のlayout属性と同様。

[tcy]縦中横を表示する

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pageforefore、backページの裏表
tyString縦中横文字列、通常半角文字を指定する。
rルビ無しStringルビ文字列

画像・画像レイヤ

[add_face]差分画像の追加

差分画像を登録する。

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

属性必須省略時値域・型コメント
namey差分名称[lay]タグface属性で指定する差分名称
fn属性nameの値画像ファイル名表示する画像、swf
dx0基本画像左上を(0, 0)とする座標差分画像の表示横位置
dy0(↑と同じ)差分画像の表示縦位置
blendmode何もしないブレンドモード名("screen"など)このレイヤと下のレイヤとの重なりにおいて、
ドット単位で色のブレンド演算を行なう。
詳細はblendModeの解説を参照。

例えば同じ画像で差分表示位置やブレンドモードが違う登録をしたい場合、
[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を変えることで登録できます。

HTMLフレーム

[add_frame]フレーム

属性必須省略時値域・型コメント
xxxxxxy

[let_frame]フレーム

属性必須省略時値域・型コメント
xxxxxxy

[set_frame]フレーム

属性必須省略時値域・型コメント
xxxxxxy

[frame]フレーム

属性必須省略時値域・型コメント
xxxxxxy

[tsy_frame]フレーム

属性必須省略時値域・型コメント
xxxxxxy

イベント

[clear_event] イベントを全消去

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

属性必須省略時値域・型コメント
globalfalseBooleantrueを指定すると全ての大域イベントを削除する。
falseの場合は大域以外の全てのイベントを削除する

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

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

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名イベント有効無効を設定するレイヤ
enabledtrueBooleanイベントを有効にするか

[event]イベントを予約

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

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

属性必須省略時値域・型コメント
keyyclick、rightclick、middleclick、upwheel、downwheel、
イベントのキー名※1
イベントを発生させるトリガーイベント

修飾キーの同時押し(あるいは修飾キーを押しといて通常キー)を任意に組み合わせられます。「半角プラスで」「ABC順に」「イベントのキー名の前に」繋げて下さい。
(例1)key=alt+enter
(例2)key=alt+ctrl+shift+enter
修飾キー対応表は以下になります。
AIRNovel表記
fn.........イベント発生時にジャンプする先。指定方法は[jump]と同様。
callの場合、ジャンプ先から[return]で戻ると、
再度[s]などのイベント待ち状態に戻る。
label.........(↑と同じ)
globalfalseBooleantrueを指定すると大域的なイベント扱いとなり、
イベント発生時にイベント予約が削除されない
argString指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
del...Booleantrueを指定すると予約済みイベントを削除する。
fn/label/callとdelは同時指定できません
frame101〜key=enter_frameの場合のみ有効。
フレームイベントは毎秒何度も([window]のframerate回)発生するが、 アプリ全体が重くなるので、適度に間引いてイベントを時々発生させるため、 フレーム何回に一回イベントを発生させるかを指定する。
例)30フレームで動作するアプリでframe=15を指定すると、30/15=0.5秒に一回発生(タイミングにより厳密ではない)

※1 イベントのキー名は以下のキーボードキー名かActionScriptイベント名のいずれか。 key属性の値 | コメント -- | -- alternate | optionと同値。Winで言うALTキー。MacならOptionキー backquote | backslash | backspace | caps_lock | command | Macにある、Winで言うCTRLキーのようなもの control | delete | down | 矢印キーの下 end | enter | equal | 「=(イコール)」キーはMacにしか無い escape | home | left | 矢印キーの左 numpad_enter | テンキーのEnterキー。テンキーはキーボードによっては存在しない option | alternateと同値。Winで言うALTキー。MacならOptionキー orientation | (デバイス・ANBooksのみ)デバイスが回転したらイベント発生(※3) page_down | page_up | right | 矢印キーの右 shift | space | tab | up | 矢印キーの上 f1 | f2 | f3 | f4 | f5 | f6 | f7 | f8 | f9 | f10 | f11 | f12 | f13 | キーボードによっては存在しない f14 | キーボードによっては存在しない f15 | キーボードによっては存在しない enter_frame | 毎フレーム毎にイベント発生(※2) activate | アプリがフォーカスを取得して、アクティブ(前面)になった deactivate | アプリがフォーカスを失って、非アクティブになった back | (Android)戻るキー
(ちなみにホームキーはAndroid仕様でホームに戻る以外の機能は持たせられない) menu | (Android)メニューキー search | (Android)検索キー

※2 enter_frameイベントは毎秒何度も発生する。

[l] 行末クリック待ち

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

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

属性必須省略時値域・型コメント
visibletrueBooleantrueで行末クリック待ち記号を表示、falseで非表示

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

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

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

属性必須省略時値域・型コメント
visibletrueBooleantrueで改ページ記号を表示、falseで非表示
er何もしないBooleantrueで改ページ待ち後に[er]処理を行なう

[s] 停止する

引数無し。

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

[set_cancel_skip] スキップ中断予約

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

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

[wait]ウェイトを入れる

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

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

属性必須省略時値域・型コメント
timeyミリ秒処理を待つ時間
canskiptrueBooleanクリックなど(→詳細は[waitclick])でウエイトをキャンセルできるか

[waitclick]クリックを待つ

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

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

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

BGM・効果音

[fadebgm]BGMのフェード

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

属性必須省略時値域・型コメント
volumey0.0〜1.0(実数)音量
timeyミリ秒フェード時間
delay0ミリ秒変化する前に待機する遅延時間

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

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

属性必須省略時値域・型コメント
timeyミリ秒フェード時間
stoptrueBooleantrueで「フェード終了時の再生停止」、falseなら行なわない。
delay0ミリ秒変化する前に待機する遅延時間

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

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
timeyミリ秒フェード時間
stoptrueBooleantrueで「フェード終了時の再生停止」、falseなら行なわない。
delay0ミリ秒変化する前に待機する遅延時間

[fadese]効果音のフェード

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
volumey0.0〜1.0(実数)音量
timeyミリ秒フェード時間
delay0ミリ秒変化する前に待機する遅延時間

[playbgm]BGM の演奏

BGMを再生する。

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

属性必須省略時値域・型コメント
fnyBGM音声ファイル名再生する音声ファイル名
looptrueBooleantrueでBGMのようにループ再生する。
volume1.00.0〜1.0(実数)再生音量。ただし音量を示すシステム変数(sys:const.an.sound.BGM.volume)は変更しない
ret_ms0(冒頭)ミリ秒ループ戻り位置指定。冒頭から再生開始するが、mp3終端に行くたびに指定したミリ秒の位置に戻る
end_ms終端ミリ秒音声ファイルの終端位置を指定する。(音声ファイルの末尾にどうしても無音が残る場合、ループ時に困るときなどに)
正の値は「冒頭から何ms目を終端とするか」
負の値は「末尾から何ms手前を終端とするか」の指定。
jointrueBooleantrueで読み込みを待って次のタグへ進む。

[playse]効果音の再生

効果音を再生する。

属性必須省略時値域・型コメント
fny効果音音声ファイル名再生する音声ファイル名
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
loopfalseBooleantrueでBGMのようにループ再生する。
volume1.00.0〜1.0(実数)再生音量。ただし音量を示すシステム変数(sys:const.an.sound.【トラック名】.volume)は変更しない
ret_ms0(冒頭)ミリ秒ループ戻り位置指定。冒頭から再生開始するが、mp3終端に行くたびに指定したミリ秒の位置に戻る。
end_ms終端ミリ秒音声ファイルの終端位置を指定する。(音声ファイルの末尾にどうしても無音が残る場合、ループ時に困るときなどに)
正の値は「冒頭から何ms目を終端とするか」
負の値は「末尾から何ms手前を終端とするか」の指定。
jointrueBooleantrueで読み込みを待って次のタグへ進む。
canskiptrueBooleantrueでキー押下Skip中なら再生をしない
cachetrueBooleantrueなら今まで通り、内部的にサウンドデータをキャッシュして再度再生時に素早く再生する(mp3のみ)

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

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

[stopbgm]BGM 演奏の停止

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

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

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
BGMと指定するとBGMの指定。

[stopse]効果音再生の停止

効果音再生を停止する。

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。

[volume]音量設定

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
BGMと指定するとBGMの音量設定。
volume1.00.0〜1.0(実数)音量

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

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

属性必須省略時値域・型コメント
canskipfalseBooleantrueでクリックキャンセル可能にする。

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

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
canskipfalseBooleantrueでクリックキャンセル可能にする。

[wl]BGM 再生の終了待ち

BGM 再生の終了を待つ。

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

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

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

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
canskipfalseBooleantrueでクリックキャンセル可能にする。

[xchgbuf]再生トラックの交換

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

属性必須省略時値域・型コメント
bufSE効果音を識別するトラック名トラック名
buf2SE効果音を識別するトラック名もう一つのトラック名

条件分岐

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

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

引数無し。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。

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

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

詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。

属性必須省略時値域・型コメント
expyBooleantrueの場合処理は直後にうつる。
falseなら次の[elsif]や[else]の評価を行なう。

[endif]ifブロックの終端

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

引数無し。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。

[if]ifブロックの開始

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

詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。

属性必須省略時値域・型コメント
expyBooleantrueの場合処理は直後にうつる。
falseなら次の[elsif]や[else]の評価を行なう。

ラベル・ジャンプ

[button]ボタンを表示

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

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

属性必須省略時値域・型コメント
layerデフォルト文字レイヤ文字レイヤ名ボタンを配置する文字レイヤ
pagebackfore、backページの裏表
picy画像ファイル名(swf不可)ボタンとして配置する画像を指定する。
ただし画像は縦に三等分し、左から「通常時」「クリック押下時」「マウスカーソルを載せた時」の画像として表示する。
pos
left
center
right
s_right
top
middle
bottom
s_bottom
※詳細は[lay]を参照
hintString設定した場合のみ、マウスカーソルを載せるとヒントをチップス表示する
clickse省略時は無音効果音ファイル名指定すると、クリック時に効果音を再生する
enterse省略時は無音効果音ファイル名指定すると、ボタン上にマウスカーソルが載った時に効果音を再生する
leavese省略時は無音効果音ファイル名指定すると、ボタン上からマウスカーソルが外れた時に効果音を再生する
clicksebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
entersebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
leavesebufSYSサウンドバッファ名クリック時効果音を再生するサウンドバッファを指定する
callfalseBooleantrueの場合は[call]、falseは[jump]。
ただしcall=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
fn.........クリック時にジャンプする先。
指定方法は[jump]と同様
label.........(↑と同じ)
argString指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
r_callfalseBoolean右クリック時ジャンプについての指定。
trueの場合は[call]、falseは[jump]。
ただしr_call=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
r_fn.........右クリック時にジャンプする先。
指定方法は[jump]と同様
r_label.........(↑と同じ)
r_argString指定した場合、右クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
onenter何もしないラベル名マウス重なり(フォーカス取得)時、指定したラベルをコールする。 必ず[return]で戻ること。
onleave何もしないラベル名マウス重なり外れ(フォーカス外れ)時、指定したラベルをコールする。 必ず[return]で戻ること。
globalfalseBoolean詳細は[event]と同様。
※ボタンを[trans]する場合はtrueにしておく
enabledtrueBooleanfalseだと押せないボタンとなり、クリックイベントが発生しない。
これにより文字レイヤの任意の位置に画像表示できる機能を提供する。
画像は三等分しない。イベントや効果音指定は無効だが、ヒント機能は有効。
joinfalseBooleantrueで画像読み込みを待って次のタグへ進む。
event_at_downfalseBooleantrue:押すだけでイベント発動(画面常駐のシステムボタンなどに)
false:押して離すとイベント発動
draggablefalseBooleantrue:テキスト背後の矩形をドラッグできる。
event_at_down=trueだとクリックイベントが発生しなくなる。
drag_x0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_y0(↑と同じ)(↑と同じ)
drag_w画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_h画面縦幅(↑と同じ)(↑と同じ)
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label.........(↑と同じ)
dragmove_argString指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる
alpha1.00.0〜1.0(実数)透過度。0(完全透明)〜0.5(半透明)〜1(不透明)
blendmode何もしないブレンドモード名("screen"など)このボタンと下のレイヤとの重なりにおいて、
ドット単位で色のブレンド演算を行なう。
詳細はblendModeの解説を参照。
rotation0-180〜180回転角を度単位で指定。時計回りは0~180、反時計回りは0~-180を指定。 左上を中心に回る
scale_x1.0正負の実数値横方向を何倍に拡大/縮小するか。負の値ならレイヤを左右反転
scale_y1.0正負の実数値縦方向を何倍に拡大/縮小するか。負の値ならレイヤを上下反転

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

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

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

属性必須省略時値域・型コメント
fnどちらか、もしくは両方を指定処理中のスクリプトファイルスクリプトファイル名コール先のスクリプトファイル
[call fn=ext_*]のようにワイルドカードをサポート。マッチするスクリプトを順不同にコールする。 (ワイルドカードは後方のみ)
labelスクリプトファイルの先頭ラベル名(半角アスタリスク*も含む)コール先のスクリプトファイルにあるラベル
countfalseBooleanタグ位置を既読とするか
clear_local_event何もしないBooleantrueの場合は[clear_event]を行なってからコールする。

[jump]シナリオジャンプ

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

属性必須省略時値域・型コメント
fnどちらか、もしくは両方を指定処理中のスクリプトファイルスクリプトファイル名コール先のスクリプトファイル
labelスクリプトファイルの先頭ラベル名(半角アスタリスク*も含む)コール先のスクリプトファイルにあるラベル
counttrueBooleanタグ位置を既読とするか

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

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

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

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

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

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

属性必須省略時値域・型コメント
clearfalseBooleantrue:全て破棄する。空でもエラーを出さない
false:スタックを一つ破棄する。空の場合はエラーメッセージ&アプリ停止

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

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

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

マクロ

[bracket2macro] 括弧マクロの定義

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

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

属性必須省略時値域・型コメント
texty特定の文字括弧にする任意の二つの文字。
マクロに出来るのは英文字、空白、;、[、]、、=、&、|、《、》以外のみ。
正規表現で言えば /[\w\s;[]
=&|《》]/ 以外。
一文字マクロや定義済みの括弧文字は使用できない。
namey定義済みのマクロ名半角文字に割り当てるマクロ名を指定。
組み込みタグか、[macro]による定義済みマクロ名で無ければならない。
組み込みタグやマクロは引数textだけを指定しても問題なく動作し、 それを処理すること。渡される引数textは空文字の場合もある。

[break_macro]マクロから脱出

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

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

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

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

属性必須省略時値域・型コメント
chary特定の半角文字マクロにする半角文字。
マクロに出来るのは英文字、空白、;、[、]、、=、&、|、《、》以外のみ。
正規表現で言えば /[\w\s;[]
=&|《》]/ 以外。
括弧文字や定義済みの一文字マクロは使用できない。
namey定義済みのマクロ名半角文字に割り当てるマクロ名を指定。
組み込みタグか、[macro]による定義済みマクロ名で無ければならない。

[endmacro]マクロ定義の終了

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

[macro]マクロ定義の開始

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

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

属性必須省略時値域・型コメント
nameyマクロ名String既存のタグやマクロと重複しないマクロ名

しおり

[copybookmark]しおりの複写

しおりデータを複写する

属性必須省略時値域・型コメント
fromy数値複写元のしおり番号
toy数値複写先のしおり番号
path従来通り SharedObjectに保存フォルダパス指定した場合、複写先(to)のしおりをファイルとしてフォルダパス下に保存する。

[erasebookmark] しおりの消去

しおりデータを削除する

属性必須省略時値域・型コメント
placey数値処理対象のしおり番号

[load]しおりの読込

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

属性必須省略時値域・型コメント
placey数値処理対象のしおり番号
fn.........ロード後最初にしたい共通処理をコールする(処理は[return]で終わらせる)。指定方法は[jump]と同様。
ただし指定する際、fnとlabelは両方指定しなければならない。

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

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

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

属性必須省略時値域・型コメント
layer全てのレイヤ保存対象レイヤ名(カンマ区切りで複数可能)しおりに状態を保存するレイヤ。Save/Load画面レイヤや設定画面レイヤなど、保存すべきでないレイヤを除いて指定すべき
reset_soundtrueBoolean全てのサウンドを停止・再度再生開始するか

[reload_script] スクリプト再読込

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

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

[save]しおりの保存

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

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

属性必須省略時値域・型コメント
placey数値処理対象のしおり番号
path従来通り SharedObjectに保存フォルダパス指定した場合、しおりをファイルとしてフォルダパス下に保存する。

画面揺らし

[quake]画面を揺らす

画面全体を揺らす

属性必須省略時値域・型コメント
timeyミリ秒数揺らす時間
hmaxn10Integer横方向の最大揺らし幅。幅はランダム値を取る
vmaxn10Integer縦方向の最大揺らし幅。幅はランダム値を取る
easenイージング無しイージング名揺れのイージング(値の変化の仕方)を指定する。
イージングの変化はこちらの図が分かりやすい。
指定できる値はplgTweensyの[tsy]を参照

[stop_quake]画面揺らし中断

画面揺らしを中断する

属性必須省略時値域・型コメント
canskipntrueBooleanクリックなど(→詳細は[waitclick])でウエイトをキャンセルできるか

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

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

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

属性必須省略時値域・型コメント
canskipntrueBooleanクリックなど(→詳細は[waitclick])でウエイトをキャンセルできるか

システム

[close]アプリの終了

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

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

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

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

《注意》立ち絵や一枚絵を表示する目的にはこの命令を推奨しません。その目的を満たすタグは[lay]です。 プラグインには裏表ページの概念がなかったりするためです ※動的ライブラリの作り方については「プラグインの自作」をご覧下さい。

属性必須省略時値域・型コメント
fnyファイル名読み込むプラグインのファイル名
[loadplugin fn=plg*]のようにワイルドカードをサポート。
マッチするプラグインを順不同に読み込む。読み込み済みなら無視。
(拡張子はswfのみ)(ワイルドカードは後方のみ)
index最前面※0〜重なり順を指定する。
※最前面とは、Flashのstage.addChildにおける重なり順
jointrueBooleantrueで読み込みを待って次のタグへ進む。

属性必須省略時値域・型コメント
urlyURL文字列開くURL

[snapshot]スナップショット

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

属性必須省略時値域・型コメント
layer全てのレイヤレイヤ名(半角カンマ区切りで複数レイヤを指定可能)「plg:プラグイン名」と記述する事でプラグインも指定できる。
pageforefore、backページの裏表
fnsnapshotString※保存するファイル名(拡張子を除く)
formatjpgpng、jpg保存する画像フォーマット
quality901〜100jpg保存する際の画質。大きいと画質が高いが処理が遅くなる。
widthアプリ表示部分の横サイズ1〜保存する画像の横ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
heightアプリ表示部分の縦サイズ1〜保存する画像の縦ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
smoothingfalseBoolean拡大・縮小保存される場合、スムージングするか
pathdlgfalseBoolean保存場所をGUIで選べるダイアログを表示するか
b_colorconfig.anprjで指定した背景色色指定。0xFF000000(黒)など
16進数では透過2桁+赤2桁+緑2桁+青2桁で指定
テキスト背後の矩形色。pngで 0x0 にすると透過する。
透過しない黒は 0xFF000000

※fnを「app-storage:」で始まるファイル名にするとセーブデータと同じフォルダに保存します。

OS Path
Mac OS XHD/Users/[user]/Library/Preferences/[id]/
Windows 7C:\Users[user]\AppData\Roaming[id]\
Linux/home/[user]/.appdata/[id]/Local Store
  [user]はインストールしたユーザー名、
  [id]はアプリ固有のIDです。
参考:アプリケーション記憶領域ディレクトリ


※fnを「ss:/」で始めると、セーブデータファイル内部(SharedObject)に保存します。(例 ss:/yyy)  保存した画像は、画像レイヤやボタンに画像として表示出来ます。(例 fn="ss:/yyy")

[title]タイトル指定

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

属性必須省略時値域・型コメント
textyStringタイトル文字列

[toggle_full_screen] 全画面状態切替

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

現在の状態は文字列変数「tmp:const.flash.display.Stage.displayState」を参照(→定数一覧)

属性必須省略時値域・型コメント
fnイベント登録せずモード切替イベントのキー名※1(Flash動作時のみ使用)イベントを発生させるトリガーイベント。
key属性の値は[event]を参照

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

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

属性必須省略時値域・型コメント
width現在値1〜アプリウインドウの横幅を指定
height現在値1〜アプリウインドウの高さを指定
framerate現在値1〜アプリ全体のフレームレートを変更
centering何もしないBooleantrueを指定すると、アプリウインドウをデスクトップの中央に移動する
x何もしない画面左上を(0, 0)とする座標デスクトップにおけるアプリウインドウの横位置を指定
y何もしない(↑と同じ)デスクトップにおけるアプリウインドウの縦位置を指定

デバッグ・その他

[dump_val]変数のダンプ

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

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

属性必須省略時値域・型コメント
xxxxxxy

[dump_stack]スタックのダンプ

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

[log] ログ出力

引数をデスクトップにテキスト出力する(追記ではなく上書き。追記する。出力日時・分・スクリプ

[dump_lay]レイヤのダンプ

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

属性必須省略時値域・型コメント
layer n 全てのレイヤ レイヤ名(半角カンマ区切りで複数レイヤを指定可能) 「plg:プラグイン名」と記述する事でプラグインも指定できる。

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

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

属性必須省略時値域・型コメント
left0画面左上を(0, 0)とする座標表示の横位置
top(↑と同じ)(↑と同じ)表示の縦位置

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

引数をデバッグ表示する

属性必須省略時値域・型コメント
textyStringデバッグ表示する値