earwax.die module

Provides the Die class.

class earwax.die.Die(sides: int = 6)

Bases: earwax.mixins.RegisterEventMixin

A single dice.

Variables:sides – The number of sides this die has.

on_roll(value: int) → None

Code to be run when a die is rolled.

An event which is dispatched by roll() method.

Parameters:value – The number that has been rolled.

roll() → int

Roll a die.

Returns a number between 1, and self.size.