Type Alias: DieHandle

type DieHandle = object;

Defined in: src/ui/die.ts:68

What mountDie hands back.

Properties

element

readonly element: HTMLElement;

Defined in: src/ui/die.ts:70

The die's own element, a button if it rolls.

---

face

readonly face: number;

Defined in: src/ui/die.ts:72

The face showing now (the one it will land on, while it tumbles).

---

rolling

readonly rolling: boolean;

Defined in: src/ui/die.ts:74

Whether it is tumbling.

Methods

roll()

roll(): void;

Defined in: src/ui/die.ts:76

Throw it, as a tap does. Does nothing on a die that does not roll, or while it is tumbling.

Returns

void

---

show()

show(face): void;

Defined in: src/ui/die.ts:78

Show a face at once, with no tumble. Faces outside the die are ignored.

Parameters

face

number

Returns

void

---

setSides()

setSides(
   sides, 
   face?, 
   faces?
): void;

Defined in: src/ui/die.ts:80

Change the kind of die, showing its first face (or face).

Parameters

sides

Sides

face?

number

faces?

CustomFace[]

Returns

void

---

setOnePip()

setOnePip(colour): void;

Defined in: src/ui/die.ts:82

Change the colour of a d6's one pip.

Parameters

colour

"red" | "black"

Returns

void

---

setLocale()

setLocale(locale): void;

Defined in: src/ui/die.ts:84

Change the language.

Parameters

locale

string

Returns

void

---

setRollable()

setRollable(rollable): void;

Defined in: src/ui/die.ts:86

Whether a tap rolls it, from now on.

Parameters

rollable

boolean

Returns

void

---

destroy()

destroy(): void;

Defined in: src/ui/die.ts:88

Take the die away, with every timer and listener.

Returns

void