Struct critfail::Damage

pub struct Damage(pub Vec<DamagePart>);

A list of dice to roll and modifiers to add, usually used for damage.

use critfail::{RollExpression, Damage};

let damage = Damage::new("2d8+1").unwrap();

let outcome = damage.roll();

print!("{}", outcome);   // Prints something like "11"
print!("{:?}", outcome); // Prints something like "[2+5]+4"

Implementations

impl Damage

pub fn crit_roll(&self) -> DamageOutcome

Roll this Damage as though it were a critical hit.

This rolls all the positive dice in the Damage twice. Modifiers and dice with negative values are only counted once.

use critfail::{RollExpression, Damage};

let damage = Damage::new("2d8+3-1d4").unwrap();
let outcome = damage.crit_roll();
// The d8s are rolled twice, the +3 is counted once, and the d4 is rolled once
print!("{:?}", damage)  // Prints something like "[5+6+4+7]+3-[2]"

pub fn roll_with_check(&self, check: &CheckOutcome) -> DamageOutcome

Roll for damage, doubling if the check was a critical success.

pub fn roll_with_score(&self, score: CritScore) -> DamageOutcome

Roll for damage, doubling if the check was a critical success.

Trait Implementations

impl Clone for Damage

fn clone(&self) -> Damage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Damage

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<Damage> for Roll

fn from(damage: Damage) -> Self

Performs the conversion.

impl FromStr for Damage

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Damage> for Damage

fn eq(&self, other: &Damage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Damage) -> bool

This method tests for !=.

impl RollExpression for Damage

type Outcome = DamageOutcome

The roll result type should implement both Display and Debug. Display should print out a consise result for the roll, and Debug should print out the details (eg the value for each rolled die).

fn roll(&self) -> Self::Outcome

Roll the dice and return an outcome.

fn new(expression: &str) -> Result<Self, ParseError>

Create a new roll expression by parsing the given string.

impl StructuralPartialEq for Damage