ygs2001シナリオファイルフォーマット

☆　サポートしているタグ(HTMLのサブセット)

改行。改行コード(CR+LF)では改行されません。あるいは、表示が右端になると、自動的に改行が入ります。
～ 　 と同じ効果があります。また、のようにしてセンタリング（中央寄せ）することが出来ます。align="left"とalign="right"もサポートしています。（ディフォルトでは左寄せです）
<HR>　HTMLでは水平線を意味しますが、１回に表示するメッセージの区切り記号として使います。
<! コメント>　コメントタグです。表示はされませんが、内部バッファに格納されるので取り出すことが出来ます。
<HEAD> ～ </HEAD>　ヘッダタグです。囲まれている領域は無視されます。
<html>,</html>,<body>,</body>　それぞれ無視します。
　ボールド体（太字）にします。
　ボールド体（太字）をもとに戻します。
　イタリック体（斜体）にします。（サポート甘いので、斜め右上欠けることあり＾＾；）
　イタリック体（斜体）をもとに戻します。
　アンダーライン付きにします。
　アンダーライン付きをもとに戻します。
<S>　取り消し線付きにします。
</S>　取り消し線付きをもとに戻します。
～　フォント指定をします。FONT指定のなかで使えるのは、size="+4"とかのサイズ指定（絶対指定は不可。相対指定のみ）と、color="#ff0000"での色指定（色名での指定は不可。色は16進数でR,G,B順）、face="ＭＳゴシック"というようなフォント指定(ディフォルトではＭＳゴシックで、使えるのは、ＭＳゴシック、ＭＳＰゴシック、ＭＳ明朝、ＭＳＰ明朝の４種）のみです。～タグは、ネストできます。

☆　HTMLには存在しないタグ

<IndentForBracket> 鍵括弧による会話文を表示するときなど、２行目以降、全角スペースひとつ分インデントしたい時に使います。一行目の行頭で書きます。

<IndentForBracket n> 鍵括弧による会話文を表示するときなど、２行目以降、全角スペースをｎ個分インデントしたい時に使います

あと、<　> &は、それぞれ < > & と自動的に変換されて表示されます。

<top> <middle> <bottom> 文字列の縦の表示位置を指定します。一行に、サイズの違う文字列が混在している場合などに、上寄せ、センタリング（縦方向）、下寄せを指定します。指定がなければ、下寄せです。

☆　特殊タグ

<Gaiji n>　ユーザー定義外字を使うことが出来ます。grp/scenario/gaiji_define.txtで外字とするスプライトを定義しておき、そのナンバーnを指定すると、それを表示することが出来ます。

【タグ表記上のカンマについて】

以下のタグで、カンマ（，）で区切って記述するように書いてありますが、実際は、スペースやタブでも構いません。

☆　ＳＥＰＬＡＹ　：　効果音再生

<SEPLAY 演奏するSEナンバー[,ループ再生か？(省略時は0)]>
例)
<SEPLAY 2,1> : 2番のSEをループ再生(繰り返し再生される。次のシーンに移行するときまで再生され続ける)します。
<SEPLAY 2,0> : 2番のSEを１回だけ再生します
<SEPLAY 2> : 上の<SEPLAY 2,0>と同じ意味です

　何番のSEが何の効果音であるかは、ゲームによって変わります。
("grp/scenario/se_define.txt"に定義した順番になります。SEは0番から始まり、たとえば2番のSEとは、このファイルの３行目にあるものを意味します。もし1番から始めたい場合は、SEPLAYで0番は使用せず、かつこの定義ファイルの１行目は空行にしてください)

　複数のSEを同時に再生することが出来ます。
　再生しているものを強制停止させるには、

<SESTOP 2> : 2番のSEを停止させる

　このSESTOPを用います。

　第２パラメータにマイナスの値を指定してやると、その絶対値の回数だけ再生されます。（つまり -3ならば3回再生される）
　第３パラメータは、その再生のインターバル（周期）　フレーム数で指定する。FPS30ならば30を指定すると再生終了後１秒経ってから、また再生される、というようになる。

