SRPG Studio スクリプト・リファレンス

root

SceneController

特定のシーンでのみ使用可能なメソッドを提供します。

メソッド

MetaSessionデータを初期化します。SceneType.TITLEで呼び出し可能です。

initializeMetaSession(difficulty)

Parameters

{Difficulty} difficulty 難易度データ


ゲームを最初から始めます。事前にinitializeMetaSessionが呼ばれている必要があります。SceneType.TITLEで呼び出し可能です。

newGame()

次に開くマップのIDを取得します。SceneType.RESTで呼び出し可能です。

{number} getNextMapId()

Returns

{number} マップID


セーブ画面を表示する場合はtrue、そうでない場合はfalseを返します。SceneType.RESTで呼び出し可能です。

{boolean} isSaveScreenDisplayable()

Returns

{boolean} 真偽値


回想イベントのIDを取得します。SceneType.EVENTTESTで呼び出し可能です。

{number} getRecollectionTestEventId()

Returns

{number} イベントのID


ゲームをクリアした場合に呼び出します。SceneType.ENDINGで呼び出し可能です。

completeGame()

エンディングイベントが既に実行済みである場合はtrue、そうでない場合はfalseを返します。SceneType.ENDINGで呼び出し可能です。

{boolean} isEndingEventExecuted()

Returns

{boolean} 真偽値


セーブ画面を表示する必要がある場合はtrue、そうでない場合はfalseを返します。SceneType.ENDINGで呼び出し可能です。

{boolean} isCompletedSaveFlag()

Returns

{boolean} 真偽値


シーンがセーブファイルのロードによって実行された場合はtrue、そうでない場合はfalseを返します。SceneType.BATTLESETUP、SceneType.FREE、SceneType.RESTで呼び出し可能です。

{boolean} isActivatedFromSaveFile()

Returns

{boolean} 真偽値


指定IDで識別されるマップを開きます。SceneType.BATTLESETUP、SceneType.FREE、SceneType.RESTで呼び出し可能です。

startNewMap(mapId)

Parameters

{number} mapId マップID


戦闘を行ったユニットをゲーム側に通知します。SceneType.FREEで呼び出し可能です。

notifyBattleEnd(active, passive)

Parameters

{Unit} active 勝利したユニット

{Unit} passive 敗北したユニット


マップクリア時に画像を表示する場合はtrue、そうでない場合はfalseを返します。SceneType.BATTLERESULTで呼び出し可能です。

{boolean} isMapVictoryDisplayable()

Returns

{boolean} 真偽値


特定のシーンの背景画像を取得します。

{Image} getSceneBackgroundImage(type)

Parameters

{number} type SceneType値

Returns

{Image} 背景画像


StartupInfo

スタートアップ情報を管理します。ScriptCall_Initializeの引数として使用されます。

メソッド

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

{number} getGameAreaWidth()

Returns

{number} ゲームエリアの幅


ゲームエリアの幅を設定します。

setGameAreaWidth(width)

Parameters

{number} width ゲームエリアの幅


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

{number} getGameAreaHeight()

Returns

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


ゲームエリアの高さを設定します。

setGameAreaHeight(height)

Parameters

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


LoadSaveManager

セーブファイルに関する情報を管理します。

メソッド

現在のデータをセーブします。SceneType.BATTLESETUP、SceneType.FREE、SceneType.RESTで有効です。SceneType.FREEの場合は、保存時にセッション情報が書き込まれるため、若干容量が増えます。

saveFile(index, step, mapId, obj)

Parameters

{number} index ファイルのインデックス

{number} step SceneType値

{number} mapId マップのID

{object} obj 独自に定義したオブジェクト


セーブファイルのデータをロードします。

loadFile(index)

Parameters

{number} index ファイルのインデックス


セーブファイルの数を取得します。

{number} getSaveFileCount()

Returns

{number} セーブファイルの数


セーブファイルの情報を取得します

{SaveFileInfo} getSaveFileInfo(index)

Parameters

{number} index セーブファイルのインデックス

Returns

{SaveFileInfo} セーブファイルの情報


セーブファイルをコピーします。

copyFile(srcIndex, destIndex)

Parameters

{number} srcIndex コピー元ファイルのインデックス

{number} destIndex コピー先ファイルのインデックス


セーブファイルを削除します。

deleteFile(index)

Parameters

{number} index ファイルのインデックス


中断ファイルに対してセーブを行います。

saveInterruptionFile(step, mapId, obj)

Parameters

{number} step SceneType値

{number} mapId マップのID

{object} obj 独自に定義したオブジェクト


中断ファイルをロードします。

loadInterruptionFile()

中断ファイルを削除します。

deleteInterruptionFile()

中断ファイルをロードできる場合はtrue、そうでない場合はfalseを返します。

{boolean} isInterruptionFileLoadable()

