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

root

MetaSession

メタセッションの情報を管理します。メタセッションはどのようなシーンでも、root.getMetaSessionで取得できます。

メソッド

ゴールドを取得します。

{number} getGold()

Returns

{number} ゴールド


ゴールドを設定します。

setGold(gold)

Parameters

{number} gold ゴールド


ボーナスを取得します。

{number} getBonus()

Returns

{number} ボーナス


ボーナスを設定します。

setBonus(bonus)

Parameters

{number} bonus ボーナス


プレイ時間を取得します。

{number} getPlayTime()

Returns

{number} プレイ時間


難易度を取得します。

{Difficulty} getDifficulty()

Returns

{Difficulty} 難易度


難易度を設定します。

setDifficulty(difficulty)

Parameters

{Difficulty} difficulty 難易度


ストックアイテムの配列を取得します。

{object} getStockItemArray()

Returns

{object} ストックアイテムの配列


プレイヤーのリストを取得します。

{DataList} getTotalPlayerList()

Returns

{DataList} オブジェクト


グローバルスイッチを管理するオブジェクトを取得します。

{SwitchTable} getGlobalSwitchTable()

Returns

{SwitchTable} オブジェクト


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

{VariableTable} getVariableTable(index)

Parameters

{number} index インデックス

Returns

{VariableTable} オブジェクト


指定インデックスに対する環境値を取得します。

{number} getDefaultEnvironmentValue(lndex)

Parameters

{number} lndex インデックス

Returns

{number} 環境値


指定インデックスに対して環境値を設定します。

setDefaultEnvironmentValue(index, value)

Parameters

{number} index インデックス

{number} value 環境値


現在のマップの「戦闘準備画面」でセーブを行っていない場合はtrue、そうでない場合はfalseを返します。

{boolean} isFirstSetup()

Returns

{boolean} 真偽値


グローバルパラメータを取得します。

{object} global()

Returns

{object} グローバルパラメータ


GameSession

ゲームセッションの情報を管理します。ゲームセッションはマップが開かれている場合に、root.getCurrentSessionで取得できます。マップが開かれているシーンは、、SceneType.BATTLESETUP、SceneType.FREE、SceneType.BATTLERESULTです。

メソッド

プレイヤーのリストを取得します。

{DataList} getPlayerList()

Returns

{DataList} プレイヤーのリスト


敵のリストを取得します。

{DataList} getEnemyList()

Returns

{DataList} 敵のリスト


同盟軍のリストを取得します。

{DataList} getAllyList()

Returns

{DataList} 同盟軍のリスト


ゲストのリストを取得します。

{DataList} getGuestList()

Returns

{DataList} ゲストのリスト


場所イベントのリストを取得します。

{DataList} getPlaceEventList()

Returns

{DataList} 場所イベントのリスト


自動イベントのリストを取得します。

{DataList} getAutoEventList()

Returns

{DataList} 自動イベントのリスト


会話イベントのリストを取得します。

{DataList} getTalkEventList()

Returns

{DataList} 会話イベントのリスト


オープニングイベントのリストを取得します。

{DataList} getOpeningEventList()

Returns

{DataList} オープニングイベントのリスト


エンディングイベントのリストを取得します。

{DataList} getEndingEventList()

Returns

{DataList} エンディングイベントのリスト


コミュニケーションイベントのリストを取得します。

{DataList} getCommunicationEventList()

Returns

{DataList} コミュニケーションイベントのリスト


マップ共有イベントのリストを取得します。

{DataList} getMapCommonEventList()

Returns

{DataList} マップ共有イベントのリスト


現在のマップの情報を取得します。Nullが返る場合は、現在のシーンがSceneType.RESTであることを意味します。

{MapData} getCurrentMapInfo()

Returns

{MapData} 現在のマップの情報


マップの侵入禁止領域の境界値を取得します。

{number} getMapBoundaryValue()

Returns

{number} 境界値


マップの侵入禁止領域の境界値を設定します。

setMapBoundaryValue(value)

Parameters

{number} value 境界値


指定位置から地形情報を取得します。

{Terrain} getTerrainFromPos(x, y, isLayer)

Parameters

{number} x x座標

{number} y y座標

{boolean} isLayer 透過チップを取得する場合はtrue、そうでない場合はfalse

Returns

{Terrain} 地形情報


指定位置からユニットを取得します。非表示状態であるユニットは考慮されません。

{Unit} getUnitFromPos(x, y)

Parameters

{number} x x座標

{number} y y座標

Returns

{Unit} ユニット


指定位置を起点にマップを描画します。

drawMapSet(x, y)

Parameters

{number} x x座標

{number} y y座標


マップ全体を描画します

drawMapAll()

マップにグリッドを描画します。

drawMapGrid(color, alpha)

Parameters

{number} color 色

{number} alpha 不透明度


ユニットの部隊を描画します。

drawUnitSet(isPlayer, isEnemy, isAlly, indexAnime, indexAnime2)

Parameters

{boolean} isPlayer 自軍を描画する場合はtrue、そうでない場合はfalse

{boolean} isEnemy 敵軍を描画する場合はtrue、そうでない場合はfalse

{boolean} isAlly 同盟軍を描画する場合はtrue、そうでない場合はfalse

{number} indexAnime ユニットのアニメにおけるインデックス

{number} indexAnime2 ユニットのアニメにおけるインデックス


マップカーソルのx座標を取得します。

{number} getMapCursorX()

Returns

{number} カーソルの位置


マップカーソルのy座標を取得します。

{number} getMapCursorY()

Returns

{number} カーソルの位置


マップカーソルのx座標を設定します。

setMapCursorX(x)

Parameters

{number} x カーソルの位置


マップカーソルのy座標を設定します。

setMapCursorY(y)

Parameters

