Script Document

システム関数

関数一覧

Sleep指定した秒数待機する
Waitエフェクトなどの演出が完了するまで待機する
FadeIn画面をフェード インする
FadeOut画面をフェード アウトする
Flash画面をフラッシュさせる
MsgBoxメッセージボックスを表示する
ShowWndメッセージ ウィンドウを表示する
HideWndメッセージ ウィンドウを非表示にする
DontSkipスキップ禁止フラグを設定する
AutoSaveオートセーブを行う
LoadSceneシーンをロードする
LoadMapマップシーンをロードする
BeginBattle戦闘シーンを開始する
Staffroleスタッフロールを再生する
SaveScreenセーブ画面を開く
BackTitleタイトル画面に戻る

関数詳細

Sleep()

機能
指定した秒数待機させます
書式
void Sleep( sleepTime )
引数
引数省略規定値詳細
sleepTime数値×---待機時間 (秒)
戻り値
なし

Wait()

機能
エフェクトなどの演出が完了するまで待機します
書式
void Wait()
引数
なし
戻り値
なし

FadeIn()

機能
画面をフェード インします
書式
void FadeIn( duration, colorR, colorG, colorB, rulePath, ruleSmoothing )
引数
引数省略規定値詳細
duration実数-1.0フェード秒数
省略した場合は前回指定されたフェード秒数となります
colorR整数0フェード色のR値
colorG整数0フェード色のG値
colorB整数0フェード色のB値
rulePath文字列nullルール画像のアセットバンドルパス
ruleSmoothing実数-1.0ルールのスムーシング値。マイナス値の場合は以前に設定された値を使用します
戻り値
なし

FadeOut()

機能
画面をフェード アウトします
書式
void FadeOut( duration, colorR, colorG, colorB, rulePath, ruleSmoothing )
引数
引数省略規定値詳細
duration実数-1.0フェード秒数
省略した場合は前回指定されたフェード秒数となります
colorR整数0フェード色のR値
colorG整数0フェード色のG値
colorB整数0フェード色のB値
rulePath文字列nullルール画像のアセットバンドルパス
ruleSmoothing実数-1.0ルールのスムーシング値。マイナス値の場合は以前に設定された値を使用します
戻り値
なし

Flash()

機能
画面をフラッシュさせます
書式
void Flash( count, showDuration, hideDuration, colorR, colorG, colorB, colorA, imagePath )
引数
引数省略規定値詳細
count整数255フェード色のR値 (0~255)
showDuration実数0.6点灯秒数
hideDuration実数0.4消灯秒数
colorR整数255フェード色のR値 (0~255)
colorG整数255フェード色のG値 (0~255)
colorB整数255フェード色のB値 (0~255)
colorA整数255フェード色のB値 (0~255)
imagePath文字列null画像のアセットバンドルパス。単色の場合は null にしてください。
表示する画像はゲーム画面のアスペクト比と同じにする必用があります
戻り値
なし

MsgBox()

機能
メッセージボックスを表示します。
メッセージボックスが表示されてる間はテキストウィンドウは非表示になります。また、メッセージボックスが閉じられるまで待機する点に注意してください (閉じられるまで次の命令は実行されません)
書式
void MsgBox( message, duration )
引数
引数省略規定値詳細
message真偽値×表示メッセージ。リッチテキストタグが使用できます
duration真偽値0.25開閉アニメーション時間
戻り値
なし

ShowWnd()

機能
メッセージ ウィンドウを表示させます
書式
void ShowWnd()
引数
なし
戻り値
なし

HideWnd()

機能
メッセージ ウィンドウを非表示にします
書式
void HideWnd()
引数
なし
戻り値
なし

DontSkip()

機能
スキップ禁止フラグを設定します
書式
void DontSkip( dontSkip )
引数
引数省略規定値詳細
dontSkip真偽値×スキップ禁止フラグ
戻り値
なし

AutoSave()

機能
オートセーブを行います
書式
void AutoSave()
引数
なし
戻り値
なし

LoadScene()

機能
シーンをロードします
注意: この関数の呼び出し直後にスクリプトは終了します
書式
void LoadScene( sceneName )
引数
引数省略規定値詳細
sceneName文字列×---シーン名
戻り値
なし
備考
この関数の呼び出し直後にスクリプトが終了することに注意してください。シーンの初期化のために別スクリプトが実行される可能性があり、スクリプトの多重実行は処理の不整合を生じる可能性があるためシーンを跨いだスクリプトの実行は行わない仕様になっています

LoadMap()

機能
マップシーンをロードします。ロード後のプレーヤーの出現位置を指定するには warpPoint 引数に出現位置のワープポイント名を設定してください
注意: この関数の呼び出し直後にスクリプトは終了します
書式
void LoadMap( mapName, warpPoint, script )
引数
引数省略規定値詳細
mapName文字列×---マップ名
warpPoint文字列NULLワープポイント名
マップのロード後にここで指定したワープポイント位置にプレーヤーがスポーンします
省略した場合はマップのデフォルトスポーン位置にプレーヤーが出現します
script文字列NULLロード後に実行させるスクリプトのパス
パスは [<アセットバンドル名>/<スクリプト名>] [*<ラベル>] の形で設定してください
戻り値
なし
備考
この関数の呼び出し直後にスクリプトが終了することに注意してください。シーンの初期化のために別スクリプトが実行される可能性があり、スクリプトの多重実行は処理の不整合を生じる可能性があるためシーンを跨いだスクリプトの実行は行わない仕様になっています

BeginBattle()

機能
戦闘シーンを開始します
注意: この関数の呼び出し直後にスクリプトは終了します
書式
void BeginBattle( encountGroup, endScript )
引数
引数省略規定値詳細
encountGroup整数×---エンカウント グループ
endScript文字列NULL戦闘終了時に実行させるスクリプトのパス。NULL の場合はエンカウントテーブルに設定に従います
パスは [<アセットバンドル名>/<スクリプト名>] [*<ラベル>] の形で設定してください
戻り値
なし
備考
この関数の呼び出し直後にスクリプトが終了することに注意してください。シーンの初期化のために別スクリプトが実行される可能性があり、スクリプトの多重実行は処理の不整合を生じる可能性があるためシーンを跨いだスクリプトの実行は行わない仕様になっています

Staffrole()

機能
スタッフロールを再生します
書式
void Staffrole()
引数
なし
戻り値
なし

SaveScreen()

機能
セーブ画面を開きます
書式
void SaveScreen( gameClear )
引数
引数省略規定値詳細
gameClear真偽値falseクリアデータとして保存するか。true にするとロード時に2週目としてプロローグから再開されます
戻り値
なし

BackTitle()

機能
タイトル画面に戻します。
注意: この関数の呼び出し直後にスクリプトは終了します
書式
void BackTitle()
引数
なし
戻り値
なし
備考
この関数の呼び出し直後にスクリプトが終了することに注意してください
TOP