aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--extension/src/MapSingleton.cpp166
-rw-r--r--extension/src/MapSingleton.hpp3
-rw-r--r--extension/src/openvic2/Map.cpp88
-rw-r--r--extension/src/openvic2/Map.hpp23
-rw-r--r--game/common/map/regions.json6
-rw-r--r--game/src/Autoload/Events.gd3
6 files changed, 229 insertions, 60 deletions
diff --git a/extension/src/MapSingleton.cpp b/extension/src/MapSingleton.cpp
index be98e85..0d4191e 100644
--- a/extension/src/MapSingleton.cpp
+++ b/extension/src/MapSingleton.cpp
@@ -11,6 +11,7 @@ MapSingleton* MapSingleton::singleton = nullptr;
void MapSingleton::_bind_methods() {
ClassDB::bind_method(D_METHOD("load_province_identifier_file", "file_path"), &MapSingleton::load_province_identifier_file);
+ ClassDB::bind_method(D_METHOD("load_region_file", "file_path"), &MapSingleton::load_region_file);
ClassDB::bind_method(D_METHOD("load_province_shape_file", "file_path"), &MapSingleton::load_province_shape_file);
ClassDB::bind_method(D_METHOD("get_province_identifier_from_pixel_coords", "coords"), &MapSingleton::get_province_identifier_from_pixel_coords);
ClassDB::bind_method(D_METHOD("get_width"), &MapSingleton::get_width);
@@ -33,90 +34,134 @@ MapSingleton::~MapSingleton() {
singleton = nullptr;
}
-Error MapSingleton::load_province_identifier_file(String const& file_path) {
- UtilityFunctions::print("Loading identifier file: ", file_path);
+typedef Error (MapSingleton::* parse_json_entry_function)(String const& identifier, Variant const& entry);
+
+static Error parse_json_dictionary_file(String const& file_description, String const& file_path,
+ String const& identifier_prefix, MapSingleton* map_singleton, parse_json_entry_function parse_entry) {
+ UtilityFunctions::print("Loading ", file_description, " file: ", file_path);
Ref<FileAccess> file = FileAccess::open(file_path, FileAccess::ModeFlags::READ);
Error err = FileAccess::get_open_error();
if (err != OK || file.is_null()) {
- UtilityFunctions::push_error("Failed to load province identifier file: ", file_path);
+ UtilityFunctions::push_error("Failed to load ", file_description, " file: ", file_path);
return err == OK ? FAILED : err;
}
- String json_string = file->get_as_text();
+ const String json_string = file->get_as_text();
Ref<JSON> json;
json.instantiate();
err = json->parse(json_string);
if (err) {
- UtilityFunctions::push_error("Failed to parse province identifier file as JSON: ", file_path,
+ UtilityFunctions::push_error("Failed to parse ", file_description, " file as JSON: ", file_path,
"\nError at line ", json->get_error_line(), ": ", json->get_error_message());
return err;
}
- Variant json_var = json->get_data();
- Variant::Type type = json_var.get_type();
+ const Variant json_var = json->get_data();
+ const Variant::Type type = json_var.get_type();
if (type != Variant::DICTIONARY) {
- UtilityFunctions::push_error("Invalid province identifier JSON: root has type ",
+ UtilityFunctions::push_error("Invalid ", file_description, " JSON: root has type ",
Variant::get_type_name(type), " (expected Dictionary)");
return FAILED;
}
- Dictionary prov_dict = json_var;
- Array prov_identifiers = prov_dict.keys();
- for (int idx = 0; idx < prov_identifiers.size(); ++idx) {
- String const& identifier = prov_identifiers[idx];
- Variant const& colour_var = prov_dict[identifier];
+ const Dictionary dict = json_var;
+ const Array identifiers = dict.keys();
+ for (int idx = 0; idx < identifiers.size(); ++idx) {
+ String const& identifier = identifiers[idx];
+ Variant const& entry = dict[identifier];
if (identifier.is_empty()) {
- UtilityFunctions::push_error("Empty province identifier with colour: ", colour_var);
+ UtilityFunctions::push_error("Empty identifier in ", file_description, " file with entry: ", entry);
err = FAILED;
continue;
}
- static const String prov_prefix = "prov_";
- if (!identifier.begins_with(prov_prefix))
- UtilityFunctions::push_warning("Province identifier missing prefix: ", identifier);
- type = colour_var.get_type();
- Province::colour_t colour = Province::NULL_COLOUR;
- if (type == Variant::ARRAY) {
- Array colour_array = colour_var;
- if (colour_array.size() == 3) {
- for (int jdx = 0; jdx < 3; ++jdx) {
- Variant var = colour_array[jdx];
- if (var.get_type() != Variant::FLOAT) {
- colour = Province::NULL_COLOUR;
- break;
- }
- double colour_double = var;
- if (std::trunc(colour_double) != colour_double) {
- colour = Province::NULL_COLOUR;
- break;
- }
- int64_t colour_int = static_cast<int64_t>(colour_double);
- if (colour_int < 0 || colour_int > 255) {
- colour = Province::NULL_COLOUR;
- break;
- }
- colour = (colour << 8) | colour_int;
+ if (!identifier.begins_with(identifier_prefix))
+ UtilityFunctions::push_warning("Identifier in ", file_description, " file missing \"", identifier_prefix, "\" prefix: ", identifier);
+ if ((map_singleton->*parse_entry)(identifier, entry) != OK) err = FAILED;
+ }
+ return err;
+}
+
+Error MapSingleton::_parse_province_identifier_entry(String const& identifier, Variant const& entry) {
+ const Variant::Type type = entry.get_type();
+ Province::colour_t colour = Province::NULL_COLOUR;
+ if (type == Variant::ARRAY) {
+ const Array colour_array = entry;
+ if (colour_array.size() == 3) {
+ for (int jdx = 0; jdx < 3; ++jdx) {
+ const Variant var = colour_array[jdx];
+ if (var.get_type() != Variant::FLOAT) {
+ colour = Province::NULL_COLOUR;
+ break;
}
- }
- } else if (type == Variant::STRING) {
- String colour_string = colour_var;
- if (colour_string.is_valid_hex_number()) {
- int64_t colour_int = colour_string.hex_to_int();
- if (0 <= colour_int && colour_int <= 0xFFFFFF)
- colour = colour_int;
+ double colour_double = var;
+ if (std::trunc(colour_double) != colour_double) {
+ colour = Province::NULL_COLOUR;
+ break;
+ }
+ int64_t colour_int = static_cast<int64_t>(colour_double);
+ if (colour_int < 0 || colour_int > 255) {
+ colour = Province::NULL_COLOUR;
+ break;
+ }
+ colour = (colour << 8) | colour_int;
}
}
- if (colour == Province::NULL_COLOUR) {
- UtilityFunctions::push_error("Invalid province identifier colour for ", identifier, ": ", colour_var);
- err = FAILED;
- continue;
- }
- std::string error_message;
- if (!map.add_province(identifier.utf8().get_data(), colour, error_message)) {
- UtilityFunctions::push_error(error_message.c_str());
- err = FAILED;
+ } else if (type == Variant::STRING) {
+ String colour_string = entry;
+ if (colour_string.is_valid_hex_number()) {
+ int64_t colour_int = colour_string.hex_to_int();
+ if (0 <= colour_int && colour_int <= 0xFFFFFF)
+ colour = colour_int;
}
+ } else {
+ UtilityFunctions::push_error("Invalid colour for province identifier \"", identifier, "\": ", entry);
+ return FAILED;
+ }
+ std::string error_message;
+ if (!map.add_province(identifier.utf8().get_data(), colour, error_message)) {
+ UtilityFunctions::push_error(error_message.c_str());
+ return FAILED;
}
+ return OK;
+}
+
+Error MapSingleton::load_province_identifier_file(String const& file_path) {
+ const Error err = parse_json_dictionary_file("province identifier",
+ file_path, "prov_", this, &MapSingleton::_parse_province_identifier_entry);
map.lock_provinces();
return err;
}
+Error MapSingleton::_parse_region_entry(String const& identifier, Variant const& entry) {
+ Error err = OK;
+ Variant::Type type = entry.get_type();
+ std::vector<std::string> province_identifiers;
+ if (type == Variant::ARRAY) {
+ const Array province_array = entry;
+ for (int64_t idx = 0; idx < province_array.size(); ++idx) {
+ const Variant province_var = province_array[idx];
+ type = province_var.get_type();
+ if (type == Variant::STRING) {
+ String province_string = province_var;
+ province_identifiers.push_back(province_string.utf8().get_data());
+ } else {
+ UtilityFunctions::push_error("Invalid province identifier for region \"", identifier, "\": ", entry);
+ err = FAILED;
+ }
+ }
+ }
+ std::string error_message;
+ if (!map.add_region(identifier.utf8().get_data(), province_identifiers, error_message)) {
+ UtilityFunctions::push_error(error_message.c_str());
+ return FAILED;
+ }
+ return err;
+}
+
+Error MapSingleton::load_region_file(String const& file_path) {
+ const Error err = parse_json_dictionary_file("region",
+ file_path, "region_", this, &MapSingleton::_parse_region_entry);
+ map.lock_regions();
+ return err;
+}
+
static Province::colour_t colour_at(PackedByteArray const& colour_data_array, int32_t idx) {
return (colour_data_array[idx * 3] << 16) | (colour_data_array[idx * 3 + 1] << 8) | colour_data_array[idx * 3 + 2];
}
@@ -140,7 +185,7 @@ Error MapSingleton::load_province_shape_file(String const& file_path) {
err = FAILED;
}
static const Image::Format expected_format = Image::FORMAT_RGB8;
- Image::Format format = province_shape_image->get_format();
+ const Image::Format format = province_shape_image->get_format();
if (format != expected_format) {
UtilityFunctions::push_error("Invalid format (", format, ", should be ", expected_format, ") for province shape file: ", file_path);
err = FAILED;
@@ -152,7 +197,8 @@ Error MapSingleton::load_province_shape_file(String const& file_path) {
std::vector<bool> province_checklist(map.get_province_count());
- PackedByteArray shape_data_array = province_shape_image->get_data(), index_data_array;
+ const PackedByteArray shape_data_array = province_shape_image->get_data();
+ PackedByteArray index_data_array;
index_data_array.resize(width * height * sizeof(Province::index_t));
Province::index_t* index_data = reinterpret_cast<Province::index_t*>(index_data_array.ptrw());
@@ -180,7 +226,7 @@ Error MapSingleton::load_province_shape_file(String const& file_path) {
}
Province const* province = map.get_province_by_colour(colour);
if (province) {
- Province::index_t index = province->get_index();
+ const Province::index_t index = province->get_index();
index_data[idx] = index;
province_checklist[index - 1] = true;
continue;
@@ -211,7 +257,9 @@ Error MapSingleton::load_province_shape_file(String const& file_path) {
for (size_t idx = 1; idx <= map.get_province_count(); ++idx) {
Province const* province = map.get_province_by_index(idx);
if (province) {
- const Province::colour_t colour = province->get_colour();
+ Province::colour_t colour = colour = province->get_colour();
+ const Region* region = province->get_region();
+ if (region) colour = region->get_provinces().front()->get_colour();
colour_data_array[3 * idx + 0] = (colour >> 16) & 0xFF;
colour_data_array[3 * idx + 1] = (colour >> 8) & 0xFF;
colour_data_array[3 * idx + 2] = colour & 0xFF;
diff --git a/extension/src/MapSingleton.hpp b/extension/src/MapSingleton.hpp
index bb34201..d0f4dc3 100644
--- a/extension/src/MapSingleton.hpp
+++ b/extension/src/MapSingleton.hpp
@@ -15,6 +15,8 @@ namespace OpenVic2 {
int32_t width = 0, height = 0;
Map map;
+ godot::Error _parse_province_identifier_entry(godot::String const& identifier, godot::Variant const& entry);
+ godot::Error _parse_region_entry(godot::String const& identifier, godot::Variant const& entry);
protected:
static void _bind_methods();
@@ -25,6 +27,7 @@ namespace OpenVic2 {
~MapSingleton();
godot::Error load_province_identifier_file(godot::String const& file_path);
+ godot::Error load_region_file(godot::String const& file_path);
godot::Error load_province_shape_file(godot::String const& file_path);
godot::String get_province_identifier_from_pixel_coords(godot::Vector2i const& coords) const;
int32_t get_width() const;
diff --git a/extension/src/openvic2/Map.cpp b/extension/src/openvic2/Map.cpp
index 6c6275a..6e1c08a 100644
--- a/extension/src/openvic2/Map.cpp
+++ b/extension/src/openvic2/Map.cpp
@@ -31,10 +31,34 @@ Province::colour_t Province::get_colour() const {
return colour;
}
+Region* Province::get_region() const {
+ return region;
+}
+
std::string Province::to_string() const {
return "(#" + std::to_string(index) + ", " + identifier + ", 0x" + colour_to_hex_string(colour) + ")";
}
+Region::Region(std::string const& new_identifier) : identifier(new_identifier) {
+ assert(!identifier.empty());
+}
+
+std::string const& Region::get_identifier() const {
+ return identifier;
+}
+
+size_t Region::get_province_count() const {
+ return provinces.size();
+}
+
+bool Region::contains_province(Province const* province) const {
+ return province && std::find(provinces.begin(), provinces.end(), province) != provinces.end();
+}
+
+std::vector<Province*> const& Region::get_provinces() const {
+ return provinces;
+}
+
bool Map::add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message) {
if (provinces_locked) {
error_message = "The map's province list has already been locked!";
@@ -44,6 +68,10 @@ bool Map::add_province(std::string const& identifier, Province::colour_t colour,
error_message = "The map's province list is full - there can be at most " + std::to_string(Province::MAX_INDEX) + " provinces";
return false;
}
+ if (identifier.empty()) {
+ error_message = "Empty province identifier for colour " + Province::colour_to_hex_string(colour);
+ return false;
+ }
if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) {
error_message = "Invalid province colour: " + Province::colour_to_hex_string(colour);
return false;
@@ -68,6 +96,66 @@ void Map::lock_provinces() {
provinces_locked = true;
}
+bool Map::add_region(std::string const& identifier, std::vector<std::string> const& province_identifiers, std::string& error_message) {
+ if (regions_locked) {
+ error_message = "The map's region list has already been locked!";
+ return false;
+ }
+ if (identifier.empty()) {
+ error_message = "Empty region identifier!";
+ return false;
+ }
+ if (provinces.empty()) {
+ error_message = "Empty province list for region " + identifier;
+ return false;
+ }
+ Region new_region{ identifier };
+ error_message = "Error message for region: " + identifier;
+ static const std::string SEPARATOR = "\n - ";
+ for (std::string const& province_identifier : province_identifiers) {
+ Province* province = get_province_by_identifier(province_identifier);
+ if (province) {
+ if (new_region.contains_province(province))
+ error_message += SEPARATOR + "Duplicate province identifier " + province_identifier;
+ else {
+ if (province->region) {
+ error_message += SEPARATOR + "Province " + province_identifier + " is already part of ";
+ const size_t other_region_index = reinterpret_cast<size_t>(province->region) - 1;
+ if (other_region_index < regions.size())
+ error_message += regions[other_region_index].get_identifier();
+ else
+ error_message += "an unknown region with index " + std::to_string(other_region_index);
+ } else new_region.provinces.push_back(province);
+ }
+ } else error_message += SEPARATOR + "Invalid province identifier " + province_identifier;
+ }
+ if (!new_region.get_province_count()) {
+ error_message += SEPARATOR + "No valid provinces in region's list";
+ return false;
+ }
+ for (Region const& region : regions) {
+ if (region.identifier == identifier) {
+ error_message += SEPARATOR + "Duplicate region identifiers: " + region.get_identifier() + " and " + identifier;
+ return false;
+ }
+ }
+ regions.push_back(new_region);
+ error_message += SEPARATOR + "Added region: " + identifier;
+ // Used to detect provinces listed in multiple regions, will
+ // be corrected once regions is stable (i.e. lock_regions).
+ Region* tmp_region_index = reinterpret_cast<Region*>(regions.size());
+ for (Province* province : new_region.provinces)
+ province->region = tmp_region_index;
+ return true;
+}
+
+void Map::lock_regions() {
+ regions_locked = true;
+ for (Region& region : regions)
+ for (Province* province : region.provinces)
+ province->region = &region;
+}
+
size_t Map::get_province_count() const {
return provinces.size();
}
diff --git a/extension/src/openvic2/Map.hpp b/extension/src/openvic2/Map.hpp
index 423b427..1527f1a 100644
--- a/extension/src/openvic2/Map.hpp
+++ b/extension/src/openvic2/Map.hpp
@@ -6,6 +6,8 @@
namespace OpenVic2 {
+ struct Region;
+
struct Province {
using colour_t = uint32_t;
using index_t = uint16_t;
@@ -16,6 +18,7 @@ namespace OpenVic2 {
index_t index;
std::string identifier;
colour_t colour;
+ Region* region = nullptr;
Province(index_t new_index, std::string const& new_identifier, colour_t new_colour);
public:
@@ -24,17 +27,35 @@ namespace OpenVic2 {
index_t get_index() const;
std::string const& get_identifier() const;
colour_t get_colour() const;
+ Region* get_region() const;
std::string to_string() const;
};
+ struct Region {
+ friend struct Map;
+ private:
+ std::string identifier;
+ std::vector<Province*> provinces;
+
+ Region(std::string const& new_identifier);
+ public:
+ std::string const& get_identifier() const;
+ size_t get_province_count() const;
+ bool contains_province(Province const* province) const;
+ std::vector<Province*> const& get_provinces() const;
+ };
+
struct Map {
private:
std::vector<Province> provinces;
- bool provinces_locked = false;
+ std::vector<Region> regions;
+ bool provinces_locked = false, regions_locked = false;
public:
bool add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message);
void lock_provinces();
+ bool add_region(std::string const& identifier, std::vector<std::string> const& province_identifiers, std::string& error_message);
+ void lock_regions();
size_t get_province_count() const;
Province* get_province_by_index(Province::index_t index);
diff --git a/game/common/map/regions.json b/game/common/map/regions.json
new file mode 100644
index 0000000..bbeeb56
--- /dev/null
+++ b/game/common/map/regions.json
@@ -0,0 +1,6 @@
+{
+ "region_europe": ["prov_britain", "prov_ireland", "prov_iceland"],
+ "region_america": ["prov_cuba"],
+ "region_africa": ["prov_madagascar"],
+ "region_asia": ["prov_ceylon", "prov_formosa"]
+}
diff --git a/game/src/Autoload/Events.gd b/game/src/Autoload/Events.gd
index 040cb06..c2f96d5 100644
--- a/game/src/Autoload/Events.gd
+++ b/game/src/Autoload/Events.gd
@@ -4,10 +4,13 @@ var Options = preload("Events/Options.gd").new()
var Localisation = preload("Events/Localisation.gd").new()
const _province_identifier_file : String = "res://common/map/provinces.json"
+const _region_file : String = "res://common/map/regions.json"
const _province_shape_file : String = "res://common/map/provinces.png"
func _ready():
if MapSingleton.load_province_identifier_file(_province_identifier_file) != OK:
push_error("Failed to load province identifiers")
+ if MapSingleton.load_region_file(_region_file) != OK:
+ push_error("Failed to load regions")
if MapSingleton.load_province_shape_file(_province_shape_file) != OK:
push_error("Failed to load province shapes")