nil-core 0.5.1

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
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

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

pub mod recruit_catalog;
pub mod recruit_queue;

use crate::check_total_resource_ratio;
use crate::infrastructure::building::{BuildingId, BuildingLevel};
use crate::infrastructure::queue::InfrastructureQueue;
use crate::infrastructure::requirements::InfrastructureRequirements;
use crate::ranking::score::Score;
use crate::resources::cost::{Cost, ResourceRatio};
use crate::resources::maintenance::MaintenanceRatio;
use crate::resources::workforce::{Workforce, WorkforceSource};
use crate::world::config::WorldConfig;
use nil_core_macros::Building;
use recruit_queue::{AcademyRecruitOrder, AcademyRecruitQueue};
use serde::{Deserialize, Serialize};

#[derive(Building, Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "typescript", derive(ts_rs::TS))]
pub struct Academy {
  level: BuildingLevel,
  enabled: bool,
  recruit_queue: AcademyRecruitQueue,
}

impl Academy {
  pub const ID: BuildingId = BuildingId::Academy;

  pub const MIN_LEVEL: BuildingLevel = BuildingLevel::ZERO;
  pub const MAX_LEVEL: BuildingLevel = BuildingLevel::new(25);

  pub const MIN_COST: Cost = Cost::new(500);
  pub const MAX_COST: Cost = Cost::new(50_000);

  pub const FOOD_RATIO: ResourceRatio = ResourceRatio::new(0.0);
  pub const IRON_RATIO: ResourceRatio = ResourceRatio::new(0.3);
  pub const STONE_RATIO: ResourceRatio = ResourceRatio::new(0.4);
  pub const WOOD_RATIO: ResourceRatio = ResourceRatio::new(0.3);

  pub const MAINTENANCE_RATIO: MaintenanceRatio = MaintenanceRatio::new(0.005);

  pub const MIN_WORKFORCE: Workforce = Workforce::new(1);
  pub const MAX_WORKFORCE: Workforce = Workforce::new(100);

  pub const MIN_SCORE: Score = Score::new(16);
  pub const MAX_SCORE: Score = Score::new(1_272);

  pub const INFRASTRUCTURE_REQUIREMENTS: InfrastructureRequirements =
    InfrastructureRequirements::none();

  pub fn recruit_queue(&self) -> &AcademyRecruitQueue {
    &self.recruit_queue
  }

  pub(crate) fn recruit_queue_mut(&mut self) -> &mut AcademyRecruitQueue {
    &mut self.recruit_queue
  }

  #[must_use]
  pub(crate) fn process_queue(&mut self, config: &WorldConfig) -> Option<Vec<AcademyRecruitOrder>> {
    if self.enabled {
      let workforce = self.workforce(config);
      let orders = self.recruit_queue.process(workforce);
      (!orders.is_empty()).then_some(orders)
    } else {
      None
    }
  }

  pub(crate) fn turns_in_recruit_queue(&self, config: &WorldConfig) -> Option<f64> {
    if self.level > 0u8 {
      let turn = self.workforce(config);
      let in_queue = self.recruit_queue.sum_pending_workforce();
      Some(f64::from(in_queue) / f64::from(turn))
    } else {
      None
    }
  }
}

impl WorkforceSource for Academy {}

impl Default for Academy {
  fn default() -> Self {
    Self {
      level: BuildingLevel::ZERO,
      enabled: true,
      recruit_queue: AcademyRecruitQueue::default(),
    }
  }
}

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