<SEPLAY 2,-5,30> : 2番のSEを５回再生する。ｎ回目終了後、（ｎ＋１）回目が再生されるには30回画面描画が行なわれてから。

☆　ＢＧＭＰＬＡＹ　：　ＢＧＭ再生

<BGMPLAY 演奏するBGMナンバー [ループ再生か？(省略時は1)]>
例)
<BGMPLAY 2 1> : 2番のBGMをループ再生(繰り返し再生される。次のシーンに移行するときまで再生され続ける)します。
<BGMPLAY 2 0> : 2番のBGMを１回だけ再生します
<BGMPLAY 2> : 上の<BGMPLAY 2 1>と同じ意味です

　何番のBGMが何のBGMであるかは、ゲームによって変わります。これはSEと同じく"grp/scenario/bgm_define.txt"によって決まります。（SE同様0番から始まります）

　複数のBGMを同時に再生することは出来ません。
BGMが再生されている状態で次のBGMが再生されると、前のBGMは自動的に停止します。しかし、同じ番号が指定された場合は、そのまま再生されつづけます。（曲頭に戻したいときは、いったんBGMを停止させて再度再生させればＯＫ）

　また再生しているBGMを強制停止させるには、

<BGMSTOP> : BGMを停止させる

　このBGMSTOPを用います。シーンの最後でもし、演奏を止めたいならばこれを入れる必要があります。通常は入れなくても、次のシーンで新たなＢＧＭ再生を指定しているので、止める必要はないはずです。

☆　背景ＣＧ

例：<BGCG 3> 背景ＣＧを３番のＣＧにします（画面効果はなし。いきなり切り替わります）
例：<BGCG 3 5> 背景ＣＧを３番のＣＧに、５番のトランジション（画面効果）を伴いながら変化させます

ＢＧは、ＳＥ同様"grp/scenario/bg_define.txt"に登録されている順番になります。０番は、真っ黒のＣＧにしておくと、そのＣＧをカットインさせることによって画面をブラックアウトできるので、便利かも知れません。（同様に真っ白のＣＧを用意しておくと、そのＣＧをカットインさせることによって画面をホワイトアウトできるので、便利かも知れません）

【画面効果番号について】

画面効果名は、yaneSDK2ndのサンプル５，７で表示されている名前と対応します。

