SRPG Studio スクリプト・マニュアル

root

Root

root情報を管理します。

メソッド

スクリプトのバージョンを取得します。

{number} getScriptVersion()

Returns

{number} バージョン


ゲームをリセットします。

resetGame()

ゲームを終了します。

endGame()

現在のアプリケーションのスクリーン状態を取得します。

{number} getAppScreenMode()

Returns

{number} AppScreenMode値


指定値が入力された場合はtrue、そうでない場合はfalseを返します。

{boolean} isInputAction(value)

Parameters

{number} value InputType値

Returns

{boolean} 真偽値


指定値が入力され続けている場合はtrue、そうでない場合はfalseを返します。

{boolean} isInputState(value)

Parameters

{number} value InputType値

Returns

{boolean} 真偽値


60FPSの場合はtrue、そうでない場合はfalseを返します。

{boolean} isHighPerfMode()

Returns

{boolean} 真偽値


テストプレイの場合はtrue、そうでない場合はfalseを返します。

{boolean} isTestPlay()

Returns

{boolean} 真偽値


オープニングイベントをスキップする場合はtrue、そうでない場合はfalseを返します。

{boolean} isOpeningEventSkip()

Returns

{boolean} 真偽値


攻撃が必ず命中する場合はtrue、そうでない場合はfalseを返します。

{boolean} isAbsoluteHit()

Returns

{boolean} 真偽値


システム設定が有効な場合はtrue、そうでない場合はfalseを返します。

{boolean} isSystemSettings(type)

Parameters

{number} type SystemSettingsType値

Returns

{boolean} 真偽値


時間の計測を開始します。

watchTime()

watchTimeを呼び出してからの経過時間をミリ秒単位で取得します。

{number} getElapsedTime()

Returns

{number} 経過時間


直近のFPSを取得します。

{number} getFPS()

Returns

{number} FPS


メッセージボックスを表示します。

msg(text)

Parameters

{string} text メッセージ


コンソールに文字列を出力します。

log(text)

Parameters

{string} text 文字列


コンソールの内容をクリアします。

resetConsole()

スクリーンショットを保存します。Game.iniのHardwareAccelerationが1に設定されている場合に有効です。

saveScreenShot(isMapAll)

Parameters

{boolean} isMapAll マップ全体を対象にする場合はtrue、そうでない場合はfalseを指定します。


デモ用のマップを開きます。

{boolean} openMap(mapId)

Parameters

{number} mapId マップのIDを指定します。

Returns

{boolean} マップを開けた場合はtrue、そうでない場合はfalseを返します。


デモ用のマップを閉じます。

closeMap()

リソースハンドルを作成します。

{ResourceHandle} createResourceHandle(isRuntime, id, colorIndex, xSrc, ySrc)

Parameters

{boolean} isRuntime ランタイムの場合はtrue、そうでない場合はfalse

{number} id 参照するid

{number} colorIndex 色のインデックス

{number} xSrc 画像元のx座標

{number} ySrc 画像元のy座標

Returns

{ResourceHandle} リソースハンドル


空のリソースハンドルを作成します。

{ResourceHandle} createEmptyHandle()

Returns

{ResourceHandle} リソースハンドル


乱数を取得します。

{number} getRandomNumber()

Returns

{number} 乱数


セルフスイッチを設定します。

setSelfSwitch(lIndex, flag)

Parameters

{number} lIndex インデックス

{boolean} flag オンにする場合はtrue、そうでない場合はfalse


背景画像の変更、画像の表示などで表示されたオブジェクトを消去します。

resetVisualEventObject()

非同期イベントデータを描画します。

drawAsyncEventData()

マップのサムネイル画像を描画します。

drawMapAll(map)

Parameters

{Map} map 描画したいマップ


インデックスが指す位置にパネルを描画します。

drawWavePanel(arr, pic, scrollCount)

Parameters

{object} arr インデックス配列

{Image} pic パネル画像

{number} scrollCount スクロール値


インデックスが指す位置の色を変更します。

drawFadeLight(arr, color, alpha)

Parameters

{object} arr インデックス配列

{number} color 色

{number} alpha アルファ値


HPゲージを描画します。

drawCharChipHpGauge(x, y, unit)

Parameters

{number} x x座標

{number} y y座標

{Unit} unit ユニット


マップユニットシンボルを描画します。

drawCharChipSymbol(x, y, unit)

Parameters

{number} x x座標

{number} y y座標

{Unit} unit ユニット


ステートアイコンを描画します。

drawCharChipStateIcon(x, y, unit)

Parameters

{number} x x座標

{number} y y座標

{Unit} unit ユニット


キャラチップのHPを装飾するオブジェクトを取得します。

