SpecialDiceButton

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Module > Symbolic Dice Button


Symbolic Dice Button

A Symbolic Dice Button is used to define dice that use arbitrary images.   Each button can roll several dice (represented by Symbolic Die components), each of which may have any number of faces (represented by Symbolic Die Face components).   When the button is pushed, a random face is selected for each Symbolic Die that this component contains.   The results of the roll can be reported as text into the chat area, or graphically in a separate window or in the   button itself.

Name:   The name of the dice button
Button Text:   Text for the button in the main controls toolbar button
Hotkey:   Keyboard shortcut for rolling the dice
Report results as text:   If true, report results to the chat area
Report format:   A Message Format specifying the format for reporting text results: name is the name of the button as specified above, result1, result2, etc is the result of the 1st, 2nd, etc. Symbolic Die as configured below (replace the '#' symbol with the desired number), numericalTotal is the sum of the numerical values of the Symbolic Die rolls.
Show result in window:   If true, show the results graphically in a standalone window.
Window title format:       A Message Format specifying the format for reporting results to the titlebar of the standalone window.
Show result in button:   If true, show the results graphically in the toolbar button.
Width:   The width of the area for displaying results graphically.
Height:   The height of the area for displaying results graphically.
Background color:   The background color to be used when displaying results graphically.

SpecialDiceButton.png


Sub-Components

Symbolic Die

Name:   The name of the die
Results format:''   A Message Format specifying how to report the result of this die roll.   The resulting text will be substituted for result1, result2, etc in the Symbolic DiceButton's results format: name is the name of this die as specified above, result is the text value of the Symbolic Die Face that is rolled, numericalValue is the numerical value of the Symbolic Die rolled.

SpecialDie.png

Symbolic Die Face

Each die face contains a text value, a numerical value, and an image.

SpecialDieFace.png