diff options
author | Minteck <contact@minteck.org> | 2021-12-21 16:52:28 +0100 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2021-12-21 16:52:28 +0100 |
commit | 46e43f4bde4a35785b4997b81e86cd19f046b69b (patch) | |
tree | c53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/miscellaneous/rpg.md | |
download | langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2 langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip |
Commit
Diffstat (limited to 'src/node_modules/chance/docs/miscellaneous/rpg.md')
-rw-r--r-- | src/node_modules/chance/docs/miscellaneous/rpg.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/miscellaneous/rpg.md b/src/node_modules/chance/docs/miscellaneous/rpg.md new file mode 100644 index 0000000..e8d1d13 --- /dev/null +++ b/src/node_modules/chance/docs/miscellaneous/rpg.md @@ -0,0 +1,25 @@ +# rpg + +```js +// usage +chance.rpg('#d#') +chance.rpg('#d#', {sum: true}) +``` + +Given an input looking like #d#, where the first # is the number of dice to +roll and the second # is the max of each die, returns an array of dice values. + +```js +chance.rpg('3d10'); +=> [1, 6, 9] + +chance.rpg('5d6'); +=> [3, 1, 2, 5, 2] +``` + +Optionally specify a sum be returned rather than an array of dice. + +```js +chance.rpg('3d10', {sum: true}); +=> 14 +``` |