Fantasy Grounds :: The Virtual Tabletop for Pen & Paper Roleplaying Games

Inherits	windowcontrol
Context	windowinstance

A die control contains a group of dice that can be of different types.

The control supports the "dice" dragdata type. Dropping dice on the control adds them to the list of dice contained in the control. Dragging from the control starts a die roll with the contained dice held.

Definition

Interface

addDie

function addDie( type )

Add a die to the list of dice in the control. The specified value should be one of the built in die types ("d4", "d6", "d8", "d10", "d12" or "d20") or a custom die type.

Parameters

type (string)

The die identifier

getDice

function getDice( )

Get the dice contained in the control.

Return values

(table)

An integer indexed table containing strings specifying the types of the dice in the control

reset

function reset( )

Empty the control, removing all dice.

setDice

function setDice( dice )

Reset the entire contents of the control to match the list given. The table should contain integer indexed strings identifying the die, either using one of the built in types ("d4", "d6", "d8", "d10", "d12" or "d20") or a custom die type.

Parameters

dice (table)

An integer indexed table containing die identifier strings