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
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! Reaction definitions

use getset::{CopyGetters, Getters};
use serde::{Deserialize, Serialize};
use smallvec::SmallVec;
use traffloat_types::time::Rate;
use traffloat_types::units;

use crate::catalyst::Catalyst;
use crate::{cargo, gas, lang, liquid, skill};

/// A type of reaction.
#[derive(Debug, Clone, CopyGetters, Getters, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize)))]
pub struct Reaction {
    /// Title for the reaction.
    #[getset(get = "pub")]
    title:       lang::Item,
    /// Description for the reaction.
    #[getset(get = "pub")]
    description: lang::Item,
    /// Catalysts for the reaction.
    #[getset(get = "pub")]
    #[cfg_attr(feature = "xy", xylem(serde(default)))]
    catalysts:   SmallVec<[Catalyst; 2]>,
    /// Inputs and outputs for the reaction.
    #[getset(get = "pub")]
    #[cfg_attr(feature = "xy", xylem(serde(default)))]
    puts:        SmallVec<[Put; 2]>,
    /// Policies for the reaction.
    #[getset(get = "pub")]
    policy:      Policy,
}

/// The inputs and outputs of a reaction.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize), serde(tag = "type")))]
pub enum Put {
    /// Consumption or production of cargo
    Cargo {
        /// Type of cargo consumed/produced
        ty:   cargo::Id,
        /// Base (unmultiplied) rate of gas consumed/produced
        base: Rate<units::CargoSize>,
    },
    /// Consumption or production of liquid
    Liquid {
        /// Type of liquid consumed/produced
        ty:   liquid::Id,
        /// Base (unmultiplied) rate of liquid consumed/produced
        base: Rate<units::LiquidVolume>,
    },
    /// Consumption or production of gas
    Gas {
        /// Type of gas consumed/produced
        ty:   gas::Id,
        /// Base (unmultiplied) rate of gas consumed/produced
        base: Rate<units::GasVolume>,
    },
    /// Consumption or generation or electricity
    Electricity {
        /// Base (unmultiplied) rate of electricity consumed/generated
        base: Rate<units::ElectricPower>,
    },
    /// Change in skill
    ///
    /// Operators used as catalyst do not receive the skill change.
    /// All other operators receive the same amount of change.
    Skill {
        /// Type of skill trained/lost
        ty:   skill::Id,
        /// Base (unmultiplied) rate of gas consumed/produced
        base: Rate<units::Skill>,
    },
}

impl Put {
    /// Base put rate of the resource.
    fn base(&self) -> f64 {
        match self {
            Self::Cargo { base, .. } => base.0.value(),
            Self::Liquid { base, .. } => base.0.value(),
            Self::Gas { base, .. } => base.0.value(),
            Self::Electricity { base, .. } => base.0.value(),
            Self::Skill { base, .. } => base.0.value(),
        }
    }

    /// Whether this is an output
    pub fn is_output(&self) -> bool { self.base() > 0. }

    /// Whether this is an input
    pub fn is_input(&self) -> bool { self.base() < 0. }
}

/// Reaction behaviour specific to this building.
#[derive(Debug, Clone, CopyGetters, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize)))]
pub struct Policy {
    /// Whethre the reaction rate can be configured by the players.
    #[get_copy = "pub"]
    configurable: bool,
    /// What happens when inputs underflow.
    #[get_copy = "pub"]
    on_underflow: FlowPolicy,
    /// What happens when outputs overflow.
    #[get_copy = "pub"]
    on_overflow:  FlowPolicy,
}

/// behaviour when inputs underflow or outputs overflow.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[cfg_attr(feature = "xy", derive(xylem::Xylem))]
#[cfg_attr(feature = "xy", xylem(derive(Deserialize), serde(tag = "type")))]
pub enum FlowPolicy {
    /// Reduce the rate of reaction such that the input/output capacity is just enough.
    ReduceRate,
}

impl Default for FlowPolicy {
    fn default() -> Self { Self::ReduceRate }
}