critfail 0.3.0

A library for parsing and rolling D&D 5e roll expressions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use crate::RollExpression;
use crate::{AdvState, Check, Damage};

pub use attackoutcome::{AttackOutcome, AttackOutcomeBuilder};

mod attackoutcome;
mod attackparse;

/// 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"
/// ```
#[derive(PartialEq, Debug, Clone)]
pub struct Attack {
    check: Check,
    damage: Damage,
}

impl Attack {
    /// 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
    /// ```
    pub fn roll_with_advantage(&self, adv: AdvState) -> AttackOutcome {
        let check = self.check.roll_with_advantage(adv);
        let damage = self.damage.roll_with_check(&check);

        AttackOutcome::new(check, damage)
    }
}

impl RollExpression for Attack {
    type Outcome = AttackOutcome;

    fn roll(&self) -> Self::Outcome {
        let check = self.check.roll();
        let damage = self.damage.roll_with_check(&check);

        AttackOutcome::new(check, damage)
    }
}