Struct critfail::DamageOutcomeBuilder

pub struct DamageOutcomeBuilder { /* fields omitted */ }

This is used to create a 'fudged' DamageOutcome without actually randomly generating anything.

use critfail::DamageOutcomeBuilder;
// To create a result that could come from rolling '2d8+4-1'
let outcome = DamageOutcomeBuilder::new()
    .dice(8, vec![2,6])
    .modifier(4)
    .modifier(-1)
    .build();

assert_eq!(outcome.score(), 11);
assert_eq!(
    format!("{:?}", outcome),
    "[2+6]+4-1"
);

Implementations

impl DamageOutcomeBuilder

pub fn new() -> Self

Create a new DamageOutcomeBuilder.

pub fn modifier(self, modifier: Score) -> Self

Add a constant modifier to the roll. This method can be chained multiple times for multiple modifiers.

use critfail::DamageOutcomeBuilder;


// To create a result that could come from rolling '2d8+6-4'
let outcome = DamageOutcomeBuilder::new()
    .dice(8, vec![1,6])
    .modifier(6)
    .modifier(-4)
    .build();

assert_eq!(outcome.score(), 9);
assert_eq!(
    format!("{:?}", outcome),
    "[1+6]+6-4"
);

pub fn dice(self, sides: Sides, scores: Vec<Score>) -> Self

Add a dice modifier to the roll. This method can be chained multiple times for multiple modifiers. sides specifies the die that was rolled.

use critfail::DamageOutcomeBuilder;


// To create a result that could come from rolling '2d6+3d10-1d4'
let outcome = DamageOutcomeBuilder::new()
    .dice(6, vec![5, 1])
    .dice(10, vec![4, 9, 2])
    .dice(-4, vec![3])
    .build();

assert_eq!(outcome.score(), 18);
assert_eq!(
    format!("{:?}", outcome),
    "[5+1]+[4+9+2]-[3]"
);

pub fn build(self) -> DamageOutcome

Create a DamageOutcome from this builder.

Trait Implementations

impl Default for DamageOutcomeBuilder

fn default() -> DamageOutcomeBuilder

Returns the "default value" for a type.