Classes DataManager - hikipuro/rpgmakermv_ref GitHub Wiki

DataManager クラス

[クラス一覧]

(ver.1.6.2)

データの管理

  • データベース
  • 設定ファイル
  • セーブデータ
  • グローバル変数の初期化

定義場所: rpg_managers.js

クラスの属性

  • Static クラス

関連項目

フィールド

名前 初期値 説明
_globalId string "RPGMV" (Static) セーブファイル情報に書き込まれるID
_lastAccessedId number 1 (Static) 最後にアクセスしたセーブファイルの番号
_errorUrl string null (Static) 読み込みエラーが発生したURL
_databaseFiles Array.<object> ※1 (Static) グローバル変数とデータベースファイルを紐付ける配列

※1

[
  { name: '$dataActors',       src: 'Actors.json'       },
  { name: '$dataClasses',      src: 'Classes.json'      },
  { name: '$dataSkills',       src: 'Skills.json'       },
  { name: '$dataItems',        src: 'Items.json'        },
  { name: '$dataWeapons',      src: 'Weapons.json'      },
  { name: '$dataArmors',       src: 'Armors.json'       },
  { name: '$dataEnemies',      src: 'Enemies.json'      },
  { name: '$dataTroops',       src: 'Troops.json'       },
  { name: '$dataStates',       src: 'States.json'       },
  { name: '$dataAnimations',   src: 'Animations.json'   },
  { name: '$dataTilesets',     src: 'Tilesets.json'     },
  { name: '$dataCommonEvents', src: 'CommonEvents.json' },
  { name: '$dataSystem',       src: 'System.json'       },
  { name: '$dataMapInfos',     src: 'MapInfos.json'     }
]

メソッド

名前 説明
loadDatabase データベース全体を読み込む
loadDataFile データファイルを読み込む
isDatabaseLoaded データベースの読み込みが完了しているか確認
loadMapData マップデータの読み込み
makeEmptyMap 空のマップデータを作成する
isMapLoaded マップデータがロードされているか確認
onLoad ファイルのロードが完了した時の処理
extractMetadata メタデータを展開する
checkError ファイルの読み込みエラーが発生しているか確認
isBattleTest 戦闘テストモードか確認
isEventTest イベントテストモードか確認
isSkill 引数で指定された項目がスキルか確認
isItem 引数で指定された項目がアイテムか確認
isWeapon 引数で指定された項目が武器か確認
isArmor 引数で指定された項目が防具か確認
createGameObjects グローバル変数を初期化する
setupNewGame ニューゲーム用の設定を行う
setupBattleTest 戦闘テスト用の設定を行う
setupEventTest イベントテスト用の設定を行う
loadGlobalInfo グローバル設定ファイルを読み込む
saveGlobalInfo グローバル設定ファイルを保存する
isThisGameFile セーブファイルが実行中のゲーム用のファイルか確認する
isAnySavefileExists 実行中のゲーム用のセーブファイルが存在するか確認する
latestSavefileId 最後にセーブしたファイルの番号を取得する
loadAllSavefileImages セーブ・ロード画面で使用するすべての画像をロードする
loadSavefileImages セーブ・ロード画面で使用する画像をロードする
maxSavefiles 最大セーブファイル数を取得する
saveGame セーブデータを保存する
loadGame セーブデータを読み込む
loadSavefileInfo セーブファイルの情報を取得する
lastAccessedSavefileId 最後にアクセスしたセーブファイルの番号を取得する
saveGameWithoutRescue セーブデータを保存する (例外処理なし)
loadGameWithoutRescue セーブデータを読み込む (例外処理なし)
selectSavefileForNewGame ニューゲーム時のセーブファイル番号を選択する
makeSavefileInfo セーブファイル情報を作成する
makeSaveContents セーブファイルの内容を作成する
extractSaveContents セーブファイルの内容を各グローバル変数に展開する

loadDatabase

定義: loadDatabase()

データベース全体を読み込む

  • _databaseFiles フィールドを巡回してファイルを読み込み
  • グローバル変数にセット

