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

root

BaseData

「データ設定」の情報を管理します。

メソッド

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

{DataList} getPlayerList()

Returns

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


クラスのリストを取得します。

{DataList} getClassList()

Returns

{DataList} クラスのリスト


武器のリストを取得します。

{DataList} getWeaponList()

Returns

{DataList} 武器のリスト


アイテムのリストを取得します。

{DataList} getItemList()

Returns

{DataList} アイテムのリスト


スキルのリストを取得します。

{DataList} getSkillList()

Returns

{DataList} スキルのリスト


ステートのリストを取得します。

{DataList} getStateList()

Returns

{DataList} ステートのリスト


武器タイプのリストを取得します。

{DataList} getWeaponTypeList(index)

Parameters

{number} index インデックス

Returns

{DataList} 武器タイプのリスト


クラスタイプのリストを取得します。

{DataList} getClassTypeList()

Returns

{DataList} クラスタイプのリスト


「難易度」のリストを取得します

{DataList} getDifficultyList()

Returns

{DataList} 「難易度」のリスト


NPCのリストを取得します

{DataList} getNpcList(index)

Parameters

{number} index インデックス

Returns

{DataList} NPCのリスト


クラスグループのリストを取得します。

{DataList} getClassGroupList()

Returns

{DataList} クラスグループのリスト


フォントのリストを取得します。

{DataList} getFontList()

Returns

{DataList} フォントのリスト


「種族」のリストを取得します。

{DataList} getRaceList()

Returns

{DataList} 「種族」のリスト


「フュージョン」のリストを取得します。

{DataList} getFusionList()

Returns

{DataList} 「フュージョン」のリスト


「形態変化」のリストを取得します。

{DataList} getMetamorphozeList()

Returns

{DataList} 「形態変化」のリスト


「オリジナルデータ」のリストを取得します。

{DataList} getOriginalDataList(index)

Parameters

{number} index インデックス

Returns

{DataList} 「オリジナルデータ」のリスト


「メッセージレイアウト」のリストを取得します。

{DataList} getMessageLayoutList()

Returns

{DataList} 「メッセージレイアウト」のリスト


「ショップレイアウト」のリストを取得します。

{DataList} getShopLayoutList()

Returns

{DataList} 「ショップレイアウト」のリスト


「コマンドレイアウト」のリストを取得します。

{DataList} getCommandLayoutList(index)

Parameters

{number} index インデックス

Returns

{DataList} 「コマンドレイアウト」のリスト


「回想イベント」のリストを取得します。

{DataList} getRecollectionEventList()

Returns

{DataList} 「回想イベント」のリスト


「キャラクター解説」のリストを取得します。

{DataList} getCharacterDictionaryList()

Returns

{DataList} 「キャラクター解説」のリスト


「用語解説」のリストを取得します。

{DataList} getWordDictionaryList()

Returns

{DataList} 「用語解説」のリスト


「ギャラリー」のリストを取得します。

{DataList} getGalleryDictionaryList()

Returns

{DataList} 「ギャラリー」のリスト


「サウンドルーム」のリストを取得します。

{DataList} getMediaDictionaryList()

Returns

{DataList} 「サウンドルーム」のリスト


「ショップ」のリストを取得します。

{DataList} getRestShopList()

Returns

{DataList} 「ショップ」のリスト


「ボーナス」のリストを取得します。

{DataList} getRestBonusList()

Returns

{DataList} 「ボーナス」のリスト


「クエスト」のリストを取得します。

{DataList} getRestQuestList()

Returns

{DataList} 「クエスト」のリスト


「拠点」の「エリア設定」のリストを取得します。

{DataList} getRestAreaList()

Returns

{DataList} 「エリア設定」のリスト


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

{DataList} getInteropList(index, isRuntime)

Parameters

{number} index インデックス

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} リソース使用箇所データのリスト


モーションデータのリストを取得します。

{DataList} getMotionAnimationList(isRuntime)