０→なし
１→ "MirrorBlt1",CPlaneTransBlt::MirrorBlt1,
２→"MirrorBlt2",CPlaneTransBlt::MirrorBlt2,
３→"MirrorBlt3",CPlaneTransBlt::MirrorBlt3,
４→"MirrorBlt4",CPlaneTransBlt::MirrorBlt4,
５→"CutInBlt1",CPlaneTransBlt::CutInBlt1,
６→"CutInBlt2",CPlaneTransBlt::CutInBlt2,
７→"CutInBlt3",CPlaneTransBlt::CutInBlt3,
８→"CutInBlt4",CPlaneTransBlt::CutInBlt4,
９→"CutInBlt5",CPlaneTransBlt::CutInBlt5,
１０→"CutInBlt6",CPlaneTransBlt::CutInBlt6,
１１→"CutInBlt7",CPlaneTransBlt::CutInBlt7,
１２→"CutInBlt8",CPlaneTransBlt::CutInBlt8,
１３→"CutInBlt9",CPlaneTransBlt::CutInBlt9,
１４→"CutInBlt10",CPlaneTransBlt::CutInBlt10,
１５→"CutInBlt11",CPlaneTransBlt::CutInBlt11,
１６→"CutInBlt12",CPlaneTransBlt::CutInBlt12,
１７→"CutInBlt13",CPlaneTransBlt::CutInBlt13,
１８→"CutInBlt14",CPlaneTransBlt::CutInBlt14,
１９→"CutInBlt15",CPlaneTransBlt::CutInBlt15,
２０→"CutInBlt16",CPlaneTransBlt::CutInBlt16,
２１→"CutInBlt17",CPlaneTransBlt::CutInBlt17,
２２→"CutInBlt18",CPlaneTransBlt::CutInBlt18,
２３→"CutInBlt19",CPlaneTransBlt::CutInBlt19,
２４→"WaveBlt1",CPlaneTransBlt::WaveBlt1,
２５→"WaveBlt2",CPlaneTransBlt::WaveBlt2,
２６→"WaveBlt3",CPlaneTransBlt::WaveBlt3,
２７→"WaveBlt4",CPlaneTransBlt::WaveBlt4,
２８→"CircleBlt1",CPlaneTransBlt::CircleBlt1,
２９→"CircleBlt2",CPlaneTransBlt::CircleBlt2,
３０→"CircleBlt3",CPlaneTransBlt::CircleBlt3,
３１→"CircleBlt4",CPlaneTransBlt::CircleBlt4,
３２→"CircleBlt5",CPlaneTransBlt::CircleBlt5,
３３→"RectBlt1",CPlaneTransBlt::RectBlt1,
３４→"RectBlt2",CPlaneTransBlt::RectBlt2,
３５→"RectBlt3",CPlaneTransBlt::RectBlt3,
３６→"BlindBlt1",CPlaneTransBlt::BlindBlt1,
３７→"BlindBlt2",CPlaneTransBlt::BlindBlt2,
３８→"BlindBlt3",CPlaneTransBlt::BlindBlt3,
３９→"BlindBlt4",CPlaneTransBlt::BlindBlt4,
４０→"BlindBlt5",CPlaneTransBlt::BlindBlt5,
４１→"BlindBlt6",CPlaneTransBlt::BlindBlt6,
４２→"BlindBlt7",CPlaneTransBlt::BlindBlt7,
４３→"BlindBlt8",CPlaneTransBlt::BlindBlt8,
４４→"BlindBlt9",CPlaneTransBlt::BlindBlt9,
４５→"BlindBlt10",CPlaneTransBlt::BlindBlt10,
４６→"WhorlBlt1",CPlaneTransBlt::WhorlBlt1,
４７→"WhorlBlt2",CPlaneTransBlt::WhorlBlt2,
４８→"WhorlBlt3",CPlaneTransBlt::WhorlBlt3,
４９→"WhorlBlt4",CPlaneTransBlt::WhorlBlt4,
５０→"WhorlBlt5",CPlaneTransBlt::WhorlBlt5,
５１→"WhorlBlt6",CPlaneTransBlt::WhorlBlt6,
５２→"WhorlBlt7",CPlaneTransBlt::WhorlBlt7,
５３→"WhorlBlt8",CPlaneTransBlt::WhorlBlt8,
５４→"BlendBlt1",CPlaneTransBlt::BlendBlt1,
５５→"DiagonalDiffusionBlt",CPlaneTransBlt::DiagonalDiffusionBlt,
５６→"DiffusionCongeriesBlt1",CPlaneTransBlt::DiffusionCongeriesBlt1,
５７→"DiffusionCongeriesBlt2",CPlaneTransBlt::DiffusionCongeriesBlt2,
５８→"DiffusionCongeriesBlt3",CPlaneTransBlt::DiffusionCongeriesBlt3,
５９→"SquashBlt",CPlaneTransBlt::SquashBlt,
６０→"ForwardRollBlt",CPlaneTransBlt::ForwardRollBlt,
６１→"RotationBlt1",CPlaneTransBlt::RotationBlt1,
６２→"RotationBlt2",CPlaneTransBlt::RotationBlt2,
６３→"RotationBlt3",CPlaneTransBlt::RotationBlt3,
６４→"RotationBlt4",CPlaneTransBlt::RotationBlt4,
６５→"EnterUpBlt1",CPlaneTransBlt::EnterUpBlt1,
６６→"EnterUpBlt2",CPlaneTransBlt::EnterUpBlt2,
６７→"CellGatherBlt1",CPlaneTransBlt::CellGatherBlt1,
６８→"CellGatherBlt2",CPlaneTransBlt::CellGatherBlt2,
６９→"MosaicBlt1",CPlaneTransBlt::MosaicBlt1,
７０→"FlushBlt1",CPlaneTransBlt::FlushBlt1,
７１→"SlitCurtainBlt1",CPlaneTransBlt::SlitCurtainBlt1,
７２→"SlitCurtainBlt2",CPlaneTransBlt::SlitCurtainBlt2,
７３→"SlitCurtainBlt3",CPlaneTransBlt::SlitCurtainBlt3,
７４→"SlitCurtainBlt4",CPlaneTransBlt::SlitCurtainBlt4,
７５→"SlitCurtainBlt5",CPlaneTransBlt::SlitCurtainBlt5,
７６→"SlitCurtainBlt6",CPlaneTransBlt::SlitCurtainBlt6,
７７→"SlitCurtainBlt7",CPlaneTransBlt::SlitCurtainBlt7,
７８→"SlitCurtainBlt8",CPlaneTransBlt::SlitCurtainBlt8,
７９→"TensileBlt1",CPlaneTransBlt::TensileBlt1,
８０→"TensileBlt2",CPlaneTransBlt::TensileBlt2,
８１→"TensileBlt3",CPlaneTransBlt::TensileBlt3,
８２→"TensileBlt4",CPlaneTransBlt::TensileBlt4,

