1 Interface
- 1.1 onValue

This definition is used to define a custom die resource. Custom dice are based on one of the built-in die models (d4,d6,d8,d10,d12,d20,dF).

The result number of a custom dice can be calculated based on custom logic or a formula translating the model die result number to a custom result. If not defined, the basic result for that die model will be used.

If the die model for the custom die is available on the desktop, then the custom die will be accessible via the radial menu of that die.

If the die model is not available on the desktop, then the custom die can only be accessed programmatically.

Definition

<customdie name="..." >
  <model > ... </model>
  <menuicon > ... </menuicon>
  <side ... /> (multiple)
  <script > ... </script>
</customdie>

<customdie name="..." >
<model > ... </model>	The name of a die resource used as the model
<menuicon > ... </menuicon>	The name of an icon resource used in the radial menu of the built-in die
<side … />	Defining the side tag will override the default display/value of each die when the result is generated. Optional Attributes: result=”#” (chat display result) value=”#” (value used for total) backcolor=”<color>” icon=”<asset>” iconcolor=“<color>” font=”<asset>” fontcolor=”<color>”
<script > ... </script>	The name of an icon resource used in the radial menu of the built-in die
</customdie>

Interface

onValue

function onValue(result)

This function is called to calculate the value for the custom die. The result of the roll made on the built-in die is passed as a parameter. This function will be bypassed if any side tags are defined.

Parameters

result (number)

The result of the built-in die roll

Return values

(number)
The value to be used as the result of the custom die