Parameters

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} モーションデータのリスト


エフェクトデータのリストを取得します。

{DataList} getEffectAnimationList(isRuntime)

Parameters

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} エフェクトデータのリスト


画像リソースのリストを取得します。

{DataList} getGraphicsResourceList(type, isRuntime)

Parameters

{number} type GraphicsType値

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} 画像リソースのリスト


メディアリソースのリストを取得します。

{DataList} getMediaResourceList(type, isRuntime)

Parameters

{number} type MediaType値

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} メディアリソースのリスト


UIリソースのリストを取得します。

{DataList} getUIResourceList(type, isRuntime)

Parameters

{number} type UIType値

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} UIリソースのリスト


フォントリソースのリストを取得します。

{DataList} getFontResourceList(isRuntime)

Parameters

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} フォントリソースのリスト


ビデオリソースのリストを取得します。

{DataList} getVideoResourceList(isRuntime)

Parameters

{boolean} isRuntime ランタイムを対象にする場合はtrue、そうでない場合はfalse

Returns

{DataList} ビデオリソースのリスト


ブックマークユニットのリストを取得します。

{DataList} getBookmarkUnitList()

Returns

{DataList} ブックマークユニットのリスト


マップのリストを取得します。

{DataList} getMapList()

Returns

{DataList} マップのリスト


クリアポイントのショップデータを取得します。

{RestShop} getPointShop()

Returns

{RestShop} ショップデータ


残ったポイントの取扱いの値を取得します。

{number} getClearPointAction()

Returns

{number} ClearPointAction値


ConfigInfo

コンフィグ情報を管理します。

メソッド

ゲームのウインドウタイトルを取得します。

{string} getWindowTitle()

Returns

{string} ウインドウタイトル


ゲームのタイトルを取得します。

{string} getGameTitle()

Returns

{string} ゲームのタイトル


スタッフロールの文字列を取得します。

{string} getStaffRollString()

Returns

{string} 文字列


指定インデックスに対応する最大値を取得します。

{number} getMaxValue(index)

Parameters

{number} index インデックス

Returns

{number} 最大値


指定インデックスに対応するパラメータの最大値を取得します。

{number} getMaxParameter(index)

Parameters

{number} index インデックス

Returns

{number} 最大値


指定インデックスに対応する「ゲームオプション」が有効である場合はtrue、そうでない場合はfalseを返します。

{number} getBattleValue(index)

Parameters

{number} index インデックス

Returns

{number} 真偽値


指定インデックスに対応する「バトル系数値」を取得します。

{boolean} isGameOptionOn(index)

Parameters

{number} index インデックス

Returns

{boolean} 「バトル系数値」


「画面解像度」のインデックスを取得します。

{number} getResolutionIndex()

Returns

{number} インデックス


UserExtension

ユーザー拡張を管理します。

メソッド

ボイスを格納したフォルダ名を返します。

{string} getVoiceCategoryName()

Returns

{string} 文字列


ボイスの拡張子のインデックスを返します。

{number} getVoiceExtIndex()

Returns

{number} インデックス


「クリティカル係数 (%)」を取得します。

{number} getCriticalFactor()

Returns

{number} 係数


「特攻係数 (%)」を取得します。

{number} getEffectiveFactor()

Returns

{number} 係数


「支援範囲」を取得します。

{number} getSupportRange()

Returns

{number} 「支援範囲」


「経験値配分レート」を取得します。

{number} getExperienceRate()

Returns

{number} 「経験値配分レート」


デモマップで効果音を再生する場合はtrue、そうでない場合はfalseを返します。

{boolean} isDemoMapSoundEnabled()

Returns

{boolean} 真偽値


デモ用のオープニングイベントを含むマップのIDを取得します。

{number} getDemoMapId()

Returns

{number} マップのID


下級クラスが上級クラスと戦闘した場合の経験値係数を取得します。

{number} getLowExperienceFactor()

Returns

