Document RollInfo

Description

I'm not really sure where this fits, however the formulas for DAMAGE and ALTDAMAGE and other damage dice have a syntax! Here is an extract from the javadoc:

Construct a RollInfo from a string. The rules:

  1. Optional positive integer, times.

  2. Literal 'd' followed by positive integer, sides.

  3. Optional literal '/' followed by positive integer, keepTop, or literal '\' followed by positive integer, keepBottom, or literal '|' followed by comma-separated list of positive integers, keepList (1-indexed after dice have been sorted).

  4. Optional literal 'm' (minimum) followed by positive integer, rerollAbove, or literal 'M' (maximum) followed by postive integer, rerollBelow.

  5. Optional literal '+' or '-' followed by positive integer, modifier.

  6. Optional literal 't' followed by positive integer, totalFloor, or literal 'T' followed by a positive *integer, totalCeiling.

Unlike previous versions of this method, it is case-sensitive with respect to the alphabetic characters, e.g., only d (lower-case) is now valid, not also D (upper-case). This is to accommodate the expanded ways to roll.

Environment

None

Activity

Show:
EricS
February 27, 2013, 8:47 PM

This will be placed the detailed sybtax info in the Formulas/Functions section of the "Global Math Operators, Formulas, Symbols and JEP" page, but I will add a note that it is used in the DAMAGE and ALTDAMAGE tags. I will then add a note in the appropriate tag docs along with a link back to the detailed syntax info.

EricS
February 27, 2013, 10:04 PM

Added Roll Info to Formulas page.
svn #19552

James, I'm having trouble figuring out the syntax beyond what I've documented. Can you give me an example for each of the undocumented elements?

Assignee

EricS

Reporter

James Dempsey

Labels

None

Epic/Theme

None

Pending User Input

None

Components

Affects versions

Priority

Minor
Configure