Returns

{boolean} 真偽値


中断ファイルの情報を取得します

{SaveFileInfo} getInterruptionFileInfo()

Returns

{SaveFileInfo} セーブファイルの情報


現在のゲームデータを中断データとしてゲーム内部に保存します。このメソッドを一度でも呼び出すと、スクリプトエラー時にゲームを再開できるようになります。

setTemporaryInterruptionData(step, mapId, obj)

Parameters

{number} step SceneType値

{number} mapId マップのID

{object} obj 独自に定義したオブジェクト


GraphicsManager

画像の操作を行います。

メソッド

画面の全範囲を指定色を塗りつぶします。ScriptCall_Draw以下の呼び出しで有効です。

fill(color)

Parameters

{number} color 色


画面の指定範囲を指定色を塗りつぶします。ScriptCall_Draw以下の呼び出しで有効です。

fillRange(x, y, width, height, color, alpha)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ

{number} color 色

{number} alpha アルファ値


テキストを描画します。ScriptCall_Draw以下の呼び出しで有効です。

drawText(x, y, text, length, color, alpha, font)

Parameters

{number} x x座標

{number} y y座標

{string} text テキスト

{number} length 何ピクセル先まで描画するかを指定します。-1の場合は、テキストが最後まで描画されます。プロポーショナルフォントの場合は、-1として扱われます。

{number} color 色

{number} alpha アルファ値

{Font} font フォント


テキストを指定文字だけ描画します。ScriptCall_Draw以下の呼び出しで有効です。

drawCharText(x, y, text, length, color, alpha, font)

Parameters

{number} x x座標

{number} y y座標

{string} text テキスト

{number} length 文字数

{number} color 色

{number} alpha アルファ値

{Font} font フォント


テキストを指定範囲内に描画します。ScriptCall_Draw以下の呼び出しで有効です。

drawTextRange(x, y, width, height, format, text, length, color, alpha, font)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ

{number} format TextFormat値

{string} text テキスト

{number} length 何ピクセル先まで描画するかを指定します。-1の場合は、テキストが最後まで描画されます。プロポーショナルフォントの場合は、-1として扱われます。

{number} color 色

{number} alpha アルファ値

{Font} font フォント


テキストの幅を取得します。

{number} getTextWidth(text, font)

Parameters

{string} text テキスト

{Font} font フォント

Returns

{number} 幅


テキストの高さを取得します。

{number} getTextHeight(text, font)

Parameters

{string} text テキスト

{Font} font フォント

Returns

{number} 高さ


整形済みテキストを作成します。

{FormattedText} createFormattedText(text, font)

Parameters

{string} text テキスト

{Font} font フォント

Returns

{FormattedText} FormattedTextオブジェクト


クリッピング領域を作成します。

{ClippingArea} createClippingArea(x, y, width, height)

Parameters

{number} x x座標

{number} y y座標

{number} width 幅

{number} height 高さ

Returns

{ClippingArea} クリッピング領域


クリッピング領域をプッシュします。ScriptCall_Draw以下の呼び出しで有効です。

{boolean} pushClippingArea(clippingArea)

Parameters

{ClippingArea} clippingArea プッシュするクリッピング領域

Returns

{boolean} 成功した場合はtrue、そうでない場合はfalse


現在のクリッピング領域をポップします。ScriptCall_Draw以下の呼び出しで有効です。

{boolean} popClippingArea()

Returns

{boolean} 成功した場合はtrue、そうでない場合はfalse


キャッシュ可能な独自画像を作成します。

{Image} createCacheGraphics(width, height)

Parameters

{number} width 画像の幅

{number} height 画像の高さ

Returns

{Image} キャッシュ


指定キャッシュを描画先として設定します。以降の描画は、画面に対してではなくキャッシュに対して行われます。

setRenderCache(cache)

Parameters

{Image} cache キャッシュ


描画先を通常の状態に戻します。

resetRenderCache()

キャッシュの中身を別のキャッシュにコピーします。ScriptCall_Draw以下の呼び出しで有効です。

copyCache(cacheDest, xDest, yDest, cacheSrc, xSrc, ySrc, width, height)

Parameters

{Image} cacheDest コピー先キャッシュ

{number} xDest コピー先のX座標

{number} yDest コピー先のY座標

{Image} cacheSrc コピー元キャッシュ

{number} xSrc コピー元のX座標

{number} ySrc コピー元のY座標

{number} width 幅

{number} height 高さ


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

{GraphicsCanvas} getCanvas()

Returns

{GraphicsCanvas} GraphicsCanvasオブジェクト


マップをクリッピングする場合はtrue、そうでない場合はfalseを返します。ScriptCall_Draw以下の呼び出しで有効です。

enableMapClipping(enable)

Parameters

{boolean} enable 真偽値