戻り値

なし


loadDataFile

定義: loadDataFile(name, src)

データファイルを読み込む

loadDatabase(), loadMapData() から呼ばれる

  • XMLHttpRequest を使用してファイルを読み込む
  • 成功した場合
    • name 引数で指定されたグローバル変数にファイルの内容をセット
    • DataManager.onLoad() を呼び出す
  • 失敗した場合
    • DataManager._errorUrl に ファイルのURLをセット
引数 説明
name string グローバル変数の名前
src string ファイルのURL

戻り値

なし


isDatabaseLoaded

定義: isDatabaseLoaded()

データベースの読み込みが完了しているか確認

戻り値

(boolean)

  • 読み込み完了している: true
  • それ以外: false

loadMapData

定義: loadMapData(mapId)

マップデータの読み込み

  • data/Map[mapId引数の値].json からマップデータを読み込む
  • $dataMap グローバル変数にファイルの内容をセット
  • mapId が 0 以下の場合
    • $dataMap グローバル変数に空のマップデータををセット
引数 説明
mapId number マップデータのファイル番号

関連項目

戻り値

なし


makeEmptyMap

定義: makeEmptyMap()

空のマップデータを作成する

作成された空のマップは $dataMap グローバル変数にセットされる

戻り値

なし


isMapLoaded

定義: isMapLoaded()

マップデータがロードされているか確認

戻り値

(boolean)

  • ロードされている: true
  • それ以外: false

onLoad

定義: onLoad(object)

ファイルのロードが完了した時の処理

loadDataFile() メソッド内の、 XHR オブジェクトの onload イベントで使用される

引数 説明
object object loadDataFile() の name で指定されたグローバル変数の内容

戻り値

なし


extractMetadata

定義: extractMetadata(data)

メタデータを展開する

onLoad() から呼ばれる

引数 説明
data object 展開されたデータを保存するオブジェクト

戻り値

なし


checkError

定義: checkError()

ファイルの読み込みエラーが発生しているか確認

  • 読み込みエラーが発生している場合は例外を投げる

戻り値

なし


isBattleTest

定義: isBattleTest()

戦闘テストモードか確認

return Utils.isOptionValid('btest');

関連項目

戻り値

(boolean)

  • 戦闘テストモード: true
  • それ以外: false

isEventTest

定義: isEventTest()

イベントテストモードか確認

return Utils.isOptionValid('etest');

関連項目

戻り値

(boolean)

  • イベントテストモード: true
  • それ以外: false

isSkill

定義: isSkill(item)

引数で指定された項目がスキルか確認

引数 説明
item object

戻り値

(boolean)

  • スキルの場合: true
  • それ以外: false

isItem

定義: isItem(item)

引数で指定された項目がアイテムか確認

引数 説明
item object

戻り値

(boolean)

  • アイテムの場合: true
  • それ以外: false

isWeapon

定義: isWeapon(item)

引数で指定された項目が武器か確認

引数 説明
item object

戻り値

(boolean)

  • 武器の場合: true
  • それ以外: false

isArmor

定義: isArmor(item)

引数で指定された項目が防具か確認

引数 説明
item object

戻り値

(boolean)

  • 防具の場合: true
  • それ以外: false

createGameObjects

定義: createGameObjects()

グローバル変数を初期化する

$gameTemp          = new Game_Temp();
$gameSystem        = new Game_System();
$gameScreen        = new Game_Screen();
$gameTimer         = new Game_Timer();
$gameMessage       = new Game_Message();
$gameSwitches      = new Game_Switches();
$gameVariables     = new Game_Variables();
$gameSelfSwitches  = new Game_SelfSwitches();
$gameActors        = new Game_Actors();
$gameParty         = new Game_Party();
$gameTroop         = new Game_Troop();
$gameMap           = new Game_Map();
$gamePlayer        = new Game_Player();

戻り値

なし


setupNewGame

定義: setupNewGame()

ニューゲーム用の設定を行う

戻り値

なし


setupBattleTest

