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

root

SceneController

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

メソッド

難易度データ

initializeMetaSession(difficulty)

Parameters

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


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

newGame()

マップID

{number} getNextMapId()

Returns

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


真偽値

{boolean} isSaveScreenDisplayable()

Returns

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


イベントのID

{number} getRecollectionTestEventId()

Returns

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


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

completeGame()

真偽値

{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で呼び出し可能です。


マップID

startNewMap(mapId)

Parameters

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


勝利したユニット

notifyBattleEnd(active, passive)

Parameters

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

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


真偽値

{boolean} isMapVictoryDisplayable()

Returns

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


SceneType値

{Image} getSceneBackgroundImage(type)

Parameters

{number} type 背景画像

Returns

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


StartupInfo

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

メソッド

ゲームエリアの幅

{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 SceneType値

{number} step マップのID

{number} mapId 独自に定義したオブジェクト

{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 中断ファイルに対してセーブを行います。


SceneType値

saveInterruptionFile(step, mapId, obj)

Parameters

{number} step マップのID

{number} mapId 独自に定義したオブジェクト

{object} obj 中断ファイルをロードします。


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

loadInterruptionFile()

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

deleteInterruptionFile()

真偽値

{boolean} isInterruptionFileLoadable()

Returns

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


セーブファイルの情報

{SaveFileInfo} getInterruptionFileInfo()

Returns

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


SceneType値

setTemporaryInterruptionData(step, mapId, obj)

Parameters

{number} step マップのID

{number} mapId 独自に定義したオブジェクト

{object} obj 画像の操作を行います。


GraphicsManager

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

メソッド

fill(color)

Parameters

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


x座標

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

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height 色

{number} color アルファ値

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


x座標

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

Parameters

{number} x y座標

{number} y テキスト

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

{number} length 色

{number} color アルファ値

{number} alpha フォント

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


x座標

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

Parameters

{number} x y座標

{number} y テキスト

{string} text 文字数

{number} length 色

{number} color アルファ値

{number} alpha フォント

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


x座標

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

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height TextFormat値

{number} format テキスト

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

{number} length 色

{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 FormattedTextオブジェクト

Returns

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


x座標

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

Parameters

{number} x y座標

{number} y 幅

{number} width 高さ

{number} height クリッピング領域

Returns

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


プッシュするクリッピング領域

{boolean} pushClippingArea(clippingArea)

Parameters

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

Returns

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


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

{boolean} popClippingArea()

Returns

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


画像の幅

{Image} createCacheGraphics(width, height)

Parameters

{number} width 画像の高さ

{number} height キャッシュ

Returns

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


キャッシュ

setRenderCache(cache)

Parameters

{Image} cache 描画先を通常の状態に戻します。


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

resetRenderCache()

コピー先キャッシュ

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

Parameters

{Image} cacheDest コピー先のX座標

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

{number} yDest コピー元キャッシュ

{Image} cacheSrc コピー元のX座標

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

{number} ySrc 幅

{number} width 高さ

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


GraphicsCanvasオブジェクト

{GraphicsCanvas} getCanvas()

Returns

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


真偽値

enableMapClipping(enable)

Parameters

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


アルファ値

setMapAlpha(alpha)

Parameters

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


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

setMapReverse(reverse)

Parameters

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


スケール値

setMapScale(scale)

Parameters

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


回転

setMapDegree(degree)

Parameters

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


X座標

setMapZoom(x, y, width, height)

Parameters

{number} x Y座標

{number} y 幅

{number} width 高さ

{number} height メディアの操作を行います。


MediaManager

BGMを再生します。

メソッド

メディアのリソースハンドル

musicPlay(handle, musicPlayType)

Parameters

{ResourceHandle} handle MusicPlayType値

{number} musicPlayType BGMを停止します。


MusicStopType値

musicStop(type, speed)

Parameters

{number} type SpeedType値

{number} speed 効果音を再生します。


リソースハンドル

soundPlay(handle, id)

Parameters

{ResourceHandle} handle 割り当てID

{number} id 効果音を停止します。


割り当てID

soundStop(id, isAllStop)

Parameters

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

{boolean} isAllStop BGMの音量を設定します。


0から100までの値

setMusicVolume(volume)

Parameters

{number} volume BGMの音量を取得します。


0から100までの値

{number} getMusicVolume()

Returns

{number} SEの音量を設定します。


0から100までの値

setSoundVolume(volume)

Parameters

{number} volume SEの音量を取得します。


0から100までの値

{number} getSoundVolume()

Returns

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


0から100までの値

setVoiceVolume(volume)

Parameters

{number} volume ボイスの音量を取得します。


0から100までの値

{number} getVoiceVolume()

Returns

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


リソースハンドル

{ResourceHandle} getActiveMusicHandle()

Returns

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


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

resetMusicList()

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

clearMusicCache()

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

clearSoundCache()

MaterialManager

テキストを取得します。

メソッド

カテゴリ名

{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 割り当てID

{number} id 効果音を停止します。


割り当てID

soundStop(id, isAllStop)

Parameters

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

{boolean} isAllStop ボイスを再生します。


カテゴリ名

voicePlay(category, name, id)

Parameters

{string} category メディア名

{string} name 割り当てID

{number} id ボイスを停止します。


割り当てID

voiceStop(id, isAllStop)

Parameters

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

{boolean} isAllStop 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 直ちに入手できる場合はtrue、そうでない場合はfalse

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


リスト

addGold(list, gold, isImmediately)

Parameters

{DataList} list ゴールド

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

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


リスト

addBonus(list, bonus, isImmediately)

Parameters

{DataList} list ボーナス

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

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


リスト

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 スイッチのID

Returns

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


スイッチのID

{number} getSwitchIndexFromId(id)

Parameters

{number} 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 スイッチを有効にする場合はtrue、そうでない場合はfalse

{boolean} flag 変数の情報を管理します。


VariableTable

変数の数を取得します。

メソッド

変数の数

{number} getVariableCount()

Returns

{number} 変数のIDを取得します。


対象変数のインデックス

{number} getVariableId(index)

Parameters

{number} index 変数のID

Returns

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


変数のID

{number} getVariableIndexFromId(id)

Parameters

{number} 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)

Parameters

{number} index 新しい変数の値