enshwick 1.0.0-alpha.2

The Enshwick Loader's modding API for Enshrouded: the one crate mods are written against
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

//! The points of the Flame altar count mod (`flame-altar-count`).

/// How many Flame Altars a Flame level allows, `flame-altar-count:limit`:
/// the answer is the altars.
///
/// The mod answers from its table and keeps the result between 1 and
/// `cap`, links' answers too, so a link cannot raise a level past `cap`.
/// Asked whenever the game checks the limit, on the thread that checks it,
/// on the server and on every client: a linking mod belongs on both sides
/// with `join: true`, or the two disagree on the limit.
///
/// # Examples
///
/// ```
/// use enshwick::points::flame_altar_count::AltarLimit;
/// use enshwick::points::{Order, Verdict};
///
/// fn init(load: &mut enshwick::Load<'_>) -> Result<(), enshwick::Off> {
///     // Two more altars at every level.
///     load.extend_point(&Order::new(), |_: &AltarLimit, altars: &u8| {
///         Verdict::Set(altars.saturating_add(2))
///     })
/// }
/// ```
#[crate::point(name = "flame-altar-count:limit", mode = Override, output = u8)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct AltarLimit {
    /// The Flame level, from 0.
    pub flame_level: u32,
    /// The most altars the game's grouping takes on this build.
    pub cap: u8,
}