Script Document

システム関数

関数一覧

Sleep指定した秒数待機する
Waitエフェクトなどの演出が完了するまで待機する
FadeInフェード インする
FadeOutフェード アウトする
ShowWndメッセージ ウィンドウを表示する
HideWndメッセージ ウィンドウを非表示にする
DontSkipスキップ禁止フラグを設定する
LoadSceneシーンをロードする
LoadMapマップシーンをロードする
BeginBattle戦闘シーンを開始する

関数詳細

Sleep()

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

Wait()

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

FadeIn()

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

FadeOut()

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

ShowWnd()

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

HideWnd()

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

DontSkip()

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

LoadScene()

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

LoadMap()

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

BeginBattle()

機能
戦闘シーンを開始する
書式
void BeginBattle( bgImage, bgm, enemy1, enmey2, enemy3, script )
引数
引数省略規定値詳細
bgImage文字列×背景のパス
bgm文字列×BGMファイルのパス
enemy1整数×1体目の敵ID
enmey2整数-12体目の敵ID
enemy3整数-13体目の敵ID
script文字列null戦闘終了後に実行するスクリプトのラベル
ラベルは [<アセットバンドル名>/<スクリプト名>] [*<ラベル>] の形で設定する
dontAdjustment真偽値false敵数調整を無効にするか
戻り値
なし
備考
この関数の呼び出し直後にスクリプトが終了することに注意すること。script 引数を指定した場合、戦闘終了後でもスクリプトの呼び出し元は維持される。また、戦闘終了後はフェードアウト状態となっているため必要なタイミングで FadeIn() 関数を使用してフェードインさせる必要がある。ゲームオブジェクトに対する OnScriptQuit() イベントは戦闘開始時と戦闘終了後のスクリプト終了時の2度呼ばれる
TOP