Struct critfail::Attack

pub struct Attack { /* fields omitted */ }

An attack roll consisting of a check and a damage roll.

use critfail::{RollExpression, Attack};

let atk = Attack::new("r+3?2d8+4").unwrap();

let outcome = atk.roll();

print!("{}", outcome);   // Prints something like "10 ? 13"
print!("{:?}", outcome); // Prints something like "(7)+3 ? [4+5]+4"

Implementations

impl Attack

pub fn roll_with_advantage(&self, adv: AdvState) -> AttackOutcome

Roll this check using adv to override the advantage state.

use critfail::{RollExpression, Attack, AdvState};
let attack = Attack::new("r+3?3d6+4").unwrap();

attack.roll(); // Roll without advantage
attack.roll_with_advantage(AdvState::Advantage); // Roll with advantage
attack.roll_with_advantage(AdvState::Neutral); // Roll without advantage
attack.roll_with_advantage(AdvState::Disadvantage); // Roll with disadvantage

Trait Implementations

impl Clone for Attack

fn clone(&self) -> Attack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attack

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

Formats the value using the given formatter.

impl From<Attack> for Roll

fn from(attack: Attack) -> Self

Performs the conversion.

impl FromStr for Attack

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<Attack> for Attack

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

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

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

This method tests for !=.

impl RollExpression for Attack

type Outcome = AttackOutcome

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 Attack