nil-core 0.5.2

Multiplayer strategy game
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// Copyright (C) Call of Nil contributors
// SPDX-License-Identifier: AGPL-3.0-only

use super::cost::{Cost, ResourceRatio};
use super::{Food, Iron, Resources, Stone, Wood};
use crate::check_total_resource_ratio;
use derive_more::Display;
use nil_num::triangle::nearest_triangle;
use nil_util::ConstDeref;
use serde::{Deserialize, Serialize};
use std::num::NonZeroU32;

/// Influence is a special resource which represents the political power of a ruler
/// and is used to determine how many cities they can simultaneously control.
///
/// The amount of influence needed to control a number `n` of cities is given by
/// the formula `n * (n + 1) / 2`, meaning it increases as a triangular number.
#[derive(Copy, Debug, Display, Deserialize, Serialize, ConstDeref)]
#[derive_const(Clone, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "typescript", derive(ts_rs::TS))]
pub struct Influence(NonZeroU32);

impl Influence {
  pub const MIN: Influence = Influence(NonZeroU32::MIN);
  pub const MAX: Influence = Influence(NonZeroU32::MAX);

  pub const COST: Cost = Cost::new(100_000);

  pub const FOOD_RATIO: ResourceRatio = ResourceRatio::new(0.19);
  pub const IRON_RATIO: ResourceRatio = ResourceRatio::new(0.27);
  pub const STONE_RATIO: ResourceRatio = ResourceRatio::new(0.27);
  pub const WOOD_RATIO: ResourceRatio = ResourceRatio::new(0.27);
}

impl Influence {
  /// # Safety
  ///
  /// Value must not be zero.
  pub const unsafe fn new_unchecked(value: u32) -> Self {
    unsafe { Self(NonZeroU32::new_unchecked(value)) }
  }

  /// Resources required to acquire one unit of influence.
  pub const fn resources() -> Resources {
    Resources {
      food: Food::from((Self::COST * Self::FOOD_RATIO).round()),
      iron: Iron::from((Self::COST * Self::IRON_RATIO).round()),
      stone: Stone::from((Self::COST * Self::STONE_RATIO).round()),
      wood: Wood::from((Self::COST * Self::WOOD_RATIO).round()),
    }
  }

  #[inline]
  pub fn city_limit(&self) -> u32 {
    nearest_triangle(self.0.get())
  }
}

impl const Default for Influence {
  fn default() -> Self {
    Self::MIN
  }
}

check_total_resource_ratio!(
  Influence::FOOD_RATIO,
  Influence::IRON_RATIO,
  Influence::STONE_RATIO,
  Influence::WOOD_RATIO
);