Dice

The dice that make up this collection, along with how many times they appear.

This [Die: Int] dictionary stores the types of dice that appear, paired with the number of times they appear. For example:

let dice1 = Dice(Die.d6)
dice1.dice // [d6: 1]

let dice2 = Dice(Die.d6, Die.d6, Die.d4)
dice2.dice // [d6: 2, d4: 1]

To iterate through this dictionary, do the following:

let dice = Dice(Die.d6, Die.d6, Die.d4)
for (die, count) in dice.dice {
    print("\(die.description) appears \(count) time(s)")

Output:

A six-sided die appears 2 time(s)
A four-sided die appears 1 time(s)

To add a die to the dictionary (only applicable if using a mutable imitiation):

let dice = Dice(Die.d6, Die.d6, Die.d4)
let dieToAdd = Die.d8
dice.dice[dieToAdd] = (dice.dice[dieToAdd] ?? 0) + 1
// dice.dice is [d6: 2, d8: 1, d4: 1]
let otherDie = Die.d4
dice.dice[otherDie] = (dice.dice[otherDie] ?? 0) + 1
// dice.dice is [d6: 2, d8: 1, d4: 2]

To convert the dictionary to an array of (Die, Int) tuples, sorted by descending size of dice:

let dice = Dice(Die.d6, Die.d6, Die.d4)
let diceArray = dice.dice.sorted(by: { $0.key > $1.key })
// diceArray is [(d6, 2), (d4, 1)]

To convert the dictionary to an array of Die objects, including duplicates:

let dice = Dice(Die.d6, Die.d6, Die.d4)
var diceArray: [Die] = []
for (die, count) in dice.dice {
    for _ in 0..<count {
        diceArray += die.copy()
    }
}
// diceArray is [d6, d6, d4]

The number of dice in this Dice instance.

The modifier added or subtracted from these Dice

This Int is added to the result whenever the roll() method is called.

Creates a new Dice object with the specified dice.

Creates a new Dice object with the specified dice.

Creates a new Dice object with the given number of the specified die. This is essentially identical to Dice(copyOf: die * count), but is more efficient.

Creates a new Dice object with the specified dice. They should be in a (die: Die, count: Int) form, with the die being the type of die to add, and the count being the number of times to add it.

Creates a new Dice object with the specified dice and modifier

Creates a new Dice object with the specified dice and modifier

Creates a new Dice object with the given number of the specified die, along with the specified modifier. This is essentially identical to Dice(copyOf: (die * count) + modifier), but is more efficient.

Creates a new Dice object with the specified dice and modifier. The dice should be in a (die: Die, count: Int) form, with the die being the type of die to add, and the count being the number of times to add it.

Creates a new Dice object from the specified string in dice notation.

You cannot have a negative die AS A RESULT (-d6), a die with negative sides (d-6), or a die with 0 sides (d0). You cannot have an unreal modifier or use any operator except for addition and subtraction.

You can have -d6s in your string, so long as they cancel each other out so that the final result is at least 0d6.

Creates a new Dice object that is a copy of the given Dice object.

The probabilities of all possible rolls.

Since 0.22.0, caches previous computations, even if they were on different objects. See enableCaching, ENABLE_CACHING for caching configuration.

In 0.24.0, the computation of this value was vastly overhauled, resulting in an up to 99.9% or more decrease in calculation times (up to 1000 or more times as fast)

Whether or not Dice should cache the results of probability computations across objects.

Note: The results of rolling are NOT cached.

Setting this value to false and then to true will clear the cache. See ENABLE_CACHING for configuration of caching for all types at once.

Rolls this Dice object.

This function rolls every Die included in this Dice object, adds them together, adds the modifier (if any), and returns the result

The minimum possible result from using the roll() method.

This method simulates rolling a 1 on every die in this Dice object. It also includes the modifier, if applicable.

The maximum possible result from using the roll() method.

This method simulates rolling the maximum on every die in this Dice object. It also includes the modifier, if applicable.

The average result from using the roll() method. It is calculated with double numbers to avoid rounding errors.

Determines whether this Dice object can reach the target Roll using the given comparison type.

A description of this Dice object.

Dice().description // No dice, without a modifier.

Dice(Die.d6).description // 1 6-sided die, with no modifier.

Dice(Die.d6, Die.d6, Die.d4).description // 2 6-sided dice, 1 four-sided die, with no modifier.

Dice(withModifier: 5).description // A modifier of 5.

Dice(Die.d6, withModifier: 5).description // 1 6-sided die, with a modifier of 5.

Dice(Die.d6, Die.d6, Die.d4, withModifier: 5).description // 2 6-sided dice, 1 four-sided die, with a modifier of 5.

A short, debug-usable description of this Dice object.

Dice().debugDescription // 0

Dice(Die.d6).debugDescription // 1d6

Dice(Die.d6, Die.d6, Die.d4).debugDescription // 2d6 + 1d4

Dice(withModifier: 5).debugDescription // + 5

Dice(Die.d6, withModifier: 5).debugDescription // 1d6 + 5

Dice(Die.d6, Die.d6, Die.d4, withModifier: 5).debugDescription // 2d6 + 1d4 + 5

Returns a copy of the given Dice with separate memory.

Adds some Dice and a Die together, creating a new Dice object.

Adds some Dice and a Die together, creating a new Dice object.

Adds some Dice together, creating a new Dice object.

Adds a modifier to a Dice object.

Adds a modifier to a Dice object.

Adds the given dice to the given Dice object.

Adds the given dice to the given Dice object.

Subtracts a modifier from a Dice object.

Multiplies the given Dice object by the given multiplier.

This multiplies the count of each type of die, and the multiplier:

let dice = Dice((Die.d6, 6), (Die.d4, 4), withModifier: 2) let newDice = dice * 3 //newDice is now 18d6 + 12d4 + 6

Multiplies the given Dice object by the given multiplier.

This multiplies the count of each type of die, and the multiplier:

let dice = Dice((Die.d6, 6), (Die.d4, 4), withModifier: 2) let newDice = dice * 3 //newDice is now 18d6 + 12d4 + 6