AIRNovel タグ リファレンス

はじめに

  • 全てのタグには属性condがあり、指定した場合は「評価結果が真(true)の時のみタグを処理する」という条件分岐が可能です。
  • 「必須」がyのものはタグを書く際、かならず指定する必要がある属性です。(書かないとエラーになり、アプリを停止します)
  • 「必須」がnなら、「省略時」の設定をしたのと同じ動作をします。
  • 「値域・型」でStringとある場合は、文字列を指定します。半角空白を含みたい場合は「"(半角ダブルクオーテーション)」「'(シングルクオーテーション)」で囲ってください。
  • 文字レイヤのlayout属性のみ、文字列を囲う記号には前述の二つに加え「#(半角井桁)」も使用可能です。
  • 「値域・型」でBooleanとある場合は、trueかfalseを指定します。属性により意味は変わりますが、trueは「はい」「許可」「有効」的な肯定的な意味で、falseは「いいえ」「不許可」「無効」という否定的な設定です。
  • 「値域・型」で数値指定、例えば「1〜100」とある場合は「最小で1、最大で100の任意の数値」を指定できます。「1〜」なら「1以上」という意味です。
  • 「値域・型」で実数値と明示している場合か「0.0」のような小数の記述がある場合以外、基本的に整数で指定します。
  • ファイル名を「http://」で始めるとネット上のファイルをロードします。これはスクリプトや画像、効果音などすべてのfn属性において同様です。
  • 瀬戸愛羅さんの解説サイト【AIRNovelをさわろう!】もご参照下さい。

システム