マップに永続的なアルファ値を設定します。ScriptCall_Move以下の呼び出しで有効です。

setMapAlpha(alpha)

Parameters

{number} alpha アルファ値


マップを永続的に反転させます。ScriptCall_Move以下の呼び出しで有効です。

setMapReverse(reverse)

Parameters

{boolean} reverse 反転させる場合はtrue、そうでない場合はfalse


マップを永続的に拡大/縮小します。ScriptCall_Move以下の呼び出しで有効です。

setMapScale(scale)

Parameters

{number} scale スケール値


マップを永続的に回転させます。ScriptCall_Move以下の呼び出しで有効です。

setMapDegree(degree)

Parameters

{number} degree 回転


マップを永続的に指定範囲にズームさせます。ScriptCall_Move以下の呼び出しで有効です。

setMapZoom(x, y, width, height)

Parameters

{number} x X座標

{number} y Y座標

{number} width 幅

{number} height 高さ


MediaManager

メディアの操作を行います。

メソッド

BGMを再生します。

musicPlay(handle, musicPlayType)

Parameters

{ResourceHandle} handle メディアのリソースハンドル

{number} musicPlayType MusicPlayType値


BGMを停止します。

musicStop(type, speed)

Parameters

{number} type MusicStopType値

{number} speed SpeedType値


効果音を再生します。

soundPlay(handle, id)

Parameters

{ResourceHandle} handle リソースハンドル

{number} id 割り当てID


効果音を停止します。

soundStop(id, isAllStop)

Parameters

{number} id 割り当てID

{boolean} isAllStop 全ての効果音を停止する場合はtrue、そうでない場合はfalse


BGMの音量を設定します。

setMusicVolume(volume)

Parameters

{number} volume 0から100までの値


BGMの音量を取得します。

{number} getMusicVolume()

Returns

{number} 0から100までの値


SEの音量を設定します。

setSoundVolume(volume)

Parameters

{number} volume 0から100までの値


SEの音量を取得します。

{number} getSoundVolume()

Returns

{number} 0から100までの値


ボイスの音量を設定します。

setVoiceVolume(volume)

Parameters

{number} volume 0から100までの値


ボイスの音量を取得します。

{number} getVoiceVolume()

Returns

{number} 0から100までの値


現在再生中のBGMを示すリソースハンドルを取得します。

{ResourceHandle} getActiveMusicHandle()

Returns

{ResourceHandle} リソースハンドル


BGMの待ち構造を初期化します。

resetMusicList()

メモリ上に存在する復号化されたBGMデータを開放します。

clearMusicCache()

メモリ上に存在する復号化されたSEデータを開放します。

clearSoundCache()

MaterialManager

マテリアルデータを管理します。マテリアルデータとは、Materiaフォルダ内のフォルダの中に存在するテキストファイル、画像ファイル、音楽ファイルの総称です。カテゴリとは、フォルダの名前です。

メソッド

テキストを取得します。

{string} getText(category, name)

Parameters

{string} category カテゴリ名

{string} name テキスト名

Returns

{string} テキスト


画像を取得します。

{Image} createImage(category, name)

Parameters

{string} category カテゴリ名

{string} name 画像名

Returns

{Image} 画像


効果音を再生します。

soundPlay(category, name, id)

Parameters

{string} category カテゴリ名

{string} name メディア名

{number} id 割り当てID


効果音を停止します。

soundStop(id, isAllStop)

Parameters

{number} id 割り当てID

{boolean} isAllStop 全ての効果音を停止する場合はtrue、そうでない場合はfalse


ボイスを再生します。

voicePlay(category, name, id)

Parameters

{string} category カテゴリ名

{string} name メディア名

{number} id 割り当てID


ボイスを停止します。

voiceStop(id, isAllStop)

Parameters

{number} id 割り当てID

{boolean} isAllStop 全ての効果音を停止する場合はtrue、そうでない場合はfalse


Materialフォルダ内の特定のフォルダ内に存在するファイル数を取得します。

{number} getMaterialCount(category)

Parameters

{string} category カテゴリ名

Returns

{number} ファイル数


Materialフォルダ内の特定のフォルダ内に存在するファイルの名前を取得します。

{string} getMaterialName(i, category)

Parameters

{number} i インデックス

{string} category カテゴリ名

Returns

{string} ファイル名


DataEditor

データの編集を管理します。

メソッド

リストにスキルを追加します。

addSkillData(list, data)

Parameters

{ReferenceList} list リスト

{Skill} data スキル


リストからスキルを削除します。

deleteSkillData(list, data)

Parameters

{ReferenceList} list リスト

{Skill} data スキル


リストから全スキルを削除します。

deleteAllSkillData(list)

Parameters

{ReferenceList} list リスト


リストに追加されているスキルを変更します。

changeSkillData(list, newData, oldData)