☆　立ちキャラ

キャラをインさせる。

例：<StandCharaIn 3 1 80>

３番の立ちキャラ（これは"grp/scenario/sc_define.txtで定義されている）を１番の位置（１番＝左，２番＝中央，３番＝右）に表示する。80番の画面効果（これはＢＧの効果番号と同じ）の画面効果を伴う。

例：<StandCharaIn 3 1>　→ <StandCharaIn 3 1 0>と同じ意味になる。

キャラをアウト（画面から消す）させる。

例：<StandCharaOut 3 80>

現在３番の位置の表示させている立ちキャラクターを８０番の画面効果を伴いながら消す。

例：<StandCharaOut 3> →　<StandCharaOut 3 0>と同じ意味になる。

次のシーンに移行するとき、ＢＧと立ちキャラ、フェイスマーク、ネームプレートはいったんリセットさせるので、通常は消す必要はない。ただし、これらは、同じシーンの間は、一度設定すると次に設定しなおすまで有効である。

☆　フェイスマーク

これはフェイスマークの指定。ＳＥ等と同じく、"grp/scenario/face_define.txt"に書いてあるファイルが選択され顔マークとして表示される。

☆　ネームプレート

ネームプレートの指定。"grp/scenario/name_define.txt"に書いてあるものが表示される。通常シナリオコンバートの時に自動的に追加されるので、シナリオファイル内に自前で指定する必要はない。

☆　特殊タグ

その段落の２行目以降をインデント（１文字、字下げ）する。通常、シナリオコンバータで、（　）で囲まれた会話文があると、行頭に自動的にこのタグを放り込む。これにより、

　（あいうえおかきくけこ
　　さしすせそたちつてと
　　なにぬねののののの）

このように、（　のぶんだけインデントされて文章が表示される。

読み上げ位置を設定します。読み上げとは、１文字ずつ表示されることで、途中までは、一気に表示して、そこから先を一文字ずつ表示する、というようなことをしたいときに使います。たとえば、途中でマウスクリックを促すような処理をしたいときは、

が<HR>
<SetReadPosition 1>
が、がぉ…<HR>
<SetReadPosition 5>
が、がぉ…ポカっ<HR>
<SetReadPosition 8>
が、がぉ…ポカっポカっ<HR>
<SetReadPosition 0>

と書きます。