{number} y カーソルの位置


x方向におけるピクセル単位のスクロール値を取得します。

{number} getScrollPixelX()

Returns

{number} スクロール値


y方向におけるピクセル単位のスクロール値を取得します。

{number} getScrollPixelY()

Returns

{number} スクロール値


x方向におけるピクセル単位のスクロール値を設定します。

setScrollPixelX(x)

Parameters

{number} x スクロール値


y方向におけるピクセル単位のスクロール値を設定します。

setScrollPixelY(y)

Parameters

{number} y スクロール値


ターン数を取得します。

{number} getTurnCount()

Returns

{number} ターン数


ターン数を設定します。

setTurnCount(count)

Parameters

{number} count ターン数


ターンの種類を取得します。

{number} getTurnType()

Returns

{number} TurnType値


ターンの種類を設定します。

setTurnType(value)

Parameters

{number} value TurnType値


マップの開始状態を設定します。

setStartEndType(type)

Parameters

{number} type StartEndType値


相対ターン数を取得します

{number} getRelativeTurnCount()

Returns

{number} 相対ターン数


相対ターンをカウントします。

increaseRelativeTurn()

現在のマップの状態を確認します。

setMapState(state, flag)

Parameters

{number} state MapStateType値

{boolean} flag 状態が満たされている場合はtrue、そうでない場合はfalse


現在のマップの状態を確認します。

{boolean} isMapState(state)

Parameters

{number} state MapStateType値

Returns

{boolean} 状態が満たされている場合はtrue、そうでない場合はfalse


アクティブなユニットを取得します。

{Unit} getActiveEventUnit()

Returns

{Unit} アクティブなユニット


指定ユニットをアクティブに設定します。

setActiveEventUnit(unit)

Parameters

{Unit} unit アクティブにしたいユニット


マップクリア後に参照するトロフィーのリストを取得します。

{DataList} getTrophyPoolList()

Returns

{DataList} トロフィーのリスト


トロフィーを編集するオブジェクトを取得します。

{TrophyEditor} getTrophyEditor()

Returns

{TrophyEditor} トロフィーを編集するオブジェクト


MapSimulatorを作成します。

{MapSimulator} createMapSimulator()

Returns

{MapSimulator} MapSimulatorオブジェクト


指定位置のマップチップを表すリソースハンドルを取得します。

{ResourceHandle} getMapChipGraphicsHandle(x, y, isLayer)

Parameters

{number} x x座標

{number} y y座標

{boolean} isLayer 透過チップを対象にする場合はtrue、そうでない場合はfalse

Returns

{ResourceHandle} リソースハンドル


指定位置のマップチップを変更します。

setMapChipGraphicsHandle(x, y, isLayer, handle)

Parameters

{number} x x座標

{number} y y座標

{boolean} isLayer 透過チップを設定する場合はtrue、そうでない場合はfalse

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


ゲストユニットを自軍に加入させます。

joinGuestUnit()

ゲストユニットを自軍から取り除きます。

removeGuestUnit()

RestSession

SceneType.RESTにおけるセッション情報を取得します。

メソッド

場所イベントのリストを取得します。

{DataList} getPlaceEventList()

Returns

{DataList} 場所イベントのリスト


自動イベントのリストを取得します。

{DataList} getAutoEventList()

Returns

{DataList} 自動イベントのリスト


会話イベントのリストを取得します。

{DataList} getTalkEventList()

Returns

{DataList} 会話イベントのリスト


オープニングイベントのリストを取得します。

{DataList} getOpeningEventList()

Returns

{DataList} オープニングイベントのリスト


エンディングイベントのリストを取得します。

{DataList} getEndingEventList()

Returns

{DataList} エンディングイベントのリスト


コミュニケーションイベントのリストを取得します。

{DataList} getCommunicationEventList()

Returns

{DataList} コミュニケーションイベントのリスト


ローカルスイッチテーブルを取得します。

{SwitchTable} getLocalSwitchTable()

Returns

{SwitchTable} ローカルスイッチテーブル


現在のマップの情報を取得します

{MapData} getCurrentMapInfo()

Returns

{MapData} 常にnullが返ります。


指定位置から「地形効果」を取得します。現在のバージョンでは、常にnullが返ります。

{Terrain} getTerrainFromPos(x, y, isLayer)

Parameters

{number} x x座標

{number} y y座標

{boolean} isLayer 透過チップを取得する場合はtrue、そうでない場合はfalse

Returns

{Terrain} 常にnullが返ります。


MapSimulatorオブジェクトを作成します。

{MapSimulator} createMapSimulator()

Returns

{MapSimulator} 常にnullが返ります。


ExternalData

環境データの情報を管理します。

メソッド

ゲームのクリア回数を取得します。

{number} getGameClearCount()

Returns

{number} クリア回数


ゲームのクリアポイントを取得します。

{number} getGameClearPoint()

Returns

{number} クリアポイント


ゲームのクリアポイントを設定します。

setGameClearPoint(point)

Parameters

{number} point クリアポイント


前回アクティブだったセーブファイルのインデックスを取得します。

{number} getActiveSaveFileIndex()

Returns

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


現在ロードしているセーブファイルが環境ファイル上でクリア済みとして記録されている場合はtrue、そうでない場合はfalseを返します。

{boolean} isCurrentSaveFileCompleted()

Returns

{boolean} 真偽値


指定ユニットの登場が環境ファイルに記録されている場合はtrue、そうでない場合はfalseを返します。現在シーンがSceneType.TITLEでない場合は、ユニットが自軍に所属しているかも調べられます。

{boolean} isUnitRegistered(unit)

Parameters

{Unit} unit ユニット

Returns

{boolean} 真偽値


環境パラメータを取得します。

{object} env()

Returns

{object} 環境パラメータ