Class Die<T>

constructor

• new Die<T>(options?): Die<T>

• Type Parameters

  • T = number

  Parameters

  • Optional options: IDieOptions<T>

  Returns Die<T>

Readonly color

Readonly faces

Readonly pipColor

Readonly scale

Static Readonly DEFAULT_FACES_6

Static Readonly DEFAULT_ROTATIONS_6

face

• get face(): IDieFace<T>

• Returns IDieFace<T>

faceIndex

• get faceIndex(): number

• Returns number

isRolling

• get isRolling(): boolean

• Returns boolean

localBounds

• get localBounds(): Bounds

• How much space does this object take up.

  Returns Bounds

value

• get value(): T

• Returns T

• set value(val): void

• Parameters

  • val: T

  Returns void

render

• render(ctx): DieView

• Builds a view of this object from the perspective of a player.

  Parameters

  • ctx: RenderContext

    Information about where the object is in the scene, and who's viewing it.

  Returns DieView

roll

• roll(duration?): Promise<IDieFace<T>>

• Parameters

  • duration: number = 1

  Returns Promise<IDieFace<T>>

startRolling

• startRolling(): void

• Returns void

stopRolling

• stopRolling(): IDieFace<T>

• Returns IDieFace<T>