Root
root情報を管理します。
メソッド
スクリプトのバージョンを取得します。
{number} getScriptVersion()
Returns
{number} バージョン
ゲームをリセットします。
resetGame()
ゲームを終了します。
endGame()
現在のアプリケーションのスクリーン状態を取得します。
{number} getAppScreenMode()
Returns
{number} AppScreenMode値
現在のアプリケーションのスクリーン状態を変更します。
setAppScreenMode(mode)
Parameters
{number} mode AppScreenMode値
ソフトウェアフルスクリーン時のサイズを設定します。デフォルトは全画面です。
setAppSoftScreenSize(width, height)
Parameters
{number} width 幅
{number} height 高さ
game.iniにおいて、フルスクリーンをどのように実行するかの値を取得します。
{number} getFullScreenModeFromGameIni()
Returns
{number} 0の場合はハードウェアフルスクリーン、1の場合はソフトウェアフルスクリーン
ソフトウェアフルスクリーンにおけるInterpolationModeを指定します。
setSoftwareFullScreenInterpolationMode(mode)
Parameters
{number} mode InterpolationMode値
ゲームがどの言語として実行されているかを取得します。
{number} getLanguageCode()
Returns
{number} LanguageCode値
ゲームがどのローカライズフォルダを参照しているかを取得します。
{string} getLocalizationFolder()
Returns
{string} ローカライズフォルダの名前
指定値が入力された場合は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} 真偽値
特定のシステム設定を有効にします。
setSystemSettings(type, flag)
Parameters
{number} type SystemSettingsType値
{boolean} flag 有効にする場合はtrue、そうでない場合はfalseを指定します。
時間の計測を開始します。
watchTime()
watchTimeを呼び出してからの経過時間をミリ秒単位で取得します。
{number} getElapsedTime()
Returns
{number} 経過時間
watchTimeを呼び出してからの経過時間をミリ秒単位で取得します。計測がサイクルをまたぐ場合、このメソッドを使用します。
{number} getCycleTime()
Returns
{number} 経過時間
直近のFPSを取得します。
{number} getFPS()
Returns
{number} FPS
メッセージボックスを表示します。
msg(text)
Parameters
{string} text メッセージ
コンソールに文字列を出力します。
log(text)
Parameters
{string} text 文字列
コンソールの内容をクリアします。
resetConsole()
スクリーンショットを保存します。Game.iniのHardwareAccelerationが1に設定されている場合に有効です。
{boolean} saveScreenShot(isMapAll)
Parameters
{boolean} isMapAll 真偽値
Returns
{boolean} マップ全体を対象にする場合は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} リソースハンドル
StateInvocationオブジェクトを作成します。
{StateInvocation} createStateInvocation(stateId, lnvValue, invType)
Parameters
{number} stateId ステートのID
{number} lnvValue 数値(係数や確率)
{number} invType InvocationType値
Returns
{StateInvocation} StateInvocationオブジェクト
乱数を取得します。
{number} getRandomNumber()
Returns
{number} 乱数
乱数のシードを設定します。
setRandomNumberSeed(seed)
Parameters
{number} seed シード
セルフスイッチを設定します。
setSelfSwitch(index, flag)
Parameters
{number} index インデックス
{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 アルファ値
全てのユニットのキャラチップをカスタムに描画できるオブジェクトを取得します。
{object} getGlobalCustomRenderer()
Returns
{object} BaseCustomCharChipを継承したオブジェクト
引数のオブジェクトを指定することで、全てのユニットのキャラチップをカスタムに描画できます。メソッドを呼び出すとBaseCustomCharChip.setupCustomCharChipが呼ばれます。カスタム描画を解除する場合は{}を設定します。
setGlobalCustomRenderer(obj)
Parameters
{object} obj BaseCustomCharChipを継承したオブジェクト
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} 装飾オブジェクト
キャラチップのステートアイコンとフュージョンアイコンを装飾するオブジェクトを取得します。
{GraphicsDecoration} getIconDecoration()
Returns
{GraphicsDecoration} 装飾オブジェクト
イベントコマンドの「背景画像の変更」で変更を開始します。
startBackgroundChange()
アイテムを複製します。
{Item} duplicateItem(*item)
Parameters
{Item} *item 複製対象のアイテム
Returns
{Item} 複製されたアイテム
「データ設定」 / 「パラメータ上限」で設定可能な値を超える上限値を設定します。
setMaxParameter(index, value)
Parameters
{number} index パラメータのインデックス
{number} value 新しい上限値
ウインドウの幅を取得します。
{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オブジェクト
動画を管理するオブジェクトを取得します。
{VideoManager} getVideoManager()
Returns
{VideoManager} VideoManagerオブジェクト
素材を管理するオブジェクトを取得します。
{MaterialManager} getMaterialManager()
Returns
{MaterialManager} MaterialManagerオブジェクト
Steam APIにアクセスできるオブジェクトを取得します。
{SteamManager} getSteamManager()
Returns
{SteamManager} SteamManagerオブジェクト
ゲーム内画像を差し替えれるオブジェクトを取得します。
{ModManager} getModManager()
Returns
{ModManager} ModManagerオブジェクト
対戦データ(suserファイル)の出力と読み込みを行うオブジェクトを取得します。
{UserFileManager} getUserFileManager()
Returns
{UserFileManager} UserFileManagerオブジェクト
特殊なオプションを設定できるオブジェクトを取得します。
{CustomizationOptionsManager} getCustomizationOptionsManager()
Returns
{CustomizationOptionsManager} CustomizationOptionsManagerオブジェクト
現在メモリにロードされているリソースを管理できるオブジェクトを取得します。
{ResourceProfiler} getResourceProfiler()
Returns
{ResourceProfiler} ResourceProfilerオブジェクト
動的にユニットを作成するオブジェクトを取得します。
{ObjectGenerator} getObjectGenerator()
Returns
{ObjectGenerator} ObjectGeneratorオブジェクト
動的にイベントを実行するオブジェクトを取得します。
{EventGenerator} getEventGenerator()
Returns
{EventGenerator} EventGeneratorオブジェクト
シーンを制御するオブジェクトを取得します。
{SceneController} getSceneController()
Returns
{SceneController} SceneControllerオブジェクト
データを編集するオブジェクトを取得します。
{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} 真偽値
キャラチップリソースのデフォルト幅を取得します。
{number} getCharChipWidth()
Returns
{number} 幅
キャラチップリソースのデフォルト高さを取得します。
{number} getCharChipHeight()
Returns
{number} 高さ
アイコンリソースのデフォルト幅を取得します。
{number} getIconWidth()
Returns
{number} 幅
アイコンリソースのデフォルト高さを取得します。
{number} getIconHeight()
Returns
{number} 高さ
マップチップリソースのデフォルト幅を取得します。
{number} getMapChipWidth()
Returns
{number} 幅
マップチップリソースのデフォルト高さを取得します。
{number} getMapChipHeight()
Returns
{number} 高さ
デフォルトの「メッセージレイアウト」を取得します。
{MessageLayout} getDefaultMessageLayout()
Returns
{MessageLayout} MessageLayoutオブジェクト
現在イベントが実行されている場合は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値
独自テキストをバックログに追加します。
{BacklogCommand} appendBacklogCommand(unitOrNpc, text, pos, facialExpressionId)
Parameters
{object} unitOrNpc ユニットまたはNPC
{string} text テキスト
{number} pos MessagePos値
{number} facialExpressionId 表情ID
Returns
{BacklogCommand} 新しく追加したバックログデータ
バックログデータの数を取得します。
{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} 真偽値
ゲームパッドにおける入出力を指定されたデバイスに関連付けます。
{boolean} changeInputDevice(type)
Parameters
{number} type InputDeviceType値
Returns
{boolean} 真偽値
現在のゲームパッドの入出力タイプを取得します。
{number} getInputDeviceType()
Returns
{number} InputDeviceType値
game.iniのkeyboardセクションの設定を取得します。
{object} getKeyBinding(keycode)
Parameters
{string} keycode game.iniのkeyboardセクションのエントリ名を指定します。たとえば、'SELECT'です。
Returns
{object} エントリに関連するキーが配列として返ります。キーは2つまで指定できるので、配列として受け取ります。たとえば、デフォルトでは、'SELECT'を指定すると、arr[0]に'z'、arr[1]に'enter'が返ります。
game.iniのkeyboardセクションの内容を変更し、ゲーム終了後にgame.iniを更新します。
setKeyBinding(keycode, key1, key2)
Parameters
{string} keycode game.iniのkeyboardセクションのエントリ名を指定します。たとえば、'SELECT'です。
{string} key1 エントリの新しい値を設定します。たとえば、SELECTとxを紐づけるには、setKeyBinding('SELECT', 'x', '');を指定します。
{string} key2 紐付ける2つ目のキーを指定します。2つ目のキーが存在しない場合は''で問題ありません。
game.iniのGamepadセクションの設定を取得します。
{number} getGamepadBinding(keycode)
Parameters
{string} keycode game.iniのGamepadセクションのエントリ名を指定します。たとえば、'SELECT'です。
Returns
{number} エントリに関連する値が数値として返ります。
game.iniのGamepadセクションの内容を変更し、ゲーム終了後にgame.iniを更新します。
setGamepadBinding(keycode, value)
Parameters
{string} keycode game.iniのGamepadセクションのエントリ名を指定します。たとえば、'SELECT'です。
{number} value エントリに設定する新しい値を指定します。
テストファイルからテキストを読み取ります。
{string} readTestFile()
Returns
{string} 読み取ったテキスト
テストファイルにテキストを書き込みます。
writeTestFile(text)
Parameters
{string} text 書き込むテキスト