Battle Test v1.0

じ☆ve冰风

Introduction
Provides various features to help with battle testing.

Features

• Run custom code at the start of each battle test.
  
• Control the quantity of items given during battle test.
  
• Set the starting HP/MP Rate of the party, as well as give a bonus/penalty to starting TP during battle test.
  
• Allows for logging details of the battle to the console.
  
• Allows for not closing the game after a battle test.
  

How to use
Save as APHO_BattleTest.js, add it via the plugin manager, adjust parameters as you see fit.
Spoiler: Parameters Explanation

Battle Test Initialise Code:
Put custom code that you want to run before a battle test here. This will only apply to battle tests, and not test play.

Override setupBattleTestItems:
If enabled, allows you to set the quantity of items given during battle test. You can also set a different quantity for regular/key items/hidden items A/B.

Exclude Item Prefix:
Items whose names start with this are never given during battle test. Leave blank to not exclude anything.
(For example, if you use items with names like '==POTIONS==' to divide your database for organisation, you can set this to '==' to ignore all such items)

HP Rate, MP Rate:
Starting HP/MP Rate of the party during a battle test. Must be a value between 0 to 1, where 1 is full HP/MP.

TP Bonus:
Grant a flat bonus to TP at the start of battle test. Can be negative to instead lose TP. Requires 'Preserve TP'.

Detailed log:
If set to true, details of the battle will be logged to the console. This works during test play as well. Set the value display and decimal rounding to whatever you prefer (if you do not want decimals to be rounded, set Decimals to -1), and set each parameter in the list to whether you want it logged or not.

Close after battle test:
By default, the game will close itself after a battle test.
You may optionally choose to not close the game.
This might be useful if you wish to review the logs at the end of battle.
Note that doing so requires overriding BattleManager.updateBattleEnd whenever in a battle test.

Script
Spoiler: CODE

                JavaScript:       