{GraphicsDecoration} getHpDecoration(type)

Parameters

{number} type HpDecorationType値

Returns

{GraphicsDecoration} 装飾オブジェクト


キャラチップの周囲を装飾するオブジェクトを取得します。

{GraphicsDecoration} getSymbolDecoration(type)

Parameters

{number} type SymbolDecorationType値

Returns

{GraphicsDecoration} 装飾オブジェクト


イベントコマンドの「背景画像の変更」で変更を開始します。

startBackgroundChange()

アイテムを複製します。

{Item} duplicateItem(*item)

Parameters

{Item} *item 複製対象のアイテム

Returns

{Item} 複製されたアイテム


ウインドウの幅を取得します。

{number} getWindowWidth()

Returns

{number} ウインドウの幅


ウインドウの高さを取得します。

{number} getWindowHeight()

Returns

{number} ウインドウの高さ


ゲームエリアの幅を取得します。

{number} getGameAreaWidth()

Returns

{number} ゲームエリアの幅


ゲームエリアの高さを取得します。

{number} getGameAreaHeight()

Returns

{number} ゲームエリアの高さ


ビューポートのx座標を取得します。

{number} getViewportX()

Returns

{number} x座標


ビューポートのy座標を取得します。

{number} getViewportY()

Returns

{number} y座標


ビューポートのx座標とy座標を設定します。ビューポートは、描画基準位置を表しますが、キャッシュに対しては常に左上が原点になります。

setViewportPos(x, y)

Parameters

{number} x x座標

{number} y y座標


メタセッションの情報を管理するオブジェクトを取得します。

{MetaSession} getMetaSession()

Returns

{MetaSession} MetaSessionオブジェクト


現在のセッションの情報を管理するオブジェクトを取得します。マップが開かれている場合はGameSessionが返ります。現在のシーンがSceneType.RESTの場合はRestSessionが返ります。

{GameSession} getCurrentSession()

Returns

{GameSession} GameSessionオブジェクトまたはRestSessionオブジェクト


外部データを管理するオブジェクトを取得します。

{ExternalData} getExternalData()

Returns

{ExternalData} MetaSessionオブジェクト


データ設定の情報を管理するオブジェクトを取得します。

{BaseData} getBaseData()

Returns

{BaseData} BaseDataオブジェクト


コンフィグ情報を管理するオブジェクトを取得します。

{ConfigInfo} getConfigInfo()

Returns

{ConfigInfo} ConfigInfoオブジェクト


ユーザー拡張を管理するオブジェクトを取得します。

{UserExtension} getUserExtension()

Returns

{UserExtension} UserExtensionオブジェクト


アニメ情報を管理するオブジェクトを取得します。

{AnimePreference} getAnimePreference()

Returns

{AnimePreference} AnimePreferenceオブジェクト


世界観設定のオプションを管理するオブジェクトを取得します。

{StoryPreference} getStoryPreference()

Returns

{StoryPreference} StoryPreferenceオブジェクト


拠点設定のオプションを管理するオブジェクトを取得します。

{RestPreference} getRestPreference()

Returns

{RestPreference} RestPreferenceオブジェクト


セーブファイルを管理するオブジェクトを取得します。

{LoadSaveManager} getLoadSaveManager()

Returns

{LoadSaveManager} LoadSaveManagerオブジェクト


描画を管理するオブジェクトを取得します。

{GraphicsManager} getGraphicsManager()

Returns

{GraphicsManager} GraphicsManagerオブジェクト


メディアを管理するオブジェクトを取得します。

{MediaManager} getMediaManager()

Returns

{MediaManager} MediaManagerオブジェクト


素材を管理するオブジェクトを取得します。

{MaterialManager} getMaterialManager()

Returns

{MaterialManager} MaterialManagerオブジェクト


シーンを制御するオブジェクトを取得します。

{SceneController} getSceneController()

Returns

{SceneController} SceneControllerオブジェクト


動的にイベントを実行するオブジェクトを取得します。

{EventGenerator} getEventGenerator()

Returns

{EventGenerator} EventGeneratorオブジェクト


データを編集するオブジェクトを取得します。

{DataEditor} getDataEditor()

Returns

{DataEditor} DataEditorオブジェクト


画面効果のオブジェクトを取得します。

{ScreenEffect} getScreenEffect()

Returns

{ScreenEffect} ScreenEffectオブジェクト


リソース使用箇所のアニメを取得します。

{Anime} queryAnime(key)

Parameters

{string} key 文字列

Returns

{Anime} Animeオブジェクト


リソース使用箇所のメディアを取得します。

{ResourceHandle} querySoundHandle(key)

Parameters

{string} key 文字列

Returns

{ResourceHandle} Resource Handleオブジェクト


