Merge pull request #78 from rpgtkoolmv/add_retry

add retry loading system

Author: krmbn0576

js/rpg_core/Bitmap.js

@@ -791,11 +791,15 @@ Bitmap.prototype.decode = function(){
             this._callLoadListeners();
             break;
 
-            case 'requesting': case 'decrypting':
+        case 'requesting': case 'decrypting':
             this._decodeAfterRequest = true;
+            if (!this._loader) {
+                this._loader = ResourceHandler.createLoader(this._url, this._requestImage.bind(this, this._url), this._onError.bind(this));
+                this._image.onerror = this._loader;
+            }
             break;
 
-        case 'pending':
+        case 'pending': case 'error':
             this._decodeAfterRequest = true;
             this._requestImage(this._url);
             break;
@@ -849,6 +853,9 @@ Bitmap.request = function(url){
 };
 
 Bitmap.prototype._requestImage = function(url){
+    if (this._decodeAfterRequest && !this._loader) {
+        this._loader = ResourceHandler.createLoader(url, this._requestImage.bind(this, url), this._onError.bind(this));
+    }
     this._image = new Image();
     this._url = url;
     this._loadingState = 'requesting';
@@ -859,7 +866,7 @@ Bitmap.prototype._requestImage = function(url){
     } else {
         this._image.src = url;
         this._image.onload = Bitmap.prototype._onLoad.bind(this);
-        this._image.onerror = Bitmap.prototype._onError.bind(this);
+        this._image.onerror = this._loader || Bitmap.prototype._onError.bind(this);
     }
 };
 

js/rpg_core/Decrypter.js

@@ -36,7 +36,7 @@ Decrypter.decryptImg = function(url, bitmap) {
             var arrayBuffer = Decrypter.decryptArrayBuffer(requestFile.response);
             bitmap._image.src = Decrypter.createBlobUrl(arrayBuffer);
             bitmap._image.onload = Bitmap.prototype._onLoad.bind(bitmap);
-            bitmap._image.onerror = Bitmap.prototype._onError.bind(bitmap);
+            bitmap._image.onerror = bitmap._loader || Bitmap.prototype._onError.bind(bitmap);
         }
     };
 };

js/rpg_core/Graphics.js

