WeightedRandom.Dice.Types (weighted_random v1.0.0-rc.1)

Summary

dice_sides()

dice_spec()

The map to later be turned into a Dice struct

die_spec()

modifier()

num_dice()

Widely used notation for describing dice. Within the context of WeightedRandom, there are two formats: string, and tuple.

@type dice_sides() :: pos_integer()

@type dice_spec() :: %{
  :dice => [WeightedRandom.Die.t()],
  optional(:modifier) => integer()
}

The map to later be turned into a Dice struct

@type die_spec() :: %{
  optional(:sides) => integer(),
  optional(:weights) => [WeightedRandom.Utils.Types.weight_spec()]
}

@type modifier() :: integer()

@type num_dice() :: pos_integer()

@type standard_dice_notation() :: String.t()

Widely used notation for describing dice. Within the context of WeightedRandom, there are two formats: string, and tuple.

String: "#{num_dice}d#{dice_sides}+#{modifier}"

Tuple: {num_dice, dice_sides, modifier}

In either case, num_dice and modifier are both optional