dice

package

v1.1.1 Latest Latest Go to latest Published: Aug 16, 2023 License: GPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Roll(def string) (int, error)

Roll the dice in given rpg dice definition (for example 3d6+2). Returns the result of the roll or an error of the def cannot be parsed.

func SupportedDice() map[int]Dice

type Dice uint

Dice represents a single game dice

const (
	D4   Dice = 4
	D6   Dice = 6
	D8   Dice = 8
	D10  Dice = 10
	D12  Dice = 12
	D20  Dice = 20
	D100 Dice = 100
)

func (d Dice) Roll() int

Roll the Dice and return the result.

func (d Dice) RollMany(amount int) (result int)

RollMany rolls the Dice multiple times and sums up the results.

func (d Dice) RollSpecial(amount, modifier int) int

RollSpecial is the same as RollMany, but after the rolls a modifier is also added to the result.