dicetables.dicetable
The two DiceTable classes are below. They inherit from :pydicetables.additiveevents.AdditiveEvents
DiceTable
new
Here is a quick demo of number_of_dice and weights_info
>>> import dicetables as dt >>> table = dt.DiceTable.new().add_die(dt.Die(6), 2).add_die(dt.WeightedDie({1: 2, 3: 1})) >>> print(table.weights_info()) 1D3 W:3 a roll of 1 has a weight of 2 a roll of 2 has a weight of 0 a roll of 3 has a weight of 1 <BLANKLINE> 2D6 No weights >>> table.number_of_dice(dt.WeightedDie({1: 2, 2: 0, 3: 1})) 1 >>> table.number_of_dice(dt.Die(6)) 2 >>> table.number_of_dice(dt.Die(100)) 0
DetailedDiceTable
DetailedDiceTable is a dicetable that owns a :pydicetables.eventsinfo.EventsCalculations. This is accessed from the .calc property and you can set whether it includes zero values with calc_includes_zeros. Owning an EventsCalculations means that it uses more memory.
You can instantiate any DiceTable or DetailedDiceTable with any data you like. This allows you to create a DiceTable from stored information or to copy. dice_data returns the correct input to instantiate a new DiceTable, which is a :pydicetables.dicerecord.DiceRecord (See below for details). To get consistent and sorted output for dice, use get_list. Equality testing is by: - type - get_dict()-- dice_data() - (and calc_includes_zeroes for DetailedDiceTable).
>>> ten_d_six = dt.DiceTable.new() >>> ten_d_six = ten_d_six.add_die(dt.Die(6), 10) >>> events_record = ten_d_six.get_dict() >>> dice_record = ten_d_six.dice_data() >>> new_ten_d_six = dt.DiceTable(events_record, dice_record) >>> print(new_ten_d_six) 10D6 >>> record = dt.DiceRecord({dt.Die(6): 10}) >>> also_ten_d_six = dt.DetailedDiceTable(new_ten_d_six.get_dict(), record, calc_includes_zeroes=False) >>> ten_d_six.get_dict() == new_ten_d_six.get_dict() == also_ten_d_six.get_dict() True >>> ten_d_six.get_list() == new_ten_d_six.get_list() == also_ten_d_six.get_list() True >>> ten_d_six == new_ten_d_six True >>> ten_d_six == also_ten_d_six # False by type False >>> isinstance(also_ten_d_six, dt.DiceTable) True >>> type(also_ten_d_six) is dt.DiceTable False
You can also remove dice, but this will raise an error if you remove too many.
>>> table = dt.DiceTable.new().add_die(dt.Die(4), 10) >>> table.remove_die(dt.Die(4), 7) <DiceTable containing [3D4]> >>> table.get_list() [(Die(4), 10)] >>> table.remove_die(dt.Die(4), 11) Traceback (most recent call last): File "<stdin>", line 1, in <module> DiceRecordError: Tried to create a DiceRecord with a negative value at Die(4): -1
DetailedDiceTable.calc_includes_zeroes defaults to True. The only way to change this property is with the switch_boolean method, which returns a new DetailedDiceTable that is identical to the original, except with calc_includes_zeroes switched.
>>> d_table = dt.DetailedDiceTable.new() >>> d_table.calc_includes_zeroes True >>> d_table = d_table.add_die(dt.StrongDie(dt.Die(2), 2)) >>> print(d_table.calc.full_table_string()) 2: 1 3: 0 4: 1 <BLANKLINE>
>>> d_table = d_table.switch_boolean() >>> the_same = dt.DetailedDiceTable({2: 1, 4: 1}, d_table.dice_data(), False) >>> d_table == the_same True >>> print(d_table.calc.full_table_string()) 2: 1 4: 1 <BLANKLINE> >>> d_table = d_table.add_die(dt.StrongDie(dt.Die(2), 2)) >>> print(d_table.calc.full_table_string()) 4: 1 6: 2 8: 1 <BLANKLINE>
>>> d_table = d_table.switch_boolean() >>> d_table == the_same False >>> print(d_table.calc.full_table_string()) 4: 1 5: 0 6: 2 7: 0 8: 1 <BLANKLINE>
The DiceRecord
dicetables.dicerecord.DiceRecord
This is an immutable record of dice. add_die, remove_die and new return new DiceRecord without altering the original. You can instantiate one with {dice_object: number_of_dice}. Trying to create a DiceRecord with a negative number of dice will raise an error.