roll: Dice Rolling Function

Description Usage Arguments Value Note Examples

Description

Allows for dice rolling simulation for any natural number of dice with any natural number of dice.

Usage

1
roll(sides = 20, num.of.dice = 1, type = reg)

Arguments

sides

How many sides should be used to run the simulation? Defaults to 20

num.of.dice

How many dice should be "rolled"? Defaults to 1

type

Do you want to roll with advantage (adv), disadvantage (dis), or regular (reg). Defaults to regular. Please no quotation marks

Value

Will return the sum of the dice after taking into account adv/dis. There is also messages for a 20 or a 1 on a single 20 sided dice.

Note

There is no way to tell if the dice rolled used adv/dis after the fact so be careful in specifing the parameters.

Examples

1
2
3
roll()
roll(sides = 4)
roll(type = "adv")

vinny-paris/DnD documentation built on May 3, 2019, 6:13 p.m.