リソース使用箇所の画像を取得します。

{ResourceHandle} queryGraphicsHandle(key)

Parameters

{string} key 文字列

Returns

{ResourceHandle} Resource Handleオブジェクト


リソース使用箇所のUIを取得します。

{Image} queryUI(key)

Parameters

{string} key 文字列

Returns

{Image} Imageオブジェクト


リソース使用箇所のテキストUIを取得します。

{InteropTextUI} queryTextUI(key)

Parameters

{string} key 文字列

Returns

{InteropTextUI} TextUIオブジェクト


リソース使用箇所の画面を取得します。

{InteropScreen} queryScreen(key)

Parameters

{string} key 文字列

Returns

{InteropScreen} Screenオブジェクト


リソース使用箇所のコマンドを取得します。

{string} queryCommand(key)

Parameters

{string} key 文字列

Returns

{string} 文字列


大きい顔画像の幅を取得します。

{number} getLargeFaceWidth()

Returns

{number} 幅


大きい顔画像の高さを取得します。

{number} getLargeFaceHeight()

Returns

{number} 高さ


大きい顔画像を使用する場合はtrue、そうでない場合はfalseを返します。

{boolean} isLargeFaceUse()

Returns

{boolean} 真偽値


喋っていない場合に暗くする場合はtrue、そうでない場合はfalseを返します。

{number} isMessageBlackOutEnabled()

Returns

{number} 真偽値


メッセージウインドウを常に下側に表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isMessageWindowFixed()

Returns

{boolean} 真偽値


現在イベントが実行されている場合はtrue、そうでない場合はfalseを返します。

{boolean} isEventSceneActived()

Returns

{boolean} 真偽値


現在のイベントコマンドを表すオブジェクトを取得します。

{object} getEventCommandObject()

Returns

{object} オブジェクト


現在のイベントコマンドのタイプを取得します。

{number} getEventCommandType()

Returns

{number} EventCommandType値


現在のイベントコマンドのイベント上でのインデックスを取得します。

{number} getEventCommandIndex()

Returns

{number} インデックス


現在のイベントコマンドを終了します。

endEventCommand(exitCode)

Parameters

{number} exitCode 終了コード


現在のイベントの終了コードを取得します。

setEventExitCode(exitCode)

Parameters

{number} exitCode 終了コード


現在のイベントに対して終了コードを設定します。

{number} getEventExitCode()

Returns

{number} 終了コード


現在のイベントに対してスキップ状態を設定します。

setEventSkipMode(isSkipMode)

Parameters

{boolean} isSkipMode スキップする場合はtrue、そうでない場合はfalse


現在のイベントがスキップ状態である場合はtrue、そうでない場合はfalseを返します。

{boolean} isEventSkipMode()

Returns

{boolean} 真偽値


イベントが階層化されている数を取得します。

{number} getChainEventCount()

Returns

{number} 階層化されている数


指定階層のイベントを取得します。

{Event} getChainEvent(index)

Parameters

{number} index インデックス

Returns

{Event} イベント


現在のシーンから特定のシーンに変更します。

changeScene(sceneType)

Parameters

{number} sceneType SceneType値


現在のシーンを取得します。戦闘準備画面時にイベントを実行し、イベント中にこのメソッドを呼び出すと、SceneType.EVENTが返ります。

{number} getCurrentScene()

Returns

{number} SceneType値


ベースシーンを取得します。戦闘準備画面時にイベントを実行し、イベント中にこのメソッドを呼び出すと、SceneType.BATTLESETUPが返ります。

{number} getBaseScene()

Returns

{number} SceneType値


バックログデータの数を取得します。

{number} getBacklogCommandCount()

Returns

{number} バックログデータの数


バックログデータを取得します。

{BacklogCommand} getBacklogCommand(index)

Parameters

{number} index バックログデータのインデックス

Returns

{BacklogCommand} バックログデータ


イベント背景が表示されている場合はtrue、そうでない場合はfalseを返します。

{boolean} isEventBackgroundVisible()

Returns

{boolean} 真偽値


マウス位置を設定します。

setMousePos(x, y)

Parameters

{number} x x座標

{number} y y座標


マウスのx座標を取得します。

{number} getMouseX()

Returns

{number} x座標


マウスのy座標を取得します。

{number} getMouseY()

Returns

{number} y座標


指定値が入力された場合はtrue、そうでない場合はfalseを返します。

{boolean} isMouseAction(value)

Parameters

{number} value MouseType値

Returns

{boolean} 真偽値


指定値が入力され続けている場合はtrue、そうでない場合はfalseを返します。

{boolean} isMouseState(value)

Parameters

{number} value MouseType値

Returns

{boolean} 真偽値