rle.core.data
Class SimpleFormulaComputer

java.lang.Object
  rle.core.vm.PlugInBase
      rle.core.data.SimpleFormulaComputer

All Implemented Interfaces:

RuntimeComputer, PlugIn

public class SimpleFormulaComputer
extends PlugInBase
implements RuntimeComputer

A Computer that processes a simple formula. This class supports the following operators:

 () - parentheses can delineate terms to force order of operations
 * - multiplication
 / - division
 + - addition
 - - subtraction

 Access to attributes in a RuntimeData set can be achieved like this:
 ${attribute-id}

 Access to values in a lookup table:
 ${table-name[row-number][column-number]}

 Special functionality is provided to facilitate using tables to specify
 the bonuses that should be used for various stat (Str, Con, etc) values:
 ${con-hp-bonus[${statIdx(${con})}]}

 Formulas are converted to lower case prior to evaluation, so users may use
 any case conventions they wish for aesthetic purposes, and it won't affect
 processing.

 It is a good bet that the supported formats will be somewhat volatile as
 time goes on; the current implementation should be deemed more a proof-
 of-concept than a finished product.
 

Field Summary

protected java.util.Random

random The random number generator

Fields inherited from class rle.core.vm.PlugInBase

config, context, parameters

Constructor Summary

SimpleFormulaComputer()

Method Summary

int	bonus(int max, int lev) Magic bonus.
java.lang.Object	compute(java.lang.String key, RuntimeData source) Perform the computation.
protected java.lang.String	evaluateVariable(java.lang.String text, RuntimeData data) Evaluate a scripted variable.
protected java.lang.String	grabToken(java.lang.String s)
int	normal(int mean, int dev) Normal dist.
boolean	oneIn(int x) Convenience -- 1 in X chance
int	percent() Convenience -- 0-99 inclusive
int	randInt(int n) Generates a random long integer X where O<=X
int	randInt(int n, java.util.Random rng) Generates a random long integer X where O<=X
int	randRange(int min, int max)
int	randSpread(int ctr, int range)
protected java.lang.String	resolveVariables(java.lang.String text, RuntimeData data) Replace scripted variables with in-place, text values.
int	roll(int dice, int sides) Convenience -- simulated die roll.
int	roll(int dice, int sides, int bonus) Convenience -- simulated die roll.
int	roll(java.lang.String s) Obtain a value for the formula s.
int	roll(java.lang.String formula, RuntimeData data) Obtain a value for the formula s, within the context of data.
int	rollStat() Roll a stat.
int	statLookupIndex(int stat) The index of a stat into a lookup table.

Methods inherited from class rle.core.vm.PlugInBase

config, getContext, getParameters, paramMap, setConfig, setParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

random

protected final java.util.Random random

The random number generator

Constructor Detail

SimpleFormulaComputer

public SimpleFormulaComputer()

Method Detail

roll

public int roll(java.lang.String s)

Obtain a value for the formula s.

roll

public int roll(java.lang.String formula,
                RuntimeData data)

Obtain a value for the formula s, within the context of data.

statLookupIndex

public int statLookupIndex(int stat)

The index of a stat into a lookup table.

resolveVariables

protected java.lang.String resolveVariables(java.lang.String text,
                                            RuntimeData data)

Replace scripted variables with in-place, text values. Scripted variables are delimited by ${ at left and } at right. Scripted variables may be nested, and if so, will be evaluated from the inside out. Examples: ${hp} - value of the hp attribute ${conHpBonus[5]} - sixth row, 1st column of table conHpBonus ${statHpBonus[5][4]} - sixth row, 5th column of table statHpBonus ${statHpBonus[${statIdx(${con})}][4]} - 5th column; row is the index value to use for a bonus progression for the current value of attribute con

Returns:

the resulting string

evaluateVariable

protected java.lang.String evaluateVariable(java.lang.String text,
                                            RuntimeData data)

Evaluate a scripted variable. Supported formats:

  1.  var - the integral value of attribute "var"
  2.  strBonus[5] - the row 5 in 1D table strBonus
  3.  statBonus[5][3] - row 5, column 3 in 2D table statBonus
  4.  statBonus[str][3] - the row corresponding to the X Axis label 'str',
      and column 3.
  5.  statIdx(5) - the index into a stat "bonus progression" array at which
      the given stat value is represented.
 Note that the text in var is guaranteed not to contain any
 unevaluated variables.
 

grabToken

protected java.lang.String grabToken(java.lang.String s)

compute

public java.lang.Object compute(java.lang.String key,
                                RuntimeData source)

Perform the computation. Default implementation uses the "formula" parameter and ignores the value of "key"

Specified by:

compute in interface RuntimeComputer

randInt

public int randInt(int n)

Generates a random long integer X where O<=X

randInt

public int randInt(int n,
                   java.util.Random rng)

Generates a random long integer X where O<=X

randRange

public int randRange(int min,
                     int max)

randSpread

public int randSpread(int ctr,
                      int range)

percent

public int percent()

Convenience -- 0-99 inclusive

roll

public int roll(int dice,
                int sides,
                int bonus)

Convenience -- simulated die roll. eg (2,5,1) --> 3-11

roll

public int roll(int dice,
                int sides)

Convenience -- simulated die roll. eg (2,5) --> 2-10

oneIn

public boolean oneIn(int x)

Convenience -- 1 in X chance

rollStat

public int rollStat()

Roll a stat.

normal

public int normal(int mean,
                  int dev)

Normal dist.

bonus

public int bonus(int max,
                 int lev)

Magic bonus.