定義: setupBattleTest()

戦闘テスト用の設定を行う

戻り値

なし


setupEventTest

定義: setupEventTest()

イベントテスト用の設定を行う

戻り値

なし


loadGlobalInfo

定義: loadGlobalInfo()

グローバル設定ファイルを読み込む

戻り値

(global.rpgsave)

読み込みに失敗した場合: 空配列


saveGlobalInfo

定義: saveGlobalInfo(info)

グローバル設定ファイルを保存する

引数 説明
info global.rpgsave グローバル設定

戻り値

なし


isThisGameFile

定義: isThisGameFile(savefileId)

セーブファイルが実行中のゲーム用のファイルか確認する

引数 説明
savefileId number セーブファイル番号

戻り値

(boolean)

  • 実行中のゲーム用のファイルの場合: true
  • 他のゲーム用のファイルの場合: false

isAnySavefileExists

定義: isAnySavefileExists()

実行中のゲーム用のセーブファイルが存在するか確認する

戻り値

(boolean)

  • 存在する: true
  • 存在しない: false

latestSavefileId

定義: latestSavefileId()

最後にセーブしたファイルの番号を取得する

戻り値

(number) 最後にセーブしたセーブファイルの番号


loadAllSavefileImages

定義: loadAllSavefileImages()

セーブ・ロード画面で使用するすべての画像をロードする

戻り値

なし


loadSavefileImages

定義: loadSavefileImages(info)

セーブ・ロード画面で使用する画像をロードする

info.characters, info.faces で指定されいてる画像をロードする

引数 説明
info SavefileInfo セーブファイル情報

戻り値

なし


maxSavefiles

定義: maxSavefiles()

最大セーブファイル数を取得する

戻り値

(number) 20


saveGame

定義: saveGame(savefileId)

セーブデータを保存する

引数 説明
savefileId number セーブファイルの番号

戻り値

(boolean)

  • 保存成功: true
  • 失敗: false

loadGame

定義: loadGame(savefileId)

セーブデータを読み込む

引数 説明
savefileId number セーブファイルの番号

戻り値

(boolean)

  • 読み込み成功: true
  • 失敗: false

loadSavefileInfo

定義: loadSavefileInfo(savefileId)

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

引数 説明
savefileId number セーブファイルの番号

戻り値

(SavefileInfo) セーブファイルの情報


lastAccessedSavefileId

定義: lastAccessedSavefileId()

最後にアクセスしたセーブファイルの番号を取得する

_lastAccessedId フィールドの値を返す

戻り値

(number) 最後にアクセスしたセーブファイルの番号


saveGameWithoutRescue

定義: saveGameWithoutRescue(savefileId)

セーブデータを保存する (例外処理なし)

引数 説明
savefileId number セーブファイルの番号

戻り値

(boolean)

  • 保存成功: true
  • 失敗: false

loadGameWithoutRescue

定義: loadGameWithoutRescue(savefileId)

セーブデータを読み込む (例外処理なし)

loadGame() から呼ばれる

引数 説明
savefileId number セーブファイルの番号

戻り値

(boolean)

  • 読み込み成功: true
  • 失敗: false

selectSavefileForNewGame

定義: selectSavefileForNewGame()

ニューゲーム時のセーブファイル番号を選択する

  • 最大ファイル数以下の番号で、空いている番号が割り当てられる
  • 結果は _lastAccessedId に保存される
  • セーブしたことがない場合は 1
  • 最大ファイル数を超えている場合は一番古いセーブデータの番号

戻り値

なし


makeSavefileInfo

定義: makeSavefileInfo()

セーブファイル情報を作成する

戻り値

(SavefileInfo)


makeSaveContents

定義: makeSaveContents()

セーブファイルの内容を作成する

戻り値

(SaveContents)


extractSaveContents

定義: extractSaveContents(contents)

セーブファイルの内容を各グローバル変数に展開する

引数 説明
contents SaveContents セーブファイルの内容

戻り値

なし

⚠️ **GitHub.com Fallback** ⚠️