@@ -32,6 +32,7 @@ Graphics.initialize = function(width, height, type) {
     this._scale = 1;
     this._realScale = 1;
 
+    this._errorShowed = false;
     this._errorPrinter = null;
     this._canvas = null;
     this._video = null;
@@ -271,6 +272,40 @@ Graphics.endLoading = function() {
     this._upperCanvas.style.opacity = 0;
 };
 
+/**
+ * Displays the loading error text to the screen.
+ *
+ * @static
+ * @method printLoadingError
+ * @param {String} url The url of the resource failed to load
+ */
+Graphics.printLoadingError = function(url) {
+    if (this._errorPrinter && !this._errorShowed) {
+        this._errorPrinter.innerHTML = this._makeErrorHtml('Loading Error', 'Failed to load: ' + url);
+        var button = document.createElement('button');
+        button.innerHTML = 'Retry';
+        button.style.fontSize = '24px';
+        button.style.color = '#ffffff';
+        button.style.backgroundColor = '#000000';
+        button.onclick = ResourceHandler.retry.bind(ResourceHandler);
+        this._errorPrinter.appendChild(button);
+        this._loadingCount = -Infinity;
+    }
+};
+
+/**
+ * Erases the loading error text.
+ *
+ * @static
+ * @method eraseLoadingError
+ */
+Graphics.eraseLoadingError = function() {
+    if (this._errorPrinter && !this._errorShowed) {
+        this._errorPrinter.innerHTML = '';
+        this.startLoading();
+    }
+};
+
 /**
  * Displays the error text to the screen.
  *
@@ -280,6 +315,7 @@ Graphics.endLoading = function() {
  * @param {String} message The message of the error
  */
 Graphics.printError = function(name, message) {
+    this._errorShowed = true;
     if (this._errorPrinter) {
         this._errorPrinter.innerHTML = this._makeErrorHtml(name, message);
     }
@@ -369,9 +405,20 @@ Graphics.isFontLoaded = function(name) {
  * @param {String} src
  */
 Graphics.playVideo = function(src) {
+    this._videoLoader = ResourceHandler.createLoader(null, this._playVideo.bind(this, src), this._onVideoError.bind(this));
+    this._playVideo(src);
+};
+
+/**
+ * @static
+ * @method _playVideo
+ * @param {String} src
+ * @private
+ */
+Graphics._playVideo = function(src) {
     this._video.src = src;
     this._video.onloadeddata = this._onVideoLoad.bind(this);
-    this._video.onerror = this._onVideoError.bind(this);
+    this._video.onerror = this._videoLoader;
     this._video.onended = this._onVideoEnd.bind(this);
     this._video.load();
     this._videoLoading = true;

js/rpg_core/ResourceHandler.js

@@ -0,0 +1,51 @@
+//-----------------------------------------------------------------------------
+/**
+ * The static class that handles resource loading.
+ *
+ * @class ResourceHandler
+ */
+function ResourceHandler() {
+    throw new Error('This is a static class');
+}
+
+ResourceHandler._reloaders = [];
+ResourceHandler._defaultRetryInterval = [500, 1000, 3000];
+
+ResourceHandler.createLoader = function(url, retryMethod, resignMethod, retryInterval) {
+    retryInterval = retryInterval || this._defaultRetryInterval;
+    var reloaders = this._reloaders;
+    var retryCount = 0;
+    return function() {
+        if (retryCount < retryInterval.length) {
+            setTimeout(retryMethod, retryInterval[retryCount]);
+            retryCount++;
+        } else {
+            if (resignMethod) {
+                resignMethod();
+            }
+            if (url) {
+                if (reloaders.length === 0) {
+                    Graphics.printLoadingError(url);
+                }
+                reloaders.push(function() {
+                    retryCount = 0;
+                    retryMethod();
+                });
+            }
+        }
+    };
+};
+
+ResourceHandler.exists = function() {
+    return this._reloaders.length > 0;
+};
+
+ResourceHandler.retry = function() {
+    if (this._reloaders.length > 0) {
+        Graphics.eraseLoadingError();
+        this._reloaders.forEach(function(reloader) {
+            reloader();
+        });
+        this._reloaders.length = 0;
+    }
+};

js/rpg_core/WebAudio.js

@@ -15,6 +15,9 @@ WebAudio.prototype.initialize = function(url) {
         WebAudio.initialize();
     }
     this.clear();
+    this._loader = ResourceHandler.createLoader(url, this._load.bind(this, url), function() {
+        this._hasError = true;
+    }.bind(this));
     this._load(url);
     this._url = url;
 };
@@ -482,9 +485,7 @@ WebAudio.prototype._load = function(url) {
                 this._onXhrLoad(xhr);
             }
         }.bind(this);
-        xhr.onerror = function() {
-            this._hasError = true;
-        }.bind(this);
+        xhr.onerror = this._loader;
         xhr.send();
     }
 };

js/rpg_managers/DataManager.js

@@ -82,7 +82,7 @@ DataManager.loadDataFile = function(name, src) {
             DataManager.onLoad(window[name]);
         }
     };
