Coin

Coin

A type of DiceTerm used to represent flipping a two-sided coin.

Constructor

new Coin()

Implements:

Members

DENOMINATION :string

Implements:

Define the denomination string used to register this DiceTerm type in CONFIG.Dice.terms

Type:
  • string

faces :number

Implements:

The number of faces on the die

Type:
  • number

MODIFIERS :Object

Implements:

Define the named modifiers that can be applied for this particular DiceTerm type.

Type:
  • Object

Methods

call(modifier)

Call the result of the coin flip, marking any coins that matched the called target as a success 3dcc1 Flip 3 coins and treat "heads" as successes 2dcc0 Flip 2 coins and treat "tails" as successes

Parameters:
Name Type Description
modifier string

The matched modifier query

getResultCSS(result) → {Array.<string>}

Implements:

Get the CSS classes that should be used to display each rolled result

Parameters:
Name Type Description
result DiceTermResult

The rolled result
Returns:

The desired classes

Type
Array.<string>

getResultLabel(result) → {string}

Implements:

Return a string used as the label for each rolled result

Parameters:
Name Type Description
result DiceTermResult

The rolled result
Returns:

The result label

Type
string

roll(optionsopt) → {DiceTermResult}

Implements:

Roll the DiceTerm by mapping a random uniform draw against the faces of the dice term.

Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Options which modify how a random result is produced

Properties
Name Type Attributes Default Description
minimize boolean <optional>
 false

Minimize the result, obtaining the smallest possible value.
maximize boolean <optional>
 false

Maximize the result, obtaining the largest possible value.
Returns:

The produced result

Type
DiceTermResult