dice

Documentation

Overview

Package dice provides methods for simulating the rolling of polyhedral dice.

Index

• func Roll(dice Dice) int
• type Dice
  • func ParseFromString(input string) (Dice, error)

Functions

func Roll

func Roll(dice Dice) int

Roll rolls "num" number of dice with "sides" sides and returns the total result

Types

type Dice

type Dice struct {
	Number int `json:"number" db:"number"`
	Sides  int `json:"sides" db:"sides"`
}

Dice is a representation of polyhedral dice

func ParseFromString

func ParseFromString(input string) (Dice, error)

ParseFromString returns a Dice struct parsed from a string