extension/src/openvic2/map/Province.hpp


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

#pragma once

#include "openvic2/map/Building.hpp"

namespace OpenVic2 {
   struct Map;
   struct Region;

   /* REQUIREMENTS:
    * MAP-5, MAP-8, MAP-43, MAP-47
    */
   struct Province : HasIdentifier {
      friend struct Map;

      using colour_t = uint32_t;
      using index_t = uint16_t;
      using life_rating_t = int8_t;

      static constexpr colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF;
      static constexpr index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF;
   private:
      const index_t index;
      const colour_t colour;
      Region* region = nullptr;
      bool water = false;
      life_rating_t life_rating = 0;
      IdentifierRegistry<Building> buildings;

      Province(index_t new_index, std::string const& new_identifier, colour_t new_colour);
   public:
      static std::string colour_to_hex_string(colour_t colour);

      Province(Province&&) = default;

      index_t get_index() const;
      colour_t get_colour() const;
      Region* get_region() const;
      bool is_water() const;
      life_rating_t get_life_rating() const;
      return_t add_building(BuildingType const& type);
      void lock_buildings();
      void reset_buildings();
      std::vector<Building> const& get_buildings() const;
      return_t expand_building(std::string const& building_type_identifier);
      std::string to_string() const;

      void update_state(Date const& today);
      void tick(Date const& today);
   };
}