{number} 経験値係数


上級クラスが下級クラスと戦闘した場合の経験値係数を取得します。

{number} getHighExperienceFactor()

Returns

{number} 経験値係数


モーション画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isMotionGraphicsEnabled()

Returns

{boolean} 真偽値


武器の耐久を無限にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isWeaponInfinity()

Returns

{boolean} 真偽値


ゲストユニットにアイテム増減を許可する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGuestTradeEnabled()

Returns

{boolean} 真偽値


アイテム購入時に所持アイテムが一杯でもストックに送る場合はtrue、そうでない場合はfalseを返します。戦闘準備画面では、常にストックへ送る仕様になります。ストックコマンドコマンドを表示できるユニットは、常にストックへ送る仕様になります。

{boolean} isFullItemTransportable()

Returns

{boolean} 真偽値


敵の撃破時の経験値をクラスの「追加経験値」にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isFixedExperience()

Returns

{boolean} 真偽値


クラスのパラメータ上限が有効な場合はtrue、そうでない場合はfalseを返します。

{boolean} isClassLimitEnabled()

Returns

{boolean} 真偽値


スキル発動でボーナスを考慮する場合はtrue、そうでない場合はfalseを返します。

{boolean} isSkillInvocationBonusEnabled()

Returns

{boolean} 真偽値


指定ユニットコマンドに再移動が許可されている場合はtrue、そうでない場合はfalseを返します。

{boolean} isUnitCommandMovable(id)

Parameters

{number} id コマンドのid

Returns

{boolean} 真偽値


戦闘時の反撃を許可する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCounterattackAllowed()

Returns

{boolean} 真偽値


リーダーの死亡をゲームオーバーとして扱う場合はtrue、そうでない場合はfalseを返します。

{boolean} isLeaderGameOver()

Returns

{boolean} 真偽値


武器の破損時にメッセージを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isWeaponLostDisplayable()

Returns

{boolean} 真偽値


武器の破損時にドロップトロフィーを削除する場合はtrue、そうでない場合はfalseを返します。

{boolean} isDropTrophyLinked()

Returns

{boolean} 真偽値


ゲームでアイテムやスキルの「有効相手」を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isAggregationVisible()

Returns

{boolean} 真偽値


スキル発動時にアニメを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isSkillAnimeEnabled()

Returns

{boolean} 真偽値


メッセージでユニット名を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isMessageUnitNameDisplayable()

Returns

{boolean} 真偽値


同盟軍の戦闘を常に簡易戦闘にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isAllyBattleFixed()

Returns

{boolean} 真偽値


成長率0のパラメータもドーピングできる場合はtrue、そうでない場合はfalseを返します。

{boolean} isFullDopingEnabled()

Returns

{boolean} 真偽値


ゲームで熟練度を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isWeaponLevelDisplayable()

Returns

{boolean} 真偽値


ゲームで体格を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isBuildDisplayable()

Returns

{boolean} 真偽値


敵AIが威力0でも攻撃する場合はtrue、そうでない場合はfalseを返します。

{boolean} isAIDamageZeroAllowed()

Returns

{boolean} 真偽値


敵AIが命中0でも攻撃する場合はtrue、そうでない場合はfalseを返します。

{boolean} isAIHitZeroAllowed()

Returns

{boolean} 真偽値


ターンダメージでユニットを撃破できる場合はtrue、そうでない場合はfalseを返します。

{boolean} isTurnDamageFinishAllowed()

Returns

{boolean} 真偽値


AnimePreference

アニメーションにおける「アニメ情報」を管理します。

メソッド

「境界線」の幅を取得します。

{number} getBoundaryWidth()

Returns

{number} 幅


「境界線」の高さを取得します。

{number} getBoundaryHeight()

Returns

{number} 高さ


オリジナルモーションのリストを取得します。

{DataList} getOriginalMotionList(templateIndex)

Parameters

{number} templateIndex テンプレートのインデックス

Returns

