summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/miscellaneous/dice.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/miscellaneous/dice.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/miscellaneous/dice.md')
-rw-r--r--src/node_modules/chance/docs/miscellaneous/dice.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/miscellaneous/dice.md b/src/node_modules/chance/docs/miscellaneous/dice.md
new file mode 100644
index 0000000..f4ebc20
--- /dev/null
+++ b/src/node_modules/chance/docs/miscellaneous/dice.md
@@ -0,0 +1,29 @@
+# dice
+
+```js
+// usage
+chance.d4()
+chance.d6()
+chance.d8()
+chance.d10()
+chance.d12()
+chance.d20()
+chance.d30()
+chance.d100()
+```
+
+<p class="pullquote" data-pullquote='"Any dungeon master worth his weight in geldings goes nowhere without his 20 sided die."' markdown="1"></p>
+
+Return a value equal to the roll of a die.
+
+```js
+chance.d20();
+=> 13
+
+chance.d6();
+=> 4
+```
+
+These are just wrappers around natural() but are convenient for use by games.
+
+They return values between 1 and the number after the `d`, so `chance.d4()` returns 1, 2, 3, or 4, just like a 4 sided die would.