pips 0.2.5

Library for analyzing dice roll expressions in TTRPGs
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

use std::collections::HashMap;

/// The result of a roll
pub type RollResult = i32;

/// The likelihood of a certain roll result
pub type Chance = f32;

/// table of the percent likelihood of possible outcomes
pub type PlotTable = HashMap<RollResult, Chance>;

/// Plot for a roll expression
#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct PlotResult {
    /// total number of possible outcomes
    pub total: f32,
    /// likelihood of all possible outcomes in this roll
    pub plot: PlotTable,
}

/// Common trait for a roll expression
pub trait Rollable {
    fn roll(&self) -> RollResult;
    fn plot(&self) -> PlotResult;
}