This definition is used to define a custom die resource. Custom dice are based on one of the built-in die
types, and share the same graphical model.
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.
If a die model name (d4,d6,d8,d10,d12,d20) is defined as a custom die, then it will not appear on the desktop;
but it will be acessible programmatically.
Definition
<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 |
|
<script
>
...
</script>
|
The name of an icon resource used in the radial menu of the built-in die |
|
</customdie>
|
|
Interface
onValue
event
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.
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
