DiceRoller plugin 1.0 (for MV, might work for MZ too)

じ☆ve冰风

Hello everyone!

I've dipped here and there at times to check on plugins and sometimes to ask questions but I felt I needed to at least contribute a little as well. Hence, while my scripting / coding has been rusty due to being out of practice, it also gave me an opportunity to dive right back into it as well.


INTRODUCTION

So first off, I've often made searches for a simple plugin to emulate dice rolls and it is possible I've just been unlucky but I never did come across one. So I figured I might as well make my own and after testing it, it seems to be working pretty good for the needs I had of it.

But then, I hear you say "Why not just use a Math.random() function to generate a random value between X and Y? My simple answer is "because of odds".

For let's say that you want to emulate a classic 3d6 rolls for stats in a D&D game, the Math.random() method would allow you to generate a value between 3 and 18 with ease... however, that method would result in each possible value having the same odd, which is 1 in 16. This will possibly satisfy most people as you then have a desired result between 3 and 18.

However, with a proper dice roll, the odds of getting the most extreme values on a roll are FAR lower than say getting a 10 or 11 simply because of the distribution of results from each possible outcome of each die. For example, landing a 3 or 18 with an actual dice roll? You can only achieve it if you roll all 1s or all 6s (which is about 0.4%)... but to get 10? You have a lot more combinations possible that will result in 10 ([6,3,1], [6,2,2], [6,1,3], [5,3,2], etc.) meaning that the results will more often than not be near 10-11 (about 12.5%).

Hence the need for a proper dice roller function to emulate an actual roll of dice.


HOW IT WORKS

So as you might imagine, making a dice roll function isn't that difficult... it just needs to be made really to be usable and be called when needed with a few features to make it easier to use.

Basically, I've created the diceroll() function which, when called, requires 2 parameters : the number of die and the type of die. Thus, if you wanted to perform the aforementionned "3d6", you call a script function and enter :

                JavaScript:       

1. diceroll(3,6);

复制代码

The function will then perform 3 consecutive Math.random() functions where a value between 1 and 6 will be generated then added to their previous result, returning the sum of all three. This will effectively and properly generate a dice roll with proper odds associated with that kind of roll.

Of course, since it is a custom function, it means that you can call it in your damage formula for skills and even use battler parameters as the parameters to send to the function to generate those rolls. So you could very well end up creating some sort of "D&D-like" weapon attack roll like so :

                JavaScript:       

1. diceroll(2,4) + Math.Int((a.atk - 10) / 2)

复制代码

.. which would be the same (somewhat) to using a 2d4 damage weapon and adding your character's STR (ATK?) mod to the damage itself.

But then, what if you wanted to make a standalone roll and use it in your game later on like, let's say, a skill check of some sort? Well I've added a plugin parameter to let you drop the result of your roll into any one game variable you want.

As long as the plugin parameter "DiceRollVar" value is 1 or greater, then the result of your rolls will ALWAYS be copied into that game system variable so you can reserve and name a variable in your game to receive those precious dice. If the value is 0 or less then it will simply ignore that step entirely.

GIMME!

Here's the code in its entirety :

Spoiler: Code

                JavaScript:       

1. //=============================================================================
2. // WIEG_DiceRoller.js                                                            
3. //=============================================================================
5. /*:
6. *
7. * @author Wiegraf
8. * @plugindesc Creates a function that replicates dice rolling.
9. *
10. * @param DiceRollVar
11. * @desc Variable ID where the result is copied to (none if 0)
12. * @default 0
13. *
14. * @help
15. * | Information |
16. * This simple plugin's purpose is to simulate actual dice rolling probabilities
17. * instead of relying on the usual method of using a random number generator
18. * range to obtain a similar result.
19. *
20. * The difference lies in the probability of each value occuring when generating
21. * such ranges. For example, taking the example of wanting to simulate a roll of
22. * 2 six-sided dice (which would result in a value between 2 and 12).
23. *
24. * Using the Math.rand() function to generate a value between 2 and 12 would mean
25. * that each of the 11 possible values would have 1 in 11 chance (or 9.0909%) of
26. * occuring by using "Math.rand() * 11 + 2".
27. *
28. * However, with a roll of 2 six-sided dice (or 2d6), the probability that you
29. * would roll either a result of 2 or 12 are both 1 in 36 (or 2.7777%) while
30. * rolling a result of 7 would be 6 in 36 (or 16.6667%) due * to the result being
31. * generated by 2 random checks of ranges of 1 to 6 instead of a single check of a
32. * range of 2 to 12.
33. *
34. * | Configuration |
35. * The plugin has a single configurable parameter named "DiceRollVar" which
36. * determines into which variable * ID the result of the dice roll will be copied.
37. * By default, the value is set to "0" which ignores that step, meaning the result
38. * isn't copied to a variable. If set to any value greater than 0 however, the result
39. * will be copied into the matching variable with the ID of the value entered.
40. *
41. * This allows the user to simply use the diceroll() function to quickly generate
42. * a number that can then be accessed through the ingame variables.
43. *
44. * | Usage |
45. * You can execute the diceroll function though an event with the "Script" advanced
46. * command.
47. *
48. * The "diceroll()" function requires 2 values to be entered in order to function :
49. * a number of die to be rolled and the type of die. Both values must be positive
50. * integers (aka rounded numbers). The proper syntax is as follows :
51. *
52. * diceroll(number,type) -> Roll "number" die with "type" faces
53. * diceroll(2,6)         -> Roll 2 dice with 6 faces for a total between 2 and 12
54. * diceroll(4,8)         -> Roll 4 dice with 8 faces for a total between 4 and 32
55. *
56. * Likewise, it is possible to use the diceroll() function in your damage formulas
57. * as long as you provide * integer-type values as the "number" and "type". For example :
58. *
59. * diceroll(a.atk, 4)    -> Roll "a.atk" dice with 4 faces
60. * diceroll(2,6) + a.atk -> Roll 2 dice with 6 faces for a total between 2 and 12
61. *                           plus the user's Attack
62. *
63. */
65. (function() {
67.     //Registers the Plugin for use
68.     var parameters = PluginManager.parameters("WIEG_DiceRoller");
69.     //A place that holds all the parameters from your plugin params above
70.     const WIEG_AdvancedSettingsParams = {
71.       DiceRollVar: Number(parameters['DiceRollVar'])
72.     };
73.    
74.   diceroll = function(dieNumb, dieType) {
75.       var i;
76.       var total = 0;
77.       for (i = 0; i < dieNumb; i++) {
78.           total += Math.floor(Math.random() * dieType + 1);
79.       }
80.       if(WIEG_AdvancedSettingsParams.DiceRollVar > 0) {
81.           $gameVariables.setValue(WIEG_AdvancedSettingsParams.DiceRollVar, total);
82.       }
83.       return total;
84.   };
86. })();

复制代码

COPYRIGHT AND STUFF

I only ask that you credit me if you use that plugin in your game.


END WORD

If you ever have questions or suggestions of features to add to this plugin, let me know and I'll consider it.


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