tools.devnull.boteco.plugins.diceroll

Interface DiceRoll

All Known Implementing Classes:

SimpleDiceRoll

public interface DiceRoll

Interface that represents a dice roll.

A dice roll may use a set of different dices and also has a fixed increment to the total value.

Method Summary

Modifier and Type	Method and Description
int	roll(String expression) Rolls the dices specified by the given expression.

Method Detail

roll

int roll(String expression)

Rolls the dices specified by the given expression.

A dice roll is represented by the following expression:

nds (+ nds)* (+ v)?

Where 'n' is the number of dices (optional in case of '1'), 's' is the number of sides and 'v' is a static increment to the final value.

Example: 2d4 + d8 + 3 will roll 2 dices of 4 sides, one dice of 8 sides and add 3 to the final score.

Parameters:

expression - the expression that defines the roll

Returns:

the final score