formula

type DiceParserListener ¶

type DiceParserListener struct {
	fp.BaseDiceListener
	// contains filtered or unexported fields
}

DiceParserListener implements the BaseDiceListener

func (s *DiceParserListener) EnterCount(ctx *fp.CountContext)

func (s *DiceParserListener) EnterFormula(ctx *fp.FormulaContext)

func (s *DiceParserListener) EnterFunccall(ctx *fp.FunccallContext)

func (s *DiceParserListener) EnterFuncname(ctx *fp.FuncnameContext)

func (s *DiceParserListener) EnterModifier(ctx *fp.ModifierContext)

func (s *DiceParserListener) EnterParameter(ctx *fp.ParameterContext)

func (s *DiceParserListener) EnterSides(ctx *fp.SidesContext)

func (s *DiceParserListener) ExitFunccall(ctx *fp.FunccallContext)

func (s *DiceParserListener) Roll() Roll

type Formula ¶

type Formula string

*

• Formula
• A dice formula is a string that breaks down the concept of rolling a number of dice
• with a number of sides into an algebraic like form. The idea is to quickly be able
• to describe a role in a more human friendly way. *
• count := uint
• sides := uint
• modifer := integer
• expr := count? 'd' sides modifier? *
• EXAMPLES:
• - d10 - Basic
• - 3d10 - With count
• - d10+10 - With modifier
• - 3d10+10 - With count and modifier
• - 3d10-2 - With negative modifier

func FromRoll(r Roll) (f Formula)

type ListenerError ¶

type ListenerError struct {
	antlr.ErrorListener
}

ListenerError Captures errors

type Parser ¶

type Parser interface {
	// Parse accepts a string that represents a dice rolling formula
	Parse(f Formula) (Roll, error)
}

Parser provides a function for consuming a Formula and transforming it into a Roll

func New() Parser

type Roll ¶

type Roll struct {
	Count      int
	Sides      int
	Modifier   int
	Extensions map[string][]string
}

Roll represents the component parts of a dice formula that can be used to actually perform a rolling of dice.