{DataList} モーションのリスト


モーションIDからモーション名を取得します。

{string} getMotionName(templateIndex, motionId)

Parameters

{number} templateIndex テンプレートのインデックス

{number} motionId モーションID

Returns

{string} モーション名


リアル戦闘時の視点が固定である場合はtrue、そうでない場合はfalseを返します。

{boolean} isFixedFocus()

Returns

{boolean} 真偽値


リアル戦闘時に移動モーションをスキップする場合はtrue、そうでない場合はfalseを返します。

{boolean} isMoveMotionDisabled()

Returns

{boolean} 真偽値


モーションの初期位置は「移動」の第一フレームに準拠する場合はtrue、そうでない場合はfalseを返します。

{boolean} isDirectMagicWeaponAttackAllowed()

Returns

{boolean} 真偽値


直接攻撃でも「魔法武器攻撃」を考慮する場合はtrue、そうでない場合はfalseを返します。

{boolean} isMoveMotionPosInherited()

Returns

{boolean} 真偽値


カットインを画面中央に表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCutinCentering()

Returns

{boolean} 真偽値


カットインのXオフセットを取得します。

{number} getCutinOffsetX()

Returns

{number} Xオフセット


カットインのYオフセットを取得します。

{number} getCutinOffsetY()

Returns

{number} Yオフセット


「ゲーム時のモーションオフセット」を取得します。

{number} getMotionOffset(versusType)

Parameters

{number} versusType VersusType値

Returns

{number} モーションオフセット


スプライト描画時の補間モードを取得します。

{number} getInterpolationMode()

Returns

{number} InterpolationMode値


リアル戦闘で画面の外にいるモーションがスキルを発動した際のずらす値を取得します。

{number} getSkillAnimeOffset()

Returns

{number} オフセット値


エフェクトをデフォルトの方向で表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isEffectDefaultStyle()

Returns

{boolean} 真偽値


StoryPreference

世界観設定のオプションを取得します。

メソッド

「キャラクター解説」のページ番号を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isCharacterNumberVisible()

Returns

{boolean} 真偽値


「用語解説」のページ番号を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isWordNumberVisible()

Returns

{boolean} 真偽値


「ギャラリー」のページ番号を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGalleryNumberVisible()

Returns

{boolean} 真偽値


「ギャラリー」を拡大して表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isGalleryScaled()

Returns

{boolean} 真偽値


「ギャラリー」を常に閲覧可能にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isGalleryPublic()

Returns

{boolean} 真偽値


テストプレイ時に全データを閲覧可能にする場合はtrue、そうでない場合はfalseを返します。

{boolean} isTestPlayPublic()

Returns

{boolean} 真偽値


RestPreference

「拠点設定」に関する情報を取得します。

メソッド

「セーブファイルタイトル」を取得します。

{string} getCompleteSaveTitle()

Returns

{string} 「セーブファイルタイトル」


条件を満たした現在有効な「エリア設定」を取得します。

{RestArea} getActiveRestArea()

Returns

{RestArea} 拠点エリア


条件を満たした現在有効な「エリア設定」を取得します。特定のマップをベースに判定します。

{RestArea} getActiveRestAreaFromMapId(mapId)

Parameters

{number} mapId マップID

Returns

{RestArea} RestAreaオブジェクト


ゲーム時にショップを一覧形式で表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isShopListView()

Returns

{boolean} 真偽値


ゲーム時にボーナスを一覧形式で表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isBonusListView()

Returns

{boolean} 真偽値


ゲーム時に会話選択で画像を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isTalkGraphicsEnabled()

Returns

{boolean} 真偽値


ゲーム時のクエストで敵の総数を表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isEnemyTotalEnabled()

Returns

{boolean} 真偽値


ゲーム時のクエストで敵の平均レベルを表示する場合はtrue、そうでない場合はfalseを返します。

{boolean} isEnemyAverageLevelEnabled()

Returns

{boolean} 真偽値