engine:functions:mechanics:successes

successes()

Deals with common success mechanics. Rolls a given dice pool and counts every result matching the success criterium as success. If a second criterium is given, every result matching the second criterium will be subtracted from the success count.

definition

successes( pool: dice, success: criterium [, failures: criterium] ) : number

parameters

pool one or more dice definitions
success comparision to find successes
failures comparision to find successes (optional)

return
number of counted successes

Internally, the dice pool definition uses the pool() function and is able to handle more than one dice definition.

There is only one success number, even if the pool consists of several different-sided dice.

examples

successes ( 6d6, '>=5' ) roll 6 six-sided dice, count all results greater or equal to 5 as success
successes ( 4d6, '>=5', '<2' ) roll 6 six-sided dice, count all results greater or equal to 5 as success and all results smaller than 2 as failures