nightshade 0.13.1

A cross-platform data-oriented game engine.
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

//! Timers.
//!
//! A timer decrements each turn while running. On each tick it runs
//! `on_tick` effects; when it reaches zero it runs `on_expire` and stops. A
//! timer can be cancelled mid-run by an effect or automatically when its
//! `cancel_on` condition holds.

use crate::interactive_fiction::data::condition::Condition;
use crate::interactive_fiction::data::effect::Effect;
use serde::{Deserialize, Serialize};

/// Content for a timer defined in `World.timers`. Actual per-run remaining
/// turns live in `RuntimeState.timers_remaining`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Timer {
    /// Number of turns the timer runs for when started.
    pub initial_turns: u32,
    /// Effects run every turn the timer is still running (after decrement).
    pub on_tick: Vec<Effect>,
    /// Effects run the turn the timer hits zero. `on_tick` still runs that turn.
    pub on_expire: Vec<Effect>,
    /// Optional condition; when it holds, the timer is cancelled without
    /// running `on_expire`.
    pub cancel_on: Option<Condition>,
}

impl Timer {
    pub fn new(initial_turns: u32) -> Self {
        Self {
            initial_turns,
            on_tick: Vec::new(),
            on_expire: Vec::new(),
            cancel_on: None,
        }
    }

    pub fn with_on_tick(mut self, effects: Vec<Effect>) -> Self {
        self.on_tick = effects;
        self
    }

    pub fn with_on_expire(mut self, effects: Vec<Effect>) -> Self {
        self.on_expire = effects;
        self
    }

    pub fn cancel_on(mut self, condition: Condition) -> Self {
        self.cancel_on = Some(condition);
        self
    }
}