character-wizard-cli 0.7.0

Native level-1 SRD character creation CLI
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

//! Read-only character-sheet projection.
//!
//! Renderers use this boundary instead of querying SRD catalog data themselves.

use crate::{Character, domain::Ability};

/// A calculated saving throw suitable for presentation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SavingThrow {
    /// Whether the character is proficient with this saving throw.
    pub proficient: bool,
    /// The total modifier, including proficiency when applicable.
    pub modifier: i16,
}

/// Read-only, SRD-derived values required by character-sheet adapters.
#[derive(Debug, Clone, Copy)]
pub struct CharacterSheet<'a> {
    character: &'a Character,
}

impl<'a> CharacterSheet<'a> {
    pub(crate) const fn new(character: &'a Character) -> Self {
        Self { character }
    }

    /// Return the class hit die.
    #[must_use]
    pub fn hit_die(self) -> u8 {
        self.character.class_hit_die()
    }

    /// Calculate one ability saving throw.
    #[must_use]
    pub fn saving_throw(self, ability: Ability) -> SavingThrow {
        let proficient = self
            .character
            .class_saving_throws()
            .contains(&ability.as_str());
        let modifier = self.character.abilities.modifier(ability)
            + if proficient {
                i16::from(self.character.proficiency_bonus())
            } else {
                0
            };
        SavingThrow {
            proficient,
            modifier,
        }
    }
}