[close] アプリの終了 引数無し。
アプリケーションを終了する
※Flash 上では動作しません。タグを呼んでも何もしません。
※iOSでは動作せず、サポート外です。(→AIR for iOS 2.7頃の仕様による制限
[export] プレイデータをエクスポート セーブデータやシステムデータ(クリア・コンプリート情報、ゲームの表示位置など)
をまとめて1ファイルにエクスポートする。
サムネイル画像なども一緒にまとめることが出来る。
※Flash 上では動作しません。タグを呼んでも何もしません。
属性必須省略時値域・型コメント
pathn一緒にエクスポートするファイルのフルパス(カンマ区切りで複数可能) [export path="app-storage:/bookmark/0.jpg,app-storage:/bookmark/1.jpg,"]
のようにカンマ過多を許す。
また、「app-storage:/bookmark/*」のようにフォルダ内全てのファイルを指定することが出来る(フォルダ・不可視ファイル以外。「/*」で終わること)
※セキュリティ上、エクスポート先をプレイヤーに選択させるダイアログが出ます
AIRNovel 3.31から出さなくなりました。デスクトップにファイル出力します。
[import] プレイデータをインポート 引数無し。
WindowsでエクスポートしてMacでインポートするなど、異なるプラットフォーム間でプレイデータを共有できます。

セキュリティ上、インポート元をプレイヤーに選択させるダイアログが出ます。
プレイヤーがキャンセルした場合、const.an.dlgUserOKをfalseにし、選択した場合はtrueにします。

インポート後は速やかにゲームを再起動する必要があります。
※Flash 上では動作しません。タグを呼んでも何もしません。
[loadplugin] プラグインの読み込み swfファイルや画像をプラグインとして読み込む

《注意》立ち絵や一枚絵を表示する目的にはこの命令を推奨しません。その目的を満たすタグは[lay]です。
プラグインには裏表ページの概念がなかったりするためです
属性必須省略時値域・型コメント
fnyファイル名 読み込むプラグインのファイル名
[loadplugin fn=plg*]のようにワイルドカードをサポート。
マッチするプラグインを順不同に読み込む。読み込み済みなら無視。
(拡張子はswfのみ)(ワイルドカードは後方のみ)
indexn最前面※0〜 重なり順を指定する。
※最前面とは、Flashのstage.addChildにおける重なり順
joinntrueBoolean trueで読み込みを待って次のタグへ進む。

※動的ライブラリの作り方については「プラグインの自作」をご覧下さい。
[mouse] マウスの設定 マウスの設定をする。
マウスカーソル自動隠し機能などの操作を行なう。
属性必須省略時値域・型コメント
visiblen何もしないBooleantrueで表示、falseで非表示
autohiden何もしないBooleantrueで自動隠し機能を有効、falseで無効に
cursorn何もしないBoolean マウスカーソルを指定する。
・arrow:矢印
・auto:自動
・button:ボタン押下時のカーソル(人差し指を立てている)
・hand:ドラッグハンドカーソル(パーの形)
・ibeam:Iビームカーソル
[navigate_to] URLを開く ブラウザでURLを開く。(突然開くので、ユーザーに確認した方が良いかも)
URLが「http://〜」ならブラウザ、「mailto:〜」ならメールアプリを開く。
(詳細はflash.net.navigateToURL()関数を参照)
属性必須省略時値域・型コメント
urlyURL文字列開くURL

メール起動やブラウザ経由でのツイッターとの連動は開発ブログで解説しています。
[plugin] プラグインの設定 読み込んだプラグインの表示位置や表示・非表示を設定する
属性必須省略時値域・型コメント
namey[loadplugin]で読み込んだプラグイン名[loadplugin]のfnと全く同一の文字列にしてください。
leftn 両方省略時に画面中央となる値を設定
以外は現在値のまま
画面左上を(0, 0)とする座標プラグインの表示横位置
topnプラグインの表示縦位置
visiblentrueBooleantrueでプラグインを表示、falseで非表示
alphan1.00.0〜1.0(実数)透過度。0(完全透明)〜0.5(半透明)〜1(不透明)
blendmoden何もしないブレンドモード名("screen"など) このプラグインと下のレイヤとの重なりにおいて、
ドット単位で色のブレンド演算を行なう。
詳細はblendModeの解説を参照。
rotationn0-180〜180 回転角を度単位で指定。時計回りは0~180、反時計回りは0~-180を指定。 左上を中心に回る
scale_xn1.0正負の実数値 横方向を何倍に拡大/縮小するか。負の値ならレイヤを左右反転
scale_yn1.0正負の実数値 縦方向を何倍に拡大/縮小するか。負の値ならレイヤを上下反転
floatn何もしないBoolean true:レイヤを最前面に移動する。
※最前面とは、Flashのstage.addChildにおける重なり順
indexn何もしない0〜 レイヤをindexで指定したインデックスに移動する。
※インデックスは、FlashのStage.setChildIndex()を参照。
diven何もしないレイヤ名 レイヤをdiveで指定したレイヤのすぐ後ろに潜り込ませる。
「plg:プラグイン名」と記述する事でプラグインも指定できる。
touchn何もしないBoolean trueのとき
stage.removeChild()し、
stage.addChild()する。
addedToStageイベントをプラグインに起こすための機能。
[set_focus] フォーカス移動 [button]フォーカスを移動する。
説明に「フォーカス順」とある場合は、[button]が文字レイヤに追加された順番。
先頭は最初に追加された[button]。
属性必須省略時値域・型コメント
toy(コメントで解説) prev……フォーカス順で前の[button]に移動
next……フォーカス順で次の[button]に移動
null……どの[button]にもフォーカスがない状態にする
数値……数値をフォーカス順の番号(0〜)として移動
[snapshot] スナップショット アプリ表示部分全体を画像として保存する
属性必須省略時値域・型コメント
layern全てのレイヤレイヤ名(半角カンマ区切りで複数レイヤを指定可能) 「plg:プラグイン名」と記述する事でプラグインも指定できる。
pagenforefore、backページの裏表
fnnsnapshotString ※保存するファイル名(拡張子を除く)
formatnjpgpng、jpg保存する画像フォーマット
qualityn901〜100 jpg保存する際の画質。大きいと画質が高いが処理が遅くなる。
widthnアプリ表示部分の横サイズ1〜 保存する画像の横ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
heightnアプリ表示部分の縦サイズ1〜 保存する画像の縦ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
smoothingnfalseBoolean 拡大・縮小保存される場合、スムージングするか
pathdlgnfalseBoolean 保存場所をGUIで選べるダイアログを表示するか
b_color【更新】nconfig.anprjで指定した背景色 色指定。0xFF000000(黒)など
16進数では透過2桁+赤2桁+緑2桁+青2桁で指定
テキスト背後の矩形色。pngで 0x0 にすると透過する。
透過しない黒は 0xFF000000

※fnを「app-storage:」で始まるファイル名にするとセーブデータと同じフォルダに保存します。
OSPath
Mac OS X HD/Users/[user]/Library/Preferences/[id]/
Windows XP C:\Documents and Settings\[user]\Application Data\[id]\
Windows Vista
Windows 7
C:\Users\[user]\AppData\Roaming\[id]\
Linux /home/[user]/.appdata/[id]/Local Store
  [user]はインストールしたユーザー名、
  [id]はアプリ固有のIDです。
参考:アプリケーション記憶領域ディレクトリ


※fnを「ss:/」で始めると、セーブデータファイル内部(SharedObject)に保存します。(例 ss:/yyy)
 保存した画像は、画像レイヤやボタンに画像として表示出来ます。(例 fn="ss:/yyy")
[title] タイトル指定 アプリウインドウのタイトル文字列を設定する。
※Flash 上では動作しません。タグを呼んでも何もしません。
属性必須省略時値域・型コメント
textyStringタイトル文字列
[toggle_full_screen] 全画面状態切替 呼び出す度にアプリの全画面/ウインドウモードを切り替えます。
現在の状態は文字列変数「tmp:const.flash.display.Stage.displayState」を参照(→定数一覧
属性必須省略時値域・型コメント
fnnイベント登録せずモード切替イベントのキー名※1 (Flash動作時のみ使用)イベントを発生させるトリガーイベント。
key属性の値は[event]を参照
[unloadplugin] プラグインの破棄 プラグインとして読み込んだswfファイルや画像を破棄する
属性必須省略時値域・型コメント
fnyファイル名 読み込むプラグインのファイル名
[unzip] ネット素材取得 ネット上のzipファイルをダウンロード&解凍して素材を利用する。
※素材を使用する場合、【拡張子を省略出来ません】し【フォルダが違えば同じファイル名を許します】。AIRNovel特有のファイル仕様、ここだけありません。
※Flash 上では動作しません。タグを呼んでも何もしません。

処理結果は非同期で以下の変数にセットされる。タグ実行と同時に変数は一旦削除され、セットされるまで「=== null」となる。
通信状況によるが数秒以内にはセットされるはず。
  tmp:const.an.unzip.(ファイル名).state …… 状態
     dl : ダウンロード中
     err : エラー発生、メッセージを更新
     unzip : 解凍中
     complete : 解凍完了、素材を使用出来る
  tmp:const.an.unzip.(ファイル名).mes …… メッセージ
属性必須省略時値域・型コメント
urlyZIPへのURL名 読み込むzipファイルが存在するURL
joinntrueBoolean trueで読み込みを待って次のタグへ進む
[update_check] 更新チェック アプリの最新バージョンをネットで確認する。
処理は非同期に行われ、更新があった時のみ更新確認ウインドウが表示される。
update.xmlより属性指定が優先。
詳細は「AIRNovel 開発者向け情報」を参照して下さい。
※Flash 上では動作しません。タグを呼んでも何もしません。
※アプリ実行中は一度きりしか使えず、二回目以降処理を行ないません。

処理結果は非同期で以下の変数にセットされる。タグ実行と同時に変数は一旦削除され、セットされるまで「=== null」となる。
通信状況によるが数秒以内にはセットされるはず。
  tmp:const.an.update_check.state …… 状態(=== null、または =='same ver'、=='err')
  tmp:const.an.update_check.errorID …… エラーコード
  tmp:const.an.update_check.subErrorID …… エラーサブコード
   ※エラーコードについてはこちらを参照
例)
 新しいバージョンが無い……
   〜.state = "same ver"
 ファイルがない……
   〜.state = "err"
   〜.errorID = "16820"
   〜.subErrorID = "404"
 新しいバージョンがあった場合……
   〜.state = "new ver"
属性必須省略時値域・型コメント
urlyURL 最新バージョンを確認するXML(更新記述ファイル)へのURLを指定。
AIR 1.5のair.update.ApplicationUpdaterを使用している。
XML仕様の詳細はApplicationUpdater.updateURLを参照。
config_fnnデフォルト値xmlファイル名 ApplicationUpdaterの設定を記述したXMLファイルを指定する。
check_for_updatenfalseBooleanアップデートの有無をチェック、アップデートがありません、およびアップデートエラーダイアログボックスの表示を有効に
download_updatentrueBooleanアップデートのダウンロードダイアログボックスの表示を有効に
download_progressntrueBooleanアップデートのダウンロードダイアログボックスの表示を有効に
install_updatenfalseBooleanファイル - 利用可能なアップデート、ファイル - 利用可能なアップデートがありません、およびファイル - エラーダイアログボックスの表示を有効に
[wait_thread] スレッド待機 引数無し。
内部スレッド処理を待機する。瞬時に次の文へ進む。
[for_call]マクロ内で多重ループ時、又は[call]、マクロ多重呼び出し時にスタックオーバーフローを防ぐ用途。
[window] アプリウインドウ設定 ゲームアプリのウインドウサイズや位置などを変更する
属性必須省略時値域・型コメント
widthn現在値1〜アプリウインドウの横幅を指定
heightn現在値1〜アプリウインドウの高さを指定
frameraten現在値1〜アプリ全体のフレームレートを変更
centeringn何もしないBooleantrueを指定すると、アプリウインドウをデスクトップの中央に移動する
xn何もしない画面左上を(0, 0)とする座標デスクトップにおけるアプリウインドウの横位置を指定
yn何もしないデスクトップにおけるアプリウインドウの縦位置を指定

変数操作

[let] 変数代入・演算 変数に値を代入する。
変数については「AIRNovel 開発者向け情報」を参照して下さい
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyStringセットする値
castn出来るだけ数値変換(コメントを参照) 値をセットする際の型。
 num……数値(実数)。「01」は数値の1となる。
 int……数値(符合付き整数)
 uint……数値(符合なし整数)
 bool……Boolean
 str……文字列。「01」は「01」のまま。

[let]を使わない、より簡潔な記述文法があります。(ver 3.18以降)
※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絶対値を求める数
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_char_at] 文字列から一字取りだし 文字列中の一文字を取り出す
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString元になる文字列
posn00(先頭)〜何番目の文字を取り出すか
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_index_of] 文字列で検索 文字列内を検索し、文字列内の start 以降で、最初に val が見つかった位置を返します。
属性必須省略時値域・型コメント
nameyString(変数名書式※)位置を代入する変数名。-1の場合は見つからなかった
textyString元になる文字列
valyString探す文字列
startn00(先頭)〜検索を開始する位置
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_length] 文字列の長さ 文字列の長さを求める
属性必須省略時値域・型コメント
nameyString(変数名書式※)長さを代入する変数名
textyString長さを求める文字列。長さをセットする
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_replace] 正規表現で置換 文字列を正規表現で検索し、マッチする箇所を文字列で置き換える。
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString置換対象の文字列
regyString正規表現
flagsn(なし)String正規表現のフラグ
valyString置き換える文字列
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_round] 四捨五入 四捨五入する
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyNumber四捨五入する数
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_search] 正規表現で検索 文字列内を正規表現で検索し、最初に val が見つかった位置を返します。
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString検索対象の文字列
regyString正規表現
flagsn(なし)String正規表現のフラグ
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)
[let_substr] 文字列から抜きだし 文字列の一部を取り出す
属性必須省略時値域・型コメント
nameyString(変数名書式※)変数名
textyString元になる文字列
posn0 0(先頭)〜
または
〜-1(末尾)
何番目の文字から取り出すか。
負の値なら「後ろから何個目か」。-1が最後の文字。
【pos=-3 len=all】とすると、後ろから3文字を取り出す。
lenn1文字数、または all何文字取り出すか。all でpos以降の全て
castn出来るだけ数値変換値をセットする際の型。(詳細は[let]を参照)

レイヤ共通

[add_lay] レイヤを追加する レイヤを追加する。
レイヤはページの裏表があり、文字レイヤや画像レイヤなどの種類があります。
※HTMLレイヤのみ、Flash環境では使用不可です。
属性必須省略時値域・型コメント
layeryString レイヤ名を指定する。
未使用のレイヤ名でなければエラー&アプリ停止
classy grp(画像レイヤ)、
txt(文字レイヤ)、
mov(ムービーレイヤ)、
htm(HTMLレイヤ)
レイヤの種類
blendModeの解説 [plugin][lay][add_face][button]で同様ですが、blendmode属性に以下のものを使用可能です。
Photoshop ブレンドモード名AIRNovel での blendmode 属性の値ActionScript での blendmode 値コメント
加算(使えない)add 表示オブジェクトの要素カラーの値を背景色に加算し、その際に上限 0xFF を適用します。
アルファ(使えない)alpha 表示オブジェクトの各ピクセルのアルファ値を背景に適用します。
比較 (暗)この値→darken 表示オブジェクトの要素カラーと背景色のうち暗い方(値が小さい方)の色を選択します。
差の絶対値この値→difference表示オブジェクトの各ピクセルのアルファ値を 背景に適用します。
消去(使えない)erase 表示オブジェクトのアルファ値に基づいて背景を消去します。
ハードライトこの値→hardlight 表示オブジェクトの暗さに基づいて、各ピクセルの色を調整します。
反転(使えない)invert 背景を反転します。
(なし)(使えない)layer 表示オブジェクトに関する透明度グループを強制的に作成します。
比較 (明)この値→lighten 表示オブジェクトの要素カラーと背景色のうち明るい方(値が大きい方)の色を選択します。
乗算この値→multiply 表示オブジェクトの要素カラーの値と背景色の要素カラーの値を乗算した後、0xFF で割って正規化し、色を暗くします。
標準この値→normal 表示オブジェクトは、背景の前に表示されます。(なにもしない)
オーバーレイこの値→overlay 背景の暗さに基づいて、各ピクセルの色を調整します。
スクリーンこの値→screen 表示オブジェクトの色の補数(逆)と背景色の補数を乗算して、ブリーチ効果を得ます。
(なし)(使えない)shader シェーダーを使用して、オブジェクト間のブレンドを定義します。
減算(使えない)subtract 結果の下限を 0 として、表示オブジェクトの要素カラーの値をその背景色の値から減算します。
・表にない、以下の「Photoshopブレンドモード」は使えません。
[平均]
[消し込み]
[除外]
[ソフトライト]
[ファジーライト]
[覆い焼き (カラー)]
[焼き込み (カラー)]
[lay] レイヤ設定 レイヤに各種設定を行う。
レイヤの種類ごとに使用できる属性が違う

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

またpos以外の属性指定値はドット数の整数だが、
値域−1<X<1の小数値を指定した場合は
横幅(縦幅)全体を1とした比率とする。

(イメージ)「櫻の樹の下には」サンプルの「最初から始めるボタン」の位置(以下のスクリプト)を色々変更した様子を示します。
  [button pic="Mnu_btnStart" left=250 top=360(後略
※この例ではタイトルの画像を一部加工し、中心位置を分かりやすくしています。

※ボタンは以下の様に加工しています。
0 left=250 top=360(変更前、leftとtopにピクセル数で画面左上からの位置を指定)

1 left=0.5 top=360 (0.5……絶対値が一未満なので「横全長1とした時の0.5=半分」という意味)

2 center=0.5 top=360

3 right=0.5 top=360

4 s_right=0.5 top=360 (right=0.5と結果は同じだが、右端からの距離指定なのか、左端からなのかの違いがある)

5 right=0.4 top=360 (ボタン右端の画面左端からの距離)

6 s_right=0.4 top=360 (ボタン右端の画面右端からの距離)

7 left=250 top=0.5

8 left=250 middle=0.5

9 left=250 bottom=0.5

10 left=250 s_bottom=0.5

11 left=250 bottom=0.4

12 left=250 s_bottom=0.4

[lay] レイヤ設定(文字レイヤ) (文字レイヤ) false
属性必須省略時値域・型コメント
max_coln現在値1〜 ページあたりの表示列数(横書き時は上から下、縦書き時は右から左へ数える)
改行・禁則処理に使用。実際に文字が表示されるかは、フォントサイズや表示位置との兼ね合いによる。
初期値は 10
max_rown1〜 ページあたりの表示行数。初期値は 10
bura_coln0〜 禁則時ぶら下がり文字数。初期値は 2
chk_overrownBoolean true:カーソルがmax_rowを超えたらエラー&停止(初期値)
false:表示行数を越える直前に自動改ページ
b_leftn現在値画面左上を(0, 0)とする座標 テキスト背後の矩形表示位置。
初期値はそれぞれ 16 16
b_topn
b_widthn矩形表示縦横ピクセル数 テキスト背後の矩形表示縦横サイズ。
初期値はそれぞれ(画面横幅 - b_left *2)(画面縦幅 - b_top *2)
b_heightn
b_colorn色指定。0x000000など テキスト背後の矩形色。初期値は 0x000000(黒)
b_alphan実数:0.0(透明)〜1.0(不透過) テキスト背後の矩形不透明度。
表示しない場合は0を指定。初期値は 0
b_picn画像ファイル名文字レイヤ背後の枠画像を指定する。b_top、b_left、b_alphaの影響を受ける。
(これを指定するとb_colorは無視される)
back_clearn現在値Boolean true:背景をクリアする
b_alpha_isfixedn現在値Boolean true:テキスト背後の矩形不透明度を、「b_alpha属性と sys:TextLayer.Back.Alpha の掛け算とせず」、b_alpha属性値そのものにする。(これは2017/2/13以前の仕様)
draggablenfalseBoolean true:テキスト背後の矩形をドラッグできる
drag_xn0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_yn0
drag_wn画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_hn画面縦幅
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label
dragmove_argnString 指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる
h_scrollnピクセル数 横スクロールさせる量
v_scrollnピクセル数 縦スクロールさせる量
mouse_wheel_enablednBoolean マウスホイールでスクロール許可するか否か
layoutn現在値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属性は現在値を継続する。
初期値は空(から)、全くの未指定。

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

初期値は center。

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


[lay] レイヤ設定(画像レイヤ) (画像レイヤ)
属性必須省略時値域・型コメント
fny何もしない画像ファイル名基本画像ファイルを指定する
facen何もしない[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]
draggablenfalseBoolean true:テキスト背後の矩形をドラッグできる
drag_xn0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_yn0
drag_wn画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_hn画面縦幅
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label
dragmove_argnString 指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる

[lay] レイヤ設定(ムービーレイヤ) (ムービーレイヤ)
再生出来るフォーマットなどは(Adobe Flash Platform * ビデオ形式について)を参照。
ただしiOSのみ、拡張子は「flv」だけを再生する。
属性必須省略時値域・型コメント
fnnファイル名 省略時は何もしない。
ムービーファイル(拡張子はf4v、flv、mp4、mov、3gp、3g2)名を指定すると、
非同期に読み込みながら再生を開始する
widthnアプリ表示部分の横幅1〜ムービー再生サイズの横幅
heightnアプリ表示部分の縦幅1〜ムービー再生サイズの縦幅
loopn何もしないBoolean trueでループ再生する。(初期値false)
volumen10.0〜1.0(実数) 音量。-1ならBGM(sys:const.an.sound.BGM.volume)と同じ値

[lay] レイヤ設定(HTMLレイヤ) (HTMLレイヤ)
属性必須省略時値域・型コメント
url【更新】n何もしないhtml・htmファイル名 指定すると読み込んで表示する
(注意)属性onclickなどほとんどの属性はこれと同時指定すること。
widthnアプリ表示部分の横幅1〜レイヤの横幅
heightnアプリ表示部分の縦幅1〜レイヤの縦幅
cache_responsentrueBoolean このオブジェクトから発行された HTTP リクエストに対する正常な応答データをキャッシュするかどうか
paints_default_backgroundntrueBoolean ドキュメントの背景を不透明白色に塗るか。
透過したいときはfalseにして<body>のbackground-colorも指定しない。
use_cachentrueBooleanローカルキャッシュを使うか
onclick【更新】n処理無し処理対象HTML要素のid名(カンマ区切りで複数可能) 指定HTML要素クリック時にジャンプやコールする。
const.an.eventArg.html.idに要素idがセットされる。
callnfalseBoolean trueの場合は[call]、falseは[jump]
ただしcall=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
fn......... イベント発生時にジャンプする先。指定方法は[jump]と同様。
callの場合、ジャンプ先から[return]で戻ると、
再度[s]などのイベント待ち状態に戻る。
label
globalnfalseBoolean trueを指定すると大域的なイベント扱いとなり、
イベント発生時にイベント予約が削除されない
argnString 指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
[clear_lay] レイヤ設定の消去 画像や文字などレイヤ状態をクリアする。
alpha、blendMode、rotation、scaleX、scaleYを初期値にする
※背景や背景画像はクリアしません(b_left、b_top、b_width、b_height、b_color、b_alpha)
 クリアしたい場合は、[lay back_clear=true]
属性必須省略時値域・型コメント
layern全てのレイヤレイヤ名(半角カンマ区切りで複数レイヤを指定可能)
pagenforefore、back、bothページの裏表(both指定で両面)
filter【更新】nfalseBooleantrue:フィルタもクリア
[trans] ページ裏表を複写 裏ページを表ページとクロスフェードする。
クロスフェードを開始すると、終了を待たずに次のタグへと処理を進める。
終了を待ちたい場合は[wt]を使用する。

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

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

全ての画像・文字レイヤにおいて表示するものが何もない状態や、
レイヤ背後が見えてしまうようなレイヤ状態で[trans]すると妙な表示になります。
画面一杯に背景を表示するか、真っ黒や真っ白の画像を表示するようにして下さい

(2014/2/18 ver 4.11〜)仕様を緩和、なくてもOKにしました
属性必須省略時値域・型コメント
layern全てのレイヤ処理対象レイヤ名(カンマ区切りで複数可能)クロスフェードするレイヤ。指定以外のレイヤは変化させない
timen0ミリ秒変化にかける時間
delayn0ミリ秒変化する前に待機する遅延時間
rulen画面全体ピクセルで同時にクロスフェードする画像ファイル名(swf不可) 指定した場合はルール画像として、ピクセル単位でクロスフェードするタイミングをずらす。
ルール画像の黒いピクセル(と同じ位置にあるピクセル)が先に処理され、白が最後になる。
vaguen0.04トランジション期間全体を1とした値表レイヤと裏レイヤの境界を曖昧にぼかす度合い
lightnfalseBoolean少々ギザギザだが処理が軽い方法でクロスフェードするか
c_pluginn何もしない処理対象プラグイン名(カンマ区切りで複数可能)指定したプラグインの可視状態が[trans]で変化するようになる。表示非表示が切り替わる。ただしクロスフェード中はアニメが止まる
[wt] トランス終了待ち [trans]で開始したトランスの終了を待つ。
終了次第、スクリプト処理を次へ進める。

また[trans]~[wt]間で文字表示や[ch]は動作未定義、非推奨。
[trans]終了を待たず何かをするのは避けた方がよいでしょう
属性必須省略時値域・型コメント
canskipntrueBoolean trueでクリックキャンセル可能にする。
[finish_trans] トランス強制終了 引数無し。
[trans]で開始したトランス終了を待たず、すぐ終了させる。
終了次第、スクリプト処理を次へ進める

文字・文字レイヤ

[auto_pager] 自動改ページの設定 強制改ページで自動的に挿入する改ページタグなどを指定する。
マクロには「何らかのクリック待ち表示」と「[er]」を必ず含める事。
属性必須省略時値域・型コメント
ins_tagn[p er=true]定義済みのマクロ自動的に挿入するマクロ名を指定(引数無し)
[autowc] 自動ウェイト 特定の文字の直後に自動的にウェイトを入れる。
textに指定した文字に対し、timeに指定した数値が対応する。
通常の文字表示速度にtimeの数値を掛け算する。
属性必須省略時値域・型コメント
enabledn現在値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] 文字を書く 文字レイヤに文字を出力する
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
textyString 表示したい文字列。ルビ文法(《》)も解析する。改行も [r] で出来る
recordntrueBoolean履歴に保存するか
waitn現在の文字表示速度ミリ秒 一時的な文字表示速度。0で瞬時。
何らかのキー押下やマウスクリックで全てを瞬時表示する
joinntrueBoolean trueで読み込みを待って次のタグへ進む。

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

以下のようにも書けます。&から&までを[ch]文と解釈します。
&test&
&'test'&
&a + b&
[clear_text] 文字消去 文字のみをクリアする
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
[current] デフォルト文字レイヤ設定 デフォルト文字レイヤを設定する
属性必須省略時値域・型コメント
layery文字レイヤ名デフォルトとするレイヤ
[endlink] ハイパーリンクの終了 [link](ハイパーリンク)で開始したリンク区間を終了する
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
[er] ページ両面の文字消去 デフォルト文字レイヤの裏と表の両方に対して[clear_lay]を行う。
属性必須省略時値域・型コメント
rec_page_breakntrueBoolean履歴を改ページするか
[graph] インライン画像表示 文字レイヤに画像を文字として表示する。ルビは同時に設定する。
フォントにない外字やswfアニメ画像表示に使える。
このタグでの画像やswfに暗号化画像は使えない。使えるようになりました

文字レイヤをクリアすると画像も消える。
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
picy画像ファイル名表示する画像やswf
rnルビ無しString ルビ文字列(ただしあまりに他の文字サイズと大きく異なる場合は正しい位置に表示されない)
widthn画像の横サイズ(※)1〜 表示する画像の横ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
heightn画像の縦サイズ(※)1〜 保存する画像の縦ドットサイズ。
元のサイズと異なる場合は拡大・縮小される。
※省略時は画像サイズになるが、ロード完了直後に文字配置を決めるのでちらつく。それを嫌う際に指定する
※特にモバイルなどでゲーム画面が自動で拡大縮小される場合、省略したらその時の本文文字サイズとして扱われる。なるべくサイズ指定を推奨。
[link] ハイパーリンク 指定した文字レイヤの表ページに、ハイパーリンクを作成する。
[link]から[endlink](ハイパーリンクの終了)までで囲った範囲をリンク区間と呼び、
その区間の文字や縦中横がハイパーリンクになる。(リンク区間は入れ子に出来ません)
※選択肢として使用する場合、ジャンプ先のラベル直後には必ず[record_place]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。
ブラウザ実行時、ローカル版swfをブラウザで開いた場合はhref属性によるリンクジャンプが利きません。非ローカル版swfをサーバーに設置すれば動作します。
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pagenforefore、backページの裏表
hrefn何もしないURLクリック時にブラウザで指定URLを開く
targetn何もしないHTML <a>タグのtarget属性hrefにてブラウザを開く際のtarget属性
f_colorn0x8888FF色指定。0x000000など(リンク上にマウスがない状態)文字色
f_alphan1.0(不透明)0.0〜1.0(実数)(リンク上にマウスがない状態)文字の透過度
f_ulntrueBoolean(リンク上にマウスがない状態)trueの場合は文字に下線を引く
hf_colorn0xFFFF00色指定。0x000000など(リンク上にマウスがある状態)文字色
hf_alphan1.0(不透明)0.0〜1.0(実数)(リンク上にマウスがある状態)文字の透過度
hf_ulnfalseBoolean(リンク上にマウスがある状態)trueの場合は文字に下線を引く
af_colorn0x8888FF色指定。0x000000など(リンクをマウス押下した状態)文字色
af_alphan1.0(不透明)0.0〜1.0(実数)(リンクをマウス押下した状態)文字の透過度
af_ulntrueBoolean(リンクをマウス押下した状態)trueの場合は文字に下線を引く
b_colorn背景色なし色指定。0x000000などリンク背景色
b_alphan1.0(不透明)0.0〜1.0(実数)リンク背景の透過度
hintnString 設定した場合のみ、マウスカーソルを載せるとヒントをチップス表示する
clicksen省略時は無音効果音ファイル名 指定すると、クリック時に効果音を再生する
entersen省略時は無音効果音ファイル名 指定すると、ボタン上にマウスカーソルが載った時に効果音を再生する
leavesen省略時は無音効果音ファイル名 指定すると、ボタン上からマウスカーソルが外れた時に効果音を再生する
clicksebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
entersebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
leavesebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
callnfalseBoolean trueの場合は[call]、falseは[jump]
ただしcall=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
fn.........クリック時にジャンプする先。
指定方法は[jump]と同様
label
onentern何もしないラベル名 マウス重なり(フォーカス取得)時、指定したラベルをコールする。 必ず[return]で戻ること。
onleaven何もしないラベル名 マウス重なり外れ(フォーカス外れ)時、指定したラベルをコールする。 必ず[return]で戻ること。
globalnfalseBoolean 詳細は[event]と同様。
※ボタンを[trans]する場合はtrueにしておく
argnString 指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
[r] 改行 指定した文字レイヤの表ページに、改行を出力する。
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pagenforefore、backページの裏表
[rec_ch] 履歴にのみ文字を書く 履歴に改行を出力する。自動で改行を付加する。
属性必須省略時値域・型コメント
textyString 表示したい文字列。ルビ文法(《》)も解析する。
rtrueBooleantrueなら改行する
[rec_r] 履歴にのみ改行を書く 履歴に改行を出力する。
[reset_rec] 履歴リセット 履歴をクリアする。
応用として、履歴に加工した文字列を設定し、履歴画面に機能を追加する事も。
属性必須省略時値域・型コメント
textn全てクリアString 履歴に設定したい文字列
[ruby] 直前一文字のルビ設定 直前一文字のルビを設定する
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pagenforefore、backページの裏表
textyStringルビ文字列
[ruby2] 文字列と複数ルビの追加 親文字列とルビ文字列のセットで文字を追加する
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ名
pagenforefore、backページの裏表
tyString親文字列
ryStringルビ文字列

★ タグの他に、《》(二重山括弧)を使用した“ルビ記法”が使用できます。
ここではルビを打たれる本文を「親文字」と表記します。

|(全角縦線、似て非なる文字があるのでこのマニュアルからコピペ推奨)はルビ開始を示す記号で、《》(二重山括弧)はルビを指定します。
安全[ruby2 t="剃刀" r="かみそり"]の
安全|剃刀《かみそり》の
と同様です。
ルビ記法・全角縦線


★ |(全角縦線)は漢字と平仮名・句読点などの境界なら省略できます。
心を撲《う》たずには


★ 《*》と二重山括弧の中に半角アスタリスクで傍点を打ちます。
親文字全てに一つずつ自動で打ちます。

★ 《*★》とすると、「★」で傍点を打ちます。文字は文法が破綻しないもの(「》」など)なら自由です。


★ ルビを半角空白で区切ると、その文字群単位で親文字にルビを振ります。
、所謂《いはゆる》〜(省略)〜廻つた独楽《こ ま》が
ルビ記法・半角空白で区切り
「こ」と「ま」の間に半角空白が入っているので、
独に「こ」、楽に「ま」がルビとして振られます。


★ ルビのルビ揃えは、通常文字レイヤのr_align属性でレイヤに設定しますが、ルビごとに一時的にルビ揃えを指定することが出来ます。
記法は《》(二重山括弧)の中に「r_align属性 + |(全角縦線)+ルビ文字」です。
文字レイヤのr_align属性がenter(中付き)だとして……
雷《いかずち》さらに雷《left|いかずち》さらに雷《right|いかずち》さらに雷《いかずち》を
ルビ記法・ルビ揃え指定
left(肩付き)で「先頭親文字から揃え」られ、
right(右/下揃え)で「末尾親文字から揃え」られています。
省略時は文字レイヤのr_align属性に従います。


★ 新機能(15/7/8 ver 5.43以上)
・ルビ記法《》内でURLエスケープをサポート(既存プロジェクトで文字「%」を使用している場合、「%25」と置換して下さい)
・ルビ記法《》内で半角で区切りたいが「その文字群単位で親文字にルビを振り『たくない』」際、タブ文字でそのような動作に

 以下のスクリプトで、
%《%25》縦棒《%ef%bd%9c》二重山括弧《%e3%80%8axxx%e3%80%8b》[r]
|ケセラセラ《Que Sera, Sera》[r] ; 半角空白区切り
|ケセラセラ《Que Sera, Sera》[r] ; タブ文字区切り
|ケセラセラ《Que%20Sera,%20Sera》[r] ; %20区切り
 以下の表示になります。(めっちゃ見づらいけど縦棒も出てます)
ルビ記法・拡張
 縦書きではこんな感じ。
ルビ記法・拡張
「タブ文字区切り」と「%20区切り」では微妙に文字配列が違うのですね。
[span] インラインスタイル設定 この指定以降の文字のレイアウト(フォントや文字色など)を指定する。
一時的に文字レイヤのlayout属性への指定を上書きするイメージ。
文字レイヤをクリア([clear_text][clear_lay])するとリセット、以降は元通り文字レイヤのlayout属性に従う
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
layoutnリセットString 文字のレイアウトを指定する。文法は[lay]のlayout属性と同様。
[tcy] 縦中横を表示する 縦中横文字を追加する。ルビは同時に設定する
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名文字を表示するレイヤ
pagenforefore、backページの裏表
tyString縦中横文字列、通常半角文字を指定する。
rnルビ無しStringルビ文字列

例えば
今[tcy t="!?"]の[tcy t="!!" r="がーん"] [tcy t="(8)"]
と記述すると……
縦中横とルビ

内部的には
[tcy t="!!" r="がーん"]
| 《tcy|!!|がーん》
に変換される。(よってルビ記法はこの縦中横タグをまたげない)

画像・画像レイヤ

[add_face] 差分画像の登録 差分画像を登録する。
本タグだけでは差分画像を表示しない。画像レイヤの[lay]タグface属性で指定する差分名称を登録する。
属性必須省略時値域・型コメント
namey差分名称[lay]タグface属性で指定する差分名称
fnn属性nameの値画像ファイル名表示する画像、swf
dxn0基本画像左上を(0, 0)とする座標差分画像の表示横位置
dyn0差分画像の表示縦位置
blendmoden何もしないブレンドモード名("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を変えることで登録できます。
[let_face_frame] 差分SWFの現在フレーム番号 変数に差分SWFの現在フレーム番号を代入する。
ActionScript 3.0(AVM2)以上のSWF必須、AVM1はエラー
【com04氏が「swf6~swf8(AVM1)のファイルを、swf10(AVM2)に変換するコンバーター」を製作されました。「tool」−「ConvertSWF10」です】
属性必須省略時値域・型コメント
nameyString(変数名書式)変数名
layery画像レイヤ名画像レイヤ名
pagenforefore、backページの裏表
face_non00〜現在画像レイヤに設定された差分画像数0は画像レイヤ、1以上は[lay face=""]で指定した差分画像を左から順に番号を振った数値
[let_face_totalframes] 差分SWFのフレーム総数 変数に差分SWFのフレーム総数を代入する。
ActionScript 3.0(AVM2)以上のSWF必須、AVM1はエラー
【com04氏が「swf6~swf8(AVM1)のファイルを、swf10(AVM2)に変換するコンバーター」を製作されました。「tool」−「ConvertSWF10」です】
属性必須省略時値域・型コメント
nameyString(変数名書式)変数名
layery画像レイヤ名画像レイヤ名
pagenforefore、backページの裏表
face_non00〜現在画像レイヤに設定された差分画像数0は画像レイヤ、1以上は[lay face=""]で指定した差分画像を左から順に番号を振った数値
[play_face] 差分SWFの再生開始 [lay]で開始したSWFアニメの再生を開始する。
ActionScript 3.0(AVM2)以上のSWF必須、AVM1はエラー
【com04氏が「swf6~swf8(AVM1)のファイルを、swf10(AVM2)に変換するコンバーター」を製作されました。「tool」−「ConvertSWF10」です】
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
pagenforefore、backページの裏表
face_non00〜現在画像レイヤに設定された差分画像数0は画像レイヤ、1以上は[lay face=""]で指定した差分画像を左から順に番号を振った数値
labelnframeが有効になるStringSWFアニメのジャンプ先フレームを指定するラベル
framen現在位置から再生NumberSWFアニメのジャンプ先フレーム番号
[stop_face] 差分SWFの再生停止 [lay]で開始したSWFアニメの再生を停止する。
ActionScript 3.0(AVM2)以上のSWF必須、AVM1はエラー
【com04氏が「swf6~swf8(AVM1)のファイルを、swf10(AVM2)に変換するコンバーター」を製作されました。「tool」−「ConvertSWF10」です】
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
pagenforefore、backページの裏表
face_non00〜現在画像レイヤに設定された差分画像数0は画像レイヤ、1以上は[lay face=""]で指定した差分画像を左から順に番号を振った数値
labelnframeが有効になるStringSWFアニメのジャンプ先フレームを指定するラベル
framen現在位置で停止NumberSWFアニメのジャンプ先フレーム番号
[wa] SWFアニメの停止待ち [lay]で開始したSWFアニメの終了を待つ。
終了次第、スクリプト処理を次へ進める。
ActionScript 3.0(AVM2)以上のSWF必須、AVM1はエラー
【com04氏が「swf6~swf8(AVM1)のファイルを、swf10(AVM2)に変換するコンバーター」を製作されました。「tool」−「ConvertSWF10」です】
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
pagenforefore、backページの裏表
face_non00〜現在画像レイヤに設定された差分画像数0は画像レイヤ、1以上は[lay face=""]で指定した差分画像を左から順に番号を振った数値
arrivenfalseBoolean trueならクリックスキップ時にアニメを終端までジャンプさせ停止。
falseならその場で停止。

ムービーレイヤ

[pausevideo] 動画の一時停止 ムービーレイヤの[lay]で開始した動画再生の一時停止
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
[resumevideo] 動画再生の再開 ムービーレイヤの[lay]で開始した動画再生の再開
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
[rewindvideo] 動画の巻き戻し ムービーレイヤの[lay]で開始した動画の先頭へ巻き戻し
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
[seekvideo] 動画のシーク移動 ムービーレイヤの[lay]で開始した動画のシーク移動
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
offsety 動画ファイルにおける、再生ヘッドのおおよその移動時間
[toggle_pausevideo] 動画再生を一時停止/再開 ムービーレイヤの[lay]で開始した動画再生を一時停止/再開する。
交互に[pausevideo][resumevideo]を繰り返す。
属性必須省略時値域・型コメント
layery画像レイヤ名画像レイヤ名
[wv] 動画再生終了待ち 引数無し。
ムービーレイヤの[lay]で開始したムービー再生の終了を待つ
属性必須省略時値域・型コメント
layern最後に追加したムービーレイヤ。省略不推奨ムービーレイヤ名ムービーレイヤ名
canskipntrueBoolean trueでクリックキャンセル可能にする。

HTMLレイヤ

[exist_html] HTML要素を存在チェック HTMLの要素やJavaScript変数の存在チェック。
結果は一時変数に代入される。
 const.an.exist_html …… 存在する場合true
[lay]でHTMLファイルを読んだ直後ではまだ準備中で、存在しない場合がある。そのチェックに使える
属性必須省略時値域・型コメント
layeryHTMLレイヤ名HTMLレイヤ名
pagenforefore、backページの裏表(HTMLレイヤは表のみです)
var_nameどちらかのみ指定String取得するJavaScript変数名
idString取得するHTML要素のid属性
[let_html] HTML要素を取得 HTMLの要素やJavaScript変数を取得する。
結果は一時変数に代入される。
 const.an.js.(変数名) …… JavaScript変数の結果が入る
 const.an.html.(HTML要素のid属性) …… HTMLタグに挟まれた文字列が入る
[lay]でHTMLファイルを読んだ直後では要素が存在しない場合があり、エラーになります。[exist_html]で存在チェックする事が出来ます。
属性必須省略時値域・型コメント
layeryHTMLレイヤ名HTMLレイヤ名
pagenforefore、backページの裏表(HTMLレイヤは表のみです)
var_nameどちらかのみ指定String取得するJavaScript変数名
idString取得するHTML要素のid属性
functionn変数として扱うBoolean trueを指定するとvar_nameを関数として呼び、戻り値を返す。
var_name指定時のみ有効。
[set_html] HTML要素に設定 HTMLの要素やJavaScript変数に設定する。
一時変数にも代入される。
 const.an.js.(変数名) …… JavaScript変数の結果が入る
 const.an.html.(HTML要素のid属性) …… HTMLタグに挟まれた文字列が入る
[lay]でHTMLファイルを読んだ直後では要素が存在しない場合があり、エラーになります。[exist_html]で存在チェックする事が出来ます。
属性必須省略時値域・型コメント
layeryHTMLレイヤ名HTMLレイヤ名
pagenforefore、backページの裏表(HTMLレイヤは表のみです)
var_nameどちらかのみ指定String設定するJavaScript変数名
idString設定するHTML要素のid属性
textyStringセットする値

イベント

[event] イベントを予約 次の[s]などのイベント待ちに向けてイベント処理を予約する。
あるイベントが発生した際、global=falseのイベント予約は全て削除される
属性必須省略時値域・型コメント
keyy click、rightclick、middleclick、upwheel、downwheel、
イベントのキー名※1
イベントを発生させるトリガーイベント

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

※1 イベントのキー名は以下のキーボードキー名かActionScriptイベント名のいずれか。
key属性の値コメント
alternateoptionと同値。Winで言うALTキー。MacならOptionキー
backquote
backslash
backspace
caps_lock
commandMacにある、Winで言うCTRLキーのようなもの
control
delete
down矢印キーの下
end
enter
equal「=(イコール)」キーはMacにしか無い
escape
home
left矢印キーの左
numpad_enterテンキーのEnterキー。テンキーはキーボードによっては存在しない
optionalternateと同値。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イベントは毎秒何度も発生する。

※3 以下のデバイス回転状態の変数を更新する。
const.Stage.deviceOrientation ; デバイス方向(iOSでは冒頭、unknown)
const.Stage.orientation ; ステージ方向
const.StageOrientationEvent.beforeOrientation ; ステージ方向の前回値(初期NULL)
const.StageOrientationEvent.afterOrientation ; ステージ方向と同じ値(初期NULL)

以下はGoogle TV用だが、開発者がテストしていない点に注意。
(Sony Internet TV リモコン製品写真に見えたもののみ用意してある)
key属性の値コメント
channel_down
channel_up
guide
dvr
yellow
blue
red
green
record
stop
skip_backward
skip_forward
previous
play
pause
next
audio
info
[clear_event] イベントを全消去 イベント予約を全て削除する
属性必須省略時値域・型コメント
globalnfalseBoolean trueを指定すると全ての大域イベントを削除する。
falseの場合は大域以外の全てのイベントを削除する
[enable_event] イベント有無の切替 文字レイヤごとのイベント発生有効無効を設定する。
無効にするとマウスイベントが無効になり、[s]待ちなどでイベントが発生しなくなるが、イベント予約は別の話であり、削除などされない。
有効にすればマウスイベントが発生するようになり、再びイベント待ちされるようになる
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名イベント有効無効を設定するレイヤ
enabledntrueBooleanイベントを有効にするか
[gesture_event] ジェスチャイベント予約 次の[s]などのイベント待ちに向けてイベント処理を予約する。
[event]と異なり、ジェスチャ関係のイベントを一つのタグで同時に全て指定できる。
[event]と異なり、arg属性は使用出来ない(値を返すのに使用される)
あるイベントが発生した際、global=falseのイベント予約は全て削除される
属性必須省略時値域・型コメント
callnfalseBoolean 指定方法は[event]と同様
fnn...... 指定方法は[event]と同様。
ただし複数ジェスチャイベント同時指定時は兼用である事に注意。変えたい場合は[gesture_event]を個別に記述する
swipen何もしないラベル名 一本指でスワイプ(上下左右、一方向へなぞる)イベント発生時、 このラベルにジャンプ(コール)する。
f2tapn何もしないラベル名 二本指で触れて離すイベント発生時、 このラベルにジャンプ(コール)する。
f2moven何もしないラベル名 二本指で触れ、広げるピンチアウト(ピンチオープン)、
狭めるピンチイン(ピンチクローズ)、
ひねるような回転イベント発生時、このラベルにジャンプ(コール)する。
f3tapn何もしないラベル名 三本指で触れて離すイベント発生時、 このラベルにジャンプ(コール)する。
globalnfalseBoolean 指定方法は[event]と同様
delnBoolean 指定方法は[event]と同様

※1 発生イベントにより、変数const.an.eventArgに以下の値がセットされる。
イベントconst.an.eventArgコメント
swipe英字一文字 スワイプ方向を表わす上下左右の「udlr」文字
f2tapなし ※指の具合によりf2moveが優先される場合があります
f2move〜.pinchOpen 戻り値「const.an.eventArg.pinchOpen」が
trueなら「拡大」、falseなら「縮小」
f2move〜.clockwise 戻り値「const.an.eventArg.clockwise」が
trueなら「時計回り」、falseなら「反時計回り」
f3tapなし
[l] 行末クリック待ち シナリオファイルの順次処理を停止し、クリックやキー押下(→詳細は[waitclick])を待つ。
「breakline」という画像やswfファイルが用意されていれば、行末クリック待ちマークとして表示する。
クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。
属性必須省略時値域・型コメント
visiblentrueBooleantrueで行末クリック待ち記号を表示、falseで非表示

※注意 ActionScript 3.0(AVM2)以上のSWF推奨、AVM1は出来れば避けて下さい。
[set_cancel_skip] スキップ中断予約 引数無し。
ページ末まで一気に読み進むモード、自動読みすすみモードなどの開始に備え、クリックなどで処理を中断できるような特殊イベントを予約する。
クリックやキー押下が発生した場合、処理を再開する。

※例えば自動読み進みモードだと[l][p]などで停止しないため、予約イベントが処理されない。その為のタグ。
[p] 改ページクリック待ち シナリオファイルの順次処理を停止し、クリックやキー押下(→詳細は[waitclick])を待つ。
「breakpage」という画像やswfファイルが用意されていれば、改ページクリック待ちマークとして表示する。
クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。
属性必須省略時値域・型コメント
visiblentrueBooleantrueで改ページ記号を表示、falseで非表示
ern何もしないBooleantrueで改ページ待ち後に[er]処理を行なう

※注意 ActionScript 3.0(AVM2)以上のSWF推奨、AVM1は出来れば避けて下さい。
また[p]の後、速やかに[er]などでテキストをクリアして下さい。[p]直後に[trans]などで不具合が起こる可能性があります。
「櫻の樹の下には」サンプルの[plc]マクロでは対応済みです。
[s] 停止する 引数無し。
シナリオファイルの順次処理を停止する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。
[wait] ウェイトを入れる 指定時間スクリプト処理を待ち、再開する。
[event]などでイベントが登録されていても、イベント発生待ちを行わない
属性必須省略時値域・型コメント
timeyミリ秒処理を待つ時間
canskipntrueBoolean クリックなど(→詳細は[waitclick])でウエイトをキャンセルできるか
[waitclick] クリックを待つ 引数無し。
シナリオファイルの順次処理を停止し、クリックやキー押下※を待つ。
クリックやキー押下が発生した場合、処理を再開する。
[event]などでイベントが登録されていれば、イベント発生待ちを行う。

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

BGM・効果音

[fadebgm] BGMのフェード BGMを指定した音量に、段階的に変化させる。
属性必須省略時値域・型コメント
volumey0.0〜1.0(実数)音量
timeyミリ秒フェード時間
delayn0ミリ秒変化する前に待機する遅延時間
[fadeoutbgm] BGMのフェードアウト BGMを無音に、段階的に変化させる。
属性必須省略時値域・型コメント
timeyミリ秒フェード時間
stopntrueBoolean trueで「フェード終了時の再生停止」、falseなら行なわない。
delayn0ミリ秒変化する前に待機する遅延時間
[fadeoutse] 効果音のフェードアウト 効果音を無音に、段階的に変化させる。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
timeyミリ秒フェード時間
stopntrueBoolean trueで「フェード終了時の再生停止」、falseなら行なわない。
delayn0ミリ秒変化する前に待機する遅延時間
[fadese] 効果音のフェード 効果音を指定した音量に、段階的に変化させる。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
volumey0.0〜1.0(実数)音量
timeyミリ秒フェード時間
delayn0ミリ秒変化する前に待機する遅延時間
[playbgm] BGM の演奏 BGMを再生する。
[playse]とは違い、キー押下Skip中でも必ず再生を行なう。(canskip = false)
属性必須省略時値域・型コメント
fnyBGM音声ファイル名 再生する音声ファイル名
loopntrueBoolean trueでBGMのようにループ再生する。
volumen1.00.0〜1.0(実数)再生音量。ただし音量を示すシステム変数(sys:const.an.sound.BGM.volume)は変更しない
ret_msn0(冒頭)ミリ秒 ループ戻り位置指定。冒頭から再生開始するが、mp3終端に行くたびに指定したミリ秒の位置に戻る
end_msn終端ミリ秒 音声ファイルの終端位置を指定する。(音声ファイルの末尾にどうしても無音が残る場合、ループ時に困るときなどに)
正の値は「冒頭から何ms目を終端とするか」
負の値は「末尾から何ms手前を終端とするか」の指定。
joinntrueBoolean trueで読み込みを待って次のタグへ進む。
[playse] 効果音の再生 効果音を再生する。
属性必須省略時値域・型コメント
fny効果音音声ファイル名 再生する音声ファイル名
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
loopnfalseBoolean trueでBGMのようにループ再生する。
volumen1.00.0〜1.0(実数)再生音量。ただし音量を示すシステム変数(sys:const.an.sound.【トラック名】.volume)は変更しない
ret_msn0(冒頭)ミリ秒 ループ戻り位置指定。冒頭から再生開始するが、mp3終端に行くたびに指定したミリ秒の位置に戻る。
end_msn終端ミリ秒 音声ファイルの終端位置を指定する。(音声ファイルの末尾にどうしても無音が残る場合、ループ時に困るときなどに)
正の値は「冒頭から何ms目を終端とするか」
負の値は「末尾から何ms手前を終端とするか」の指定。
joinntrueBoolean trueで読み込みを待って次のタグへ進む。
canskipntrueBoolean trueでキー押下Skip中なら再生をしない
cachentrueBoolean trueなら今まで通り、内部的にサウンドデータをキャッシュして再度再生時に素早く再生する(mp3のみ)
[stop_allse] 全サウンドの停止 全てのサウンドを停止する。ぴたっと止める。
[stopbgm] BGM 演奏の停止 BGM 演奏を停止する。ぴたっと止める。
[stopfadese] 音声フェードの停止 音声フェードを停止する。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名 トラック名を変えれば同時に複数の音を操作することが出来ます。
BGMと指定するとBGMの指定。
[stopse] 効果音再生の停止 効果音再生を停止する。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
[volume] 音量設定 BGMや効果音を指定した音量にする。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名 トラック名を変えれば同時に複数の音を操作することが出来ます。
BGMと指定するとBGMの音量設定。
volumen1.00.0〜1.0(実数)音量
[wb] BGM フェードの終了待ち BGM フェードの終了を待つ。
属性必須省略時値域・型コメント
canskipnfalseBoolean trueでクリックキャンセル可能にする。
[wf] 効果音フェードの終了待ち 効果音 フェードの終了を待つ。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
canskipnfalseBoolean trueでクリックキャンセル可能にする。
[wl] BGM 再生の終了待ち BGM 再生の終了を待つ。
loop=true([playbgm]のデフォルト値)なら待たない。
利用時は【音声再生[playbgm]がjoin=true(ちなみにデフォルト)であること】を必須条件とします。
[ws] 効果音再生の終了待ち 効果音再生の終了を待つ。
loop=trueなら待たない。
利用時は【音声再生[playse]がjoin=true(ちなみにデフォルト)であること】を必須条件とします。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名を変えれば同時に複数の音を操作することが出来ます。
canskipnfalseBoolean trueでクリックキャンセル可能にする。
[xchgbuf] 再生トラックの交換 二つのバッファを交換する。未再生でも再生中でも良いが、フェード中は避けること。
属性必須省略時値域・型コメント
bufnSE効果音を識別するトラック名トラック名
buf2nSE効果音を識別するトラック名もう一つのトラック名

条件分岐

[else] その他ifブロック開始 引数無し。
プログラム言語における、条件分岐のelse文。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。
[elsif] 別条件のifブロック開始 プログラム言語における、条件分岐のelsif文。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。
属性必須省略時値域・型コメント
expyBooleantrueの場合処理は直後にうつる。
falseなら次の[elsif]や[else]の評価を行なう。
[endif] ifブロックの終端 引数無し。
プログラム言語における、条件分岐のendif文。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。
[if] ifブロック開始 プログラム言語における、条件分岐のif文。
詳細は【開発者向け情報:式の評価と条件分岐】をご覧下さい。
属性必須省略時値域・型コメント
expyBooleantrueの場合処理は直後にうつる。
falseなら次の[elsif]や[else]の評価を行なう。

ラベル・ジャンプ

[button] ボタンを表示 文字レイヤにボタンを配置する。
※選択肢として使用する場合、ジャンプ先のラベル直後には必ず[record_place]を記述して、ジャンプ直後でセーブしても正しくセーブされるようにして下さい。
属性必須省略時値域・型コメント
layernデフォルト文字レイヤ文字レイヤ名ボタンを配置する文字レイヤ
pagenbackfore、backページの裏表
picy画像ファイル名(swf不可) ボタンとして配置する画像を指定する。
ただし画像は縦に三等分し、左から「通常時」「クリック押下時」「マウスカーソルを載せた時」の画像として表示する。
pos
left
center
right
s_right
top
middle
bottom
s_bottom
n※詳細は[lay]を参照
hintnString 設定した場合のみ、マウスカーソルを載せるとヒントをチップス表示する
clicksen省略時は無音効果音ファイル名 指定すると、クリック時に効果音を再生する
entersen省略時は無音効果音ファイル名 指定すると、ボタン上にマウスカーソルが載った時に効果音を再生する
leavesen省略時は無音効果音ファイル名 指定すると、ボタン上からマウスカーソルが外れた時に効果音を再生する
clicksebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
entersebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
leavesebufnSYSサウンドバッファ名 クリック時効果音を再生するサウンドバッファを指定する
callnfalseBoolean trueの場合は[call]、falseは[jump]
ただしcall=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
fn.........クリック時にジャンプする先。
指定方法は[jump]と同様
label
argnString 指定した場合、クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
r_callnfalseBoolean 右クリック時ジャンプについての指定。
trueの場合は[call]、falseは[jump]
ただしr_call=trueによりサブルーチンコールした場合、[return]によって「コールする前のイベント予約状態&待ち状態」に戻る。
r_fn.........右クリック時にジャンプする先。
指定方法は[jump]と同様
r_label
r_argnString 指定した場合、右クリック時ジャンプ先で「&const.an.eventArg」にて値を受け取れる
onentern何もしないラベル名 マウス重なり(フォーカス取得)時、指定したラベルをコールする。 必ず[return]で戻ること。
onleaven何もしないラベル名 マウス重なり外れ(フォーカス外れ)時、指定したラベルをコールする。 必ず[return]で戻ること。
globalnfalseBoolean 詳細は[event]と同様。
※ボタンを[trans]する場合はtrueにしておく
enabledntrueBoolean falseだと押せないボタンとなり、クリックイベントが発生しない。
これにより文字レイヤの任意の位置に画像表示できる機能を提供する。
画像は三等分しない。イベントや効果音指定は無効だが、ヒント機能は有効。
joinnfalseBoolean trueで画像読み込みを待って次のタグへ進む。
event_at_downnfalseBoolean true:押すだけでイベント発動(画面常駐のシステムボタンなどに)
false:押して離すとイベント発動
draggablenfalseBoolean true:テキスト背後の矩形をドラッグできる。
event_at_down=trueだとクリックイベントが発生しなくなる。
drag_xn0画面左上を(0, 0)とする座標ドラッグ範囲の左上始点。
drag_yn0
drag_wn画面横幅ドラッグ範囲縦横ピクセル数ドラッグ範囲縦横サイズ。
drag_hn画面縦幅
dragmove_fn.........ドラッグ中にサブルーチンコールする先。
指定方法は[jump]と同様
dragmove_label
dragmove_argnString 指定した場合、ドラッグ中コール先で「&const.an.eventArg」にて値を受け取れる
alphan1.00.0〜1.0(実数)透過度。0(完全透明)〜0.5(半透明)〜1(不透明)
blendmoden何もしないブレンドモード名("screen"など) このボタンと下のレイヤとの重なりにおいて、
ドット単位で色のブレンド演算を行なう。
詳細はblendModeの解説を参照。
rotationn0-180〜180 回転角を度単位で指定。時計回りは0~180、反時計回りは0~-180を指定。 左上を中心に回る
scale_xn1.0正負の実数値 横方向を何倍に拡大/縮小するか。負の値ならレイヤを左右反転
scale_yn1.0正負の実数値 縦方向を何倍に拡大/縮小するか。負の値ならレイヤを上下反転
[call] サブルーチンコール スクリプト処理の現在位置をコールスタックに積み、ジャンプする。
ジャンプ先での[return]により本タグの次の位置に戻る事が出来る。
属性必須省略時値域・型コメント
fnどちらか、もしくは両方を指定処理中のスクリプトファイルスクリプトファイル名 コール先のスクリプトファイル
[call fn=ext_*]のようにワイルドカードをサポート。マッチするスクリプトを順不同にコールする。 (ワイルドカードは後方のみ)
labelスクリプトファイルの先頭ラベル名(半角アスタリスク*も含む)コール先のスクリプトファイルにあるラベル
countnfalseBooleanタグ位置を既読とするか
clear_local_eventn何もしないBooleantrueの場合は[clear_event]を行なってからコールする。

※あらゆるタグの中で唯一「通常、既読としない」タグですが、普通に使う分には気にしなくて良いです。
[jump] シナリオジャンプ 指定位置のスクリプトにジャンプする
属性必須省略時値域・型コメント
fnどちらか、もしくは両方を指定処理中のスクリプトファイルスクリプトファイル名コール先のスクリプトファイル
labelスクリプトファイルの先頭ラベル名(半角アスタリスク*も含む)コール先のスクリプトファイルにあるラベル
countntrueBooleanタグ位置を既読とするか
※スクリプトファイル名を「http://」で始めるとネット上のスクリプトファイルをロードし実行します。
これは[button]などすべてのfn属性において同様です。

ラベルは例えば以下のように使います。
; =======================
*aaa
    無限ループ
    [jump label=*aaa]
; =======================

さらにラベル名を考えるのが面倒なとき、「無名ラベル」ともいうべき機能が使えます。
「**after」は「そのコマンド以降で最初に見つかった**ラベルに」
「**before」は「そのコマンド以前で最初に見つかった**ラベルに」
ジャンプ・コールする、という指定です。次のように書きます。
; =======================
	[jump label=****after]
***
**
	も
	[jump label=**after]
;**
	っ
**
	[l]
	ぷ
	[jump label=**before]
**
	@[s]
**
****
	す
	[jump label=***before]
; =======================
この例では「すもぷぷぷ……」と文字が表示されます。
「**」とか「***」とかアスタリスクは二個以上の任意の数が使え、同じ数同士が対応するラベルとなります。
が、上記例で見るとおりあんまり複雑に使うと可読性が下がってしまう気がしますので、局所的な用途に限ったほうが良さげです。
[pop_stack] コールスタック破棄 コールスタックを一つ破棄する
属性必須省略時値域・型コメント
clearnfalseBooleantrue:全て破棄する。空でもエラーを出さない
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既存のタグやマクロと重複しないマクロ名
exist_errntrueBoolean false:定義済みの際、エラーを出さず何もしない

しおり

[copybookmark] しおりの複写 しおりデータを複写する
属性必須省略時値域・型コメント
fromy数値複写元のしおり番号
toy数値複写先のしおり番号
pathn従来通り SharedObjectに保存フォルダパス 指定した場合、複写先(to)のしおりをファイルとしてフォルダパス下に保存する。
※AdobeAIR環境のみ。Flash環境では無視される
[erasebookmark] しおりの消去 しおりデータを削除する
属性必須省略時値域・型コメント
placey数値処理対象のしおり番号
[load] しおりの読込 しおりデータを読み込み、スクリプト処理を再開する
属性必須省略時値域・型コメント
placey数値処理対象のしおり番号
fn......... ロード後最初にしたい共通処理をコールする(処理は[return]で終わらせる)。指定方法は[jump]と同様。
ただし指定する際、fnとlabelは両方指定しなければならない。
label
[record_place] セーブポイント指定 引数無し。
本タグの位置を、スクリプト読み込み時に再開する位置として設定する。
本タグで「しおりを挟み」、[save]タグで実際にデータをセーブするイメージ。

※マクロやサブルーチン内に記述された場合、最初に積まれたコールスタック位置をセーブポイントとする。
属性必須省略時値域・型コメント
layern全てのレイヤ保存対象レイヤ名(カンマ区切りで複数可能)しおりに状態を保存するレイヤ。Save/Load画面レイヤや設定画面レイヤなど、保存すべきでないレイヤを除いて指定すべき
reset_soundntrueBoolean全てのサウンドを停止・再度再生開始するか
[save] しおりの保存 しおりデータを保存する。
読み込み時に再開するスクリプトの位置は最後に[record_place]をコールした位置。

[record_place]がゲーム状態(レイヤ状態など)をバッファに退避し、
[save]は指定しおりに書き出す機能。
属性必須省略時値域・型コメント
placey数値処理対象のしおり番号
pathn従来通り SharedObjectに保存フォルダパス 指定した場合、しおりをファイルとしてフォルダパス下に保存する。
※AdobeAIR環境のみ。Flash環境では無視される
※ファイルとして保存するとSharedObjectの肥大を抑え、システム動作の緩慢化を防ぐ効果があるので、推奨します。

デバッグ・その他

[clearsysvar] システム変数の全消去 引数無し。
削除すると言うより、初期化する
[clearvar] ゲーム変数の全消去 引数無し。
削除すると言うより、初期化する
[dump_lay] レイヤのダンプ レイヤの内容をデバッグ表示する
属性必須省略時値域・型コメント
layern全てのレイヤレイヤ名(半角カンマ区切りで複数レイヤを指定可能) 「plg:プラグイン名」と記述する事でプラグインも指定できる。
[dump_val] 変数のダンプ 引数無し。
変数の内容をデバッグ表示する
[dump_stack] スタックのダンプ 引数無し。
[call]等によるコールスタックの内容をデバッグ表示する
[log] ログ出力 引数をデスクトップにテキスト出力する(追記ではなく上書き。追記する。出力日時・分・スクリプト名や行番号・OSやプロジェクト名も出力)
属性必須省略時値域・型コメント
textyString出力する値
[reload_script] スクリプト再読込 引数無し。
現在処理中のスクリプトをリロードする。
実行位置は[record_place]によるセーブポイントまで戻って再開する。

※テキストエディタなどで大幅に変えた後リロードすると、正常に再開できない場合があります。
※HTMLレイヤーはリロードをサポートしません。Adobe AIRというVMの中にあるJavaScript VMという二重構造なためです。
 HTMLが読み込まれているか(そのHTMLファイル名)を示す変数「const.an.lay.(layer名).url」を駆使して再初期化を行いなど、処理が必要です。
[stats] パフォーマンス表示 FPSやメモリ使用量をチェックするStatsを表示する。(見方)。
指定しない場合はデバッグ表示[trace]を右にどかす
属性必須省略時値域・型コメント
leftn0画面左上を(0, 0)とする座標表示の横位置
topn表示の縦位置
[trace] デバッグ表示へ出力 引数をデバッグ表示する
属性必須省略時値域・型コメント
textyStringデバッグ表示する値
inserted by FC2 system