-    xhr.onerror = function() {
+    xhr.onerror = this._mapLoader || function() {
         DataManager._errorUrl = DataManager._errorUrl || url;
     };
     window[name] = null;
@@ -102,6 +102,7 @@ DataManager.isDatabaseLoaded = function() {
 DataManager.loadMapData = function(mapId) {
     if (mapId > 0) {
         var filename = 'Map%1.json'.format(mapId.padZero(3));
+        this._mapLoader = ResourceHandler.createLoader('data/' + filename, this.loadDataFile.bind(this, '$dataMap', filename));
         this.loadDataFile('$dataMap', filename);
     } else {
         this.makeEmptyMap();

js/rpg_managers/ImageManager.js

@@ -116,10 +116,6 @@ ImageManager.clear = function() {
 };
 
 ImageManager.isReady = function() {
-    var bitmap = null;
-    if(bitmap = this._imageCache.getErrorBitmap()){
-        throw new Error('Failed to load: ' + bitmap.url);
-    }
     return this._imageCache.isReady();
 };
 

js/rpg_managers/SceneManager.js

@@ -248,6 +248,10 @@ SceneManager.changeScene = function() {
 };
 
 SceneManager.updateScene = function() {
+    if (ResourceHandler.exists() && Input.isTriggered('ok')) {
+        ResourceHandler.retry();
+        this.updateInputData();
+    }
     if (this._scene) {
         if (!this._sceneStarted && this._scene.isReady()) {
             this._scene.start();

js/rpg_scenes/Scene_Base.js

@@ -45,7 +45,6 @@ Scene_Base.prototype.start = function() {
 Scene_Base.prototype.update = function() {
     this.updateFade();
     this.updateChildren();
-    AudioManager.checkErrors();
 };
 
 Scene_Base.prototype.stop = function() {

plugins/Debug_FailLoading.js

@@ -0,0 +1,109 @@
+/*:
+ * @plugindesc Fail to load images, audio, movies and map data.
+ * @author RM CoreScript team
+ *
+ * @param failImage
+ * @desc Probability of image loading failure (0-1)
+ * @default 0.5
+ *
+ * @param failAudio
+ * @desc Probability of audio loading failure (0-1)
+ * @default 0.5
+ *
+ * @param failMovie
+ * @desc Probability of movie loading failure (0-1)
+ * @default 0.5
+ *
+ * @param failMapData
+ * @desc Probability of map data loading failure (0-1)
+ * @default 0.5
+ */
+
+/*:ja
+ * @plugindesc 画像や音声、動画やマップデータの読み込みに失敗します。
+ * @author RM CoreScript team
+ *
+ * @param failImage
+ * @desc 画像の読み込みに失敗する確率 (0-1)
+ * @default 0.5
+ *
+ * @param failAudio
+ * @desc 音声の読み込みに失敗する確率 (0-1)
+ * @default 0.5
+ *
+ * @param failMovie
+ * @desc 動画の読み込みに失敗する確率 (0-1)
+ * @default 0.5
+ *
+ * @param failMapData
+ * @desc マップデータ読み込みに失敗する確率 (0-1)
+ * @default 0.5
+ */
+
+(function() {
+    function toNumber(str, def) {
+        return isNaN(str) ? def : +(str || def);
+    }
+
+    var parameters = PluginManager.parameters('Debug_FailLoading');
+    var failImage = toNumber(parameters['failImage'], 0.5);
+    var failAudio = toNumber(parameters['failAudio'], 0.5);
+    var failMovie = toNumber(parameters['failMovie'], 0.5);
+    var failMapData = toNumber(parameters['failMapData'], 0.5);
+
+    var _Bitmap_onLoad = Bitmap.prototype._onLoad;
+    Bitmap.prototype._onLoad = function() {
+        if (Math.random() < failImage) {
+            this._image.onerror();
+        } else {
+            _Bitmap_onLoad.apply(this, arguments);
+        }
+    };
+
+    WebAudio.prototype._load = function(url) {
+        if (WebAudio._context) {
+            var xhr = new XMLHttpRequest();
+            if(Decrypter.hasEncryptedAudio) url = Decrypter.extToEncryptExt(url);
+            xhr.open('GET', url);
+            xhr.responseType = 'arraybuffer';
+            xhr.onload = function() {
+                if (Math.random() < failAudio) {
+                    xhr.onerror();
+                } else if (xhr.status < 400) {
+                    this._onXhrLoad(xhr);
+                }
+            }.bind(this);
+            xhr.onerror = this._loader;
+            xhr.send();
+        }
+    };
+
+    var _Graphics_onVideoLoad = Graphics._onVideoLoad;
+    Graphics._onVideoLoad = function() {
+        if (Math.random() < failMovie) {
+            this._video.onerror();
+        } else {
+            _Graphics_onVideoLoad.apply(this, arguments);
+        }
+    };
+
+    DataManager.loadDataFile = function(name, src) {
+        var xhr = new XMLHttpRequest();
+        var url = 'data/' + src;
+        xhr.open('GET', url);
+        xhr.overrideMimeType('application/json');
+        xhr.onload = function() {
+            if (name === '$dataMap' && Math.random() < failMapData) {
+                xhr.onerror();
+            } else if (xhr.status < 400) {
+                window[name] = JSON.parse(xhr.responseText);
+                DataManager.onLoad(window[name]);
+            }
+        };
+        xhr.onerror = this._mapLoader || function() {
+            DataManager._errorUrl = DataManager._errorUrl || url;
+        };
+        window[name] = null;
+        xhr.send();
+    };
+})();