1. //==========================================
2. // APHO_BattleTest.js
3. //==========================================
4. /*:
5. * @title Battle Test
6. * @author Apho
7. * @plugindesc v1.0 Provides various features to help with battle testing.
8. *
9. * @param BattleTestInitCode
10. * @text Battle Test Initialise Code
11. * @desc Code to run whenever a battle test starts. This runs after the default functions.
12. * @type note
13. * @default ""
14. *
15. * @param OverridesetupBattleTestItems
16. * @text Override setupBattleTestItems?
17. * @desc Override the default setupBattleTestItems function which gives the max number of all items?
18. * @type boolean
19. * @default false
20. *
21. * @param ExcludeItemPrefix
22. * @parent OverridesetupBattleTestItems
23. * @text Exclude Item Prefix
24. * @desc Items whose names start with this are never given during battle test. Leave blank to not exclude anything.
25. * @type string
26. * @default
27. *
28. * @param RegularItemQty
29. * @parent OverridesetupBattleTestItems
30. * @text Regular Item Quantity
31. * @desc Quantity of each regular item that will be given at the start of a battle test. This is an eval.
32. * @type string
33. * @default this.maxItems(item)
34. *
35. * @param KeyItemQty
36. * @parent OverridesetupBattleTestItems
37. * @text Key Item Quantity
38. * @desc Quantity of each key item that will be given at the start of a battle test. This is an eval.
39. * @type string
40. * @default 0
41. *
42. * @param HiddenItemAQty
43. * @parent OverridesetupBattleTestItems
44. * @text Hidden Item A Quantity
45. * @desc Quantity of each hidden item A that will be given at the start of a battle test. This is an eval.
46. * @type string
47. * @default 0
48. *
49. * @param HiddenItemBQty
50. * @parent OverridesetupBattleTestItems
51. * @text Hidden Item B Quantity
52. * @desc Quantity of each hidden item B that will be given at the start of a battle test. This is an eval.
53. * @type string
54. * @default 0
55. *
56. * @param HpRate
57. * @text HP Rate
58. * @desc Starting HP rate of the party during battle test.
59. * @type number
60. * @decimals 10
61. * @max 1
62. * @min 0
63. * @default 1
64. *
65. * @param MpRate
66. * @text MP Rate
67. * @desc Starting MP rate of the party during battle test.
68. * @type number
69. * @decimals 10
70. * @max 1
71. * @min 0
72. * @default 1
73. *
74. * @param TpBonus
75. * @text TP Bonus
76. * @desc Grant a flat bonus (or penalty) to TP at the start of battle test. Requires 'Preserve TP'.
77. * @type number
78. * @min -999999
79. * @default 0
80. *
81. * @param DetailedLog
82. * @text Detailed Log
83. * @desc Displays detailed information about the battle in the console.
84. * @type boolean
85. * @default true
86. *
87. * @param ValueDisplay
88. * @parent DetailedLog
89. * @text Value Display
90. * @desc How should values in the log be displayed as?
91. * @type select
92. * @option Decimal
93. * @value 0
94. * @option Percentage
95. * @value 1
96. * @default 1
97. *
98. * @param Decimals
99. * @parent DetailedLog
100. * @text Decimals
101. * @desc How many decimal places should values in the log be rounded to? Set to -1 for no rounding.
102. * @type number
103. * @min -1
104. * @default -1
105. *
106. * @param EscapeRate
107. * @parent DetailedLog
108. * @text Escape Rate
109. * @desc Show the current escape success rate. This is shown as a decimal, where 1.0 = 100%.
110. * @type boolean
111. * @default true
112. *
113. * @param PartyAvgHP
114. * @parent DetailedLog
115. * @text Party Average HP
116. * @desc Show the average HP% of party members. Dead members count as having 0%.
117. * @type boolean
118. * @default true
119. *
120. * @param PartyAvgMP
121. * @parent DetailedLog
122. * @text Party Average MP
123. * @desc Show the average MP% of party members. Members with 0 max MP count as having 0%.
124. * @type boolean
125. * @default true
126. *
127. * @param PartyAvgTP
128. * @parent DetailedLog
129. * @text Party Average TP
130. * @desc Show the average TP% of party members.
131. * @type boolean
132. * @default true
134. * @param TroopAvgHP
135. * @parent DetailedLog
136. * @text Troop Average HP
137. * @desc Show the average HP% of enemy troop members. Dead members count as having 0%.
138. * @type boolean
139. * @default true
140. *
141. * @param TroopAvgMP
142. * @parent DetailedLog
143. * @text Troop Average MP
144. * @desc Show the average MP% of enemy troop members. Members with 0 max MP count as having 0%.
145. * @type boolean
146. * @default true
147. *
148. * @param TroopAvgTP
149. * @parent DetailedLog
150. * @text Troop Average TP
151. * @desc Show the average TP% of enemy troop members.
152. * @type boolean
153. * @default true
154. *
155. * @param CloseAfterBattleTest
156. * @text Close after battle test
157. * @desc Close the game after a battle test ends?
158. * @type boolean
159. * @default true
160. *
161. * @help
162. * Battle Test Initialise Code:
163. * Allows for running custom code upon starting a battle test.
164. *
165. * Override setupBattleTestItems:
166. * Allows for overriding the default function that gives the max amount of items.
167. * If enabled, you may exclude items, as well as specify the quantity based on
168. * type. (regular item, key item, etc)
169. * Evals may also be used. Use 'item' to refer to the item.
170. *
171. * HP Rate, MP Rate, TP Bonus:
172. * Set the starting HP/MP Rate of the party during battle test.
173. * HP/MP Rate must be a value from 0 to 1, where 1 is full HP/MP.
174. * TP Bonus is a flat value added to starting TP. Can be negative.
175. * Requires 'Preserve TP'.
176. *
177. * Detailed Log:
178. * Allows for logging details of the battle to the console (F8).
179. * Unlike the other features, this also works during regular test play battles.
180. * This log will be updated at the end of each turn / battle.
181. * You may have the values displayed either as a decimal (where 1.0 = 100%), or
182. * as a percentage, as well as specify which values will be logged and number of
183. * decimal places rounded to.
184. *
185. * Close after battle test:
186. * By default, the game will close itself after a battle test.
187. * You may optionally choose to not close the game.
188. * This might be useful if you wish to review the logs at the end of battle.
189. * Note that doing so requires overriding BattleManager.updateBattleEnd
190. * whenever in a battle test.
191. *
192. * NOTES
193. * - Since this plugin is purely for testing purposes, it can be removed or
194. * disabled prior to deployment.
195. * - If using YEP_BattleEngineCore.js, place this plugin above it in the Plugin
196. * Manager.
197. *
198. * TERMS OF USE
199. * - Edits allowed for personal use.
200. * - Do not repost or claim as your own, even if edited.
201. *
202. * VERSION HISTORY
203. * v1.0 - 2023/10/19 - Initial release.
204. */
205. (function(){
206.     var parameters = PluginManager.parameters('APHO_BattleTest');
207.     const GameParty_setupBattleTest = Game_Party.prototype.setupBattleTest;
208.     Game_Party.prototype.setupBattleTest = function()
209.     {
210.         GameParty_setupBattleTest.call(this);
211.         let HpRate = parseFloat(parameters['HpRate']);
212.         let MpRate = parseFloat(parameters['MpRate']);
213.         let TpBonus = parseInt(parameters['TpBonus']);
214.         $gameParty.members().forEach(function(member) {
215.             if(HpRate < 1)member.setHp(Math.round(member.mhp * HpRate));
216.             if(MpRate < 1)member.setMp(Math.round(member.mmp * MpRate));
217.             if(TpBonus != 0)member.gainTp(TpBonus);
218.         });
219.         eval(JSON.parse(parameters['BattleTestInitCode']));
220.     };
221.     const Game_Party_setupBattleTestItems = Game_Party.prototype.setupBattleTestItems;
222.     Game_Party.prototype.setupBattleTestItems = function()
223.     {
224.         if(!parameters['OverridesetupBattleTestItems'])
225.         {
226.             Game_Party_setupBattleTestItems.call(this);
227.         }
228.         else
229.         {
230.             let ExcludeItemPrefix = parameters['ExcludeItemPrefix'];
231.             let NeedsExclude = ExcludeItemPrefix && (ExcludeItemPrefix.length > 0);
232.             $dataItems.forEach(function(item) {
233.                 if (item && item.name.length > 0 && (!NeedsExclude || !item.name.startsWith(ExcludeItemPrefix)))
234.                 {
235.                     switch(item.itypeId)
236.                     {
237.                         case 1:
238.                             this.gainItem(item, eval(parameters['RegularItemQty']));
239.                             break;
240.                         case 2:
241.                             this.gainItem(item, eval(parameters['KeyItemQty']));
242.                             break;
243.                         case 3:
244.                             this.gainItem(item, eval(parameters['HiddenItemAQty']));
245.                             break;
246.                         case 4:
247.                             this.gainItem(item, eval(parameters['HiddenItemBQty']));
248.                             break;
249.                     }
250.                 }
251.             }, this);
252.         }
253.     }
254.     //DETAILED LOGGING
255.     var DetailedLog = JSON.parse(parameters['DetailedLog']);
256.     if(DetailedLog)
257.     {
258.         //setting up functions and stuff
259.         var ValueDisplay = parseInt(parameters['ValueDisplay']);
260.         var Decimals = parseInt(parameters['Decimals']);
261.         function round(n)
262.         {
263.             if(ValueDisplay == 0)
264.             {
265.                 if(Decimals == -1)
266.                 {
267.                     return n;
268.                 }
269.                 else
270.                 {
271.                     return n.toFixed(Decimals);
272.                 }
273.             }
274.             else if(ValueDisplay == 1)
275.             {
276.                 n *= 100;
277.                 if(Decimals == -1)
278.                 {
279.                     return n + "%";
280.                 }
281.                 else
282.                 {
283.                     return n.toFixed(Decimals) + "%";
284.                 }
285.             }
286.         }
287.         var NeedsEscapeRate = JSON.parse(parameters['EscapeRate']);
288.         function EscapeRate()
289.         {
290.             if(NeedsEscapeRate)
291.             {
292.                 console.log("Escape Rate: " + round(BattleManager._escapeRatio));
293.             }
294.         }
295.         var NeedsPartyAvgHP = JSON.parse(parameters['PartyAvgHP']);
296.         function PartyAvgHP()
297.         {
298.             if(NeedsPartyAvgHP)
299.             {
300.                 let total = 0, average = 0;
301.                 $gameParty.members().forEach(function(member){
302.                     total += member.hpRate();
303.                 });
304.                 average = total / $gameParty.members().length
305.                 console.log("Party HP: " + round(average));
306.             }
307.         }
308.         var NeedsPartyAvgMP = JSON.parse(parameters['PartyAvgMP']);
309.         function PartyAvgMP()
310.         {
311.             if(NeedsPartyAvgMP)
312.             {
313.                 let total = 0, average = 0;
314.                 $gameParty.members().forEach(function(member){
315.                     total += member.mpRate();
316.                 });
317.                 average = total / $gameParty.members().length
318.                 console.log("Party MP: " + round(average));
319.             }
320.         }
321.         var NeedsPartyAvgTP = JSON.parse(parameters['PartyAvgTP']);
322.         function PartyAvgTP()
323.         {
324.             if(NeedsPartyAvgTP)
325.             {
326.                 let total = 0, average = 0;
327.                 $gameParty.members().forEach(function(member){
328.                     total += member.tpRate();
329.                 });
330.                 average = total / $gameParty.members().length
331.                 console.log("Party TP: " + round(average));
332.             }
333.         }
334.         var NeedsTroopAvgHP = JSON.parse(parameters['TroopAvgHP']);
335.         function TroopAvgHP()
336.         {
337.             if(NeedsTroopAvgHP)
338.             {
339.                 let total = 0, average = 0;
340.                 $gameTroop.members().forEach(function(member){
341.                     total += member.hpRate();
342.                 });
343.                 average = total / $gameTroop.members().length
344.                 console.log("Enemy Troop HP: " + round(average));
345.             }
346.         }
347.         var NeedsTroopAvgMP = JSON.parse(parameters['TroopAvgMP']);
348.         function TroopAvgMP()
349.         {
350.             if(NeedsTroopAvgMP)
351.             {
352.                 let total = 0, average = 0;
353.                 $gameTroop.members().forEach(function(member){
354.                     total += member.mpRate();
355.                 });
356.                 average = total / $gameTroop.members().length
357.                 console.log("Enemy Troop MP: " + round(average));
358.             }
359.         }
360.         var NeedsTroopAvgTP = JSON.parse(parameters['TroopAvgTP']);
361.         function TroopAvgTP()
362.         {
363.             if(NeedsTroopAvgTP)
364.             {
365.                 let total = 0, average = 0;
366.                 $gameTroop.members().forEach(function(member){
367.                     total += member.tpRate();
368.                 });
369.                 average = total / $gameTroop.members().length
370.                 console.log("Enemy Troop TP: " + round(average));
371.             }
372.         }
373.         //actual logging
374.         const BattleManager_startBattle = BattleManager.startBattle
375.         BattleManager.startBattle = function()
376.         {
377.             BattleManager_startBattle.call(this);
378.             console.log("==BATTLE START!==");
379.             EscapeRate();
380.             PartyAvgTP();
381.             TroopAvgTP();
382.         }
383.         const BattleManager_endTurn = BattleManager.endTurn;
384.         BattleManager.endTurn = function()
385.         {
386.             BattleManager_endTurn.call(this);
387.             console.log("==TURN " + $gameTroop.turnCount() + " END==");
388.             EscapeRate();
389.             PartyAvgHP();
390.             PartyAvgMP();
391.             PartyAvgTP();
392.             TroopAvgHP();
393.             TroopAvgMP();
394.             TroopAvgTP();
395.         }
396.         const BattleManager_processVictory = BattleManager.processVictory;
397.         BattleManager.processVictory = function()
398.         {
399.             BattleManager_processVictory.call(this);
400.             console.log("==VICTORY (TURN " + $gameTroop.turnCount() + ")==");
401.             EscapeRate();
402.             PartyAvgHP();
403.             PartyAvgMP();
404.             PartyAvgTP();
405.             TroopAvgHP();
406.             TroopAvgMP();
407.             TroopAvgTP();
408.         }
409.         if(NeedsEscapeRate)
410.         {
411.             const BattleManager_processEscape = BattleManager.processEscape;
412.             BattleManager.processEscape = function()
413.             {
414.                 let OriginalEscapeRate = round(BattleManager._escapeRatio);
415.                 let EscapeSuccess = BattleManager_processEscape.call(this);
416.                 if(EscapeSuccess)
417.                 {
418.                     console.log("==ESCAPED (TURN " + ($gameTroop.turnCount() + 1) + ")==");
419.                     EscapeRate();
420.                     PartyAvgHP();
421.                     PartyAvgMP();
422.                     PartyAvgTP();
423.                     TroopAvgHP();
424.                     TroopAvgMP();
425.                     TroopAvgTP();
426.                 }else
427.                 {
428.                     console.log("==ESCAPE FAILED==\nEscape Rate: " + OriginalEscapeRate + " → " + round(BattleManager._escapeRatio));
429.                 }
430.             }
431.         }
432.         const BattleManager_processAbort = BattleManager.processAbort;
433.         BattleManager.processAbort = function()
434.         {
435.             BattleManager_processAbort.call(this);
436.             console.log("==ABORTED (TURN " + $gameTroop.turnCount() + ")==");
437.             EscapeRate();
438.             PartyAvgHP();
439.             PartyAvgMP();
440.             PartyAvgTP();
441.             TroopAvgHP();
442.             TroopAvgMP();
443.             TroopAvgTP();
444.         }
445.         const BattleManager_processDefeat = BattleManager.processDefeat;
446.         BattleManager.processDefeat = function()
447.         {
448.             BattleManager_processDefeat.call(this);
449.             console.log("==DEFEATED (TURN " + $gameTroop.turnCount() + ")==");
450.             EscapeRate();
451.             PartyAvgHP();
452.             PartyAvgMP();
453.             PartyAvgTP();
454.             TroopAvgHP();
455.             TroopAvgMP();
456.             TroopAvgTP();
457.         }
458.     }
459.     //Don't close the game after battleTest
460.     var CloseAfterBattleTest = JSON.parse(parameters['CloseAfterBattleTest']);
461.     if(!CloseAfterBattleTest)
462.     {
463.         const BattleManager_updateBattleEnd = BattleManager.updateBattleEnd;
464.         BattleManager.updateBattleEnd = function()
465.         {
466.             if (!this.isBattleTest()) BattleManager_updateBattleEnd.call(this);
467.         };
468.     }
469. })();

复制代码

Notes

• Since this plugin is purely for testing purposes, it can be removed or disabled prior to deployment.
  
• If using YEP_BattleEngineCore.js, place this plugin above it in the Plugin Manager.
  

Terms of Use

• Edits allowed for personal use.
  
• Do not repost or claim as your own, even if edited.
  
• Do not use for training AI models. This includes, but is not limited to, inputting the plugin contents or part thereof into AI models that train on user input.
  

Version History
v1.0 - 2023/10/19 - Initial release.

Download Link
GitHub

Spoiler: SCREENSHOT

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