Parameters

{ReferenceList} list リスト

{Skill} newData 新しく追加されるスキル

{Skill} oldData 置き換えられるスキル


リストにステートを追加します。

{TurnState} addTurnStateData(list, data)

Parameters

{DataList} list リスト

{State} data 追加したいステート

Returns

{TurnState} 実際に追加されたステート


リストからステートを削除します。

deleteTurnStateData(list, data)

Parameters

{DataList} list リスト

{State} data ステート


リストから全ステートを削除します。

deleteAllTurnStateData(list)

Parameters

{DataList} list リスト


TrophyEditor

トロフィーを管理します。

メソッド

リストにトロフィーを追加します。

addTrophy(list, trophy)

Parameters

{DataList} list リスト

{Trophy} trophy トロフィー


リストにアイテムのみで構成されるトロフィーを追加します。

addItem(list, *item, isImmediately)

Parameters

{DataList} list リスト

{Item} *item アイテム

{boolean} isImmediately 直ちに入手できる場合はtrue、そうでない場合はfalse


リストにゴールドのみで構成されるトロフィーを追加します。

addGold(list, gold, isImmediately)

Parameters

{DataList} list リスト

{number} gold ゴールド

{boolean} isImmediately 直ちに入手できる場合はtrue、そうでない場合はfalse


リストにボーナスのみで構成されるトロフィーを追加します。

addBonus(list, bonus, isImmediately)

Parameters

{DataList} list リスト

{number} bonus ボーナス

{boolean} isImmediately 直ちに入手できる場合はtrue、そうでない場合はfalse


指定トロフィーをリストから削除します。

deleteTrophy(list, trophy)

Parameters

{DataList} list リスト

{Trophy} trophy トロフィー


リスト内の全てのトロフィーを削除します。

deleteAllTrophy(list)

Parameters

{DataList} list リスト


SwitchTable

スイッチの情報を管理します。

メソッド

スイッチの数を取得します。

{number} getSwitchCount()

Returns

{number} スイッチの数


スイッチのIDを取得します。

{number} getSwitchId(index)

Parameters

{number} index 対象スイッチのインデックス

Returns

{number} スイッチのID


スイッチのIDをベースにインデックスを取得します。

{number} getSwitchIndexFromId(id)

Parameters

{number} id スイッチのID

Returns

{number} スイッチのインデックス


スイッチの名前を取得します。

{string} getSwitchName(index)

Parameters

{number} index 対象スイッチのインデックス

Returns

{string} スイッチの名前


スイッチの説明文を取得します。

{string} getSwitchDescription(index)

Parameters

{number} index 対象スイッチのインデックス

Returns

{string} スイッチの説明文


スイッチのリソースハンドルを取得します。

{ResourceHandle} getSwitchResourceHandle(index)

Parameters

{number} index 対象スイッチのインデックス

Returns

{ResourceHandle} スイッチのリソースハンドル


スイッチが有効である場合はtrue、そうでない場合はfalseを返します。

{boolean} isSwitchOn(index)

Parameters

{number} index 対象スイッチのインデックス

Returns

{boolean} 真偽値


スイッチの状態を変更します。

setSwitch(index, flag)

Parameters

{number} index 対象スイッチのインデックス

{boolean} flag スイッチを有効にする場合はtrue、そうでない場合はfalse


VariableTable

変数の情報を管理します。

メソッド

変数の数を取得します。

{number} getVariableCount()

Returns

{number} 変数の数


変数のIDを取得します。

{number} getVariableId(index)

Parameters

{number} index 対象変数のインデックス

Returns

{number} 変数のID


変数のIDをベースにインデックスを取得します。

{number} getVariableIndexFromId(id)

Parameters

{number} id 変数のID

Returns

{number} 変数のインデックス


変数の名前を取得します。

{string} getVariableName(index)

Parameters

{number} index 対象変数のインデックス

Returns

{string} 変数の名前


変数の説明文を取得します。

{string} getVariableDescription(index)

Parameters

{number} index 対象変数のインデックス

Returns

{string} 変数の説明文


変数のリソースハンドルを取得します。

{ResourceHandle} getVariableResourceHandle(index)

Parameters

{number} index 対象変数のインデックス

Returns

{ResourceHandle} 変数のリソースハンドル


変数の値を取得します。

{number} getVariable(index)

Parameters

{number} index 対象変数のインデックス

Returns

{number} 変数の値


変数の最小値を取得します。

{number} getVariableMin(index)

Parameters

{number} index 対象変数のインデックス

Returns

{number} 最小値


変数の最大値を取得します。

{number} getVariableMax(index)

Parameters

{number} index 対象変数のインデックス

Returns

{number} 最大値


変数に値を設定します。

setVariable(index, value)

Parameters

{number} index 対象変数のインデックス

{number} value 新しい変数の値