パラメータの汎用例
入力が必須なパラメータです。
デフォルトの値を持っている省略可能なパラメータです。
メッセージテキスト
表示するテキスト
テキストを表示
テキストを表示するのに特別なタグは必要ありません。書かれたテキストがそのまま表示されます。
ただし、改行は無視され、[r]タグ以外では改行されません。
パラメータ
なし
[r]
改行
このタグでテキストを改行します。
パラメータ
なし
[l]
文中のクリック待ち
クリック待ちを行ないます。このタグでは改ページされません。
パラメータ
なし
[p]
文末のクリック待ち
クリック待ちを行ないます。このタグでは改ページされます。
パラメータ
なし
[cm]
テキストをクリア
メッセージレイヤーに表示されているテキストをクリアします。[cls]と同じです。
パラメータ
なし
[cls]
テキストをクリア
メッセージレイヤーに表示されているテキストをクリアします。[cm]と同じです。
パラメータ
なし
ビジュアル関連
[bg storage="fileAlias or FillColor"]
背景の読み込み
背景レイヤーに画像を読み込む、または指定したカラーで塗りつぶします。
パラメータ
storage……背景レイヤーに読み込むファイルエイリアス、または塗り潰すカラー値(0xRRGGBB形式)を指定します。
[image layer="LayerName" storage="fileAlias or FillColor" top="LayerTopPosision" left="LayerLeftPosition" scale="LayerScale" mode="LayerBlendMode"]
画像の読み込み
指定したレイヤーに画像を読み込む、または指定したカラーで塗りつぶします。
パラメータ
layer……画像の読み込み先のレイヤーナンバー(0~)を指定します。もしくは"base"で背景レイヤー。
storage……レイヤーに読み込むファイルエイリアス、または塗り潰すカラー値(0xRRGGBB形式)を指定します。
top……レイヤーの上辺の座標を指定します。省略すると0。
left……レイヤーの左辺の座標を指定します。省略すると0。
scale……レイヤーの拡縮率を指定します。1が原寸で、0.5が半分のサイズ、2が倍のサイズ。省略すると原寸。
mode……レイヤーの重ねあわせモードを指定します。通常、乗算、スクリーン、覆い焼きのどれかを指定。省略すると通常。
[freeimage layer="LayerName"]
レイヤーのアンロード
指定されたレイヤーをアンロードします。
背景レイヤーはアンロード出来ないので、layerパラメータに"base"は指定しないで下さい。
背景レイヤーのリセットには[bg]タグのstorageパラメータにリセットカラーを指定するようにして下さい。
"all"を指定すると、背景レイヤーをstorageパラメータに指定したカラーでリセットし、それ以外のレイヤーをすべてアンロードします。
パラメータ
layer……アンロードするレイヤーナンバー(0~)もしくは"all"。
[setlayer layer="LayerName" top="LayerTopPosision" left="LayerLeftPosition" scale="LayerScale"]
レイヤーの場所、拡縮率の変更
指定されたレイヤーの場所、及び拡縮率の変更を行います。
背景レイヤーは移動、拡縮出来ないので、layerパラメータに"base"は指定しないで下さい。
パラメータ
layer……画像の読み込み先のレイヤーナンバー(0~)を指定します。
top……レイヤーの上辺の座標を指定します。省略すると0。
left……レイヤーの左辺の座標を指定します。省略すると0。
scale……レイヤーの拡縮率を指定します。1が原寸で、0.5が半分のサイズ、2が倍のサイズ。省略すると原寸。
[trans method="MethodName" rule="TransitionRulePictAlias or EasingMode" time="TransitionTime(ms)"]
トランジション行ない、画面を更新する
トランジションを行ない、bg、image、freeimageで変更された内容を実際の画面へ適用します。
パラメータ
method……トランジション方法。"flash"、"fade"、"universal"、"shake"、"shakeV"、"shakeH"、"move"、"wait"
flash……必要オプションパラメータ「なし」……トランジションなしで一瞬で切り替わります。
fade……必要オプションパラメータ「time」……フェード効果でトランジションを行います。
universal……必要オプションパラメータ「rule,time」……ruleで指定した画像のグレー値をアルファ値に変換してユニバーサルトランジションを行います。
shake……必要オプションパラメータ「time」……画面を上下左右に揺らします。終了時、画面が更新されます。
shakeV……必要オプションパラメータ「time」……画面を上下に揺らすします。終了時、画面が更新されます。
shakeH……必要オプションパラメータ「time」……画面を左右に揺らすします。終了時、画面が更新されます。
move……必要オプションパラメータ「rule,time」……setLayerで変更した移動、拡縮へトゥイーンすします。終了時、画面が更新されます。
wait……必要オプションパラメータ「time」……指定時間待った後に画面を更新されます。
rule……method="universal"時……値変換を行う元画像のファイルエイリアスを指定します。
rule……method="move"時……イージングモードを指定します。
"Back_in","Back_out","Back_inout"……最初、または最後、及びその両方で反対に一旦行き過ぎる効果が得られます。
"Bounce_in","Bounce_out","Bounce_inout"……最初、または最後、及びその両方でバウンドする効果が得られます。
"Circular_in","Circular_out","Circular_inout"……Circularイージング方式を用いて、低速から加速する、または減速して終了する、及びその両方の効果が得られます。
"Cubic_in","Cubic_out","Cubic_inout"……Cubicイージング方式を用いて、低速から加速する、または減速して終了する、及びその両方の効果が得られます。
"Elastic_in","Elastic_out","Elastic_inout"……Elasticイージング方式を用いて、指数関数的に減衰する正弦波による加速、または減速、及びその両方の効果が得られます。
"Exponential_in","Exponential_out","Exponential_inout"……Exponentialイージング方式を用いて、指数関数的に減衰する正弦波による加速、または減速、及びその両方の効果が得られます。
"Liner_in","Liner_out","Liner_inout"……Linerイージング方式は直線的な加速、または減速、及びその両方の効果が得られます。
"Quadratic_in","Quadratic_out","Quadratic_inout"……Quadraticイージング方式を用いて、低速から加速する、または減速して終了する、及びその両方の効果が得られます。
"Quartic_in","Quartic_out","Quartic_inout"……Quarticイージング方式を用いて、低速から加速する、または減速して終了する、及びその両方の効果が得られます。
"Sine_in","Sine_out","Sine_inout"……正弦波による加速、または減速、及びその両方の効果が得られます。
time……トランジションの継続時間をミリ秒で指定。
[wt canskip="true | false"]
トランジションの終了を待つ
[trans]の直後で使用し、トランジションの終了を待ちます。
パラメータ
canskip……trueの場合、クリック及びスキップ操作でトランジションを即時終了させることが出来ます。falseだとトランジションが終了するまで待ちます。省略した場合はtrue
サウンド・ムービー
[playbgm storage="fileAlias" fadein="time(ms)" fadeout="time(ms)" loop="true | falase" layervolume="volumeNumber" pan="panposition"]
BGMの再生
BGMを再生します。既にBGMが再生されていた場合、fadeoutで指定した時間でフェードアウトし、再生開始後にfadeinで指定した時間でフェードインします。
パラメータ
storage……BGMとして再生するファイルのファイルエイリアスを指定します。同時にループ設定ファイル(ファイルエイリアス+".mp3.slc")があれば読み込まれます。
fadein……指定した時間かけてフェードインして再生されます。省略した場合は0。
fadeout……このタグよりも前にBGMが既に再生されていた場合、指定した時間かけてフェードアウトした後、再生がスタートします。省略した場合は500。
loop……trueの場合、最後まで再生した後、再度最初から再生が始まります。(ループ定義ファイルが読み込まれているときは、この設定は無視されます)省略された場合はtrue。
layervolume……この再生限定でボリュームを最小の0~元の音量の1.0の間で調整できます。省略した場合は1(元の音量)
panposition……この再生のパンポジションを-1(左)~0(中央)~1(右)の間で設定できます。省略した場合は1(中央)
[stopbgm fadeout="time(ms)"]
BGMの停止
BGMをfadeoutで指定した時間でフェードアウトし停止します。
パラメータ
fadeout……このタグよりも前にBGMが既に再生されていた場合、指定した時間かけてフェードアウトして停止します。省略した場合は0。
[playse storage="fileAlias" layer="layerNumber" fadein="time(ms)" fadeout="time(ms)" loop="true | falase" layervolume="volumeNumber" pan="panposition"]
効果音の再生
効果音を再生します。既に効果音が再生されていた場合、fadeoutで指定した時間でフェードアウトし、再生開始後にfadeinで指定した時間でフェードインします。
パラメータ
storage……効果音として再生するファイルのファイルエイリアスを指定します。同時にループ設定ファイル(ファイルエイリアス+".mp3.slc")があれば読み込まれます。
layer……効果音を再生するレイヤーナンバー(0~)を指定します。
fadein……指定した時間かけてフェードインして再生されます。省略した場合は0。
fadeout……このタグよりも前にBGMが既に再生されていた場合、指定した時間かけてフェードアウトした後、再生がスタートします。省略した場合は0。
loop……trueの場合、最後まで再生した後、再度最初から再生が始まります。(ループ定義ファイルが読み込まれているときは、この設定は無視されます)省略された場合はfalse。
layervolume……この再生限定でボリュームを最小の0~元の音量の1.0の間で調整できます。省略した場合は1(元の音量)
panposition……この再生のパンポジションを-1(左)~0(中央)~1(右)の間で設定できます。省略した場合は1(中央)
[stopse layer="layerNumber" fadeout="time(ms)"]
効果音の停止
効果音をfadeoutで指定した時間でフェードアウトし停止します。
パラメータ
layer……効果音を再生するレイヤーナンバー(0~)もしくは"all"を指定します。
fadeout……このタグよりも前にBGMが既に再生されていた場合、指定した時間かけてフェードアウトして停止します。省略した場合は0。
[stopallsound fadeout="time(ms)"]
BGM、効果音、ボイスすべての停止
すべてのサウンドをfadeoutで指定した時間でフェードアウトし停止します。
パラメータ
fadeout……このタグよりも前にBGMが既に再生されていた場合、指定した時間かけてフェードアウトして停止します。省略した場合は0。
[voice storage="fileAlias" layervolume="volumeNumber" pan="panposition"]
ボイスの再生
ボイスを再生します。既に効果音が再生されていた場合、即時停止し再生されます。
パラメータ
storage……効果音として再生するファイルのファイルエイリアスを指定します。
layervolume……この再生限定でボリュームを最小の0~元の音量の1.0の間で調整できます。省略した場合は1(元の音量)
panposition……この再生のパンポジションを-1(左)~0(中央)~1(右)の間で設定できます。省略した場合は1(中央)
[ws layer="layerNumber" canskip="true | false"]
サウンドの停止を待つ
指定したサウンドレイヤーの再生終了を待ちます。再生が既に終了していた場合、もしくはloopパラメータがtrueだった場合、何もしません。
パラメータ
layer……効果音のレイヤーナンバー(0~)もしくは"bgm"及び"voice"を指定します。
canskip……trueの場合、クリック等でスキップが出来ます。falseだと再生が終わるまで次へ進みません。
[playvideo storage="fileAlias" canskip="true | false"]
ムービーの再生
ムービーを再生します。ムービー再生中、メッセージウィンドウなど全て非表示になります。
対応コンテナ、コーデックはAdobe Flashに準じます。
パックファイルからの読み込みには対応していないため、パックファイルに含めないで下さい。
パラメータ
storage……再生するムービーファイルのファイルエイリアスを指定します。
canskip……trueの場合、クリック等でスキップが出来ます。falseだと再生が終わるまで次へ進みません。
シナリオ
*labelName
ジャンプ用ラベルを設定
ジャンプ先の目印です。[clickjump]が有効な場合、ラベルを通過するとクリックジャンプが解除されます。
パラメータ
なし
[jump storage="fileAlias" label="labelName"]
シナリオジャンプ(オートセーブあり)
指定されたシナリオを読み込み、labelパラメータが指定されていればそこまでスキップした後、処理を継続します。このタグが処理された時、オートセーブが働きます。
パラメータ
storage……読み込むシナリオファイルのファイルエイリアスを指定します。
label……読み込むシナリオ内の*labelNameを指定します。省略された場合はファイルの先頭から処理が開始されます。
[jump2 storage="fileAlias" label="labelName"]
シナリオジャンプ(オートセーブなし)
指定されたシナリオを読み込み、labelパラメータが指定されていればそこまでスキップした後、処理を継続します。このタグが処理された時、オートセーブは働きません。
パラメータ
storage……読み込むシナリオファイルのファイルエイリアスを指定します。
label……読み込むシナリオ内の*labelNameを指定します。省略された場合はファイルの先頭から処理が開始されます。
[if name="flagName" mode="operator" value="operand"]
条件分岐(第一条件)
[elseif][else][endif]とセットで使う条件分岐命令。
条件が真なら直後の命令から順に実行された後に、[endif]までスキップされます。
条件が偽の場合、[elseif][else][endif]いずれかのタグまでスキップされます。
パラメータ
name……判定に使用する[setlocal]でセットした変数名を指定します。
mode……演算子を指定します。使用できる演算子は"=="、"!="、"<"、"<="、">"、">="です。
value……nameパラメータに指定した変数と比較するオペランドです。数字の他に変数名も入力出来ます。
[elseif name="flagName" mode="operator" value="operand"]
条件分岐(第二以降の条件)
[if][endif]の間に挟み、[if]や前段にある[elseif]が偽だった時に更に条件分岐させるときに使用します。
条件が真なら直後の命令から順に実行され、他の[elseif]や[else]が出てくると[endif]までスキップされます。
条件が偽の場合、[elseif][else][endif]いずれかのタグまでスキップされます。
パラメータ
name……判定に使用する[setlocal]でセットした変数名を指定します。
mode……演算子を指定します。使用できる演算子は"=="、"!="、"<"、"<="、">"、">="です。
value……nameパラメータに指定した変数と比較するオペランドです。数字の他に変数名も入力出来ます。
[else]
条件分岐(最終条件)
[if][endif]の間に挟み、[if]や[elseif]がすべて偽だった場合に命令を実行したい時に使用します。
無条件で直後の命令から順に実行され、[endif]まで実行されます。
パラメータ
なし
[endif]
条件分岐終了
[if]で始まる条件分岐セクションの終了を意味するタグです。
必ず[if]とセットで使用して下さい。
パラメータ
なし
[select text="selectText" label="labelName"]
選択肢の項目をセット
選択肢の項目を設定します。このタグで設定した選択肢を[selectshow]で表示させます。
パラメータ
text……選択肢の項目に表示するテキストです。
label……選択肢が選択された時にジャンプする*labelNameを指定します。
[selectshow]
選択肢を表示する
[select]で設定した選択肢を表示します。
パラメータ
なし
[s]
シナリオの停止
このタグを実行するとシナリオの進行が止まります。ファイルの最後や[selectshow]の後で使用します。
パラメータ
なし
[title]
タイトル画面に戻るスクリプトの起動
このタグを実行すると"scptitle.src"が読み込まれ実行されます。
パラメータ
なし
[titleshow]
タイトル画面を起動する
このタグを実行すると即時タイトル画面が起動します。scptitle.srcの最後以外で使用しないで下さい。
パラメータ
なし
[backsce]
シーン回想から戻るタグ
シーン回想中にこのタグを実行すると回想を終了します。通常時は何も起こりません。
パラメータ
なし
フラグ
[setlocal name="flagName" mode="operator" value="operand"]
ゲーム内変数を操作する
セーブデータに記録されるゲーム内変数の操作をします。
mode="+"の場合、flagName = flagName + operand……flagNameoperandが足されます。
mode="-"の場合、flagName = flagName - operand……flagNameからoperandが引かれます。
mode="*"の場合、flagName = flagName * operand……flagNameoperand倍にします。
mode="/"の場合、flagName = flagName / operand……flagNameoperandで割ります。
mode="="もしくは省略された場合、flagName = operand……flagNameoperandになります。
パラメータ
name……変数名を指定します。日本語の変数名も可
mode……演算子を指定します。使用できる演算子は"="、"+"、"-"、"*"、"/"です。省略した場合"="
value……nameパラメータに指定した変数と比較するオペランドです。数字の他に変数名も入力出来ます。
[setcomp value="setValue"]
クリアフラグを設定する
設定ファイルに記録されるクリアフラグを設定します。クリアフラグはセーブデータに影響されません。
クリアフラグを加算したい場合は[addcomp]を使用して下さい。
パラメータ
value……クリアフラグに設定する値を指定します。
[addcomp]
クリアフラグをインクリメントする
設定ファイルに記録されるクリアフラグをインクリメント(+1)します。クリアフラグはセーブデータに影響されません。
パラメータ
なし
[cgflag name="CGFileAlias"]
CG鑑賞モードで使用するフラグを設定する
指定されたファイル名から差分番号を抽出し、ベース名と差分識別子を記録する。
ベース名と差分識別子を"_"で連結した命名規則で機能します。
パラメータ
name……イベントCGのファイルエイリアスを指定します。
[sceflag name="ScenarioFlagName"]
シーン回想モードで使用するフラグを設定する
シーンの通過識別子を記録します。この通過識別子はシーン回想モードで使用します。
パラメータ
name……ユニークなシーンの通過識別子を指定します。
システム設定
[messhow time="FadeInTime(ms)"]
メッセージウィンドウを表示する
メッセージレイヤーをtimeパラメータで指定した時間をかけて表示します。
パラメータ
time……メッセージウィンドウを表示するのにかかる時間をミリ秒で指定します。省略した場合は0(即時)
[meshide time="FadeInTime(ms)"]
メッセージウィンドウを非表示にする
メッセージレイヤーをtimeパラメータで指定した時間をかけて非表示にします。
パラメータ
time……メッセージウィンドウを非表示にするのにかかる時間をミリ秒で指定します。省略した場合は0(即時)
[meschange preset="PresetName"]
メッセージウィンドウを非表示にする
メッセージレイヤーを指定したプリセットに切り替えます。
メッセージウィンドウ表示中に切り替えると読み込んでいく様子が見えてしまうため、[meshide]の後に切り替えることを推奨。
パラメータ
preset……そらスクリプト設定エディタで指定したプリセットネーム
[rclick enable="true | false"]
右クリックの有効/無効を切り替え
右クリックの有効/無効を切り替えます。
パラメータ
enable……trueの場合右クリックが有効です。falseの場合は無効です。省略した場合はtrue有効です。
[backlog enable="true | false"]
バックログの有効/無効を切り替え
バックログの有効/無効を切り替えます。
パラメータ
enable……trueの場合バックログが有効です。falseの場合は無効です。省略した場合はtrue有効です。
[save enable="true | false"]
セーブ・クイックセーブの有効/無効を切り替え
セーブ・クイックセーブの有効/無効を切り替えます。
パラメータ
enable……trueの場合セーブ・クイックセーブが有効です。falseの場合は無効です。省略した場合はtrue有効です。
[clickjump label="labelName"]
クリックジャンプを設定する
このタグを実行してから、[endclickjump]、[jump]、[jump2]もしくは*labelNameを通過するまで、クリックすると指定した*labelNameまでスキップします
パラメータ
label……クリックされた時にジャンプする*labelNameを指定します。
[endclickjump]
クリックジャンプを無効にする
[clickjump]が有効になっていた場合、無効にします。
パラメータ
なし
[savetitle value="saveTitle" visible="true | false"]
セーブタイトルを設定します
セーブデータに記録されるタイトルを設定します。visibleパラメータがtrueの場合、セーブタイトルが表示されます。
パラメータ
value……セーブデータに記録するタイトルを設定します。省略した場合""(空文字)が設定されますが、推奨ではありません。
visible……trueの場合、セーブタイトルを画面に表示します。falseの場合はタイトルの設定だけが行われます。省略するとtrue(表示する)
※このドキュメントは、そらスクリプトv3.0.xに対応しています。