ModSaveDataPlugin

じ☆ve冰风

I wish to share my save data plugin with no copyright/license restritions. I wish to purpose as a convenant of mods memory usage where the main core objects doesn't need to be modified adding attributes.

Data stored in $modData object is 100% serializable and will be stored when game is saved and any plugin that uses ModSaveDataPlugin won't have any problem with other mods compatibilities beacause their data will be isolated from other mods data.

Also data will have a better and visual structure.

                JavaScript:       

1. //=============================================================================
2. // ModSaveDataPlugin.js
3. //=============================================================================
4. /*:
5. * @plugindesc Mod that provides a serializable object for mod data saving.
6. * @author VolcoV
7. *
8. * @help
9. *
10. * Mod data plugin provides a new serializable object: $modData wich can store
11. * any kind of JSON data from scripts. (As serializable object, it will be
12. * saved and loaded on save/load game).
13. *
14. * Use example:
15. *
16. * $modData.myProfessionsMod = {
17. *  alchemy: {
18. *    character: 1,
19. *    level: 3,
20. *    exp: 61,
21. *    nextLevel: 127
22. *  },
23. *  smithing: {
24. *    character: 1,
25. *    level: 3,
26. *    exp: 61,
27. *    nextLevel: 127
28. *  }
29. * };
30. *
31. * const alchemyLevel = $modData.myProfessionsMod.alchemy.level;
32. *
33. *
34. * Why should I use ModSaveData:
35. *
36. * - No license comercial/personal restrictions. That plugis is under MIT
37. *   license: https://opensource.org/licenses/MIT
38. * - Less plugins incompatibilities: data structure is isolated from
39. *   core structure
40. * - Data is saved when game is saved and restored when game is loaded.
41. *
42. * Usage:
43. *
44. * - Plugin must be included listed before the plugins that will use $modData.
45. * - $modData will be cleared on new game start. If your plugin needs to add
46. *   initial data to $modData consider to add this data modifying
47. *   DataManager.setupNewGame in your plugin. Example:
48. *
49. *  let _DataManager_setupNewGame = DataManager.setupNewGame;
50. *  DataManager.setupNewGame = function() {
51. *    _DataManager_setupNewGame.call(this);
52. *    $modData.myPluginData = {
53. *      yourPlugin: 'initializationExample'
54. *    };
55. *  }
56. *
57. * @link JSON format documentation: https://www.json.org/json-en.html
58. */
59. (() => {
60.     window['$modData'] = {};
61.     let _DataManager_makeSaveContents = DataManager.makeSaveContents;
62.     DataManager.makeSaveContents = function () {
63.         const contents = _DataManager_makeSaveContents.call(this);
64.         contents.modData = $modData;
65.         return contents;
66.     };
67.     let _DataManager_extractSaveContents = DataManager.extractSaveContents;
68.     DataManager.extractSaveContents = function (contents) {
69.         _DataManager_extractSaveContents.call(this, contents);
70.         $modData = contents.modData || {};
71.     };
72.     let _DataManager_setupNewGame = DataManager.setupNewGame;
73.     DataManager.setupNewGame = function() {
74.         _DataManager_setupNewGame.call(this);
75.         $modData = {};
76.     };
77. })();

复制代码

Version: 1.0.0
Last update: 29/06/2020


本贴来自国际rpgmaker官方论坛作者:VolcoV处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/modsavedataplugin.123348/