Merge pull request rpgtkoolmv#120 from rpgtkoolmv/add_autosave

Add Auto Save System

Author: krmbn0576

js/rpg_managers/DataManager.js

@@ -40,6 +40,7 @@ var $testEvent        = null;
 DataManager._globalId       = 'RPGMV';
 DataManager._lastAccessedId = 1;
 DataManager._errorUrl       = null;
+DataManager._autoSaveFileId = 0;
 
 DataManager._databaseFiles = [
     { name: '$dataActors',       src: 'Actors.json'       },
@@ -451,3 +452,20 @@ DataManager.extractSaveContents = function(contents) {
     $gameMap           = contents.map;
     $gamePlayer        = contents.player;
 };
+
+DataManager.setAutoSaveFileId = function(autoSaveFileId) {
+    this._autoSaveFileId = autoSaveFileId;
+};
+
+DataManager.isAutoSaveFileId = function(saveFileId) {
+    return this._autoSaveFileId !== 0 && this._autoSaveFileId === saveFileId;
+};
+
+DataManager.autoSaveGame = function() {
+    if (this._autoSaveFileId !== 0 && !this.isEventTest() && $gameSystem.isSaveEnabled()) {
+        $gameSystem.onBeforeSave();
+        if (this.saveGame(this._autoSaveFileId)) {
+            StorageManager.cleanBackup(this._autoSaveFileId);
+        }
+    }
+};

js/rpg_objects/Game_Player.js

@@ -95,6 +95,7 @@ Game_Player.prototype.performTransfer = function() {
         this.locate(this._newX, this._newY);
         this.refresh();
         this.clearTransferInfo();
+        DataManager.autoSaveGame();
     }
 };
 

js/rpg_scenes/Scene_Save.js

@@ -27,6 +27,10 @@ Scene_Save.prototype.firstSavefileIndex = function() {
 };
 
 Scene_Save.prototype.onSavefileOk = function() {
+    if (DataManager.isAutoSaveFileId(this.savefileId())) {
+        this.onSaveFailure();
+        return;
+    }
     Scene_File.prototype.onSavefileOk.call(this);
     $gameSystem.onBeforeSave();
     if (DataManager.saveGame(this.savefileId())) {

js/rpg_windows/Window_SavefileList.js

@@ -51,7 +51,14 @@ Window_SavefileList.prototype.drawItem = function(index) {
 };
 
 Window_SavefileList.prototype.drawFileId = function(id, x, y) {
-    this.drawText(TextManager.file + ' ' + id, x, y, 180);
+    if (DataManager.isAutoSaveFileId(id)) {
+        if (this._mode === 'save') {
+            this.changePaintOpacity(false);
+        }
+        this.drawText(TextManager.file + ' ' + id + '(Auto)', x, y, 180);
+    } else {
+        this.drawText(TextManager.file + ' ' + id, x, y, 180);
+    }
 };
 
 Window_SavefileList.prototype.drawContents = function(info, rect, valid) {

plugins/Community_Basic.js

@@ -7,32 +7,48 @@
  * There is no plugin command.
  *
  * @param cacheLimit
+ * @type number
  * @desc The upper limit of images' cached size (MPixel)
  * @default 10
  *
  * @param screenWidth
+ * @type number
  * @desc The resolution of screen width
  * @default 816
  *
  * @param screenHeight
+ * @type number
  * @desc The resolution of screen height
  * @default 624
  *
  * @param changeWindowWidthTo
+ * @type number
  * @desc If set, change window width to this value
  *
  * @param changeWindowHeightTo
+ * @type number
  * @desc If set, change window height to this value
  *
  * @param renderingMode
+ * @type select
+ * @option canvas
+ * @option webgl
+ * @option auto
  * @desc The rendering mode (canvas/webgl/auto)
  * @default auto
  *
  * @param alwaysDash
+ * @type boolean
  * @desc The initial value whether the player always dashes (on/off)
- * @default off
+ * @default false
+ *
+ * @param autoSaveFileId
+ * @type number
+ * @desc The file number to auto save when "Transfer Player" (0: off)
+ * @default 0
  *
  * @param errorMessage
+ * @type string
  * @desc The message when error occurred
  * @default Error occurred. Please ask to the creator of this game.
  */
@@ -46,49 +62,71 @@
  * このプラグインにはプラグインコマンドはありません。
  *
  * @param cacheLimit
+ * @type number
  * @desc 画像のメモリへのキャッシュの上限値 (MPix)
  * @default 10
  *
  * @param screenWidth
+ * @type number
  * @desc 画面サイズの幅
  * @default 816
  *
  * @param screenHeight
+ * @type number
  * @desc 画面サイズの高さ
  * @default 624
  *
  * @param changeWindowWidthTo
+ * @type number
  * @desc 値が設定された場合、ウインドウの幅を指定した値に変更
  *
  * @param changeWindowHeightTo
+ * @type number
  * @desc 値が設定された場合、ウインドウの高さを指定した値に変更
  *
  * @param renderingMode
+ * @type select
+ * @option canvas
+ * @option webgl
+ * @option auto
  * @desc レンダリングモード (canvas/webgl/auto)
  * @default auto
  *
  * @param alwaysDash
+ * @type boolean
  * @desc プレイヤーが常時ダッシュするかどうかの初期値 (on/off)
- * @default off
+ * @default false
+ *
+ * @param autoSaveFileId
+ * @type number
+ * @desc 「場所移動」の際にオートセーブするファイル番号 (0でoff)
+ * @default 0
  *
  * @param errorMessage
+ * @type string
  * @desc エラーが発生した際に表示するメッセージ
  * @default エラーが発生しました。ゲームの作者にご連絡ください。
  */
 
 (function() {
+    'use strict';
+    function isNumber(str) {
+        return !!str && !isNaN(str);
+    }
+
     function toNumber(str, def) {
-        return isNaN(str) ? def : +(str || def);
+        return isNumber(str) ? +str : def;
     }
 
     var parameters = PluginManager.parameters('Community_Basic');
     var cacheLimit = toNumber(parameters['cacheLimit'], 10);
     var screenWidth = toNumber(parameters['screenWidth'], 816);
     var screenHeight = toNumber(parameters['screenHeight'], 624);
     var renderingMode = parameters['renderingMode'].toLowerCase();
-    var alwaysDash = parameters['alwaysDash'].toLowerCase() === 'on';
+    var alwaysDash = parameters['alwaysDash'].toLowerCase() === 'true';
     var windowWidthTo = toNumber(parameters['changeWindowWidthTo'], 0);
     var windowHeightTo = toNumber(parameters['changeWindowHeightTo'], 0);
+    var autoSaveFileId = toNumber(parameters['autoSaveFileId'], 0);
     var errorMessage = parameters['errorMessage'];
 
     var windowWidth;
@@ -148,6 +186,6 @@
         }
     };
 
-
+    DataManager.setAutoSaveFileId(autoSaveFileId);
     Graphics.setErrorMessage(errorMessage);
 })();