Classes StorageManager - hikipuro/rpgmakermv_ref GitHub Wiki

StorageManager クラス

[クラス一覧]

(ver.1.6.2)

セーブデータの管理

定義場所: rpg_managers.js

クラスの属性

  • Static クラス

関連項目

メソッド

名前 説明
save セーブファイルを保存する
load セーブファイルを読み込む
exists セーブファイルが存在するか確認する
remove セーブファイルを削除する
backup セーブファイルのバックアップを作成する
backupExists セーブファイルのバックアップが存在するか確認する
cleanBackup セーブファイルのバックアップを削除する
restoreBackup セーブファイルの内容をバックアップから復元する
isLocalMode ローカル環境で実行されているか確認する
saveToLocalFile セーブファイルを保存する (ローカル)
loadFromLocalFile セーブファイルを読み込む (ローカル)
loadFromLocalBackupFile セーブファイルのバックアップを読み込む (ローカル)
localFileBackupExists セーブファイルのバックアップが存在するか確認する (ローカル)
localFileExists セーブファイルが存在するか確認する (ローカル)
removeLocalFile セーブファイルを削除する (ローカル)
saveToWebStorage セーブファイルを保存する (WebStorage)
loadFromWebStorage セーブファイルを読み込む (WebStorage)
loadFromWebStorageBackup セーブファイルのバックアップを読み込む (WebStorage)
webStorageBackupExists セーブファイルのバックアップが存在するか確認する (WebStorage)
webStorageExists セーブファイルが存在するか確認する (WebStorage)
removeWebStorage セーブファイルを削除する (WebStorage)
localFileDirectoryPath ローカルファイルのディレクトリパスを取得する
localFilePath ローカルファイルのパスを取得する
webStorageKey WebStorage 用のキーを取得する

save

定義: save(savefileId, json)

セーブファイルを保存する

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

load

定義: load(savefileId)

セーブファイルを読み込む

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

戻り値

(config.rpgsave or global.rpgsave or file0.rpgsave)

exists

定義: exists(savefileId)

セーブファイルが存在するか確認する

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

戻り値

(boolean)

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

remove

定義: remove(savefileId)

セーブファイルを削除する

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

backup

定義: backup(savefileId)

セーブファイルのバックアップを作成する

  • 元のセーブファイルが存在しない場合: なにもしない
  • ローカル環境の保存先: localFilePath(savefileId) + ".bak"
  • Web 環境の保存先: webStorageKey(savefileId) + "bak"
引数 型 説明
savefileId number セーブファイルの番号

backupExists

定義: backupExists(savefileId)

セーブファイルのバックアップが存在するか確認する

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

戻り値

(boolean)

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

cleanBackup

定義: cleanBackup(savefileId)

セーブファイルのバックアップを削除する

  • バックアップファイルが存在しない場合: なにもしない
  • ローカル環境: .bak ファイルを削除する
    • ファイル名: localFilePath(savefileId) + ".bak"
  • Web 環境: 項目名の最後に bak の付く項目を削除する
    • 項目名: webStorageKey(savefileId) + "bak"
引数 型 説明
savefileId number セーブファイルの番号

restoreBackup

定義: restoreBackup(savefileId)

セーブファイルの内容をバックアップから復元する

  • バックアップファイルが存在しない場合: なにもしない
  • ローカル環境: .bak ファイルから読み込んで復元する。復元後、 .bak ファイルは削除する
    • 復元 (上書き) されるファイル名: localFilePath(savefileId)
  • Web 環境: 項目名の最後に bak の付く項目から読み込んで復元する。復元後、 bak の項目は削除する
    • 復元 (上書き) される項目名: webStorageKey(savefileId)
引数 型 説明
savefileId number セーブファイルの番号

isLocalMode

定義: isLocalMode()

現在実行中のブラウザがローカル環境で実行されているか確認する

戻り値

(boolean)

  • ローカル環境: true
  • それ以外: false

saveToLocalFile

定義: saveToLocalFile(savefileId, json)

ローカルファイルシステム上にセーブファイルを保存する

  • ファイル名は localFilePath(savefileId)
  • データは LZString で圧縮と Base64 文字列化する
引数 型 説明
savefileId number セーブファイルの番号
json セーブデータ

loadFromLocalFile

定義: loadFromLocalFile(savefileId)

ローカルファイルシステム上のセーブファイルを読み込む

  • ファイル名は localFilePath(savefileId)
  • データは LZString で圧縮と Base64 文字列化されているので復号する
引数 型 説明
savefileId number セーブファイルの番号

戻り値

(config.rpgsave or global.rpgsave or file0.rpgsave)

loadFromLocalBackupFile

定義: loadFromLocalBackupFile(savefileId)

ローカルファイルシステム上のセーブファイルのバックアップを読み込む

  • ファイル名は localFilePath(savefileId) + ".bak"
  • データは LZString で圧縮と Base64 文字列化されているので復号する
引数 型 説明
savefileId number セーブファイルの番号

戻り値

(config.rpgsave or global.rpgsave or file0.rpgsave)

localFileBackupExists

定義: localFileBackupExists(savefileId)

ローカルファイルシステム上にセーブファイルのバックアップが存在するか確認する

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

戻り値

(boolean)

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

localFileExists

定義: localFileExists(savefileId)

ローカルファイルシステム上にセーブファイルが存在するか確認する

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

戻り値

(boolean)

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

removeLocalFile

定義: removeLocalFile(savefileId)

ローカルファイルシステム上のセーブファイルを削除する

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

saveToWebStorage

定義: saveToWebStorage(savefileId, json)

WebStorage にセーブファイルを保存する

  • 項目名は webStorageKey(savefileId)
  • データは LZString で圧縮と Base64 文字列化する
引数 型 説明
savefileId number セーブファイルの番号
json セーブデータ

loadFromWebStorage

定義: loadFromWebStorage(savefileId)

WebStorage からセーブファイルを読み込む

  • 項目名は webStorageKey(savefileId)
  • データは LZString で圧縮と Base64 文字列化されているので復号する
引数 型 説明
savefileId number セーブファイルの番号

戻り値

(config.rpgsave or global.rpgsave or file0.rpgsave)

loadFromWebStorageBackup

定義: loadFromWebStorageBackup(savefileId)

WebStorage からセーブファイルのバックアップを読み込む

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

戻り値

(config.rpgsave or global.rpgsave or file0.rpgsave)

webStorageBackupExists

定義: webStorageBackupExists(savefileId)

WebStorage 上にセーブファイルのバックアップが存在するか確認する

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

戻り値

(boolean)

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

webStorageExists

定義: webStorageExists(savefileId)

WebStorage 上にセーブファイルが存在するか確認する

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

戻り値

(boolean)

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

removeWebStorage

定義: removeWebStorage(savefileId)

WebStorage からセーブファイルを削除する

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

localFileDirectoryPath

定義: localFileDirectoryPath()

ローカルファイルのディレクトリパスを取得する

戻り値

(string) 実行ファイルのパス + "save/"

localFilePath

定義: localFilePath(savefileId)

ローカルファイルのパスを取得する

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

戻り値

(string)

webStorageKey

定義: webStorageKey(savefileId)

WebStorage 用のキーを取得する

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

戻り値

(string)

  • savefileId < 0: "RPG Config"
  • savefileId == 0: "RPG Global"
  • savefileId > 0: "RPG File%1" (%1 に savefileId が入る)