From c0d76b78d3762e6eec3ed1c62618be84c5b7559b Mon Sep 17 00:00:00 2001 From: Hop311 Date: Thu, 30 Mar 2023 22:50:50 +0100 Subject: Add terrain map With Directional movement using WASD With Directional movement using arrow keys With Click-Drag movement using middle mouse button With Province identifiers With Province shape loading With Province rendering With Province selection With Province overview panel With Color lookup texture --- extension/src/register_types.cpp | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) (limited to 'extension/src/register_types.cpp') diff --git a/extension/src/register_types.cpp b/extension/src/register_types.cpp index d1613a5..16e59b2 100644 --- a/extension/src/register_types.cpp +++ b/extension/src/register_types.cpp @@ -9,6 +9,8 @@ #include "Simulation.hpp" #include "Checksum.hpp" #include "LoadLocalisation.hpp" +#include "MapSingleton.hpp" +#include "MapMesh.hpp" using namespace godot; using namespace OpenVic2; @@ -17,9 +19,9 @@ static TestSingleton* _test_singleton; static Simulation* _simulation; static Checksum* _checksum; static LoadLocalisation* _load_localisation; +static MapSingleton* _map_singleton; -void initialize_openvic2_types(ModuleInitializationLevel p_level) -{ +void initialize_openvic2_types(ModuleInitializationLevel p_level) { if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { return; } @@ -40,6 +42,11 @@ void initialize_openvic2_types(ModuleInitializationLevel p_level) _load_localisation = memnew(LoadLocalisation); Engine::get_singleton()->register_singleton("LoadLocalisation", LoadLocalisation::get_singleton()); + ClassDB::register_class(); + _map_singleton = memnew(MapSingleton); + Engine::get_singleton()->register_singleton("MapSingleton", MapSingleton::get_singleton()); + + ClassDB::register_class(); } void uninitialize_openvic2_types(ModuleInitializationLevel p_level) { @@ -58,15 +65,16 @@ void uninitialize_openvic2_types(ModuleInitializationLevel p_level) { Engine::get_singleton()->unregister_singleton("LoadLocalisation"); memdelete(_load_localisation); + + Engine::get_singleton()->unregister_singleton("MapSingleton"); + memdelete(_map_singleton); } -extern "C" -{ +extern "C" { // Initialization. - GDExtensionBool GDE_EXPORT openvic2_library_init(const GDExtensionInterface *p_interface, const GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization) - { + GDExtensionBool GDE_EXPORT openvic2_library_init(const GDExtensionInterface* p_interface, const GDExtensionClassLibraryPtr p_library, GDExtensionInitialization* r_initialization) { GDExtensionBinding::InitObject init_obj(p_interface, p_library, r_initialization); init_obj.register_initializer(initialize_openvic2_types); -- cgit v1.2.3-56-ga3b1 From 7241811bd8c9493b7b6c6480e8d63a5fb7f38e4e Mon Sep 17 00:00:00 2001 From: Gone2Daly <71726742+Gone2Daly@users.noreply.github.com> Date: Fri, 7 Apr 2023 18:10:49 +0200 Subject: Add minimap for terrain map With accurate viewport shape display on minimap With Mapmode management With Region mapmode With Province mapmode With Index mapmode With Minimap single-click movement With Minimap drag-click movement --- extension/src/Checksum.hpp | 8 +- extension/src/LoadLocalisation.hpp | 1 - extension/src/MapMesh.cpp | 1 - extension/src/MapSingleton.cpp | 359 +++++++++++++++--------- extension/src/MapSingleton.hpp | 24 +- extension/src/Simulation.hpp | 6 +- extension/src/TestSingleton.hpp | 1 - extension/src/openvic2/Map.cpp | 283 ++++++++++++++++--- extension/src/openvic2/Map.hpp | 78 ++++- extension/src/openvic2/Province.cpp | 40 +++ extension/src/openvic2/Region.cpp | 26 ++ extension/src/openvic2/Types.hpp | 7 + extension/src/register_types.cpp | 7 +- extension/src/register_types.h | 2 +- game/art/terrain/terrain.png | Bin 0 -> 27542091 bytes game/art/terrain/terrain.png.import | 34 +++ game/art/ui/minimap.png | Bin 0 -> 122017 bytes game/art/ui/minimap.png.import | 34 +++ game/art/ui/minimap_frame.png | Bin 0 -> 1043 bytes game/art/ui/minimap_frame.png.import | 34 +++ game/common/map/regions.json | 6 + game/common/map/terrain/terrain.png | Bin 27542091 -> 0 bytes game/common/map/terrain/terrain.png.import | 34 --- game/localisation/en_GB/mapmodes.csv | 5 + game/localisation/en_GB/mapmodes.csv.import | 3 + game/src/Autoload/Events.gd | 5 + game/src/GameSession/GameSession.tscn | 9 +- game/src/GameSession/MapControlPanel.gd | 40 ++- game/src/GameSession/MapControlPanel.tscn | 36 ++- game/src/GameSession/MapView.gd | 160 ++++++++--- game/src/GameSession/MapView.tscn | 10 +- game/src/GameSession/Minimap.gd | 89 ++++++ game/src/GameSession/ProvinceOverviewPanel.tscn | 2 + game/src/GameSession/TerrainMap.gdshader | 13 +- 34 files changed, 1058 insertions(+), 299 deletions(-) create mode 100644 extension/src/openvic2/Province.cpp create mode 100644 extension/src/openvic2/Region.cpp create mode 100644 extension/src/openvic2/Types.hpp create mode 100644 game/art/terrain/terrain.png create mode 100644 game/art/terrain/terrain.png.import create mode 100644 game/art/ui/minimap.png create mode 100644 game/art/ui/minimap.png.import create mode 100644 game/art/ui/minimap_frame.png create mode 100644 game/art/ui/minimap_frame.png.import create mode 100644 game/common/map/regions.json delete mode 100644 game/common/map/terrain/terrain.png delete mode 100644 game/common/map/terrain/terrain.png.import create mode 100644 game/localisation/en_GB/mapmodes.csv create mode 100644 game/localisation/en_GB/mapmodes.csv.import create mode 100644 game/src/GameSession/Minimap.gd (limited to 'extension/src/register_types.cpp') diff --git a/extension/src/Checksum.hpp b/extension/src/Checksum.hpp index ebdbd43..717910e 100644 --- a/extension/src/Checksum.hpp +++ b/extension/src/Checksum.hpp @@ -1,15 +1,13 @@ #pragma once -#include #include -#include namespace OpenVic2 { class Checksum : public godot::Object { GDCLASS(Checksum, godot::Object) //BEGIN BOILERPLATE - static Checksum* _checksum; + inline static Checksum* _checksum = nullptr; protected: static void _bind_methods() { @@ -33,6 +31,4 @@ namespace OpenVic2 { return godot::String("1234abcd"); } }; - - Checksum* Checksum::_checksum = nullptr; -} \ No newline at end of file +} diff --git a/extension/src/LoadLocalisation.hpp b/extension/src/LoadLocalisation.hpp index f54a025..49c0313 100644 --- a/extension/src/LoadLocalisation.hpp +++ b/extension/src/LoadLocalisation.hpp @@ -1,6 +1,5 @@ #pragma once -#include #include namespace OpenVic2 { diff --git a/extension/src/MapMesh.cpp b/extension/src/MapMesh.cpp index f0fc819..91c7611 100644 --- a/extension/src/MapMesh.cpp +++ b/extension/src/MapMesh.cpp @@ -111,7 +111,6 @@ Array MapMesh::_create_mesh_array() const { uv.x = -repeat_proportion; for (int i = 0; i <= subdivide_w + 1; ++i) { - points[point_index] = point; normals[point_index] = normal; tangents[point_index * 4 + 0] = 1.0f; diff --git a/extension/src/MapSingleton.cpp b/extension/src/MapSingleton.cpp index 0f5fe7c..73cf522 100644 --- a/extension/src/MapSingleton.cpp +++ b/extension/src/MapSingleton.cpp @@ -11,21 +11,50 @@ 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_province_index_from_uv_coords", "coords"), &MapSingleton::get_province_index_from_uv_coords); + ClassDB::bind_method(D_METHOD("get_province_identifier_from_uv_coords", "coords"), &MapSingleton::get_province_identifier_from_uv_coords); ClassDB::bind_method(D_METHOD("get_width"), &MapSingleton::get_width); ClassDB::bind_method(D_METHOD("get_height"), &MapSingleton::get_height); ClassDB::bind_method(D_METHOD("get_province_index_image"), &MapSingleton::get_province_index_image); ClassDB::bind_method(D_METHOD("get_province_colour_image"), &MapSingleton::get_province_colour_image); + + ClassDB::bind_method(D_METHOD("update_colour_image"), &MapSingleton::update_colour_image); + ClassDB::bind_method(D_METHOD("get_mapmode_count"), &MapSingleton::get_mapmode_count); + ClassDB::bind_method(D_METHOD("get_mapmode_identifier", "index"), &MapSingleton::get_mapmode_identifier); + ClassDB::bind_method(D_METHOD("set_mapmode", "identifier"), &MapSingleton::set_mapmode); } MapSingleton* MapSingleton::get_singleton() { return singleton; } +/* REQUIREMENTS: + * MAP-21, MAP-25 + */ MapSingleton::MapSingleton() { ERR_FAIL_COND(singleton != nullptr); singleton = this; + + using mapmode_t = std::pair; + const std::vector mapmodes = { + { "mapmode_province", [](Map const&, Province const& province) -> Province::colour_t { return province.get_colour(); } }, + { "mapmode_region", [](Map const&, Province const& province) -> Province::colour_t { + Region const* region = province.get_region(); + if (region != nullptr) return region->get_provinces().front()->get_colour(); + return province.get_colour(); + } }, + { "mapmode_index", [](Map const& map, Province const& province) -> Province::colour_t { + const uint8_t f = float(province.get_index()) / float(map.get_province_count()) * 255.0f; + return (f << 16) | (f << 8) | f; + } } + }; + std::string error_message = ""; + for (mapmode_t mapmode : mapmodes) + if (map.add_mapmode(mapmode.first, mapmode.second, error_message) != SUCCESS) + UtilityFunctions::push_error(error_message.c_str()); } MapSingleton::~MapSingleton() { @@ -33,172 +62,171 @@ MapSingleton::~MapSingleton() { singleton = nullptr; } -Error MapSingleton::load_province_identifier_file(String const& file_path) { - UtilityFunctions::print("Loading identifier file: ", file_path); +Error MapSingleton::parse_json_dictionary_file(String const& file_description, String const& file_path, + String const& identifier_prefix, parse_json_entry_func_t parse_entry) const { + UtilityFunctions::print("Loading ", file_description, " file: ", file_path); Ref 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.instantiate(); err = json->parse(json_string); - if (err) { - UtilityFunctions::push_error("Failed to parse province identifier file as JSON: ", file_path, + if (err != OK) { + 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(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 (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(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) != SUCCESS) { + 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](String const& identifier, Variant const& entry) -> Error { + return this->_parse_province_identifier_entry(identifier, entry); + }); map.lock_provinces(); 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]; +Error MapSingleton::_parse_region_entry(String const& identifier, Variant const& entry) { + Error err = OK; + Variant::Type type = entry.get_type(); + std::vector 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) != SUCCESS) { + 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](String const& identifier, Variant const& entry) -> Error { + return this->_parse_region_entry(identifier, entry); + }); + map.lock_regions(); + return err; } Error MapSingleton::load_province_shape_file(String const& file_path) { - if (province_shape_image.is_valid()) { + if (province_index_image.is_valid()) { UtilityFunctions::push_error("Province shape file has already been loaded, cannot load: ", file_path); return FAILED; } + Ref province_shape_image; province_shape_image.instantiate(); Error err = province_shape_image->load(file_path); if (err != OK) { UtilityFunctions::push_error("Failed to load province shape file: ", file_path); - province_shape_image.unref(); return err; } - width = province_shape_image->get_width(); - height = province_shape_image->get_height(); + int32_t width = province_shape_image->get_width(); + int32_t height = province_shape_image->get_height(); if (width < 1 || height < 1) { UtilityFunctions::push_error("Invalid dimensions (", width, "x", height, ") for province shape file: ", 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; } - if (err) { - province_shape_image.unref(); - return err; - } + if (err != OK) return err; - std::vector province_checklist(map.get_province_count()); - - PackedByteArray shape_data_array = province_shape_image->get_data(), index_data_array; - index_data_array.resize(width * height * sizeof(Province::index_t)); - Province::index_t* index_data = reinterpret_cast(index_data_array.ptrw()); - - for (int32_t y = 0; y < height; ++y) { - for (int32_t x = 0; x < width; ++x) { - const int32_t idx = x + y * width; - const Province::colour_t colour = colour_at(shape_data_array, idx); - if (colour == Province::NULL_COLOUR) { - index_data[idx] = Province::NULL_INDEX; - continue; - } - if (x > 0) { - const int32_t jdx = idx - 1; - if (colour_at(shape_data_array, jdx) == colour) { - index_data[idx] = index_data[jdx]; - continue; - } - } - if (y > 0) { - const int32_t jdx = idx - width; - if (colour_at(shape_data_array, jdx) == colour) { - index_data[idx] = index_data[jdx]; - continue; - } - } - const Province* province = map.get_province_by_colour(colour); - if (province) { - Province::index_t index = province->get_index(); - index_data[idx] = index; - province_checklist[index - 1] = true; - continue; - } - UtilityFunctions::push_error("Unrecognised province colour ", Province::colour_to_hex_string(colour).c_str(), " at (", x, ", ", y, ")"); - err = FAILED; - index_data[idx] = Province::NULL_INDEX; - } + std::string error_message = ""; + if (map.generate_province_index_image(width, height, province_shape_image->get_data().ptr(), error_message) != SUCCESS) { + UtilityFunctions::push_error(error_message.c_str()); + err = FAILED; } - for (size_t idx = 0; idx < province_checklist.size(); ++idx) { - if (!province_checklist[idx]) { - Province* province = map.get_province_by_index(idx + 1); - if (province) UtilityFunctions::push_error("Province missing from shape image: ", province->to_string().c_str()); - else UtilityFunctions::push_error("Province missing for index: ", static_cast(idx + 1)); - err = FAILED; - } - } + PackedByteArray index_data_array; + index_data_array.resize(width * height * sizeof(Province::index_t)); + memcpy(index_data_array.ptrw(), map.get_province_index_image().data(), index_data_array.size()); province_index_image = Image::create_from_data(width, height, false, Image::FORMAT_RG8, index_data_array); if (province_index_image.is_null()) { @@ -206,45 +234,51 @@ Error MapSingleton::load_province_shape_file(String const& file_path) { err = FAILED; } - PackedByteArray colour_data_array; - colour_data_array.resize((Province::MAX_INDEX + 1) * 3); - for (size_t idx = 1; idx <= map.get_province_count(); ++idx) { - const Province* province = map.get_province_by_index(idx); - if (province) { - const Province::colour_t colour = province->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; - } else UtilityFunctions::push_error("Missing province at index ", static_cast(idx)); - } - static const int32_t PROVINCE_INDEX_SQRT = 1 << (sizeof(Province::index_t) * 4); - province_colour_image = Image::create_from_data(PROVINCE_INDEX_SQRT, PROVINCE_INDEX_SQRT, false, Image::FORMAT_RGB8, colour_data_array); - if (province_colour_image.is_null()) { - UtilityFunctions::push_error("Failed to create province colour image"); - err = FAILED; - } + if (update_colour_image() != OK) err = FAILED; return err; } -String MapSingleton::get_province_identifier_from_pixel_coords(Vector2i const& coords) { +Province* MapSingleton::get_province_from_uv_coords(godot::Vector2 const& coords) { + if (province_index_image.is_valid()) { + const PackedByteArray index_data_array = province_index_image->get_data(); + Province::index_t const* index_data = reinterpret_cast(index_data_array.ptr()); + const int32_t x_mod_w = UtilityFunctions::fposmod(coords.x, 1.0f) * get_width(); + const int32_t y_mod_h = UtilityFunctions::fposmod(coords.y, 1.0f) * get_height(); + return map.get_province_by_index(index_data[x_mod_w + y_mod_h * get_width()]); + } + return nullptr; +} + +Province const* MapSingleton::get_province_from_uv_coords(godot::Vector2 const& coords) const { if (province_index_image.is_valid()) { const PackedByteArray index_data_array = province_index_image->get_data(); - const Province::index_t* index_data = reinterpret_cast(index_data_array.ptr()); - const int32_t x_mod_w = UtilityFunctions::posmod(coords.x, width); - const int32_t y_mod_h = UtilityFunctions::posmod(coords.y, height); - const Province* province = map.get_province_by_index(index_data[x_mod_w + y_mod_h * width]); - if (province) return province->get_identifier().c_str(); + Province::index_t const* index_data = reinterpret_cast(index_data_array.ptr()); + const int32_t x_mod_w = UtilityFunctions::fposmod(coords.x, 1.0f) * get_width(); + const int32_t y_mod_h = UtilityFunctions::fposmod(coords.y, 1.0f) * get_height(); + return map.get_province_by_index(index_data[x_mod_w + y_mod_h * get_width()]); } + return nullptr; +} + +int32_t MapSingleton::get_province_index_from_uv_coords(Vector2 const& coords) const { + Province const* province = get_province_from_uv_coords(coords); + if (province != nullptr) return province->get_index(); + return Province::NULL_INDEX; +} + +String MapSingleton::get_province_identifier_from_uv_coords(Vector2 const& coords) const { + Province const* province = get_province_from_uv_coords(coords); + if (province != nullptr) return province->get_identifier().c_str(); return String{}; } int32_t MapSingleton::get_width() const { - return width; + return map.get_width(); } int32_t MapSingleton::get_height() const { - return height; + return map.get_height(); } Ref MapSingleton::get_province_index_image() const { @@ -254,3 +288,48 @@ Ref MapSingleton::get_province_index_image() const { Ref MapSingleton::get_province_colour_image() const { return province_colour_image; } + +Error MapSingleton::update_colour_image() { + static PackedByteArray colour_data_array; + static const int64_t colour_data_array_size = (Province::MAX_INDEX + 1) * 3; + colour_data_array.resize(colour_data_array_size); + + Error err = OK; + std::string error_message = ""; + if (map.generate_mapmode_colours(mapmode_index, colour_data_array.ptrw(), error_message) != SUCCESS) { + UtilityFunctions::push_error(error_message.c_str()); + err = FAILED; + } + + static const int32_t PROVINCE_INDEX_SQRT = 1 << (sizeof(Province::index_t) * 4); + if (province_colour_image.is_null()) + province_colour_image.instantiate(); + province_colour_image->set_data(PROVINCE_INDEX_SQRT, PROVINCE_INDEX_SQRT, + false, Image::FORMAT_RGB8, colour_data_array); + if (province_colour_image.is_null()) { + UtilityFunctions::push_error("Failed to update province colour image"); + return FAILED; + } + return err; +} + +int32_t MapSingleton::get_mapmode_count() const { + return map.get_mapmode_count(); +} + +String MapSingleton::get_mapmode_identifier(int32_t index) const { + Mapmode const* mapmode = map.get_mapmode_by_index(index); + if (mapmode != nullptr) return mapmode->get_identifier().c_str(); + return String{}; +} + +Error MapSingleton::set_mapmode(godot::String const& identifier) { + Mapmode const* mapmode = map.get_mapmode_by_identifier(identifier.utf8().get_data()); + if (mapmode != nullptr) { + mapmode_index = mapmode->get_index(); + return OK; + } else { + UtilityFunctions::push_error("Failed to set mapmode to: ", identifier); + return FAILED; + } +} diff --git a/extension/src/MapSingleton.hpp b/extension/src/MapSingleton.hpp index 71761cd..9205e92 100644 --- a/extension/src/MapSingleton.hpp +++ b/extension/src/MapSingleton.hpp @@ -1,19 +1,27 @@ #pragma once +#include + #include + #include "openvic2/Map.hpp" namespace OpenVic2 { class MapSingleton : public godot::Object { + using parse_json_entry_func_t = std::function; GDCLASS(MapSingleton, godot::Object) static MapSingleton* singleton; - godot::Ref province_shape_image, province_index_image, province_colour_image; - int32_t width = 0, height = 0; + godot::Ref province_index_image, province_colour_image; Map map; + Mapmode::index_t mapmode_index = 0; + godot::Error parse_json_dictionary_file(godot::String const& file_description, godot::String const& file_path, + godot::String const& identifier_prefix, parse_json_entry_func_t parse_entry) const; + 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(); @@ -24,11 +32,21 @@ 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); + + Province* get_province_from_uv_coords(godot::Vector2 const& coords); + Province const* get_province_from_uv_coords(godot::Vector2 const& coords) const; + int32_t get_province_index_from_uv_coords(godot::Vector2 const& coords) const; + godot::String get_province_identifier_from_uv_coords(godot::Vector2 const& coords) const; int32_t get_width() const; int32_t get_height() const; godot::Ref get_province_index_image() const; godot::Ref get_province_colour_image() const; + + godot::Error update_colour_image(); + int32_t get_mapmode_count() const; + godot::String get_mapmode_identifier(int32_t index) const; + godot::Error set_mapmode(godot::String const& identifier); }; } diff --git a/extension/src/Simulation.hpp b/extension/src/Simulation.hpp index 8959310..b84016b 100644 --- a/extension/src/Simulation.hpp +++ b/extension/src/Simulation.hpp @@ -1,8 +1,6 @@ #pragma once -#include #include -#include #include namespace OpenVic2 { @@ -11,7 +9,7 @@ namespace OpenVic2 { std::vector exampleProvinces; //BEGIN BOILERPLATE - static Simulation* _simulation; + inline static Simulation* _simulation = nullptr; protected: static void _bind_methods() { @@ -47,6 +45,4 @@ namespace OpenVic2 { return exampleProvinces[provinceID]; } }; - - Simulation* Simulation::_simulation = nullptr; } diff --git a/extension/src/TestSingleton.hpp b/extension/src/TestSingleton.hpp index d140516..1261573 100644 --- a/extension/src/TestSingleton.hpp +++ b/extension/src/TestSingleton.hpp @@ -1,7 +1,6 @@ #pragma once #include -#include namespace OpenVic2 { class TestSingleton : public godot::Object diff --git a/extension/src/openvic2/Map.cpp b/extension/src/openvic2/Map.cpp index d980b88..1654189 100644 --- a/extension/src/openvic2/Map.cpp +++ b/extension/src/openvic2/Map.cpp @@ -1,73 +1,126 @@ #include "Map.hpp" #include -#include -#include using namespace OpenVic2; -Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : - index(new_index), identifier(new_identifier), colour(new_colour) { - assert(index != NULL_INDEX); - assert(!identifier.empty()); - assert(colour != NULL_COLOUR); -} +static const std::string SEPARATOR = "\n - "; -std::string Province::colour_to_hex_string(colour_t colour) { - std::ostringstream stream; - stream << std::hex << std::setfill('0') << std::setw(6) << colour; - return stream.str(); +Mapmode::Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func) + : index(new_index), identifier(new_identifier), colour_func(new_colour_func) { + assert(!identifier.empty()); + assert(colour_func != nullptr); } -Province::index_t Province::get_index() const { +Mapmode::index_t Mapmode::get_index() const { return index; } -std::string const& Province::get_identifier() const { +std::string const& Mapmode::get_identifier() const { return identifier; } -Province::colour_t Province::get_colour() const { - return colour; -} - -std::string Province::to_string() const { - return "(#" + std::to_string(index) + ", " + identifier + ", 0x" + colour_to_hex_string(colour) + ")"; +Mapmode::colour_func_t Mapmode::get_colour_func() const { + return colour_func; } -bool Map::add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message) { +return_t 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!"; - return false; + return FAILURE; } if (provinces.size() >= Province::MAX_INDEX) { error_message = "The map's province list is full - there can be at most " + std::to_string(Province::MAX_INDEX) + " provinces"; - return false; + return FAILURE; + } + if (identifier.empty()) { + error_message = "Empty province identifier for colour " + Province::colour_to_hex_string(colour); + return FAILURE; } if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) { error_message = "Invalid province colour: " + Province::colour_to_hex_string(colour); - return false; + return FAILURE; } Province new_province{ static_cast(provinces.size() + 1), identifier, colour }; for (Province const& province : provinces) { - if (province.identifier == identifier) { + if (province.get_identifier() == identifier) { error_message = "Duplicate province identifiers: " + province.to_string() + " and " + new_province.to_string(); - return false; + return FAILURE; } - if (province.colour == colour) { + if (province.get_colour() == colour) { error_message = "Duplicate province colours: " + province.to_string() + " and " + new_province.to_string(); - return false; + return FAILURE; } } provinces.push_back(new_province); error_message = "Added province: " + new_province.to_string(); - return true; + return SUCCESS; } void Map::lock_provinces() { provinces_locked = true; } +return_t Map::add_region(std::string const& identifier, std::vector const& province_identifiers, std::string& error_message) { + if (regions_locked) { + error_message = "The map's region list has already been locked!"; + return FAILURE; + } + if (identifier.empty()) { + error_message = "Empty region identifier!"; + return FAILURE; + } + if (provinces.empty()) { + error_message = "Empty province list for region " + identifier; + return FAILURE; + } + Region new_region{ identifier }; + error_message = "Error message for region: " + identifier; + for (std::string const& province_identifier : province_identifiers) { + Province* province = get_province_by_identifier(province_identifier); + if (province != nullptr) { + if (new_region.contains_province(province)) + error_message += SEPARATOR + "Duplicate province identifier " + province_identifier; + else { + size_t other_region_index = reinterpret_cast(province->get_region()); + if (other_region_index != 0) { + other_region_index--; + error_message += SEPARATOR + "Province " + province_identifier + " is already part of "; + 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 FAILURE; + } + for (Region const& region : regions) { + if (region.get_identifier() == identifier) { + error_message += SEPARATOR + "Duplicate region identifiers: " + region.get_identifier() + " and " + identifier; + return FAILURE; + } + } + 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(regions.size()); + for (Province* province : new_region.get_provinces()) + province->region = tmp_region_index; + return SUCCESS; +} + +void Map::lock_regions() { + regions_locked = true; + for (Region& region : regions) + for (Province* province : region.get_provinces()) + province->region = ®ion; +} + size_t Map::get_province_count() const { return provinces.size(); } @@ -76,14 +129,178 @@ Province* Map::get_province_by_index(Province::index_t index) { return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; } +Province const* Map::get_province_by_index(Province::index_t index) const { + return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; +} + Province* Map::get_province_by_identifier(std::string const& identifier) { - for (Province& province : provinces) - if (province.identifier == identifier) return &province; + if (!identifier.empty()) + for (Province& province : provinces) + if (province.get_identifier() == identifier) return &province; + return nullptr; +} + +Province const* Map::get_province_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (Province const& province : provinces) + if (province.get_identifier() == identifier) return &province; return nullptr; } Province* Map::get_province_by_colour(Province::colour_t colour) { - for (Province& province : provinces) - if (province.colour == colour) return &province; + if (colour != Province::NULL_COLOUR) + for (Province& province : provinces) + if (province.get_colour() == colour) return &province; + return nullptr; +} + +Province const* Map::get_province_by_colour(Province::colour_t colour) const { + if (colour != Province::NULL_COLOUR) + for (Province const& province : provinces) + if (province.get_colour() == colour) return &province; + return nullptr; +} + +static Province::colour_t colour_at(uint8_t const* colour_data, int32_t idx) { + return (colour_data[idx * 3] << 16) | (colour_data[idx * 3 + 1] << 8) | colour_data[idx * 3 + 2]; +} + +return_t Map::generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message) { + if (!province_index_image.empty()) { + error_message = "Province index image has already been generated!"; + return FAILURE; + } + if (!provinces_locked) { + error_message = "Province index image cannot be generated until after provinces are locked!"; + return FAILURE; + } + if (new_width < 1 || new_height < 1) { + error_message = "Invalid province image dimensions: " + std::to_string(new_width) + "x" + std::to_string(new_height); + return FAILURE; + } + if (colour_data == nullptr) { + error_message = "Province colour data pointer is null!"; + return FAILURE; + } + width = new_width; + height = new_height; + province_index_image.resize(width * height); + + std::vector province_checklist(provinces.size()); + return_t ret = SUCCESS; + + error_message = "Error message for province index image generation:"; + + for (int32_t y = 0; y < height; ++y) { + for (int32_t x = 0; x < width; ++x) { + const int32_t idx = x + y * width; + const Province::colour_t colour = colour_at(colour_data, idx); + if (colour == Province::NULL_COLOUR) { + province_index_image[idx] = Province::NULL_INDEX; + continue; + } + if (x > 0) { + const int32_t jdx = idx - 1; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + if (y > 0) { + const int32_t jdx = idx - width; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + Province const* province = get_province_by_colour(colour); + if (province != nullptr) { + const Province::index_t index = province->get_index(); + province_index_image[idx] = index; + province_checklist[index - 1] = true; + continue; + } + error_message += SEPARATOR + "Unrecognised province colour " + Province::colour_to_hex_string(colour) + " at (" + std::to_string(x) + ", " + std::to_string(x) + ")"; + ret = FAILURE; + province_index_image[idx] = Province::NULL_INDEX; + } + } + + for (size_t idx = 0; idx < province_checklist.size(); ++idx) { + if (!province_checklist[idx]) { + error_message += SEPARATOR + "Province missing from shape image: " + provinces[idx].to_string(); + ret = FAILURE; + } + } + + error_message += SEPARATOR + "Generated province index image"; + return ret; +} + +size_t Map::get_width() const { + return width; +} + +size_t Map::get_height() const { + return height; +} + +std::vector const& Map::get_province_index_image() const { + return province_index_image; +} + +return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message) { + if (identifier.empty()) { + error_message = "Empty mapmode identifier!"; + return FAILURE; + } + if (colour_func == nullptr) { + error_message = "Mapmode colour function is null for identifier: " + identifier; + return FAILURE; + } + Mapmode new_mapmode{ mapmodes.size(), identifier, colour_func }; + for (Mapmode const& mapmode : mapmodes) { + if (mapmode.get_identifier() == identifier) { + error_message = "Duplicate mapmode identifiers: " + mapmode.get_identifier() + " and " + identifier; + return FAILURE; + } + } + mapmodes.push_back(new_mapmode); + error_message = "Added mapmode: " + identifier; + return SUCCESS; +} + +size_t Map::get_mapmode_count() const { + return mapmodes.size(); +} + +Mapmode const* Map::get_mapmode_by_index(size_t index) const { + return index < mapmodes.size() ? &mapmodes[index] : nullptr; +} + +Mapmode const* Map::get_mapmode_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (Mapmode const& mapmode : mapmodes) + if (mapmode.get_identifier() == identifier) return &mapmode; return nullptr; } + +return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const { + if (target == nullptr) { + error_message = "Mapmode colour target pointer is null!"; + return FAILURE; + } + if (index >= mapmodes.size()) { + error_message = "Invalid mapmode index: " + std::to_string(index); + return FAILURE; + } + Mapmode const& mapmode = mapmodes[index]; + target += 3; // Skip past Province::NULL_INDEX + for (Province const& province : provinces) { + const Province::colour_t colour = mapmode.get_colour_func()(*this, province); + *target++ = (colour >> 16) & 0xFF; + *target++ = (colour >> 8) & 0xFF; + *target++ = colour & 0xFF; + } + return SUCCESS; +} diff --git a/extension/src/openvic2/Map.hpp b/extension/src/openvic2/Map.hpp index 365d78b..42963c9 100644 --- a/extension/src/openvic2/Map.hpp +++ b/extension/src/openvic2/Map.hpp @@ -3,43 +3,111 @@ #include #include #include +#include + +#include "Types.hpp" namespace OpenVic2 { + struct Region; + struct Map; + /* REQUIREMENTS: + * MAP-43, MAP-47 + */ struct Province { + friend struct Map; + using colour_t = uint32_t; using index_t = uint16_t; - friend struct Map; + static const colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF; static const index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF; private: index_t index; std::string identifier; colour_t colour; + Region* region = nullptr; - Province(index_t index, std::string const& identifier, colour_t colour); + 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); 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; }; + /* REQUIREMENTS: + * MAP-6, MAP-44, MAP-48 + */ + struct Region { + friend struct Map; + private: + std::string identifier; + std::vector 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 const& get_provinces() const; + }; + + struct Mapmode { + friend struct Map; + + using colour_func_t = std::function; + using index_t = size_t; + private: + index_t index; + std::string identifier; + colour_func_t colour_func; + + Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func); + public: + index_t get_index() const; + std::string const& get_identifier() const; + colour_func_t get_colour_func() const; + }; + + /* REQUIREMENTS: + * MAP-4 + */ struct Map { private: std::vector provinces; - bool provinces_locked = false; + std::vector regions; + bool provinces_locked = false, regions_locked = false; + size_t width = 0, height = 0; + std::vector province_index_image; + std::vector mapmodes; public: - bool add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message); + return_t add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message); void lock_provinces(); + return_t add_region(std::string const& identifier, std::vector 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); + Province const* get_province_by_index(Province::index_t index) const; Province* get_province_by_identifier(std::string const& identifier); + Province const* get_province_by_identifier(std::string const& identifier) const; Province* get_province_by_colour(Province::colour_t colour); - }; + Province const* get_province_by_colour(Province::colour_t colour) const; + + return_t generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message); + size_t get_width() const; + size_t get_height() const; + std::vector const& get_province_index_image() const; + return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message); + size_t get_mapmode_count() const; + Mapmode const* get_mapmode_by_index(Mapmode::index_t index) const; + Mapmode const* get_mapmode_by_identifier(std::string const& identifier) const; + return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const; + }; } diff --git a/extension/src/openvic2/Province.cpp b/extension/src/openvic2/Province.cpp new file mode 100644 index 0000000..49f1b0e --- /dev/null +++ b/extension/src/openvic2/Province.cpp @@ -0,0 +1,40 @@ +#include "Map.hpp" + +#include +#include +#include + +using namespace OpenVic2; + +Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : + index(new_index), identifier(new_identifier), colour(new_colour) { + assert(index != NULL_INDEX); + assert(!identifier.empty()); + assert(colour != NULL_COLOUR); +} + +std::string Province::colour_to_hex_string(colour_t colour) { + std::ostringstream stream; + stream << std::hex << std::setfill('0') << std::setw(6) << colour; + return stream.str(); +} + +Province::index_t Province::get_index() const { + return index; +} + +std::string const& Province::get_identifier() const { + return identifier; +} + +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) + ")"; +} diff --git a/extension/src/openvic2/Region.cpp b/extension/src/openvic2/Region.cpp new file mode 100644 index 0000000..6ee05f5 --- /dev/null +++ b/extension/src/openvic2/Region.cpp @@ -0,0 +1,26 @@ +#include "Map.hpp" + +#include +#include + +using namespace OpenVic2; + +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 const& Region::get_provinces() const { + return provinces; +} diff --git a/extension/src/openvic2/Types.hpp b/extension/src/openvic2/Types.hpp new file mode 100644 index 0000000..0fb1c8b --- /dev/null +++ b/extension/src/openvic2/Types.hpp @@ -0,0 +1,7 @@ +#pragma once + +namespace OpenVic2 { + using return_t = bool; + // This mirrors godot::Error, where `OK = 0` and `FAILED = 1`. + static const return_t SUCCESS = false, FAILURE = true; +} diff --git a/extension/src/register_types.cpp b/extension/src/register_types.cpp index 16e59b2..9fd934e 100644 --- a/extension/src/register_types.cpp +++ b/extension/src/register_types.cpp @@ -1,8 +1,5 @@ #include "register_types.h" -#include -#include -#include -#include + #include #include "TestSingleton.hpp" @@ -74,7 +71,7 @@ extern "C" { // Initialization. - GDExtensionBool GDE_EXPORT openvic2_library_init(const GDExtensionInterface* p_interface, const GDExtensionClassLibraryPtr p_library, GDExtensionInitialization* r_initialization) { + GDExtensionBool GDE_EXPORT openvic2_library_init(GDExtensionInterface const* p_interface, const GDExtensionClassLibraryPtr p_library, GDExtensionInitialization* r_initialization) { GDExtensionBinding::InitObject init_obj(p_interface, p_library, r_initialization); init_obj.register_initializer(initialize_openvic2_types); diff --git a/extension/src/register_types.h b/extension/src/register_types.h index 860359f..1bc96f8 100644 --- a/extension/src/register_types.h +++ b/extension/src/register_types.h @@ -1,6 +1,6 @@ #pragma once -#include +#include void initialize_openvic2_types(godot::ModuleInitializationLevel); void uninitialize_openvic2_types(godot::ModuleInitializationLevel); \ No newline at end of file diff --git a/game/art/terrain/terrain.png b/game/art/terrain/terrain.png new file mode 100644 index 0000000..6d36dee Binary files /dev/null and b/game/art/terrain/terrain.png differ diff --git a/game/art/terrain/terrain.png.import b/game/art/terrain/terrain.png.import new file mode 100644 index 0000000..d7a078f --- /dev/null +++ b/game/art/terrain/terrain.png.import @@ -0,0 +1,34 @@ +[remap] + +importer="texture" +type="CompressedTexture2D" +uid="uid://cmw0pvjthnn8c" +path="res://.godot/imported/terrain.png-06c63c2b87b3131a2067f668f87a9d67.ctex" +metadata={ +"vram_texture": false +} + +[deps] + +source_file="res://art/terrain/terrain.png" +dest_files=["res://.godot/imported/terrain.png-06c63c2b87b3131a2067f668f87a9d67.ctex"] + +[params] + +compress/mode=3 +compress/high_quality=false +compress/lossy_quality=0.7 +compress/hdr_compression=1 +compress/normal_map=2 +compress/channel_pack=0 +mipmaps/generate=true +mipmaps/limit=-1 +roughness/mode=0 +roughness/src_normal="" +process/fix_alpha_border=false +process/premult_alpha=false +process/normal_map_invert_y=false +process/hdr_as_srgb=false +process/hdr_clamp_exposure=false +process/size_limit=0 +detect_3d/compress_to=0 diff --git a/game/art/ui/minimap.png b/game/art/ui/minimap.png new file mode 100644 index 0000000..9922b28 Binary files /dev/null and b/game/art/ui/minimap.png differ diff --git a/game/art/ui/minimap.png.import b/game/art/ui/minimap.png.import new file mode 100644 index 0000000..36f22e7 --- /dev/null +++ b/game/art/ui/minimap.png.import @@ -0,0 +1,34 @@ +[remap] + +importer="texture" +type="CompressedTexture2D" +uid="uid://c0sm1jfu4kyv3" +path="res://.godot/imported/minimap.png-05ee44469856e77fd05107fe9e259e25.ctex" +metadata={ +"vram_texture": false +} + +[deps] + +source_file="res://art/ui/minimap.png" +dest_files=["res://.godot/imported/minimap.png-05ee44469856e77fd05107fe9e259e25.ctex"] + +[params] + +compress/mode=3 +compress/high_quality=false +compress/lossy_quality=0.7 +compress/hdr_compression=1 +compress/normal_map=2 +compress/channel_pack=0 +mipmaps/generate=false +mipmaps/limit=-1 +roughness/mode=0 +roughness/src_normal="" +process/fix_alpha_border=false +process/premult_alpha=false +process/normal_map_invert_y=false +process/hdr_as_srgb=false +process/hdr_clamp_exposure=false +process/size_limit=0 +detect_3d/compress_to=0 diff --git a/game/art/ui/minimap_frame.png b/game/art/ui/minimap_frame.png new file mode 100644 index 0000000..21aa2ce Binary files /dev/null and b/game/art/ui/minimap_frame.png differ diff --git a/game/art/ui/minimap_frame.png.import b/game/art/ui/minimap_frame.png.import new file mode 100644 index 0000000..3d2aeee --- /dev/null +++ b/game/art/ui/minimap_frame.png.import @@ -0,0 +1,34 @@ +[remap] + +importer="texture" +type="CompressedTexture2D" +uid="uid://vr1hq2stk8ny" +path="res://.godot/imported/minimap_frame.png-3668393435d2582fb1dc8a9598573e80.ctex" +metadata={ +"vram_texture": false +} + +[deps] + +source_file="res://art/ui/minimap_frame.png" +dest_files=["res://.godot/imported/minimap_frame.png-3668393435d2582fb1dc8a9598573e80.ctex"] + +[params] + +compress/mode=3 +compress/high_quality=false +compress/lossy_quality=0.7 +compress/hdr_compression=1 +compress/normal_map=2 +compress/channel_pack=0 +mipmaps/generate=false +mipmaps/limit=-1 +roughness/mode=0 +roughness/src_normal="" +process/fix_alpha_border=false +process/premult_alpha=false +process/normal_map_invert_y=false +process/hdr_as_srgb=false +process/hdr_clamp_exposure=false +process/size_limit=0 +detect_3d/compress_to=0 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/common/map/terrain/terrain.png b/game/common/map/terrain/terrain.png deleted file mode 100644 index 6d36dee..0000000 Binary files a/game/common/map/terrain/terrain.png and /dev/null differ diff --git a/game/common/map/terrain/terrain.png.import b/game/common/map/terrain/terrain.png.import deleted file mode 100644 index 56ba5dc..0000000 --- a/game/common/map/terrain/terrain.png.import +++ /dev/null @@ -1,34 +0,0 @@ -[remap] - -importer="texture" -type="CompressedTexture2D" -uid="uid://cmw0pvjthnn8c" -path="res://.godot/imported/terrain.png-c443b8a709ca7acc4b3bb3df1d3095a9.ctex" -metadata={ -"vram_texture": false -} - -[deps] - -source_file="res://common/map/terrain/terrain.png" -dest_files=["res://.godot/imported/terrain.png-c443b8a709ca7acc4b3bb3df1d3095a9.ctex"] - -[params] - -compress/mode=3 -compress/high_quality=false -compress/lossy_quality=0.7 -compress/hdr_compression=1 -compress/normal_map=2 -compress/channel_pack=0 -mipmaps/generate=true -mipmaps/limit=-1 -roughness/mode=0 -roughness/src_normal="" -process/fix_alpha_border=true -process/premult_alpha=false -process/normal_map_invert_y=false -process/hdr_as_srgb=false -process/hdr_clamp_exposure=false -process/size_limit=0 -detect_3d/compress_to=0 diff --git a/game/localisation/en_GB/mapmodes.csv b/game/localisation/en_GB/mapmodes.csv new file mode 100644 index 0000000..c5b1bb0 --- /dev/null +++ b/game/localisation/en_GB/mapmodes.csv @@ -0,0 +1,5 @@ + +,, Test Mapmodes +mapmode_province,Province Mapmode +mapmode_region,Region Mapmode +mapmode_index,Index Mapmode diff --git a/game/localisation/en_GB/mapmodes.csv.import b/game/localisation/en_GB/mapmodes.csv.import new file mode 100644 index 0000000..8dd0c09 --- /dev/null +++ b/game/localisation/en_GB/mapmodes.csv.import @@ -0,0 +1,3 @@ +[remap] + +importer="keep" diff --git a/game/src/Autoload/Events.gd b/game/src/Autoload/Events.gd index 040cb06..f4aac70 100644 --- a/game/src/Autoload/Events.gd +++ b/game/src/Autoload/Events.gd @@ -4,10 +4,15 @@ 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" +# REQUIREMENTS +# * FS-333, FS-335, FS-341 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") diff --git a/game/src/GameSession/GameSession.tscn b/game/src/GameSession/GameSession.tscn index 390040e..e270f8a 100644 --- a/game/src/GameSession/GameSession.tscn +++ b/game/src/GameSession/GameSession.tscn @@ -7,7 +7,7 @@ [ext_resource type="PackedScene" uid="uid://byq323jbel48u" path="res://src/GameSession/ProvinceOverviewPanel.tscn" id="5_osjnn"] [node name="GameSession" type="Node" node_paths=PackedStringArray("_game_session_menu")] -editor_description = "SS-102" +editor_description = "SS-102, UI-546" script = ExtResource("1_eklvp") _game_session_menu = NodePath("GameSessionMenu") @@ -29,6 +29,8 @@ anchor_left = 1.0 anchor_top = 1.0 anchor_right = 1.0 anchor_bottom = 1.0 +offset_left = -350.0 +offset_top = -210.0 grow_horizontal = 0 grow_vertical = 0 @@ -39,6 +41,11 @@ anchor_right = 0.15625 offset_top = 0.0 offset_right = 0.0 +[connection signal="map_view_camera_changed" from="MapView" to="MapControlPanel" method="_on_map_view_camera_changed"] [connection signal="province_selected" from="MapView" to="ProvinceOverviewPanel" method="_on_province_selected"] [connection signal="close_button_pressed" from="GameSessionMenu" to="." method="_on_game_session_menu_close_button_pressed"] [connection signal="game_session_menu_button_pressed" from="MapControlPanel" to="." method="_on_game_session_menu_button_pressed"] +[connection signal="mapmode_changed" from="MapControlPanel" to="MapView" method="_update_colour_texture"] +[connection signal="minimap_clicked" from="MapControlPanel" to="MapView" method="_on_minimap_clicked"] +[connection signal="mouse_entered" from="MapControlPanel" to="MapView" method="_on_mouse_exited_viewport"] +[connection signal="mouse_exited" from="MapControlPanel" to="MapView" method="_on_mouse_entered_viewport"] diff --git a/game/src/GameSession/MapControlPanel.gd b/game/src/GameSession/MapControlPanel.gd index ad56536..693890f 100644 --- a/game/src/GameSession/MapControlPanel.gd +++ b/game/src/GameSession/MapControlPanel.gd @@ -1,8 +1,46 @@ extends PanelContainer signal game_session_menu_button_pressed +signal mapmode_changed +signal map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) +signal minimap_clicked(pos_clicked : Vector2) + +@export var _mapmodes_grid : GridContainer + +var _mapmode_button_group : ButtonGroup + +# REQUIREMENTS: +# * UI-550, UI-554 +func _add_mapmode_button(identifier : String) -> void: + var button := Button.new() + button.text = identifier + button.tooltip_text = identifier + button.toggle_mode = true + button.button_group = _mapmode_button_group + _mapmodes_grid.add_child(button) + if _mapmode_button_group.get_pressed_button() == null: + button.button_pressed = true + +func _ready(): + _mapmode_button_group = ButtonGroup.new() + _mapmode_button_group.pressed.connect(_mapmode_pressed) + for index in MapSingleton.get_mapmode_count(): + _add_mapmode_button(MapSingleton.get_mapmode_identifier(index)) # REQUIREMENTS: # * UIFUN-10 -func _on_game_session_menu_button_pressed(): +func _on_game_session_menu_button_pressed() -> void: game_session_menu_button_pressed.emit() + +# REQUIREMENTS: +# * SS-76 +# * UIFUN-129, UIFUN-133 +func _mapmode_pressed(button : BaseButton) -> void: + MapSingleton.set_mapmode(button.tooltip_text) + mapmode_changed.emit() + +func _on_map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) -> void: + map_view_camera_changed.emit(near_left, far_left, far_right, near_right) + +func _on_minimap_clicked(pos_clicked : Vector2) -> void: + minimap_clicked.emit(pos_clicked) diff --git a/game/src/GameSession/MapControlPanel.tscn b/game/src/GameSession/MapControlPanel.tscn index 2a0c971..70d7eab 100644 --- a/game/src/GameSession/MapControlPanel.tscn +++ b/game/src/GameSession/MapControlPanel.tscn @@ -1,6 +1,9 @@ -[gd_scene load_steps=4 format=3 uid="uid://g524p8lr574w"] +[gd_scene load_steps=7 format=3 uid="uid://g524p8lr574w"] [ext_resource type="Script" path="res://src/GameSession/MapControlPanel.gd" id="1_ign64"] +[ext_resource type="Texture2D" uid="uid://c0sm1jfu4kyv3" path="res://art/ui/minimap.png" id="2_r613r"] +[ext_resource type="Script" path="res://src/GameSession/Minimap.gd" id="3_s4dml"] +[ext_resource type="Texture2D" uid="uid://vr1hq2stk8ny" path="res://art/ui/minimap_frame.png" id="4_f1exl"] [sub_resource type="InputEventAction" id="InputEventAction_5nck3"] action = &"ui_cancel" @@ -8,23 +11,42 @@ action = &"ui_cancel" [sub_resource type="Shortcut" id="Shortcut_fc1tk"] events = [SubResource("InputEventAction_5nck3")] -[node name="PanelContainer" type="PanelContainer"] +[node name="MapControlPanel" type="PanelContainer" node_paths=PackedStringArray("_mapmodes_grid")] editor_description = "SS-103" +mouse_filter = 1 script = ExtResource("1_ign64") +_mapmodes_grid = NodePath("HBoxContainer/VBoxContainer/MapmodesGrid") [node name="HBoxContainer" type="HBoxContainer" parent="."] layout_mode = 2 +alignment = 2 [node name="VBoxContainer" type="VBoxContainer" parent="HBoxContainer"] layout_mode = 2 -[node name="MapmodesPlaceholder" type="Label" parent="HBoxContainer/VBoxContainer"] +[node name="MapmodesGrid" type="GridContainer" parent="HBoxContainer/VBoxContainer"] +editor_description = "UI-750" layout_mode = 2 -text = "MAPMODES" +columns = 11 -[node name="MinimapPlaceholder" type="Label" parent="HBoxContainer/VBoxContainer"] +[node name="Minimap" type="PanelContainer" parent="HBoxContainer/VBoxContainer"] +editor_description = "UI-549" layout_mode = 2 -text = "MINIMAP" +mouse_filter = 1 + +[node name="TextureRect" type="TextureRect" parent="HBoxContainer/VBoxContainer/Minimap"] +editor_description = "UI-751, FS-338" +layout_mode = 2 +texture = ExtResource("2_r613r") + +[node name="ViewportQuad" type="Control" parent="HBoxContainer/VBoxContainer/Minimap"] +layout_mode = 2 +mouse_filter = 2 +script = ExtResource("3_s4dml") + +[node name="Frame" type="NinePatchRect" parent="HBoxContainer/VBoxContainer/Minimap"] +layout_mode = 2 +texture = ExtResource("4_f1exl") [node name="AuxiliaryPanel" type="VBoxContainer" parent="HBoxContainer"] editor_description = "UI-761" @@ -36,4 +58,6 @@ layout_mode = 2 shortcut = SubResource("Shortcut_fc1tk") text = "ESC" +[connection signal="map_view_camera_changed" from="." to="HBoxContainer/VBoxContainer/Minimap/ViewportQuad" method="_on_map_view_camera_changed"] +[connection signal="minimap_clicked" from="HBoxContainer/VBoxContainer/Minimap/ViewportQuad" to="." method="_on_minimap_clicked"] [connection signal="pressed" from="HBoxContainer/AuxiliaryPanel/GameSessionMenuButton" to="." method="_on_game_session_menu_button_pressed"] diff --git a/game/src/GameSession/MapView.gd b/game/src/GameSession/MapView.gd index faf90e8..54d8df8 100644 --- a/game/src/GameSession/MapView.gd +++ b/game/src/GameSession/MapView.gd @@ -1,6 +1,7 @@ extends Node3D signal province_selected(identifier : String) +signal map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) const _action_north : StringName = &"map_north" const _action_east : StringName = &"map_east" @@ -13,17 +14,19 @@ const _action_click : StringName = &"map_click" const _shader_param_province_index : StringName = &"province_index_tex" const _shader_param_province_colour : StringName = &"province_colour_tex" -const _shader_param_hover_pos : StringName = &"hover_pos" -const _shader_param_selected_pos : StringName = &"selected_pos" +const _shader_param_hover_index : StringName = &"hover_index" +const _shader_param_selected_index : StringName = &"selected_index" @export var _camera : Camera3D @export var _cardinal_move_speed : float = 1.0 -@export var _edge_move_threshold: float = 0.15 +@export var _edge_move_threshold: float = 0.02 @export var _edge_move_speed: float = 2.5 var _drag_anchor : Vector2 var _drag_active : bool = false +var _mouse_over_viewport : bool = false + @export var _zoom_target_min : float = 0.2 @export var _zoom_target_max : float = 5.0 @export var _zoom_target_step : float = 0.1 @@ -38,38 +41,33 @@ var _map_mesh : MapMesh var _map_shader_material : ShaderMaterial var _map_image_size : Vector2 var _map_province_index_image : Image +var _map_province_colour_image : Image +var _map_province_colour_texture : ImageTexture var _map_mesh_corner : Vector2 var _map_mesh_dims : Vector2 var _mouse_pos_viewport : Vector2 = Vector2(0.5, 0.5) var _mouse_pos_map : Vector2 = Vector2(0.5, 0.5) +var _viewport_dims : Vector2 = Vector2(1, 1) +# ??? Strange Godot/GDExtension Bug ??? +# Upon first opening a clone of this repo with the Godot Editor, +# if MapSingleton.get_province_index_image is called before MapMesh +# is referenced in the script below, then the editor will crash due +# to a failed HashMap lookup. I'm not sure if this is a bug in the +# editor, GDExtension, my own extension, or a combination of them. +# This was an absolute pain to track down. --- hop311 func _ready(): if _camera == null: push_error("MapView's _camera variable hasn't been set!") return + _zoom_target = _camera.position.y if _map_mesh_instance == null: push_error("MapView's _map_mesh variable hasn't been set!") return - if not _map_mesh_instance.mesh is MapMesh: - push_error("Invalid map mesh class: ", _map_mesh_instance.mesh.get_class(), "(expected MapMesh)") - return - _map_mesh = _map_mesh_instance.mesh - - # Set map mesh size and get bounds - _map_image_size = Vector2(Vector2i(MapSingleton.get_width(), MapSingleton.get_height())) - _map_mesh.aspect_ratio = _map_image_size.x / _map_image_size.y - var map_mesh_aabb := _map_mesh.get_core_aabb() * _map_mesh_instance.transform - _map_mesh_corner = Vector2( - min(map_mesh_aabb.position.x, map_mesh_aabb.end.x), - min(map_mesh_aabb.position.z, map_mesh_aabb.end.z) - ) - _map_mesh_dims = abs(Vector2( - map_mesh_aabb.position.x - map_mesh_aabb.end.x, - map_mesh_aabb.position.z - map_mesh_aabb.end.z - )) - var map_material = _map_mesh_instance.get_active_material(0) + # Shader Material + var map_material := _map_mesh_instance.get_active_material(0) if map_material == null: push_error("Map mesh is missing material!") return @@ -77,6 +75,7 @@ func _ready(): push_error("Invalid map mesh material class: ", map_material.get_class()) return _map_shader_material = map_material + # Province index texture _map_province_index_image = MapSingleton.get_province_index_image() if _map_province_index_image == null: @@ -84,22 +83,72 @@ func _ready(): return var province_index_texture := ImageTexture.create_from_image(_map_province_index_image) _map_shader_material.set_shader_parameter(_shader_param_province_index, province_index_texture) + # Province colour texture - var province_colour_image = MapSingleton.get_province_colour_image() - if province_colour_image == null: + _map_province_colour_image = MapSingleton.get_province_colour_image() + if _map_province_colour_image == null: push_error("Failed to get province colour image!") return - var province_colour_texture := ImageTexture.create_from_image(province_colour_image) - _map_shader_material.set_shader_parameter(_shader_param_province_colour, province_colour_texture) + _map_province_colour_texture = ImageTexture.create_from_image(_map_province_colour_image) + _map_shader_material.set_shader_parameter(_shader_param_province_colour, _map_province_colour_texture) + + if not _map_mesh_instance.mesh is MapMesh: + push_error("Invalid map mesh class: ", _map_mesh_instance.mesh.get_class(), "(expected MapMesh)") + return + _map_mesh = _map_mesh_instance.mesh + + # Set map mesh size and get bounds + _map_image_size = Vector2(Vector2i(MapSingleton.get_width(), MapSingleton.get_height())) + _map_mesh.aspect_ratio = _map_image_size.x / _map_image_size.y + var map_mesh_aabb := _map_mesh.get_core_aabb() * _map_mesh_instance.transform + _map_mesh_corner = Vector2( + min(map_mesh_aabb.position.x, map_mesh_aabb.end.x), + min(map_mesh_aabb.position.z, map_mesh_aabb.end.z) + ) + _map_mesh_dims = abs(Vector2( + map_mesh_aabb.position.x - map_mesh_aabb.end.x, + map_mesh_aabb.position.z - map_mesh_aabb.end.z + )) + +func _notification(what : int): + match what: + NOTIFICATION_WM_MOUSE_ENTER: # Mouse inside window + _on_mouse_entered_viewport() + NOTIFICATION_WM_MOUSE_EXIT: # Mouse out of window + _on_mouse_exited_viewport() + +func _update_colour_texture() -> void: + MapSingleton.update_colour_image() + _map_province_colour_texture.update(_map_province_colour_image) + +func _world_to_map_coords(pos : Vector3) -> Vector2: + return (Vector2(pos.x, pos.z) - _map_mesh_corner) / _map_mesh_dims + +func _viewport_to_map_coords(pos_viewport : Vector2) -> Vector2: + var ray_origin := _camera.project_ray_origin(pos_viewport) + var ray_normal := _camera.project_ray_normal(pos_viewport) + # Plane with normal (0,1,0) facing upwards, at a distance 0 from the origin + var intersection = Plane(0, 1, 0, 0).intersects_ray(ray_origin, ray_normal) + if typeof(intersection) == TYPE_VECTOR3: + return _world_to_map_coords(intersection as Vector3) + else: + # Normals parallel to the xz-plane could cause null intersections, + # but the camera's orientation should prevent such normals + push_error("Invalid intersection: ", intersection) + return Vector2(0.5, 0.5) +# REQUIREMENTS +# * SS-31 func _unhandled_input(event : InputEvent): if event.is_action_pressed(_action_click): # Check if the mouse is outside of bounds if _map_mesh.is_valid_uv_coord(_mouse_pos_map): - _map_shader_material.set_shader_parameter(_shader_param_selected_pos, _mouse_pos_map) - var mouse_pixel_pos := Vector2i(_mouse_pos_map * _map_image_size) - var province_identifier := MapSingleton.get_province_identifier_from_pixel_coords(mouse_pixel_pos) + var selected_index := MapSingleton.get_province_index_from_uv_coords(_mouse_pos_map) + _map_shader_material.set_shader_parameter(_shader_param_selected_index, selected_index) + var province_identifier := MapSingleton.get_province_identifier_from_uv_coords(_mouse_pos_map) province_selected.emit(province_identifier) + else: + print("Clicked outside the map!") elif event.is_action_pressed(_action_drag): if _drag_active: push_warning("Drag being activated while already active!") @@ -116,6 +165,7 @@ func _unhandled_input(event : InputEvent): func _physics_process(delta : float): _mouse_pos_viewport = get_viewport().get_mouse_position() + _viewport_dims = Vector2(Resolution.get_current_resolution()) # Process movement _movement_process(delta) # Keep within map bounds @@ -124,9 +174,13 @@ func _physics_process(delta : float): _zoom_process(delta) # Orient based on height _update_orientation() + # Update viewport on minimap + _update_minimap_viewport() # Calculate where the mouse lies on the map _update_mouse_map_position() +# REQUIREMENTS +# * UIFUN-124 func _movement_process(delta : float) -> void: var direction : Vector2 if _drag_active: @@ -137,13 +191,18 @@ func _movement_process(delta : float) -> void: direction *= _camera.position.y * delta _camera.position += Vector3(direction.x, 0, direction.y) +# REQUIREMENTS +# * UIFUN-125 func _edge_scrolling_vector() -> Vector2: - var viewport_dims := Vector2(Resolution.get_current_resolution()) - var mouse_vector := _mouse_pos_viewport / viewport_dims - Vector2(0.5, 0.5); - if pow(mouse_vector.x, 4) + pow(mouse_vector.y, 4) < pow(0.5 - _edge_move_threshold, 4): + if not _mouse_over_viewport: + return Vector2() + var mouse_vector := _mouse_pos_viewport / _viewport_dims - Vector2(0.5, 0.5) + if abs(mouse_vector.x) < 0.5 - _edge_move_threshold and abs(mouse_vector.y) < 0.5 - _edge_move_threshold: mouse_vector *= 0 return mouse_vector * _edge_move_speed +# REQUIREMENTS +# * SS-75 func _cardinal_movement_vector() -> Vector2: var move := Vector2( float(Input.is_action_pressed(_action_east)) - float(Input.is_action_pressed(_action_west)), @@ -155,6 +214,9 @@ func _clamp_over_map() -> void: _camera.position.x = _map_mesh_corner.x + fposmod(_camera.position.x - _map_mesh_corner.x, _map_mesh_dims.x) _camera.position.z = clamp(_camera.position.z, _map_mesh_corner.y, _map_mesh_corner.y + _map_mesh_dims.y) +# REQUIREMENTS +# * SS-74 +# * UIFUN-123 func _zoom_process(delta : float) -> void: var height := _camera.position.y var zoom := _zoom_target - height @@ -169,17 +231,27 @@ func _update_orientation() -> void: var dir := Vector3(0, -1, -exp(-_camera.position.y * 2.0 + 0.5)) _camera.look_at(_camera.position + dir) +func _update_minimap_viewport() -> void: + var near_left := _viewport_to_map_coords(Vector2(0, _viewport_dims.y)) + var far_left := _viewport_to_map_coords(Vector2(0, 0)) + var far_right := _viewport_to_map_coords(Vector2(_viewport_dims.x, 0)) + var near_right := _viewport_to_map_coords(_viewport_dims) + map_view_camera_changed.emit(near_left, far_left, far_right, near_right) + func _update_mouse_map_position() -> void: - var ray_origin := _camera.project_ray_origin(_mouse_pos_viewport) - var ray_normal := _camera.project_ray_normal(_mouse_pos_viewport) - # Plane with normal (0,1,0) facing upwards, at a distance 0 from the origin - var intersection = Plane(0, 1, 0, 0).intersects_ray(ray_origin, ray_normal) - if typeof(intersection) == TYPE_VECTOR3: - var intersection_vec := intersection as Vector3 - # This loops both horizontally (good) and vertically (bad) - _mouse_pos_map = (Vector2(intersection_vec.x, intersection_vec.z) - _map_mesh_corner) / _map_mesh_dims - _map_shader_material.set_shader_parameter(_shader_param_hover_pos, _mouse_pos_map) - else: - # Normals parallel to the xz-plane could cause null intersections, - # but the camera's orientation should prevent such normals - push_error("Invalid intersection: ", intersection) + _mouse_pos_map = _viewport_to_map_coords(_mouse_pos_viewport) + var hover_index := MapSingleton.get_province_index_from_uv_coords(_mouse_pos_map) + if _mouse_over_viewport: + _map_shader_material.set_shader_parameter(_shader_param_hover_index, hover_index) + +func _on_mouse_entered_viewport(): + _mouse_over_viewport = true + +func _on_mouse_exited_viewport(): + _mouse_over_viewport = false + +func _on_minimap_clicked(pos_clicked : Vector2): + pos_clicked *= _map_mesh_dims + _camera.position.x = pos_clicked.x + _camera.position.z = pos_clicked.y + _clamp_over_map() \ No newline at end of file diff --git a/game/src/GameSession/MapView.tscn b/game/src/GameSession/MapView.tscn index 4650acb..93fc162 100644 --- a/game/src/GameSession/MapView.tscn +++ b/game/src/GameSession/MapView.tscn @@ -2,26 +2,28 @@ [ext_resource type="Script" path="res://src/GameSession/MapView.gd" id="1_exccw"] [ext_resource type="Shader" path="res://src/GameSession/TerrainMap.gdshader" id="1_upocn"] -[ext_resource type="Texture2D" uid="uid://cmw0pvjthnn8c" path="res://common/map/terrain/terrain.png" id="3_l8pnf"] +[ext_resource type="Texture2D" uid="uid://cmw0pvjthnn8c" path="res://art/terrain/terrain.png" id="3_l8pnf"] [sub_resource type="ShaderMaterial" id="ShaderMaterial_tayeg"] render_priority = 0 shader = ExtResource("1_upocn") -shader_parameter/hover_pos = Vector2(0.5, 0.5) -shader_parameter/selected_pos = Vector2(0.5, 0.5) +shader_parameter/hover_index = null +shader_parameter/selected_index = null shader_parameter/terrain_tex = ExtResource("3_l8pnf") [sub_resource type="MapMesh" id="MapMesh_3gtsd"] [node name="MapView" type="Node3D" node_paths=PackedStringArray("_camera", "_map_mesh_instance")] +editor_description = "SS-73" script = ExtResource("1_exccw") _camera = NodePath("MapCamera") _map_mesh_instance = NodePath("MapMeshInstance") [node name="MapCamera" type="Camera3D" parent="."] -transform = Transform3D(1, 0, 0, 0, 0.707107, 0.707107, 0, -0.707107, 0.707107, 0, 1, 1) +transform = Transform3D(1, 0, 0, 0, 0.707107, 0.707107, 0, -0.707107, 0.707107, 0.25, 1.5, -2.75) [node name="MapMeshInstance" type="MeshInstance3D" parent="."] +editor_description = "FS-343" transform = Transform3D(10, 0, 0, 0, 10, 0, 0, 0, 10, 0, 0, 0) material_override = SubResource("ShaderMaterial_tayeg") mesh = SubResource("MapMesh_3gtsd") diff --git a/game/src/GameSession/Minimap.gd b/game/src/GameSession/Minimap.gd new file mode 100644 index 0000000..25c7cac --- /dev/null +++ b/game/src/GameSession/Minimap.gd @@ -0,0 +1,89 @@ +extends Control + +signal minimap_clicked(pos_clicked : Vector2) + +const _action_click : StringName = &"map_click" + +var _viewport_points : PackedVector2Array + +# REQUIREMENTS +# * SS-80 +# * UI-752 +func _draw() -> void: + if _viewport_points.size() > 1: + draw_multiline(_viewport_points, Color.WHITE, -1) + +# REQUIREMENTS +# * SS-81 +# * UIFUN-127 +func _unhandled_input(event : InputEvent): + if event is InputEventMouse and Input.is_action_pressed(_action_click): + var pos_clicked := get_local_mouse_position() / size - Vector2(0.5, 0.5) + if abs(pos_clicked.x) < 0.5 and abs(pos_clicked.y) < 0.5: + minimap_clicked.emit(pos_clicked) + +# Returns the point on the line going through p and q with the specific x coord +func _intersect_x(p : Vector2, q : Vector2, x : float) -> Vector2: + if p.x == q.x: + return Vector2(x, 0.5 * (p.y + q.y)) + var t := (x - q.x) / (p.x - q.x) + return q + t * (p - q) + +# Returns the point on the line going through p and q with the specific y coord +func _intersect_y(p : Vector2, q : Vector2, y : float) -> Vector2: + if p.y == q.y: + return Vector2(0.5 * (p.x + q.x), y) + var t := (y - q.y) / (p.y - q.y) + return q + t * (p - q) + +const _one_x := Vector2(1, 0) + +func _add_line_looped_over_x(left : Vector2, right : Vector2) -> void: + if left.x < 0: + if right.x < 0: + _viewport_points.push_back(left + _one_x) + _viewport_points.push_back(right + _one_x) + else: + var mid_point := _intersect_x(left, right, 0) + _viewport_points.push_back(mid_point) + _viewport_points.push_back(right) + mid_point.x = 1 + _viewport_points.push_back(left + _one_x) + _viewport_points.push_back(mid_point) + elif right.x > 1: + if left.x > 1: + _viewport_points.push_back(left - _one_x) + _viewport_points.push_back(right - _one_x) + else: + var mid_point := _intersect_x(left, right, 1) + _viewport_points.push_back(left) + _viewport_points.push_back(mid_point) + mid_point.x = 0 + _viewport_points.push_back(mid_point) + _viewport_points.push_back(right - _one_x) + else: + _viewport_points.push_back(left) + _viewport_points.push_back(right) + +# This can break if the viewport is rotated too far! +func _on_map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) -> void: + # Bound far y coords + if far_left.y < 0: + far_left = _intersect_y(near_left, far_left, 0) + if far_right.y < 0: + far_right = _intersect_y(near_right, far_right, 0) + # Bound near y coords + if near_left.y > 1: + near_left = _intersect_y(near_left, far_left, 1) + if near_right.y > 1: + near_right = _intersect_y(near_right, far_right, 1) + + _viewport_points.clear() + _add_line_looped_over_x(near_left, near_right) + _add_line_looped_over_x(far_left, far_right) + _add_line_looped_over_x(far_left, near_left) + _add_line_looped_over_x(near_right, far_right) + + for i in _viewport_points.size(): + _viewport_points[i] *= size + queue_redraw() diff --git a/game/src/GameSession/ProvinceOverviewPanel.tscn b/game/src/GameSession/ProvinceOverviewPanel.tscn index e21b1c3..2df95fb 100644 --- a/game/src/GameSession/ProvinceOverviewPanel.tscn +++ b/game/src/GameSession/ProvinceOverviewPanel.tscn @@ -3,6 +3,7 @@ [ext_resource type="Script" path="res://src/GameSession/ProvinceOverviewPanel.gd" id="1_3n8k5"] [node name="ProvinceOverviewPanel" type="Panel" node_paths=PackedStringArray("_province_name_label")] +editor_description = "UI-56" anchors_preset = 2 anchor_top = 1.0 anchor_bottom = 1.0 @@ -23,6 +24,7 @@ offset_right = -10.0 offset_bottom = -5.0 [node name="ProvinceName" type="Label" parent="VBoxContainer"] +editor_description = "UI-57" layout_mode = 2 text = "PROVINCE_NAME" vertical_alignment = 1 diff --git a/game/src/GameSession/TerrainMap.gdshader b/game/src/GameSession/TerrainMap.gdshader index a6774fd..7aca0f9 100644 --- a/game/src/GameSession/TerrainMap.gdshader +++ b/game/src/GameSession/TerrainMap.gdshader @@ -8,10 +8,10 @@ uniform sampler2D terrain_tex: source_color, repeat_enable, filter_linear; uniform sampler2D province_index_tex : repeat_enable, filter_nearest; // Province colour texture uniform sampler2D province_colour_tex: source_color, repeat_enable, filter_nearest; -// Position of the mouse over the map mesh in UV coords -uniform vec2 hover_pos; -// Position in UV coords of a pixel belonging to the currently selected province -uniform vec2 selected_pos; +// Index of the mouse over the map mesh +uniform uint hover_index; +// Index of the currently selected province +uniform uint selected_index; uvec2 vec2_to_uvec2(vec2 v) { return uvec2(v * 255.0); @@ -31,13 +31,10 @@ uint read_uint16(sampler2D tex, vec2 uv) { void fragment() { uvec2 prov_idx_split = read_uvec2(province_index_tex, UV); - uint prov_index = uvec2_to_uint(prov_idx_split); - uint hover_index = read_uint16(province_index_tex, hover_pos); - uint selected_index = read_uint16(province_index_tex, selected_pos); // Boost prov_colour's contribution if it matches hover_colour or selected_colour - float mix_val = float(prov_index == hover_index) * 0.3 + float(prov_index == selected_index) * 0.5; + float mix_val = 0.3 + float(prov_index == hover_index) * 0.3 + float(prov_index == selected_index) * 0.3; // Don't mix if the province index is 0 mix_val *= float(prov_index != 0u); -- cgit v1.2.3-56-ga3b1 From 04b213d4e20ca4e7ea66b059329771f6fd36c650 Mon Sep 17 00:00:00 2001 From: ClarkeCode Date: Fri, 14 Apr 2023 23:41:57 -0400 Subject: Removing TestSingleton Extracted game advancement behaviour to separate class --- extension/src/Simulation.cpp | 64 ------------------------ extension/src/Simulation.hpp | 68 ------------------------- extension/src/TestSingleton.cpp | 36 -------------- extension/src/TestSingleton.hpp | 23 --------- extension/src/openvic2/GameAdvancementHook.cpp | 69 ++++++++++++++++++++++++++ extension/src/openvic2/GameAdvancementHook.hpp | 40 +++++++++++++++ extension/src/register_types.cpp | 20 -------- game/src/MainMenu/MainMenu.gd | 2 - 8 files changed, 109 insertions(+), 213 deletions(-) delete mode 100644 extension/src/Simulation.cpp delete mode 100644 extension/src/Simulation.hpp delete mode 100644 extension/src/TestSingleton.cpp delete mode 100644 extension/src/TestSingleton.hpp create mode 100644 extension/src/openvic2/GameAdvancementHook.cpp create mode 100644 extension/src/openvic2/GameAdvancementHook.hpp (limited to 'extension/src/register_types.cpp') diff --git a/extension/src/Simulation.cpp b/extension/src/Simulation.cpp deleted file mode 100644 index 5ea99c5..0000000 --- a/extension/src/Simulation.cpp +++ /dev/null @@ -1,64 +0,0 @@ -#include "Simulation.hpp" - -namespace OpenVic2 { - void Simulation::togglePauseState() { - this->isPaused = !isPaused; - } - - bool Simulation::getPauseState() { - return this->isPaused; - } - - void Simulation::increaseSimulationSpeed() { - switch (this->currentSpeed) { - case(Speed::Speed1): - this->currentSpeed = Speed::Speed2; - break; - case(Speed::Speed2): - this->currentSpeed = Speed::Speed3; - break; - case(Speed::Speed3): - this->currentSpeed = Speed::Speed4; - break; - case(Speed::Speed4): - this->currentSpeed = Speed::Speed5; - break; - } - } - - void Simulation::decreaseSimulationSpeed() { - switch (this->currentSpeed) { - case(Speed::Speed2): - this->currentSpeed = Speed::Speed1; - break; - case(Speed::Speed3): - this->currentSpeed = Speed::Speed2; - break; - case(Speed::Speed4): - this->currentSpeed = Speed::Speed3; - break; - case(Speed::Speed5): - this->currentSpeed = Speed::Speed4; - break; - } - } - - void Simulation::setSimulationSpeed(Speed speed) { - this->currentSpeed = speed; - } - - int Simulation::getSimulationSpeed() { - return static_cast(this->currentSpeed); - } - - void Simulation::conditionallyAdvanceSimulation() { - if (!(this->isPaused)) { - std::chrono::time_point previousTime = this->lastPolledTime; - std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); - if (std::chrono::duration_cast(currentTime - previousTime).count() >= this->getSimulationSpeed()) { - this->lastPolledTime = currentTime; - this->inGameDate++; - } - } - } -} diff --git a/extension/src/Simulation.hpp b/extension/src/Simulation.hpp deleted file mode 100644 index 58ba7c7..0000000 --- a/extension/src/Simulation.hpp +++ /dev/null @@ -1,68 +0,0 @@ -#pragma once - -#include -#include -#include -#include "openvic2/Date.hpp" - -namespace OpenVic2 { - class Simulation : public godot::Object { - GDCLASS(Simulation, godot::Object) - std::vector exampleProvinces; - - enum class Speed { Speed1 = 4000, Speed2 = 3000, Speed3 = 2000, Speed4 = 1000, Speed5 = 100, Speed6 = 1 }; - - std::chrono::time_point lastPolledTime; - bool isPaused; - Speed currentSpeed; - Date inGameDate; - - //BEGIN BOILERPLATE - inline static Simulation* _simulation = nullptr; - - protected: - static void _bind_methods() { - godot::ClassDB::bind_method(godot::D_METHOD("conductSimulationStep"), &Simulation::conductSimulationStep); - godot::ClassDB::bind_method(godot::D_METHOD("queryProvinceSize"), &Simulation::queryProvinceSize); - } - - public: - inline static Simulation* get_singleton() { return _simulation; } - - inline Simulation() : inGameDate(1836, 1, 1) { - ERR_FAIL_COND(_simulation != nullptr); - _simulation = this; - this->lastPolledTime = std::chrono::high_resolution_clock::now(); - this->isPaused = false; - this->currentSpeed = Speed::Speed1; - exampleProvinces.resize(10, 1); - } - inline ~Simulation() { - ERR_FAIL_COND(_simulation != this); - _simulation = nullptr; - } - //END BOILERPLATE - - void togglePauseState(); - bool getPauseState(); - void increaseSimulationSpeed(); - void decreaseSimulationSpeed(); - void setSimulationSpeed(Speed speed); - int getSimulationSpeed(); - - inline void conductSimulationStep() { - for (uint64_t x = 0; x < exampleProvinces.size(); x++) { - exampleProvinces[x] += (x + 1); - } - } - - inline uint64_t queryProvinceSize(uint64_t provinceID) { - if (provinceID >= exampleProvinces.size()) { - return 0; - } - return exampleProvinces[provinceID]; - } - - void conditionallyAdvanceSimulation(); - }; -} \ No newline at end of file diff --git a/extension/src/TestSingleton.cpp b/extension/src/TestSingleton.cpp deleted file mode 100644 index d9e2b03..0000000 --- a/extension/src/TestSingleton.cpp +++ /dev/null @@ -1,36 +0,0 @@ -#include "TestSingleton.hpp" - -#include -#include - -using namespace godot; -using namespace OpenVic2; - -TestSingleton* TestSingleton::singleton = nullptr; - -void TestSingleton::_bind_methods() -{ - ClassDB::bind_method(D_METHOD("hello_singleton"), &TestSingleton::hello_singleton); -} - -TestSingleton* TestSingleton::get_singleton() -{ - return singleton; -} - -TestSingleton::TestSingleton() -{ - ERR_FAIL_COND(singleton != nullptr); - singleton = this; -} - -TestSingleton::~TestSingleton() -{ - ERR_FAIL_COND(singleton != this); - singleton = nullptr; -} - -void TestSingleton::hello_singleton() -{ - UtilityFunctions::print("Hello GDExtension Singleton!"); -} \ No newline at end of file diff --git a/extension/src/TestSingleton.hpp b/extension/src/TestSingleton.hpp deleted file mode 100644 index 1261573..0000000 --- a/extension/src/TestSingleton.hpp +++ /dev/null @@ -1,23 +0,0 @@ -#pragma once - -#include - -namespace OpenVic2 { - class TestSingleton : public godot::Object - { - GDCLASS(TestSingleton, godot::Object) - - static TestSingleton* singleton; - - protected: - static void _bind_methods(); - - public: - static TestSingleton* get_singleton(); - - TestSingleton(); - ~TestSingleton(); - - void hello_singleton(); - }; -} \ No newline at end of file diff --git a/extension/src/openvic2/GameAdvancementHook.cpp b/extension/src/openvic2/GameAdvancementHook.cpp new file mode 100644 index 0000000..3db3224 --- /dev/null +++ b/extension/src/openvic2/GameAdvancementHook.cpp @@ -0,0 +1,69 @@ +#include "GameAdvancementHook.hpp" + +namespace OpenVic2 { + GameAdvancementHook::GameAdvancementHook(AdvancementFunction function, bool startPaused, GameSpeed startingSpeed) { + triggerFunction = function; + lastPolledTime = std::chrono::high_resolution_clock::now(); + isPaused = startPaused; + currentSpeed = startingSpeed; + } + + void GameAdvancementHook::increaseSimulationSpeed() { + switch (currentSpeed) { + case(GameSpeed::Speed1): + currentSpeed = GameSpeed::Speed2; + break; + case(GameSpeed::Speed2): + currentSpeed = GameSpeed::Speed3; + break; + case(GameSpeed::Speed3): + currentSpeed = GameSpeed::Speed4; + break; + case(GameSpeed::Speed4): + currentSpeed = GameSpeed::Speed5; + break; + } + } + + void GameAdvancementHook::decreaseSimulationSpeed() { + switch (currentSpeed) { + case(GameSpeed::Speed2): + currentSpeed = GameSpeed::Speed1; + break; + case(GameSpeed::Speed3): + currentSpeed = GameSpeed::Speed2; + break; + case(GameSpeed::Speed4): + currentSpeed = GameSpeed::Speed3; + break; + case(GameSpeed::Speed5): + currentSpeed = GameSpeed::Speed4; + break; + } + } + + GameAdvancementHook GameAdvancementHook::operator++(int) { + GameAdvancementHook oldCopy = *this; + increaseSimulationSpeed(); + return oldCopy; + }; + + GameAdvancementHook GameAdvancementHook::operator--(int) { + GameAdvancementHook oldCopy = *this; + decreaseSimulationSpeed(); + return oldCopy; + }; + + void GameAdvancementHook::conditionallyAdvanceGame() { + if (!isPaused) { + std::chrono::time_point previousTime = lastPolledTime; + std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); + if (std::chrono::duration_cast(currentTime - previousTime).count() >= static_cast(currentSpeed)) { + lastPolledTime = currentTime; + if (triggerFunction) { + triggerFunction(); + } + } + } + } +} \ No newline at end of file diff --git a/extension/src/openvic2/GameAdvancementHook.hpp b/extension/src/openvic2/GameAdvancementHook.hpp new file mode 100644 index 0000000..72af4ac --- /dev/null +++ b/extension/src/openvic2/GameAdvancementHook.hpp @@ -0,0 +1,40 @@ +#pragma once + +#include +#include + +namespace OpenVic2 { + //Value of different game speeds are the minimum number of miliseconds before the simulation advances + enum class GameSpeed { + Speed1 = 4000, + Speed2 = 3000, + Speed3 = 2000, + Speed4 = 1000, + Speed5 = 100, + Speed6 = 1 + }; + + //Conditionally advances game with provided behaviour + //Class governs game speed and pause state + class GameAdvancementHook { + public: + using AdvancementFunction = std::function; + + private: + std::chrono::time_point lastPolledTime; + //A function pointer that advances the simulation, intended to be a capturing lambda or something similar. May need to be reworked later + AdvancementFunction triggerFunction; + + public: + bool isPaused; + GameSpeed currentSpeed; + + GameAdvancementHook(AdvancementFunction function = nullptr, bool startPaused = false, GameSpeed startingSpeed = GameSpeed::Speed1); + + void increaseSimulationSpeed(); + void decreaseSimulationSpeed(); + GameAdvancementHook operator++(int); + GameAdvancementHook operator--(int); + void conditionallyAdvanceGame(); + }; +} \ No newline at end of file diff --git a/extension/src/register_types.cpp b/extension/src/register_types.cpp index 9fd934e..10ed781 100644 --- a/extension/src/register_types.cpp +++ b/extension/src/register_types.cpp @@ -2,8 +2,6 @@ #include -#include "TestSingleton.hpp" -#include "Simulation.hpp" #include "Checksum.hpp" #include "LoadLocalisation.hpp" #include "MapSingleton.hpp" @@ -12,8 +10,6 @@ using namespace godot; using namespace OpenVic2; -static TestSingleton* _test_singleton; -static Simulation* _simulation; static Checksum* _checksum; static LoadLocalisation* _load_localisation; static MapSingleton* _map_singleton; @@ -23,14 +19,6 @@ void initialize_openvic2_types(ModuleInitializationLevel p_level) { return; } - ClassDB::register_class(); - _test_singleton = memnew(TestSingleton); - Engine::get_singleton()->register_singleton("TestSingleton", TestSingleton::get_singleton()); - - ClassDB::register_class(); - _simulation = memnew(Simulation); - Engine::get_singleton()->register_singleton("Simulation", Simulation::get_singleton()); - ClassDB::register_class(); _checksum = memnew(Checksum); Engine::get_singleton()->register_singleton("Checksum", Checksum::get_singleton()); @@ -51,12 +39,6 @@ void uninitialize_openvic2_types(ModuleInitializationLevel p_level) { return; } - Engine::get_singleton()->unregister_singleton("TestSingleton"); - memdelete(_test_singleton); - - Engine::get_singleton()->unregister_singleton("Simulation"); - memdelete(_simulation); - Engine::get_singleton()->unregister_singleton("Checksum"); memdelete(_checksum); @@ -68,9 +50,7 @@ void uninitialize_openvic2_types(ModuleInitializationLevel p_level) { } extern "C" { - // Initialization. - GDExtensionBool GDE_EXPORT openvic2_library_init(GDExtensionInterface const* p_interface, const GDExtensionClassLibraryPtr p_library, GDExtensionInitialization* r_initialization) { GDExtensionBinding::InitObject init_obj(p_interface, p_library, r_initialization); diff --git a/game/src/MainMenu/MainMenu.gd b/game/src/MainMenu/MainMenu.gd index 4420786..9d0edc6 100644 --- a/game/src/MainMenu/MainMenu.gd +++ b/game/src/MainMenu/MainMenu.gd @@ -10,8 +10,6 @@ var _new_game_button : BaseButton # REQUIREMENTS: # * SS-3 func _ready(): - print("From GDScript") - TestSingleton.hello_singleton() _on_new_game_button_visibility_changed() # REQUIREMENTS: -- cgit v1.2.3-56-ga3b1 From d3f3187209cb4085f27f95ce8ad2a77af25704fd Mon Sep 17 00:00:00 2001 From: Hop311 Date: Sun, 23 Apr 2023 19:49:01 +0100 Subject: C++ refactoring + simulation prototype --- .github/workflows/builds.yml | 4 + SConstruct | 6 + extension/src/GameSingleton.cpp | 449 ++++++++++++++++++++++++ extension/src/GameSingleton.hpp | 62 ++++ extension/src/MapSingleton.cpp | 394 --------------------- extension/src/MapSingleton.hpp | 50 --- extension/src/openvic2/Date.cpp | 190 ++++++---- extension/src/openvic2/Date.hpp | 139 ++++---- extension/src/openvic2/GameAdvancementHook.cpp | 120 ++++--- extension/src/openvic2/GameAdvancementHook.hpp | 29 +- extension/src/openvic2/GameManager.cpp | 43 +++ extension/src/openvic2/GameManager.hpp | 29 ++ extension/src/openvic2/Logger.cpp | 26 ++ extension/src/openvic2/Logger.hpp | 83 +++++ extension/src/openvic2/Map.cpp | 348 ------------------ extension/src/openvic2/Map.hpp | 67 ---- extension/src/openvic2/Province.cpp | 43 --- extension/src/openvic2/Province.hpp | 39 -- extension/src/openvic2/Region.cpp | 26 -- extension/src/openvic2/Region.hpp | 29 -- extension/src/openvic2/Types.cpp | 4 +- extension/src/openvic2/Types.hpp | 8 +- extension/src/openvic2/map/Building.cpp | 129 +++++++ extension/src/openvic2/map/Building.hpp | 63 ++++ extension/src/openvic2/map/Map.cpp | 359 +++++++++++++++++++ extension/src/openvic2/map/Map.hpp | 73 ++++ extension/src/openvic2/map/Province.cpp | 67 ++++ extension/src/openvic2/map/Province.hpp | 45 +++ extension/src/openvic2/map/Region.cpp | 26 ++ extension/src/openvic2/map/Region.hpp | 28 ++ extension/src/register_types.cpp | 14 +- game/localisation/en_GB/menus.csv | 9 + game/localisation/en_GB/provinces.csv | 374 ++++++++++---------- game/localisation/en_GB/regions.csv | 12 +- game/src/Autoload/Events.gd | 9 +- game/src/GameSession/GameSession.gd | 5 +- game/src/GameSession/GameSessionMenu.gd | 1 + game/src/GameSession/GameSpeedPanel.gd | 29 +- game/src/GameSession/MapControlPanel.gd | 6 +- game/src/GameSession/MapView.gd | 21 +- game/src/GameSession/ProvinceOverviewPanel.gd | 82 ++++- game/src/GameSession/ProvinceOverviewPanel.tscn | 14 +- 42 files changed, 2086 insertions(+), 1468 deletions(-) create mode 100644 extension/src/GameSingleton.cpp create mode 100644 extension/src/GameSingleton.hpp delete mode 100644 extension/src/MapSingleton.cpp delete mode 100644 extension/src/MapSingleton.hpp create mode 100644 extension/src/openvic2/GameManager.cpp create mode 100644 extension/src/openvic2/GameManager.hpp create mode 100644 extension/src/openvic2/Logger.cpp create mode 100644 extension/src/openvic2/Logger.hpp delete mode 100644 extension/src/openvic2/Map.cpp delete mode 100644 extension/src/openvic2/Map.hpp delete mode 100644 extension/src/openvic2/Province.cpp delete mode 100644 extension/src/openvic2/Province.hpp delete mode 100644 extension/src/openvic2/Region.cpp delete mode 100644 extension/src/openvic2/Region.hpp create mode 100644 extension/src/openvic2/map/Building.cpp create mode 100644 extension/src/openvic2/map/Building.hpp create mode 100644 extension/src/openvic2/map/Map.cpp create mode 100644 extension/src/openvic2/map/Map.hpp create mode 100644 extension/src/openvic2/map/Province.cpp create mode 100644 extension/src/openvic2/map/Province.hpp create mode 100644 extension/src/openvic2/map/Region.cpp create mode 100644 extension/src/openvic2/map/Region.hpp (limited to 'extension/src/register_types.cpp') diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 772b16c..664f8e4 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -80,6 +80,10 @@ jobs: run: | sudo apt-get update -qq sudo apt-get install -qqq build-essential pkg-config + g++ --version + sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 12 + sudo update-alternatives --set g++ /usr/bin/g++-12 + g++ --version - name: Setup MinGW for Windows/MinGW build if: ${{ matrix.platform == 'windows' }} diff --git a/SConstruct b/SConstruct index 4e6fe70..3213efd 100644 --- a/SConstruct +++ b/SConstruct @@ -10,6 +10,12 @@ ARGUMENTS.pop('intermediate_delete', True) env = SConscript("godot-cpp/SConstruct") +# Require C++20 +if env.get("is_msvc", False): + env.Replace(CXXFLAGS=["/std:c++20"]) +else: + env.Replace(CXXFLAGS=["-std=c++20"]) + ARGUMENTS = SAVED_ARGUMENTS # Custom options and profile flags. diff --git a/extension/src/GameSingleton.cpp b/extension/src/GameSingleton.cpp new file mode 100644 index 0000000..68eb252 --- /dev/null +++ b/extension/src/GameSingleton.cpp @@ -0,0 +1,449 @@ +#include "GameSingleton.hpp" + +#include +#include +#include + +#include "openvic2/Logger.hpp" + +using namespace godot; +using namespace OpenVic2; + +#define ERR(x) ((x) == SUCCESS ? OK : FAILED) + +GameSingleton* GameSingleton::singleton = nullptr; + +void GameSingleton::_bind_methods() { + ClassDB::bind_method(D_METHOD("load_province_identifier_file", "file_path"), &GameSingleton::load_province_identifier_file); + ClassDB::bind_method(D_METHOD("load_water_province_file", "file_path"), &GameSingleton::load_water_province_file); + ClassDB::bind_method(D_METHOD("load_region_file", "file_path"), &GameSingleton::load_region_file); + ClassDB::bind_method(D_METHOD("load_province_shape_file", "file_path"), &GameSingleton::load_province_shape_file); + ClassDB::bind_method(D_METHOD("finished_loading_data"), &GameSingleton::finished_loading_data); + + ClassDB::bind_method(D_METHOD("get_province_index_from_uv_coords", "coords"), &GameSingleton::get_province_index_from_uv_coords); + ClassDB::bind_method(D_METHOD("get_province_info_from_index", "index"), &GameSingleton::get_province_info_from_index); + ClassDB::bind_method(D_METHOD("get_width"), &GameSingleton::get_width); + ClassDB::bind_method(D_METHOD("get_height"), &GameSingleton::get_height); + ClassDB::bind_method(D_METHOD("get_province_index_image"), &GameSingleton::get_province_index_image); + ClassDB::bind_method(D_METHOD("get_province_colour_image"), &GameSingleton::get_province_colour_image); + + ClassDB::bind_method(D_METHOD("update_colour_image"), &GameSingleton::update_colour_image); + ClassDB::bind_method(D_METHOD("get_mapmode_count"), &GameSingleton::get_mapmode_count); + ClassDB::bind_method(D_METHOD("get_mapmode_identifier", "index"), &GameSingleton::get_mapmode_identifier); + ClassDB::bind_method(D_METHOD("set_mapmode", "identifier"), &GameSingleton::set_mapmode); + + ClassDB::bind_method(D_METHOD("expand_building", "province_index", "building_type_identifier"), &GameSingleton::expand_building); + + ClassDB::bind_method(D_METHOD("set_paused", "paused"), &GameSingleton::set_paused); + ClassDB::bind_method(D_METHOD("toggle_paused"), &GameSingleton::toggle_paused); + ClassDB::bind_method(D_METHOD("is_paused"), &GameSingleton::is_paused); + ClassDB::bind_method(D_METHOD("increase_speed"), &GameSingleton::increase_speed); + ClassDB::bind_method(D_METHOD("decrease_speed"), &GameSingleton::decrease_speed); + ClassDB::bind_method(D_METHOD("can_increase_speed"), &GameSingleton::can_increase_speed); + ClassDB::bind_method(D_METHOD("can_decrease_speed"), &GameSingleton::can_decrease_speed); + ClassDB::bind_method(D_METHOD("get_longform_date"), &GameSingleton::get_longform_date); + ClassDB::bind_method(D_METHOD("try_tick"), &GameSingleton::try_tick); + + ADD_SIGNAL(MethodInfo("state_updated")); +} + +GameSingleton* GameSingleton::get_singleton() { + return singleton; +} + +/* REQUIREMENTS: + * MAP-21, MAP-25 + */ +GameSingleton::GameSingleton() : game_manager{ [this]() { emit_signal("state_updated"); } } { + ERR_FAIL_COND(singleton != nullptr); + singleton = this; + + Logger::set_info_func([](std::string&& str) { UtilityFunctions::print(str.c_str()); }); + Logger::set_error_func([](std::string&& str) { UtilityFunctions::push_error(str.c_str()); }); + + using mapmode_t = std::pair; + const std::vector mapmodes = { + { "mapmode_province", [](Map const&, Province const& province) -> Province::colour_t { return province.get_colour(); } }, + { "mapmode_region", [](Map const&, Province const& province) -> Province::colour_t { + Region const* region = province.get_region(); + if (region != nullptr) return region->get_colour(); + return province.get_colour(); + } }, + { "mapmode_terrain", [](Map const&, Province const& province) -> Province::colour_t { + return province.is_water() ? 0x4287F5 : 0x0D7017; + } }, + { "mapmode_index", [](Map const& map, Province const& province) -> Province::colour_t { + const uint8_t f = static_cast(province.get_index()) / static_cast(map.get_province_count()) * 255.0f; + return (f << 16) | (f << 8) | f; + } } + }; + for (mapmode_t const& mapmode : mapmodes) + game_manager.map.add_mapmode(mapmode.first, mapmode.second); + + using building_type_t = std::tuple; + const std::vector building_types = { + { "building_fort", 4, 8 }, { "building_naval_base", 6, 15 }, { "building_railroad", 5, 10 } + }; + for (building_type_t const& type : building_types) + game_manager.building_manager.add_building_type(std::get<0>(type), std::get<1>(type), std::get<2>(type)); + +} + +GameSingleton::~GameSingleton() { + ERR_FAIL_COND(singleton != this); + singleton = nullptr; +} + +static Error load_json_file(String const& file_description, String const& file_path, Variant& result) { + result.clear(); + UtilityFunctions::print("Loading ", file_description, " file: ", file_path); + const Ref 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 ", file_description, " file: ", file_path); + return err == OK ? FAILED : err; + } + const String json_string = file->get_as_text(); + JSON json; + err = json.parse(json_string); + if (err != OK) { + 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; + } + result = json.get_data(); + return err; +} + +using parse_json_entry_func_t = std::function; + +static Error parse_json_dictionary_file(String const& file_description, String const& file_path, + String const& identifier_prefix, parse_json_entry_func_t parse_entry) { + Variant json_var; + Error err = load_json_file(file_description, file_path, json_var); + if (err != OK) return err; + const Variant::Type type = json_var.get_type(); + if (type != Variant::DICTIONARY) { + UtilityFunctions::push_error("Invalid ", file_description, " JSON: root has type ", + Variant::get_type_name(type), " (expected Dictionary)"); + return FAILED; + } + Dictionary const& dict = json_var; + const Array identifiers = dict.keys(); + for (int64_t idx = 0; idx < identifiers.size(); ++idx) { + String const& identifier = identifiers[idx]; + Variant const& entry = dict[identifier]; + if (identifier.is_empty()) { + UtilityFunctions::push_error("Empty identifier in ", file_description, " file with entry: ", entry); + err = FAILED; + continue; + } + if (!identifier.begins_with(identifier_prefix)) + UtilityFunctions::push_warning("Identifier in ", file_description, " file missing \"", identifier_prefix, "\" prefix: ", identifier); + if (parse_entry(identifier, entry) != OK) err = FAILED; + } + return err; +} + +Error GameSingleton::_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) { + Array const& colour_array = entry; + if (colour_array.size() == 3) { + for (int jdx = 0; jdx < 3; ++jdx) { + Variant const& var = colour_array[jdx]; + if (var.get_type() != Variant::FLOAT) { + colour = Province::NULL_COLOUR; + break; + } + const double colour_double = var; + if (std::trunc(colour_double) != colour_double) { + colour = Province::NULL_COLOUR; + break; + } + const int64_t colour_int = static_cast(colour_double); + if (colour_int < 0 || colour_int > 255) { + colour = Province::NULL_COLOUR; + break; + } + colour = (colour << 8) | colour_int; + } + } + } else if (type == Variant::STRING) { + String const& colour_string = entry; + if (colour_string.is_valid_hex_number()) { + const int64_t colour_int = colour_string.hex_to_int(); + if (0 <= colour_int && colour_int <= 0xFFFFFF) + colour = colour_int; + } + } + if (colour == Province::NULL_COLOUR) { + UtilityFunctions::push_error("Invalid colour for province identifier \"", identifier, "\": ", entry); + return FAILED; + } + return ERR(game_manager.map.add_province(identifier.utf8().get_data(), colour)); +} + +Error GameSingleton::load_province_identifier_file(String const& file_path) { + const Error err = parse_json_dictionary_file("province identifier", file_path, "prov_", + [this](String const& identifier, Variant const& entry) -> Error { + return _parse_province_identifier_entry(identifier, entry); + }); + game_manager.map.lock_provinces(); + return err; +} + +Error GameSingleton::_parse_region_entry(String const& identifier, Variant const& entry) { + Error err = OK; + Variant::Type type = entry.get_type(); + std::vector province_identifiers; + if (type == Variant::ARRAY) { + Array const& province_array = entry; + for (int64_t idx = 0; idx < province_array.size(); ++idx) { + Variant const& province_var = province_array[idx]; + type = province_var.get_type(); + if (type == Variant::STRING) { + String const& 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; + } + } + } + if (province_identifiers.empty()) { + UtilityFunctions::push_error("Invalid province list for region \"", identifier, "\": ", entry); + return FAILED; + } + return ERR(game_manager.map.add_region(identifier.utf8().get_data(), province_identifiers)); +} + +Error GameSingleton::load_region_file(String const& file_path) { + const Error err = parse_json_dictionary_file("region", file_path, "region_", + [this](String const& identifier, Variant const& entry) -> Error { + return _parse_region_entry(identifier, entry); + }); + game_manager.map.lock_regions(); + return err; +} + +Error GameSingleton::load_province_shape_file(String const& file_path) { + if (province_index_image.is_valid()) { + UtilityFunctions::push_error("Province shape file has already been loaded, cannot load: ", file_path); + return FAILED; + } + Ref province_shape_image; + province_shape_image.instantiate(); + Error err = province_shape_image->load(file_path); + if (err != OK) { + UtilityFunctions::push_error("Failed to load province shape file: ", file_path); + return err; + } + int32_t width = province_shape_image->get_width(); + int32_t height = province_shape_image->get_height(); + if (width < 1 || height < 1) { + UtilityFunctions::push_error("Invalid dimensions (", width, "x", height, ") for province shape file: ", file_path); + err = FAILED; + } + static constexpr Image::Format expected_format = Image::FORMAT_RGB8; + 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; + } + if (err != OK) return err; + err = ERR(game_manager.map.generate_province_index_image(width, height, province_shape_image->get_data().ptr())); + + PackedByteArray index_data_array; + index_data_array.resize(width * height * sizeof(Province::index_t)); + std::vector const& province_index_data = game_manager.map.get_province_index_image(); + memcpy(index_data_array.ptrw(), province_index_data.data(), province_index_data.size()); + + province_index_image = Image::create_from_data(width, height, false, Image::FORMAT_RG8, index_data_array); + if (province_index_image.is_null()) { + UtilityFunctions::push_error("Failed to create province ID image"); + err = FAILED; + } + + if (update_colour_image() != OK) err = FAILED; + + return err; +} + +void GameSingleton::finished_loading_data() { + game_manager.finished_loading_data(); +} + +Error GameSingleton::load_water_province_file(String const& file_path) { + Variant json_var; + Error err = load_json_file("water province", file_path, json_var); + if (err != OK) return err; + Variant::Type type = json_var.get_type(); + if (type != Variant::ARRAY) { + UtilityFunctions::push_error("Invalid water province JSON: root has type ", + Variant::get_type_name(type), " (expected Array)"); + err = FAILED; + } else { + Array const& array = json_var; + for (int64_t idx = 0; idx < array.size(); ++idx) { + Variant const& entry = array[idx]; + type = entry.get_type(); + if (type != Variant::STRING) { + UtilityFunctions::push_error("Invalid water province identifier: ", entry); + err = FAILED; + continue; + } + String const& identifier = entry; + if (game_manager.map.set_water_province(identifier.utf8().get_data()) != SUCCESS) + err = FAILED; + } + } + game_manager.map.lock_water_provinces(); + return err; +} + +int32_t GameSingleton::get_province_index_from_uv_coords(Vector2 const& coords) const { + const size_t x_mod_w = UtilityFunctions::fposmod(coords.x, 1.0f) * get_width(); + const size_t y_mod_h = UtilityFunctions::fposmod(coords.y, 1.0f) * get_height(); + return game_manager.map.get_province_index_at(x_mod_w, y_mod_h); +} + +#define KEY(x) static const StringName x##_key = #x; +Dictionary GameSingleton::get_province_info_from_index(int32_t index) const { + Province const* province = game_manager.map.get_province_by_index(index); + if (province == nullptr) return {}; + KEY(province) KEY(region) KEY(life_rating) KEY(buildings) + Dictionary ret; + + ret[province_key] = province->get_identifier().c_str(); + + Region const* region = province->get_region(); + if (region != nullptr) ret[region_key] = region->get_identifier().c_str(); + + ret[life_rating_key] = province->get_life_rating(); + + std::vector const& buildings = province->get_buildings(); + if (!buildings.empty()) { + Array buildings_array; + buildings_array.resize(buildings.size()); + for (size_t idx = 0; idx < buildings.size(); ++idx) { + KEY(building) KEY(level) KEY(expansion_state) KEY(start_date) KEY(end_date) KEY(expansion_progress) + + Dictionary building_dict; + Building const& building = buildings[idx]; + building_dict[building_key] = building.get_type().get_identifier().c_str(); + building_dict[level_key] = static_cast(building.get_level()); + building_dict[expansion_state_key] = static_cast(building.get_expansion_state()); + building_dict[start_date_key] = static_cast(building.get_start_date()).c_str(); + building_dict[end_date_key] = static_cast(building.get_end_date()).c_str(); + building_dict[expansion_progress_key] = building.get_expansion_progress(); + + buildings_array[idx] = building_dict; + } + ret[buildings_key] = buildings_array; + } + return ret; +} +#undef KEY + +int32_t GameSingleton::get_width() const { + return game_manager.map.get_width(); +} + +int32_t GameSingleton::get_height() const { + return game_manager.map.get_height(); +} + +Ref GameSingleton::get_province_index_image() const { + return province_index_image; +} + +Ref GameSingleton::get_province_colour_image() const { + return province_colour_image; +} + +Error GameSingleton::update_colour_image() { + static PackedByteArray colour_data_array; + static constexpr int64_t colour_data_array_size = (Province::MAX_INDEX + 1) * 4; + colour_data_array.resize(colour_data_array_size); + + Error err = OK; + if (game_manager.map.generate_mapmode_colours(mapmode_index, colour_data_array.ptrw()) != SUCCESS) + err = FAILED; + + static constexpr int32_t PROVINCE_INDEX_SQRT = 1 << (sizeof(Province::index_t) * 4); + if (province_colour_image.is_null()) + province_colour_image.instantiate(); + province_colour_image->set_data(PROVINCE_INDEX_SQRT, PROVINCE_INDEX_SQRT, + false, Image::FORMAT_RGBA8, colour_data_array); + if (province_colour_image.is_null()) { + UtilityFunctions::push_error("Failed to update province colour image"); + return FAILED; + } + return err; +} + +int32_t GameSingleton::get_mapmode_count() const { + return game_manager.map.get_mapmode_count(); +} + +String GameSingleton::get_mapmode_identifier(int32_t index) const { + Mapmode const* mapmode = game_manager.map.get_mapmode_by_index(index); + if (mapmode != nullptr) return mapmode->get_identifier().c_str(); + return String{}; +} + +Error GameSingleton::set_mapmode(godot::String const& identifier) { + Mapmode const* mapmode = game_manager.map.get_mapmode_by_identifier(identifier.utf8().get_data()); + if (mapmode == nullptr) { + UtilityFunctions::push_error("Failed to set mapmode to: ", identifier); + return FAILED; + } + mapmode_index = mapmode->get_index(); + return OK; +} + +Error GameSingleton::expand_building(int32_t province_index, String const& building_type_identifier) { + if (game_manager.expand_building(province_index, building_type_identifier.utf8().get_data()) != SUCCESS) { + UtilityFunctions::push_error("Failed to expand ", building_type_identifier, " at province index ", province_index); + return FAILED; + } + return OK; +} + +void GameSingleton::set_paused(bool paused) { + game_manager.clock.isPaused = paused; +} + +void GameSingleton::toggle_paused() { + game_manager.clock.isPaused = !game_manager.clock.isPaused; +} + +bool GameSingleton::is_paused() const { + return game_manager.clock.isPaused; +} + +void GameSingleton::increase_speed() { + game_manager.clock.increaseSimulationSpeed(); +} + +void GameSingleton::decrease_speed() { + game_manager.clock.decreaseSimulationSpeed(); +} + +bool GameSingleton::can_increase_speed() const { + return game_manager.clock.canIncreaseSimulationSpeed(); +} + +bool GameSingleton::can_decrease_speed() const { + return game_manager.clock.canDecreaseSimulationSpeed(); +} + +String GameSingleton::get_longform_date() const { + return static_cast(game_manager.get_today()).c_str(); +} + +void GameSingleton::try_tick() { + game_manager.clock.conditionallyAdvanceGame(); +} diff --git a/extension/src/GameSingleton.hpp b/extension/src/GameSingleton.hpp new file mode 100644 index 0000000..0e2cfd1 --- /dev/null +++ b/extension/src/GameSingleton.hpp @@ -0,0 +1,62 @@ +#pragma once + +#include + +#include + +#include "openvic2/GameManager.hpp" + +namespace OpenVic2 { + class GameSingleton : public godot::Object { + GDCLASS(GameSingleton, godot::Object) + + static GameSingleton* singleton; + + GameManager game_manager; + + godot::Ref province_index_image, province_colour_image; + Mapmode::index_t mapmode_index = 0; + + 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); + void _tick(); + protected: + static void _bind_methods(); + + public: + static GameSingleton* get_singleton(); + + GameSingleton(); + ~GameSingleton(); + + godot::Error load_province_identifier_file(godot::String const& file_path); + godot::Error load_water_province_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); + void finished_loading_data(); + + int32_t get_province_index_from_uv_coords(godot::Vector2 const& coords) const; + godot::Dictionary get_province_info_from_index(int32_t index) const; + int32_t get_width() const; + int32_t get_height() const; + godot::Ref get_province_index_image() const; + godot::Ref get_province_colour_image() const; + + godot::Error update_colour_image(); + int32_t get_mapmode_count() const; + godot::String get_mapmode_identifier(int32_t index) const; + godot::Error set_mapmode(godot::String const& identifier); + + godot::Error expand_building(int32_t province_index, godot::String const& building_type_identifier); + + void set_paused(bool paused); + void toggle_paused(); + bool is_paused() const; + void increase_speed(); + void decrease_speed(); + bool can_increase_speed() const; + bool can_decrease_speed() const; + godot::String get_longform_date() const; + void try_tick(); + }; +} diff --git a/extension/src/MapSingleton.cpp b/extension/src/MapSingleton.cpp deleted file mode 100644 index 6f90dee..0000000 --- a/extension/src/MapSingleton.cpp +++ /dev/null @@ -1,394 +0,0 @@ -#include "MapSingleton.hpp" - -#include -#include -#include - -using namespace godot; -using namespace OpenVic2; - -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_water_province_file", "file_path"), &MapSingleton::load_water_province_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_index_from_uv_coords", "coords"), &MapSingleton::get_province_index_from_uv_coords); - ClassDB::bind_method(D_METHOD("get_province_identifier_from_uv_coords", "coords"), &MapSingleton::get_province_identifier_from_uv_coords); - ClassDB::bind_method(D_METHOD("get_region_identifier_from_province_identifier", "identifier"), &MapSingleton::get_region_identifier_from_province_identifier); - ClassDB::bind_method(D_METHOD("get_width"), &MapSingleton::get_width); - ClassDB::bind_method(D_METHOD("get_height"), &MapSingleton::get_height); - ClassDB::bind_method(D_METHOD("get_province_index_image"), &MapSingleton::get_province_index_image); - ClassDB::bind_method(D_METHOD("get_province_colour_image"), &MapSingleton::get_province_colour_image); - - ClassDB::bind_method(D_METHOD("update_colour_image"), &MapSingleton::update_colour_image); - ClassDB::bind_method(D_METHOD("get_mapmode_count"), &MapSingleton::get_mapmode_count); - ClassDB::bind_method(D_METHOD("get_mapmode_identifier", "index"), &MapSingleton::get_mapmode_identifier); - ClassDB::bind_method(D_METHOD("set_mapmode", "identifier"), &MapSingleton::set_mapmode); -} - -MapSingleton* MapSingleton::get_singleton() { - return singleton; -} - -/* REQUIREMENTS: - * MAP-21, MAP-25 - */ -MapSingleton::MapSingleton() { - ERR_FAIL_COND(singleton != nullptr); - singleton = this; - - using mapmode_t = std::pair; - const std::vector mapmodes = { - { "mapmode_province", [](Map const&, Province const& province) -> Province::colour_t { return province.get_colour(); } }, - { "mapmode_region", [](Map const&, Province const& province) -> Province::colour_t { - Region const* region = province.get_region(); - if (region != nullptr) return region->get_colour(); - return province.get_colour(); - } }, - { "mapmode_terrain", [](Map const&, Province const& province) -> Province::colour_t { - return province.is_water() ? 0x4287F5 : 0x0D7017; - } }, - { "mapmode_index", [](Map const& map, Province const& province) -> Province::colour_t { - const uint8_t f = float(province.get_index()) / float(map.get_province_count()) * 255.0f; - return (f << 16) | (f << 8) | f; - } } - }; - std::string error_message; - for (mapmode_t const& mapmode : mapmodes) - if (map.add_mapmode(mapmode.first, mapmode.second, error_message) != SUCCESS) - UtilityFunctions::push_error(error_message.c_str()); -} - -MapSingleton::~MapSingleton() { - ERR_FAIL_COND(singleton != this); - singleton = nullptr; -} - -static Error load_json_file(String const& file_description, String const& file_path, Variant& result) { - result.clear(); - UtilityFunctions::print("Loading ", file_description, " file: ", file_path); - const Ref 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 ", file_description, " file: ", file_path); - return err == OK ? FAILED : err; - } - const String json_string = file->get_as_text(); - JSON json; - err = json.parse(json_string); - if (err != OK) { - 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; - } - result = json.get_data(); - return err; -} - -using parse_json_entry_func_t = std::function; - -static Error parse_json_dictionary_file(String const& file_description, String const& file_path, - String const& identifier_prefix, parse_json_entry_func_t parse_entry) { - Variant json_var; - Error err = load_json_file(file_description, file_path, json_var); - if (err != OK) return err; - const Variant::Type type = json_var.get_type(); - if (type != Variant::DICTIONARY) { - UtilityFunctions::push_error("Invalid ", file_description, " JSON: root has type ", - Variant::get_type_name(type), " (expected Dictionary)"); - return FAILED; - } - Dictionary const& dict = json_var; - const Array identifiers = dict.keys(); - for (int64_t idx = 0; idx < identifiers.size(); ++idx) { - String const& identifier = identifiers[idx]; - Variant const& entry = dict[identifier]; - if (identifier.is_empty()) { - UtilityFunctions::push_error("Empty identifier in ", file_description, " file with entry: ", entry); - err = FAILED; - continue; - } - if (!identifier.begins_with(identifier_prefix)) - UtilityFunctions::push_warning("Identifier in ", file_description, " file missing \"", identifier_prefix, "\" prefix: ", identifier); - if (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) { - Array const& colour_array = entry; - if (colour_array.size() == 3) { - for (int jdx = 0; jdx < 3; ++jdx) { - Variant const& var = colour_array[jdx]; - if (var.get_type() != Variant::FLOAT) { - colour = Province::NULL_COLOUR; - break; - } - const double colour_double = var; - if (std::trunc(colour_double) != colour_double) { - colour = Province::NULL_COLOUR; - break; - } - const int64_t colour_int = static_cast(colour_double); - if (colour_int < 0 || colour_int > 255) { - colour = Province::NULL_COLOUR; - break; - } - colour = (colour << 8) | colour_int; - } - } - } else if (type == Variant::STRING) { - String const& colour_string = entry; - if (colour_string.is_valid_hex_number()) { - const int64_t colour_int = colour_string.hex_to_int(); - if (0 <= colour_int && colour_int <= 0xFFFFFF) - colour = colour_int; - } - } - if (colour == Province::NULL_COLOUR) { - 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) != SUCCESS) { - 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](String const& identifier, Variant const& entry) -> Error { - return this->_parse_province_identifier_entry(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 province_identifiers; - if (type == Variant::ARRAY) { - Array const& province_array = entry; - for (int64_t idx = 0; idx < province_array.size(); ++idx) { - Variant const& province_var = province_array[idx]; - type = province_var.get_type(); - if (type == Variant::STRING) { - String const& 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; - } - } - } - if (province_identifiers.empty()) { - UtilityFunctions::push_error("Invalid province list for region \"", identifier, "\": ", entry); - return FAILED; - } - std::string error_message; - if (map.add_region(identifier.utf8().get_data(), province_identifiers, error_message) != SUCCESS) { - 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](String const& identifier, Variant const& entry) -> Error { - return this->_parse_region_entry(identifier, entry); - }); - map.lock_regions(); - return err; -} - -Error MapSingleton::load_province_shape_file(String const& file_path) { - if (province_index_image.is_valid()) { - UtilityFunctions::push_error("Province shape file has already been loaded, cannot load: ", file_path); - return FAILED; - } - Ref province_shape_image; - province_shape_image.instantiate(); - Error err = province_shape_image->load(file_path); - if (err != OK) { - UtilityFunctions::push_error("Failed to load province shape file: ", file_path); - return err; - } - int32_t width = province_shape_image->get_width(); - int32_t height = province_shape_image->get_height(); - if (width < 1 || height < 1) { - UtilityFunctions::push_error("Invalid dimensions (", width, "x", height, ") for province shape file: ", file_path); - err = FAILED; - } - static const Image::Format expected_format = Image::FORMAT_RGB8; - 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; - } - if (err != OK) return err; - - std::string error_message; - if (map.generate_province_index_image(width, height, province_shape_image->get_data().ptr(), error_message) != SUCCESS) { - UtilityFunctions::push_error(error_message.c_str()); - err = FAILED; - } - - PackedByteArray index_data_array; - index_data_array.resize(width * height * sizeof(Province::index_t)); - memcpy(index_data_array.ptrw(), map.get_province_index_image().data(), index_data_array.size()); - - province_index_image = Image::create_from_data(width, height, false, Image::FORMAT_RG8, index_data_array); - if (province_index_image.is_null()) { - UtilityFunctions::push_error("Failed to create province ID image"); - err = FAILED; - } - - if (update_colour_image() != OK) err = FAILED; - - return err; -} - -Error MapSingleton::load_water_province_file(String const& file_path) { - Variant json_var; - Error err = load_json_file("water province", file_path, json_var); - if (err != OK) return err; - Variant::Type type = json_var.get_type(); - if (type != Variant::ARRAY) { - UtilityFunctions::push_error("Invalid water province JSON: root has type ", - Variant::get_type_name(type), " (expected Array)"); - err = FAILED; - } else { - Array const& array = json_var; - std::string error_message; - for (int64_t idx = 0; idx < array.size(); ++idx) { - Variant const& entry = array[idx]; - type = entry.get_type(); - if (type != Variant::STRING) { - UtilityFunctions::push_error("Invalid water province identifier: ", entry); - err = FAILED; - continue; - } - String const& identifier = entry; - if (map.set_water_province(identifier.utf8().get_data(), error_message) != SUCCESS) { - UtilityFunctions::push_error(error_message.c_str()); - err = FAILED; - } - } - } - map.lock_water_provinces(); - return err; -} - -Province* MapSingleton::get_province_from_uv_coords(godot::Vector2 const& coords) { - if (province_index_image.is_valid()) { - const PackedByteArray index_data_array = province_index_image->get_data(); - Province::index_t const* index_data = reinterpret_cast(index_data_array.ptr()); - const int32_t x_mod_w = UtilityFunctions::fposmod(coords.x, 1.0f) * get_width(); - const int32_t y_mod_h = UtilityFunctions::fposmod(coords.y, 1.0f) * get_height(); - return map.get_province_by_index(index_data[x_mod_w + y_mod_h * get_width()]); - } - return nullptr; -} - -Province const* MapSingleton::get_province_from_uv_coords(godot::Vector2 const& coords) const { - if (province_index_image.is_valid()) { - const PackedByteArray index_data_array = province_index_image->get_data(); - Province::index_t const* index_data = reinterpret_cast(index_data_array.ptr()); - const int32_t x_mod_w = UtilityFunctions::fposmod(coords.x, 1.0f) * get_width(); - const int32_t y_mod_h = UtilityFunctions::fposmod(coords.y, 1.0f) * get_height(); - return map.get_province_by_index(index_data[x_mod_w + y_mod_h * get_width()]); - } - return nullptr; -} - -int32_t MapSingleton::get_province_index_from_uv_coords(Vector2 const& coords) const { - Province const* province = get_province_from_uv_coords(coords); - if (province != nullptr) return province->get_index(); - return Province::NULL_INDEX; -} - -String MapSingleton::get_province_identifier_from_uv_coords(Vector2 const& coords) const { - Province const* province = get_province_from_uv_coords(coords); - if (province != nullptr) return province->get_identifier().c_str(); - return String{}; -} - -String MapSingleton::get_region_identifier_from_province_identifier(String const& identifier) const { - Province const* province = map.get_province_by_identifier(identifier.utf8().get_data()); - if (province != nullptr) { - Region const* region = province->get_region(); - if (region != nullptr) return region->get_identifier().c_str(); - } - return String{}; -} - -int32_t MapSingleton::get_width() const { - return map.get_width(); -} - -int32_t MapSingleton::get_height() const { - return map.get_height(); -} - -Ref MapSingleton::get_province_index_image() const { - return province_index_image; -} - -Ref MapSingleton::get_province_colour_image() const { - return province_colour_image; -} - -Error MapSingleton::update_colour_image() { - static PackedByteArray colour_data_array; - static const int64_t colour_data_array_size = (Province::MAX_INDEX + 1) * 4; - colour_data_array.resize(colour_data_array_size); - - Error err = OK; - std::string error_message; - if (map.generate_mapmode_colours(mapmode_index, colour_data_array.ptrw(), error_message) != SUCCESS) { - UtilityFunctions::push_error(error_message.c_str()); - err = FAILED; - } - - static const int32_t PROVINCE_INDEX_SQRT = 1 << (sizeof(Province::index_t) * 4); - if (province_colour_image.is_null()) - province_colour_image.instantiate(); - province_colour_image->set_data(PROVINCE_INDEX_SQRT, PROVINCE_INDEX_SQRT, - false, Image::FORMAT_RGBA8, colour_data_array); - if (province_colour_image.is_null()) { - UtilityFunctions::push_error("Failed to update province colour image"); - return FAILED; - } - return err; -} - -int32_t MapSingleton::get_mapmode_count() const { - return map.get_mapmode_count(); -} - -String MapSingleton::get_mapmode_identifier(int32_t index) const { - Mapmode const* mapmode = map.get_mapmode_by_index(index); - if (mapmode != nullptr) return mapmode->get_identifier().c_str(); - return String{}; -} - -Error MapSingleton::set_mapmode(godot::String const& identifier) { - Mapmode const* mapmode = map.get_mapmode_by_identifier(identifier.utf8().get_data()); - if (mapmode != nullptr) { - mapmode_index = mapmode->get_index(); - return OK; - } else { - UtilityFunctions::push_error("Failed to set mapmode to: ", identifier); - return FAILED; - } -} diff --git a/extension/src/MapSingleton.hpp b/extension/src/MapSingleton.hpp deleted file mode 100644 index 6ec2ea4..0000000 --- a/extension/src/MapSingleton.hpp +++ /dev/null @@ -1,50 +0,0 @@ -#pragma once - -#include - -#include - -#include "openvic2/Map.hpp" - -namespace OpenVic2 { - class MapSingleton : public godot::Object { - GDCLASS(MapSingleton, godot::Object) - - static MapSingleton* singleton; - - godot::Ref province_index_image, province_colour_image; - Map map; - Mapmode::index_t mapmode_index = 0; - - 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(); - - public: - static MapSingleton* get_singleton(); - - MapSingleton(); - ~MapSingleton(); - - godot::Error load_province_identifier_file(godot::String const& file_path); - godot::Error load_water_province_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); - - Province* get_province_from_uv_coords(godot::Vector2 const& coords); - Province const* get_province_from_uv_coords(godot::Vector2 const& coords) const; - int32_t get_province_index_from_uv_coords(godot::Vector2 const& coords) const; - godot::String get_province_identifier_from_uv_coords(godot::Vector2 const& coords) const; - godot::String get_region_identifier_from_province_identifier(godot::String const& identifier) const; - int32_t get_width() const; - int32_t get_height() const; - godot::Ref get_province_index_image() const; - godot::Ref get_province_colour_image() const; - - godot::Error update_colour_image(); - int32_t get_mapmode_count() const; - godot::String get_mapmode_identifier(int32_t index) const; - godot::Error set_mapmode(godot::String const& identifier); - }; -} diff --git a/extension/src/openvic2/Date.cpp b/extension/src/openvic2/Date.cpp index e1cef72..bb891fd 100644 --- a/extension/src/openvic2/Date.cpp +++ b/extension/src/openvic2/Date.cpp @@ -1,115 +1,161 @@ -#include -#include "Date.hpp" +#include "openvic2/Date.hpp" + +#include +#include + +#include "openvic2/Logger.hpp" using namespace OpenVic2; -bool Timespan::operator< (Timespan const& other) const { return days < other.days; } -bool Timespan::operator> (Timespan const& other) const { return days > other.days; } -bool Timespan::operator<= (Timespan const& other) const { return days <= other.days; } -bool Timespan::operator>= (Timespan const& other) const { return days >= other.days; } -bool Timespan::operator== (Timespan const& other) const { return days == other.days; } -bool Timespan::operator!= (Timespan const& other) const { return days != other.days; } +Timespan::Timespan(day_t value) : days{value} {} + +bool Timespan::operator<(Timespan other) const { return days < other.days; }; +bool Timespan::operator>(Timespan other) const { return days > other.days; }; +bool Timespan::operator<=(Timespan other) const { return days <= other.days; }; +bool Timespan::operator>=(Timespan other) const { return days >= other.days; }; +bool Timespan::operator==(Timespan other) const { return days == other.days; }; +bool Timespan::operator!=(Timespan other) const { return days != other.days; }; + +Timespan Timespan::operator+(Timespan other) const { return days + other.days; } + +Timespan Timespan::operator-(Timespan other) const { return days - other.days; } -Timespan Timespan::operator+ (Timespan const& other) const { return Timespan(days + other.days); } -Timespan Timespan::operator- (Timespan const& other) const { return Timespan(days - other.days); } -Timespan Timespan::operator* (int64_t const& factor) const { return Timespan(days * factor); } -Timespan Timespan::operator/ (int64_t const& factor) const { return Timespan(days / factor); } +Timespan Timespan::operator*(day_t factor) const { return days * factor; } -Timespan& Timespan::operator+= (Timespan const& other) { +Timespan Timespan::operator/(day_t factor) const { return days / factor; } + +Timespan& Timespan::operator+=(Timespan other) { days += other.days; return *this; } -Timespan& Timespan::operator-= (Timespan const& other) { + +Timespan& Timespan::operator-=(Timespan other) { days -= other.days; return *this; } -Timespan::operator std::string() const { - return std::to_string(days); +Timespan& Timespan::operator++() { + days++; + return *this; } -std::ostream &operator<<(std::ostream &out, Timespan const& timespan) { - return out << static_cast(timespan); + +Timespan Timespan::operator++(int) { + Timespan old = *this; + ++(*this); + return old; } -Timespan fromYearZero(year_t year, month_t month, date_t day) { - int64_t daysElapsed = year * DAYS_IN_YEAR; - size_t daysSinceMonthStart = (day == 0) ? 0 : day - 1; //Underflow protection - for (size_t x = 0; x < month && x < MONTHS_IN_YEAR; x++) { - daysElapsed += DAYS_IN_MONTH[x]; - } - daysElapsed += daysSinceMonthStart; - return Timespan(daysElapsed); +Timespan::operator day_t() const { + return days; } -//This function is not set up to handle dates before Year 0 -YearMonthDayBundle toGregorianDate(Timespan const& timespan) { - year_t year = 0; - month_t month = 0; - date_t day = 0; +Timespan::operator double() const { + return days; +} - if (timespan >= 0) { - year = timespan.days / DAYS_IN_YEAR; - int64_t remainingDays = timespan.days % DAYS_IN_YEAR; +Timespan::operator std::string() const { + return std::to_string(days); +} + +std::ostream& OpenVic2::operator<<(std::ostream& out, Timespan timespan) { + return out << static_cast(timespan); +} - for (size_t x = 0; x < MONTHS_IN_YEAR && remainingDays >= DAYS_IN_MONTH[x]; x++) { - remainingDays -= DAYS_IN_MONTH[x]; - month++; - } +Timespan Date::_dateToTimespan(year_t year, month_t month, day_t day) { + month = std::clamp(month, 1, MONTHS_IN_YEAR); + day = std::clamp(day, 1, DAYS_IN_MONTH[month - 1]); + return year * DAYS_IN_YEAR + DAYS_UP_TO_MONTH[month - 1] + day - 1; +} - //Corrects month and day to be 1-indexed - month++; - day++; +Date::Date(Timespan total_days) : timespan{ total_days } { + if (timespan < 0) { + Logger::error("Invalid timespan for date: ", timespan, " (cannot be negative)"); + timespan = 0; } - return std::make_tuple(year, month, day); } +Date::Date(year_t year, month_t month, day_t day) : timespan{ _dateToTimespan(year, month, day) } {} -Date::Date(Timespan const& timespan) : ts(timespan) { updateDate(ts); } +Date::year_t Date::getYear() const { + return static_cast(timespan) / DAYS_IN_YEAR; +} -Date::Date(year_t year, month_t month, date_t day) { - ts = fromYearZero(year, month, day); - updateDate(ts); +Date::month_t Date::getMonth() const { + return ((static_cast(timespan) % DAYS_IN_YEAR) / 32) + 1; } -void Date::updateDate(Timespan const& timespan) { - gregorianDate = toGregorianDate(timespan); +Date::day_t Date::getDay() const { + const Timespan::day_t days_in_year = static_cast(timespan) % DAYS_IN_YEAR; + return days_in_year - DAYS_UP_TO_MONTH[days_in_year / 32] + 1; } -size_t Date::getDay() const { return std::get<2>(gregorianDate); } -size_t Date::getMonth() const { return std::get<1>(gregorianDate); } -size_t Date::getYear() const { return std::get<0>(gregorianDate); } -bool Date::operator< (Date const& other) const { return ts < other.ts; } -bool Date::operator> (Date const& other) const { return ts > other.ts; } -bool Date::operator<= (Date const& other) const { return ts <= other.ts; } -bool Date::operator>= (Date const& other) const { return ts >= other.ts; } -bool Date::operator== (Date const& other) const { return ts == other.ts; } -bool Date::operator!= (Date const& other) const { return ts != other.ts; } +bool Date::operator<(Date other) const { return timespan < other.timespan; }; +bool Date::operator>(Date other) const { return timespan > other.timespan; }; +bool Date::operator<=(Date other) const { return timespan <= other.timespan; }; +bool Date::operator>=(Date other) const { return timespan >= other.timespan; }; +bool Date::operator==(Date other) const { return timespan == other.timespan; }; +bool Date::operator!=(Date other) const { return timespan != other.timespan; }; + +Date Date::operator+(Timespan other) const { return timespan + other; } + +Timespan Date::operator-(Date other) const { return timespan - other.timespan; } -Date Date::operator+ (Timespan timespan) const { return Date(ts + timespan); } -Timespan Date::operator- (Date const& other) const { return ts - other.ts; } +Date& Date::operator+=(Timespan other) { + timespan += other; + return *this; +} -Date& Date::operator+= (Timespan const& timespan) { - ts += timespan; - updateDate(ts); +Date& Date::operator-=(Timespan other) { + timespan -= other; return *this; } -Date& Date::operator-= (Timespan const& timespan) { - ts -= timespan; - updateDate(ts); + +Date& Date::operator++() { + timespan++; return *this; } -Date Date::operator++ (int) { - Date oldCopy = *this; - (*this) += 1; - return oldCopy; + +Date Date::operator++(int) { + Date old = *this; + ++(*this); + return old; } Date::operator std::string() const { std::stringstream ss; - ss << getYear() << '.' << getMonth() << '.' << getDay(); + ss << *this; return ss.str(); } -std::ostream &operator<<(std::ostream &out, Date const& date) { - return out << static_cast(date); + +std::ostream& OpenVic2::operator<<(std::ostream& out, Date date) { + return out << (int) date.getYear() << '.' << (int) date.getMonth() << '.' << (int) date.getDay(); } + +// Parsed from string of the form YYYY.MM.DD +Date Date::from_string(std::string const& date) { + year_t year = 0; + month_t month = 1; + day_t day = 1; + + size_t first_pos = 0; + while (first_pos < date.length() && std::isdigit(date[first_pos++])); + year = atoi(date.substr(0, first_pos).c_str()); + if (first_pos < date.length()) { + if (date[first_pos] == '.') { + size_t second_pos = first_pos + 1; + while (second_pos < date.length() && std::isdigit(date[second_pos++])); + month = atoi(date.substr(first_pos, second_pos - first_pos).c_str()); + if (second_pos < date.length()) { + if (date[second_pos] == '.') { + size_t third_pos = second_pos + 1; + while (third_pos < date.length() && std::isdigit(date[third_pos++])); + day = atoi(date.substr(second_pos, third_pos - second_pos).c_str()); + if (third_pos < date.length()) + Logger::error("Unexpected string \"", date.substr(third_pos), "\" at the end of date ", date); + } else Logger::error("Unexpected character \"", date[second_pos], "\" in date ", date); + } + } else Logger::error("Unexpected character \"", date[first_pos], "\" in date ", date); + } + return _dateToTimespan(year, month, day); +}; diff --git a/extension/src/openvic2/Date.hpp b/extension/src/openvic2/Date.hpp index 9ed5963..b19602b 100644 --- a/extension/src/openvic2/Date.hpp +++ b/extension/src/openvic2/Date.hpp @@ -1,86 +1,83 @@ #pragma once #include -#include -#include #include -#include +#include namespace OpenVic2 { - //A relative period between points in time, measured in days + // A relative period between points in time, measured in days struct Timespan { - int64_t days; - - Timespan() : days(0) {} - Timespan(int64_t const& value) : days(value) {} - - bool operator< (Timespan const& other) const; - bool operator> (Timespan const& other) const; - bool operator<= (Timespan const& other) const; - bool operator>= (Timespan const& other) const; - bool operator== (Timespan const& other) const; - bool operator!= (Timespan const& other) const; - - Timespan operator+ (Timespan const& other) const; - Timespan operator- (Timespan const& other) const; - Timespan operator* (int64_t const& factor) const; - Timespan operator/ (int64_t const& factor) const; - - Timespan& operator+= (Timespan const& other); - Timespan& operator-= (Timespan const& other); - + using day_t = int64_t; + private: + day_t days; + public: + Timespan(day_t value = 0); + + bool operator<(Timespan other) const; + bool operator>(Timespan other) const; + bool operator<=(Timespan other) const; + bool operator>=(Timespan other) const; + bool operator==(Timespan other) const; + bool operator!=(Timespan other) const; + + Timespan operator+(Timespan other) const; + Timespan operator-(Timespan other) const; + Timespan operator*(day_t factor) const; + Timespan operator/(day_t factor) const; + Timespan& operator+=(Timespan other); + Timespan& operator-=(Timespan other); + Timespan& operator++(); + Timespan operator++(int); + + explicit operator day_t() const; + explicit operator double() const; explicit operator std::string() const; - friend std::ostream& operator<< (std::ostream& out, Timespan const& timespan); }; + std::ostream& operator<< (std::ostream& out, Timespan timespan); - static constexpr size_t MONTHS_IN_YEAR = 12; - static constexpr size_t DAYS_IN_YEAR = 365; - static constexpr size_t DAYS_IN_MONTH[MONTHS_IN_YEAR] = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}; - - using date_t = uint8_t; - using month_t = uint8_t; - using year_t = uint16_t; - using YearMonthDayBundle = std::tuple; - - //Represents an in-game date - //Note: Current implementation does not account for leap-years, or dates before Year 0 + // Represents an in-game date + // Note: Current implementation does not account for leap-years, or dates before Year 0 struct Date { - private: - YearMonthDayBundle gregorianDate; - //Number of days since Jan 1st, Year 0 - Timespan ts; - - public: - //The Timespan is considered to be the number of days since Jan 1st, Year 0 - Date(Timespan const& timespan); - - //Year month day specification - Date(year_t year = 1836, month_t month = 1, date_t day = 1); - - private: - void updateDate(Timespan const& timespan); - - public: - size_t getDay() const; - size_t getMonth() const; - size_t getYear() const; - - bool operator< (Date const& other) const; - bool operator> (Date const& other) const; - bool operator<= (Date const& other) const; - bool operator>= (Date const& other) const; - bool operator== (Date const& other) const; - bool operator!= (Date const& other) const; - - Date operator+ (Timespan timespan) const; - Timespan operator- (Date const& other) const; - - Date& operator+= (Timespan const& timespan); - Date& operator-= (Timespan const& timespan); - //Postfix increment - Date operator++ (int); + using year_t = uint16_t; + using month_t = uint8_t; + using day_t = uint8_t; + + static constexpr Timespan::day_t MONTHS_IN_YEAR = 12; + static constexpr Timespan::day_t DAYS_IN_YEAR = 365; + static constexpr Timespan::day_t DAYS_IN_MONTH[MONTHS_IN_YEAR] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }; + static constexpr Timespan::day_t DAYS_UP_TO_MONTH[MONTHS_IN_YEAR] = { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 }; + private: + // Number of days since Jan 1st, Year 0 + Timespan timespan; + + static Timespan _dateToTimespan(year_t year, month_t month, day_t day); + public: + // The Timespan is considered to be the number of days since Jan 1st, Year 0 + Date(Timespan total_days); + // Year month day specification + Date(year_t year = 0, month_t month = 1, day_t day = 1); + + year_t getYear() const; + month_t getMonth() const; + day_t getDay() const; + + bool operator<(Date other) const; + bool operator>(Date other) const; + bool operator<=(Date other) const; + bool operator>=(Date other) const; + bool operator==(Date other) const; + bool operator!=(Date other) const; + + Date operator+(Timespan other) const; + Timespan operator-(Date other) const; + Date& operator+=(Timespan other); + Date& operator-=(Timespan other); + Date& operator++(); + Date operator++(int); explicit operator std::string() const; - friend std::ostream& operator<< (std::ostream& out, Date const& date); + // Parsed from string of the form YYYY.MM.DD + static Date from_string(std::string const& date); }; + std::ostream& operator<< (std::ostream& out, Date date); } diff --git a/extension/src/openvic2/GameAdvancementHook.cpp b/extension/src/openvic2/GameAdvancementHook.cpp index 3db3224..c78847b 100644 --- a/extension/src/openvic2/GameAdvancementHook.cpp +++ b/extension/src/openvic2/GameAdvancementHook.cpp @@ -1,69 +1,67 @@ -#include "GameAdvancementHook.hpp" +#include "openvic2/GameAdvancementHook.hpp" -namespace OpenVic2 { - GameAdvancementHook::GameAdvancementHook(AdvancementFunction function, bool startPaused, GameSpeed startingSpeed) { - triggerFunction = function; - lastPolledTime = std::chrono::high_resolution_clock::now(); - isPaused = startPaused; - currentSpeed = startingSpeed; - } +using namespace OpenVic2; - void GameAdvancementHook::increaseSimulationSpeed() { - switch (currentSpeed) { - case(GameSpeed::Speed1): - currentSpeed = GameSpeed::Speed2; - break; - case(GameSpeed::Speed2): - currentSpeed = GameSpeed::Speed3; - break; - case(GameSpeed::Speed3): - currentSpeed = GameSpeed::Speed4; - break; - case(GameSpeed::Speed4): - currentSpeed = GameSpeed::Speed5; - break; - } - } +const std::vector GameAdvancementHook::GAME_SPEEDS = { + std::chrono::milliseconds{ 4000 }, + std::chrono::milliseconds{ 3000 }, + std::chrono::milliseconds{ 2000 }, + std::chrono::milliseconds{ 1000 }, + std::chrono::milliseconds{ 100 }, + std::chrono::milliseconds{ 1 } }; - void GameAdvancementHook::decreaseSimulationSpeed() { - switch (currentSpeed) { - case(GameSpeed::Speed2): - currentSpeed = GameSpeed::Speed1; - break; - case(GameSpeed::Speed3): - currentSpeed = GameSpeed::Speed2; - break; - case(GameSpeed::Speed4): - currentSpeed = GameSpeed::Speed3; - break; - case(GameSpeed::Speed5): - currentSpeed = GameSpeed::Speed4; - break; - } - } +GameAdvancementHook::GameAdvancementHook(AdvancementFunction tickFunction, RefreshFunction updateFunction, bool startPaused, speed_t startingSpeed) + : triggerFunction{ tickFunction }, refreshFunction{ updateFunction }, isPaused{ startPaused } { + lastPolledTime = std::chrono::high_resolution_clock::now(); + setSimulationSpeed(startingSpeed); +} + +void GameAdvancementHook::setSimulationSpeed(speed_t speed) { + if (speed < 0) + currentSpeed = 0; + else if (speed >= GAME_SPEEDS.size()) + currentSpeed = GAME_SPEEDS.size() - 1; + else + currentSpeed = speed; +} + +GameAdvancementHook::speed_t GameAdvancementHook::getSimulationSpeed() const { + return currentSpeed; +} + +void GameAdvancementHook::increaseSimulationSpeed() { + setSimulationSpeed(currentSpeed + 1); +} + +void GameAdvancementHook::decreaseSimulationSpeed() { + setSimulationSpeed(currentSpeed - 1); +} + +bool GameAdvancementHook::canIncreaseSimulationSpeed() const { + return currentSpeed + 1 < GAME_SPEEDS.size(); +} + +bool GameAdvancementHook::canDecreaseSimulationSpeed() const { + return currentSpeed > 0; +} - GameAdvancementHook GameAdvancementHook::operator++(int) { - GameAdvancementHook oldCopy = *this; - increaseSimulationSpeed(); - return oldCopy; - }; +GameAdvancementHook& GameAdvancementHook::operator++() { + increaseSimulationSpeed(); + return *this; +}; - GameAdvancementHook GameAdvancementHook::operator--(int) { - GameAdvancementHook oldCopy = *this; - decreaseSimulationSpeed(); - return oldCopy; - }; +GameAdvancementHook& GameAdvancementHook::operator--() { + decreaseSimulationSpeed(); + return *this; +}; - void GameAdvancementHook::conditionallyAdvanceGame() { - if (!isPaused) { - std::chrono::time_point previousTime = lastPolledTime; - std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); - if (std::chrono::duration_cast(currentTime - previousTime).count() >= static_cast(currentSpeed)) { - lastPolledTime = currentTime; - if (triggerFunction) { - triggerFunction(); - } - } +void GameAdvancementHook::conditionallyAdvanceGame() { + if (!isPaused) { + std::chrono::time_point currentTime = std::chrono::high_resolution_clock::now(); + if (std::chrono::duration_cast(currentTime - lastPolledTime) >= GAME_SPEEDS[currentSpeed]) { + lastPolledTime = currentTime; + if (triggerFunction) triggerFunction(); } } -} \ No newline at end of file + if (refreshFunction) refreshFunction(); +} diff --git a/extension/src/openvic2/GameAdvancementHook.hpp b/extension/src/openvic2/GameAdvancementHook.hpp index 72af4ac..572494a 100644 --- a/extension/src/openvic2/GameAdvancementHook.hpp +++ b/extension/src/openvic2/GameAdvancementHook.hpp @@ -2,39 +2,40 @@ #include #include +#include namespace OpenVic2 { - //Value of different game speeds are the minimum number of miliseconds before the simulation advances - enum class GameSpeed { - Speed1 = 4000, - Speed2 = 3000, - Speed3 = 2000, - Speed4 = 1000, - Speed5 = 100, - Speed6 = 1 - }; - //Conditionally advances game with provided behaviour //Class governs game speed and pause state class GameAdvancementHook { public: using AdvancementFunction = std::function; + using RefreshFunction = std::function; + using speed_t = int8_t; + + //Minimum number of miliseconds before the simulation advances + static const std::vector GAME_SPEEDS; private: std::chrono::time_point lastPolledTime; //A function pointer that advances the simulation, intended to be a capturing lambda or something similar. May need to be reworked later AdvancementFunction triggerFunction; + RefreshFunction refreshFunction; public: bool isPaused; - GameSpeed currentSpeed; + speed_t currentSpeed; - GameAdvancementHook(AdvancementFunction function = nullptr, bool startPaused = false, GameSpeed startingSpeed = GameSpeed::Speed1); + GameAdvancementHook(AdvancementFunction tickFunction, RefreshFunction updateFunction, bool startPaused = false, speed_t startingSpeed = 0); + void setSimulationSpeed(speed_t speed); + speed_t getSimulationSpeed() const; void increaseSimulationSpeed(); void decreaseSimulationSpeed(); - GameAdvancementHook operator++(int); - GameAdvancementHook operator--(int); + bool canIncreaseSimulationSpeed() const; + bool canDecreaseSimulationSpeed() const; + GameAdvancementHook& operator++(); + GameAdvancementHook& operator--(); void conditionallyAdvanceGame(); }; } \ No newline at end of file diff --git a/extension/src/openvic2/GameManager.cpp b/extension/src/openvic2/GameManager.cpp new file mode 100644 index 0000000..da742ca --- /dev/null +++ b/extension/src/openvic2/GameManager.cpp @@ -0,0 +1,43 @@ +#include "openvic2/GameManager.hpp" + +#include "openvic2/Logger.hpp" + +using namespace OpenVic2; + +GameManager::GameManager(state_updated_func_t state_updated_callback) + : clock{ [this]() { tick(); }, [this]() { update_state(); }, true }, today{ 1836 }, state_updated{ state_updated_callback } {} + +void GameManager::set_needs_update() { + needs_update = true; +} + +void GameManager::update_state() { + if (needs_update) { + Logger::info("Update: ", today); + map.update_state(today); + if (state_updated) state_updated(); + needs_update = false; + } +} + +void GameManager::tick() { + today++; + Logger::info("Tick: ", today); + map.tick(today); + set_needs_update(); +} + +void GameManager::finished_loading_data() { + map.generate_province_buildings(building_manager); +} + +Date const& GameManager::get_today() const { + return today; +} + +return_t GameManager::expand_building(Province::index_t province_index, std::string const& building_type_identifier) { + set_needs_update(); + Province* province = map.get_province_by_index(province_index); + if (province == nullptr) return FAILURE; + return province->expand_building(building_type_identifier); +} diff --git a/extension/src/openvic2/GameManager.hpp b/extension/src/openvic2/GameManager.hpp new file mode 100644 index 0000000..cba0180 --- /dev/null +++ b/extension/src/openvic2/GameManager.hpp @@ -0,0 +1,29 @@ +#pragma once + +#include "openvic2/GameAdvancementHook.hpp" +#include "openvic2/map/Map.hpp" + +namespace OpenVic2 { + struct GameManager { + using state_updated_func_t = std::function; + + Map map; + BuildingManager building_manager; + GameAdvancementHook clock; + private: + Date today; + state_updated_func_t state_updated; + bool needs_update = true; + + void set_needs_update(); + void update_state(); + void tick(); + public: + GameManager(state_updated_func_t state_updated_callback); + + void finished_loading_data(); + + Date const& get_today() const; + return_t expand_building(Province::index_t province_index, std::string const& building_type_identifier); + }; +} diff --git a/extension/src/openvic2/Logger.cpp b/extension/src/openvic2/Logger.cpp new file mode 100644 index 0000000..f211e7e --- /dev/null +++ b/extension/src/openvic2/Logger.cpp @@ -0,0 +1,26 @@ +#include "openvic2/Logger.hpp" + +#include + +using namespace OpenVic2; + +Logger::log_func_t Logger::info_func = [](std::string&& str) { std::cout << str; }; +Logger::log_func_t Logger::error_func = [](std::string&& str) { std::cerr << str; }; + +const char* Logger::get_filename(const char* filepath) { + if (filepath == nullptr) return nullptr; + const char *last_slash = filepath; + while (*filepath != '\0') { + if (*filepath == '\\' || *filepath == '/') last_slash = filepath + 1; + filepath++; + } + return last_slash; +} + +void Logger::set_info_func(log_func_t log_func) { + info_func = log_func; +} + +void Logger::set_error_func(log_func_t log_func) { + error_func = log_func; +} diff --git a/extension/src/openvic2/Logger.hpp b/extension/src/openvic2/Logger.hpp new file mode 100644 index 0000000..749c67f --- /dev/null +++ b/extension/src/openvic2/Logger.hpp @@ -0,0 +1,83 @@ +#pragma once + +#include +#include +#ifdef __cpp_lib_source_location +#include +#endif + +namespace OpenVic2 { + + #ifndef __cpp_lib_source_location + #include + //Implementation of std::source_location for compilers that do not support it + //Note: uses non-standard extensions that are supported by Clang, GCC, and MSVC + //https://clang.llvm.org/docs/LanguageExtensions.html#source-location-builtins + //https://stackoverflow.com/a/67970107 + class source_location { + std::string _file; + int _line; + std::string _function; + + public: + source_location(std::string f, int l, std::string n) : _file(f), _line(l), _function(n) {} + static source_location current(std::string f = __builtin_FILE(), int l = __builtin_LINE(), std::string n = __builtin_FUNCTION()) { + return source_location(f, l, n); + } + + inline const char* file_name() const { return _file.c_str(); } + inline int line() const {return _line; } + inline const char* function_name() const { return _function.c_str(); } + }; + #endif + + class Logger { + using log_func_t = std::function; + + #ifdef __cpp_lib_source_location + using source_location = std::source_location; + #else + using source_location = OpenVic2::source_location; + #endif + + static log_func_t info_func, error_func; + + static const char* get_filename(const char* filepath); + + template + struct log { + log(log_func_t log_func, Ts&&... ts, const source_location& location) { + if (log_func) { + std::stringstream stream; + stream << std::endl << get_filename(location.file_name()) << "(" << location.line() << ") `" << location.function_name() << "`: "; + ((stream << std::forward(ts)), ...); + stream << std::endl; + log_func(stream.str()); + } + } + }; + public: + static void set_info_func(log_func_t log_func); + static void set_error_func(log_func_t log_func); + + template + struct info { + info(Ts&&... ts, const source_location& location = source_location::current()) { + log{ info_func, std::forward(ts)..., location }; + } + }; + + template + info(Ts&&...) -> info; + + template + struct error { + error(Ts&&... ts, const source_location& location = source_location::current()) { + log{ error_func, std::forward(ts)..., location }; + } + }; + + template + error(Ts&&...) -> error; + }; +} diff --git a/extension/src/openvic2/Map.cpp b/extension/src/openvic2/Map.cpp deleted file mode 100644 index 0ac8091..0000000 --- a/extension/src/openvic2/Map.cpp +++ /dev/null @@ -1,348 +0,0 @@ -#include "Map.hpp" - -#include -#include - -using namespace OpenVic2; - -static const std::string SEPARATOR = "\n - "; - -Mapmode::Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func) - : HasIdentifier(new_identifier), index(new_index), colour_func(new_colour_func) { - assert(colour_func != nullptr); -} - -Mapmode::index_t Mapmode::get_index() const { - return index; -} - -Mapmode::colour_func_t Mapmode::get_colour_func() const { - return colour_func; -} - -return_t 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!"; - return FAILURE; - } - if (provinces.size() >= Province::MAX_INDEX) { - error_message = "The map's province list is full - there can be at most " + std::to_string(Province::MAX_INDEX) + " provinces"; - return FAILURE; - } - if (identifier.empty()) { - error_message = "Empty province identifier for colour " + Province::colour_to_hex_string(colour); - return FAILURE; - } - if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) { - error_message = "Invalid province colour: " + Province::colour_to_hex_string(colour); - return FAILURE; - } - Province new_province{ static_cast(provinces.size() + 1), identifier, colour }; - Province const* old_province = get_province_by_identifier(identifier); - if (old_province != nullptr) { - error_message = "Duplicate province identifiers: " + old_province->to_string() + " and " + new_province.to_string(); - return FAILURE; - } - old_province = get_province_by_colour(colour); - if (old_province != nullptr) { - error_message = "Duplicate province colours: " + old_province->to_string() + " and " + new_province.to_string(); - return FAILURE; - } - provinces.push_back(new_province); - error_message = "Added province: " + new_province.to_string(); - return SUCCESS; -} - -void Map::lock_provinces() { - provinces_locked = true; -} - -return_t Map::set_water_province(std::string const& identifier, std::string& error_message) { - if (water_provinces_locked) { - error_message = "The map's water provinces have already been locked!"; - return FAILURE; - } - Province* province = get_province_by_identifier(identifier); - if (province == nullptr) { - error_message = "Unrecognised water province identifier: " + identifier; - return FAILURE; - } - if (province->is_water()) { - error_message = "Province " + identifier + " is already a water province!"; - return FAILURE; - } - province->water = true; - error_message = "Set province " + identifier + " as a water province"; - return SUCCESS; -} - -void Map::lock_water_provinces() { - water_provinces_locked = true; -} - -return_t Map::add_region(std::string const& identifier, std::vector const& province_identifiers, std::string& error_message) { - if (regions_locked) { - error_message = "The map's region list has already been locked!"; - return FAILURE; - } - if (identifier.empty()) { - error_message = "Empty region identifier!"; - return FAILURE; - } - if (provinces.empty()) { - error_message = "Empty province list for region " + identifier; - return FAILURE; - } - Region new_region{ identifier }; - error_message.clear(); - for (std::string const& province_identifier : province_identifiers) { - Province* province = get_province_by_identifier(province_identifier); - if (province != nullptr) { - if (new_region.contains_province(province)) - error_message += SEPARATOR + "Duplicate province identifier " + province_identifier; - else { - size_t other_region_index = reinterpret_cast(province->get_region()); - if (other_region_index != 0) { - other_region_index--; - error_message += SEPARATOR + "Province " + province_identifier + " is already part of "; - 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.insert(province); - } - } else error_message += SEPARATOR + "Invalid province identifier " + province_identifier; - } - return_t ret = SUCCESS; - if (!new_region.get_province_count()) { - error_message += SEPARATOR + "No valid provinces in region's list"; - ret = FAILURE; - } - Region const* old_region = get_region_by_identifier(identifier); - if (old_region != nullptr) { - error_message += SEPARATOR + "Duplicate region identifiers: " + old_region->get_identifier() + " and " + identifier; - ret = FAILURE; - } - - if (ret == SUCCESS) { - regions.push_back(new_region); - // 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(regions.size()); - for (Province* province : new_region.get_provinces()) - province->region = tmp_region_index; - if (!error_message.empty()) { - error_message += SEPARATOR; - ret = FAILURE; - } - error_message += "Added region: " + identifier; - } - if (ret != SUCCESS) error_message = "Error message for region: " + identifier + error_message; - return ret; -} - -void Map::lock_regions() { - regions_locked = true; - for (Region& region : regions) - for (Province* province : region.get_provinces()) - province->region = ®ion; -} - -size_t Map::get_province_count() const { - return provinces.size(); -} - -Province* Map::get_province_by_index(Province::index_t index) { - return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; -} - -Province const* Map::get_province_by_index(Province::index_t index) const { - return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; -} - -Province* Map::get_province_by_identifier(std::string const& identifier) { - if (!identifier.empty()) - for (Province& province : provinces) - if (province.get_identifier() == identifier) return &province; - return nullptr; -} - -Province const* Map::get_province_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Province const& province : provinces) - if (province.get_identifier() == identifier) return &province; - return nullptr; -} - -Province* Map::get_province_by_colour(Province::colour_t colour) { - if (colour != Province::NULL_COLOUR) - for (Province& province : provinces) - if (province.get_colour() == colour) return &province; - return nullptr; -} - -Province const* Map::get_province_by_colour(Province::colour_t colour) const { - if (colour != Province::NULL_COLOUR) - for (Province const& province : provinces) - if (province.get_colour() == colour) return &province; - return nullptr; -} - -Region* Map::get_region_by_identifier(std::string const& identifier) { - if (!identifier.empty()) - for (Region& region : regions) - if (region.get_identifier() == identifier) return ®ion; - return nullptr; -} - -Region const* Map::get_region_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Region const& region : regions) - if (region.get_identifier() == identifier) return ®ion; - return nullptr; -} - -static Province::colour_t colour_at(uint8_t const* colour_data, int32_t idx) { - return (colour_data[idx * 3] << 16) | (colour_data[idx * 3 + 1] << 8) | colour_data[idx * 3 + 2]; -} - -return_t Map::generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message) { - if (!province_index_image.empty()) { - error_message = "Province index image has already been generated!"; - return FAILURE; - } - if (!provinces_locked) { - error_message = "Province index image cannot be generated until after provinces are locked!"; - return FAILURE; - } - if (new_width < 1 || new_height < 1) { - error_message = "Invalid province image dimensions: " + std::to_string(new_width) + "x" + std::to_string(new_height); - return FAILURE; - } - if (colour_data == nullptr) { - error_message = "Province colour data pointer is null!"; - return FAILURE; - } - width = new_width; - height = new_height; - province_index_image.resize(width * height); - - std::vector province_checklist(provinces.size()); - return_t ret = SUCCESS; - std::unordered_set unrecognised_colours; - error_message.clear(); - - for (int32_t y = 0; y < height; ++y) { - for (int32_t x = 0; x < width; ++x) { - const int32_t idx = x + y * width; - const Province::colour_t colour = colour_at(colour_data, idx); - if (x > 0) { - const int32_t jdx = idx - 1; - if (colour_at(colour_data, jdx) == colour) { - province_index_image[idx] = province_index_image[jdx]; - continue; - } - } - if (y > 0) { - const int32_t jdx = idx - width; - if (colour_at(colour_data, jdx) == colour) { - province_index_image[idx] = province_index_image[jdx]; - continue; - } - } - Province const* province = get_province_by_colour(colour); - if (province != nullptr) { - const Province::index_t index = province->get_index(); - province_index_image[idx] = index; - province_checklist[index - 1] = true; - continue; - } - if (unrecognised_colours.find(colour) == unrecognised_colours.end()) { - unrecognised_colours.insert(colour); - error_message += SEPARATOR + "Unrecognised province colour " + Province::colour_to_hex_string(colour) + " at (" + std::to_string(x) + ", " + std::to_string(y) + ")"; - ret = FAILURE; - } - province_index_image[idx] = Province::NULL_INDEX; - } - } - - for (size_t idx = 0; idx < province_checklist.size(); ++idx) { - if (!province_checklist[idx]) { - error_message += SEPARATOR + "Province missing from shape image: " + provinces[idx].to_string(); - ret = FAILURE; - } - } - - if (!error_message.empty()) error_message = "Error message for province index image generation:" + error_message + SEPARATOR; - error_message += "Generated province index image"; - return ret; -} - -size_t Map::get_width() const { - return width; -} - -size_t Map::get_height() const { - return height; -} - -std::vector const& Map::get_province_index_image() const { - return province_index_image; -} - -return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message) { - if (identifier.empty()) { - error_message = "Empty mapmode identifier!"; - return FAILURE; - } - if (colour_func == nullptr) { - error_message = "Mapmode colour function is null for identifier: " + identifier; - return FAILURE; - } - Mapmode new_mapmode{ mapmodes.size(), identifier, colour_func }; - Mapmode const* old_mapmode = get_mapmode_by_identifier(identifier); - if (old_mapmode != nullptr) { - error_message = "Duplicate mapmode identifiers: " + old_mapmode->get_identifier() + " and " + identifier; - return FAILURE; - } - mapmodes.push_back(new_mapmode); - error_message = "Added mapmode: " + identifier; - return SUCCESS; -} - -size_t Map::get_mapmode_count() const { - return mapmodes.size(); -} - -Mapmode const* Map::get_mapmode_by_index(size_t index) const { - return index < mapmodes.size() ? &mapmodes[index] : nullptr; -} - -Mapmode const* Map::get_mapmode_by_identifier(std::string const& identifier) const { - if (!identifier.empty()) - for (Mapmode const& mapmode : mapmodes) - if (mapmode.get_identifier() == identifier) return &mapmode; - return nullptr; -} - -return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const { - if (target == nullptr) { - error_message = "Mapmode colour target pointer is null!"; - return FAILURE; - } - if (index >= mapmodes.size()) { - error_message = "Invalid mapmode index: " + std::to_string(index); - return FAILURE; - } - Mapmode const& mapmode = mapmodes[index]; - target += 4; // Skip past Province::NULL_INDEX - for (Province const& province : provinces) { - const Province::colour_t colour = mapmode.get_colour_func()(*this, province); - *target++ = (colour >> 16) & 0xFF; - *target++ = (colour >> 8) & 0xFF; - *target++ = colour & 0xFF; - *target++ = province.is_water() ? 0 : 255; - } - error_message = "Generated province colours for mapmode " + mapmode.get_identifier(); - return SUCCESS; -} diff --git a/extension/src/openvic2/Map.hpp b/extension/src/openvic2/Map.hpp deleted file mode 100644 index 73ab8fd..0000000 --- a/extension/src/openvic2/Map.hpp +++ /dev/null @@ -1,67 +0,0 @@ -#pragma once - -#include -#include - -#include "Region.hpp" - -namespace OpenVic2 { - - struct Mapmode : HasIdentifier { - friend struct Map; - - using colour_func_t = std::function; - using index_t = size_t; - private: - index_t index; - colour_func_t colour_func; - - Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func); - public: - index_t get_index() const; - colour_func_t get_colour_func() const; - }; - - /* REQUIREMENTS: - * MAP-4 - */ - struct Map { - private: - std::vector provinces; - std::vector regions; - bool provinces_locked = false, water_provinces_locked = false, regions_locked = false; - - size_t width = 0, height = 0; - std::vector province_index_image; - std::vector mapmodes; - public: - return_t add_province(std::string const& identifier, Province::colour_t colour, std::string& error_message); - void lock_provinces(); - return_t set_water_province(std::string const& identifier, std::string& error_message); - void lock_water_provinces(); - return_t add_region(std::string const& identifier, std::vector 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); - Province const* get_province_by_index(Province::index_t index) const; - Province* get_province_by_identifier(std::string const& identifier); - Province const* get_province_by_identifier(std::string const& identifier) const; - Province* get_province_by_colour(Province::colour_t colour); - Province const* get_province_by_colour(Province::colour_t colour) const; - - Region* get_region_by_identifier(std::string const& identifier); - Region const* get_region_by_identifier(std::string const& identifier) const; - - return_t generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data, std::string& error_message); - size_t get_width() const; - size_t get_height() const; - std::vector const& get_province_index_image() const; - - return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func, std::string& error_message); - size_t get_mapmode_count() const; - Mapmode const* get_mapmode_by_index(Mapmode::index_t index) const; - Mapmode const* get_mapmode_by_identifier(std::string const& identifier) const; - return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target, std::string& error_message) const; - }; -} diff --git a/extension/src/openvic2/Province.cpp b/extension/src/openvic2/Province.cpp deleted file mode 100644 index 7d55708..0000000 --- a/extension/src/openvic2/Province.cpp +++ /dev/null @@ -1,43 +0,0 @@ -#include "Province.hpp" - -#include -#include -#include - -using namespace OpenVic2; - -Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : - HasIdentifier(new_identifier), index(new_index), colour(new_colour) { - assert(index != NULL_INDEX); - assert(colour != NULL_COLOUR); -} - -std::string Province::colour_to_hex_string(colour_t colour) { - std::ostringstream stream; - stream << std::hex << std::setfill('0') << std::setw(6) << colour; - return stream.str(); -} - -Province::index_t Province::get_index() const { - return index; -} - -Province::colour_t Province::get_colour() const { - return colour; -} - -Region* Province::get_region() const { - return region; -} - -bool Province::is_water() const { - return water; -} - -Province::life_rating_t Province::get_life_rating() const { - return life_rating; -} - -std::string Province::to_string() const { - return "(#" + std::to_string(index) + ", " + get_identifier() + ", 0x" + colour_to_hex_string(colour) + ")"; -} diff --git a/extension/src/openvic2/Province.hpp b/extension/src/openvic2/Province.hpp deleted file mode 100644 index deebd8c..0000000 --- a/extension/src/openvic2/Province.hpp +++ /dev/null @@ -1,39 +0,0 @@ -#pragma once - -#include "Types.hpp" - -namespace OpenVic2 { - struct Region; - struct Map; - - /* 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 const colour_t NULL_COLOUR = 0, MAX_COLOUR = 0xFFFFFF; - static const index_t NULL_INDEX = 0, MAX_INDEX = 0xFFFF; - private: - index_t index; - colour_t colour; - Region* region = nullptr; - bool water = false; - life_rating_t life_rating = 0; - - 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); - - 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; - std::string to_string() const; - }; -} diff --git a/extension/src/openvic2/Region.cpp b/extension/src/openvic2/Region.cpp deleted file mode 100644 index 67a75a9..0000000 --- a/extension/src/openvic2/Region.cpp +++ /dev/null @@ -1,26 +0,0 @@ -#include "Region.hpp" - -#include -#include - -using namespace OpenVic2; - -size_t ProvinceSet::get_province_count() const { - return provinces.size(); -} - -bool ProvinceSet::contains_province(Province const* province) const { - return province && std::find(provinces.begin(), provinces.end(), province) != provinces.end(); -} - -std::set const& ProvinceSet::get_provinces() const { - return provinces; -} - -Region::Region(std::string const& new_identifier) : HasIdentifier(new_identifier) {} - -Province::colour_t Region::get_colour() const { - if (provinces.empty()) return 0xFF0000; - Province const* province = *provinces.cbegin(); - return province->get_colour(); -} diff --git a/extension/src/openvic2/Region.hpp b/extension/src/openvic2/Region.hpp deleted file mode 100644 index 4ebabd1..0000000 --- a/extension/src/openvic2/Region.hpp +++ /dev/null @@ -1,29 +0,0 @@ -#pragma once - -#include - -#include "Province.hpp" - -namespace OpenVic2 { - struct Map; - - struct ProvinceSet { - protected: - std::set provinces; - public: - size_t get_province_count() const; - bool contains_province(Province const* province) const; - std::set const& get_provinces() const; - }; - - /* REQUIREMENTS: - * MAP-6, MAP-44, MAP-48 - */ - struct Region : HasIdentifier, ProvinceSet { - friend struct Map; - private: - Region(std::string const& new_identifier); - public: - Province::colour_t get_colour() const; - }; -} diff --git a/extension/src/openvic2/Types.cpp b/extension/src/openvic2/Types.cpp index 67c7a21..861ab50 100644 --- a/extension/src/openvic2/Types.cpp +++ b/extension/src/openvic2/Types.cpp @@ -1,10 +1,10 @@ -#include "Types.hpp" +#include "openvic2/Types.hpp" #include using namespace OpenVic2; -HasIdentifier::HasIdentifier(std::string const& new_identifier) : identifier(new_identifier) { +HasIdentifier::HasIdentifier(std::string const& new_identifier) : identifier{ new_identifier } { assert(!identifier.empty()); } diff --git a/extension/src/openvic2/Types.hpp b/extension/src/openvic2/Types.hpp index bf5ee27..b20db10 100644 --- a/extension/src/openvic2/Types.hpp +++ b/extension/src/openvic2/Types.hpp @@ -1,14 +1,16 @@ #pragma once #include +#include + +#include "openvic2/Logger.hpp" namespace OpenVic2 { using return_t = bool; // This mirrors godot::Error, where `OK = 0` and `FAILED = 1`. - static const return_t SUCCESS = false, FAILURE = true; + static constexpr return_t SUCCESS = false, FAILURE = true; - struct HasIdentifier { - private: + class HasIdentifier { std::string identifier; protected: HasIdentifier(std::string const& new_identifier); diff --git a/extension/src/openvic2/map/Building.cpp b/extension/src/openvic2/map/Building.cpp new file mode 100644 index 0000000..f453a0f --- /dev/null +++ b/extension/src/openvic2/map/Building.cpp @@ -0,0 +1,129 @@ +#include "openvic2/map/Building.hpp" + +#include + +#include "openvic2/Logger.hpp" + +using namespace OpenVic2; + +Building::Building(BuildingType const& new_type) : type{ new_type } {} + +bool Building::_can_expand() const { + return level < type.get_max_level(); +} + +BuildingType const& Building::get_type() const { + return type; +} + +Building::level_t Building::get_level() const { + return level; +} + +Building::ExpansionState Building::get_expansion_state() const { + return expansion_state; +} + +Date const& Building::get_start_date() const { + return start; +} + +Date const& Building::get_end_date() const { + return end; +} + +float Building::get_expansion_progress() const { + return expansion_progress; +} + +return_t Building::expand() { + if (expansion_state == ExpansionState::CanExpand) { + expansion_state = ExpansionState::Preparing; + expansion_progress = 0.0f; + return SUCCESS; + } + return FAILURE; +} + +void Building::update_state(Date const& today) { + switch (expansion_state) { + case ExpansionState::Preparing: + start = today; + end = start + type.get_build_time(); + break; + case ExpansionState::Expanding: + expansion_progress = static_cast(today - start) / static_cast(end - start); + break; + default: expansion_state = _can_expand() ? ExpansionState::CanExpand : ExpansionState::CannotExpand; + } +} + +void Building::tick(Date const& today) { + if (expansion_state == ExpansionState::Preparing) { + expansion_state = ExpansionState::Expanding; + } + if (expansion_state == ExpansionState::Expanding) { + if (end <= today) { + level++; + expansion_state = ExpansionState::CannotExpand; + } + } +} + +BuildingType::BuildingType(std::string const& new_identifier, Building::level_t new_max_level, Timespan new_build_time) : + HasIdentifier{ new_identifier }, max_level{ new_max_level }, build_time{ new_build_time } { + assert(new_max_level >= 0); + assert(build_time >= 0); +} + +Building::level_t BuildingType::get_max_level() const { + return max_level; +} + +Timespan BuildingType::get_build_time() const { + return build_time; +} + +return_t BuildingManager::add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time) { + if (building_types_locked) { + Logger::error("The building type list has already been locked!"); + return FAILURE; + } + if (identifier.empty()) { + Logger::error("Empty building type identifier!"); + return FAILURE; + } + if (max_level < 0) { + Logger::error("Invalid building type max level: ", max_level); + return FAILURE; + } + if (build_time < 0) { + Logger::error("Invalid building type build time: ", build_time); + return FAILURE; + } + BuildingType new_building_type{ identifier, max_level, build_time }; + BuildingType const* old_building_type = get_building_type_by_identifier(identifier); + if (old_building_type != nullptr) { + Logger::error("Duplicate building type identifiers: ", old_building_type->get_identifier(), " and ", identifier); + return FAILURE; + } + building_types.push_back(new_building_type); + return SUCCESS; +} + +void BuildingManager::lock_building_types() { + building_types_locked = true; + Logger::info("Locked building types after registering ", building_types.size()); +} + +BuildingType const* BuildingManager::get_building_type_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (BuildingType const& building_type : building_types) + if (building_type.get_identifier() == identifier) return &building_type; + return nullptr; +} + +void BuildingManager::generate_province_buildings(std::vector& buildings) const { + for (BuildingType const& type : building_types) + buildings.push_back(Building{ type }); +} diff --git a/extension/src/openvic2/map/Building.hpp b/extension/src/openvic2/map/Building.hpp new file mode 100644 index 0000000..7a1a777 --- /dev/null +++ b/extension/src/openvic2/map/Building.hpp @@ -0,0 +1,63 @@ +#pragma once + +#include + +#include "openvic2/Types.hpp" +#include "openvic2/Date.hpp" + +namespace OpenVic2 { + struct BuildingManager; + struct BuildingType; + + struct Building { + friend struct BuildingManager; + + using level_t = int8_t; + + enum class ExpansionState { CannotExpand, CanExpand, Preparing, Expanding }; + private: + BuildingType const& type; + level_t level = 0; + ExpansionState expansion_state = ExpansionState::CannotExpand; + Date start, end; + float expansion_progress; + + Building(BuildingType const& new_type); + + bool _can_expand() const; + public: + BuildingType const& get_type() const; + level_t get_level() const; + ExpansionState get_expansion_state() const; + Date const& get_start_date() const; + Date const& get_end_date() const; + float get_expansion_progress() const; + + return_t expand(); + void update_state(Date const& today); + void tick(Date const& today); + }; + + struct BuildingType : HasIdentifier { + friend struct BuildingManager; + private: + Building::level_t max_level; + Timespan build_time; + + BuildingType(std::string const& new_identifier, Building::level_t new_max_level, Timespan new_build_time); + public: + Building::level_t get_max_level() const; + Timespan get_build_time() const; + }; + + struct BuildingManager { + private: + std::vector building_types; + bool building_types_locked = false; + public: + return_t add_building_type(std::string const& identifier, Building::level_t max_level, Timespan build_time); + void lock_building_types(); + BuildingType const* get_building_type_by_identifier(std::string const& identifier) const; + void generate_province_buildings(std::vector& buildings) const; + }; +} diff --git a/extension/src/openvic2/map/Map.cpp b/extension/src/openvic2/map/Map.cpp new file mode 100644 index 0000000..1089d61 --- /dev/null +++ b/extension/src/openvic2/map/Map.cpp @@ -0,0 +1,359 @@ +#include "openvic2/map/Map.hpp" + +#include +#include + +#include "openvic2/Logger.hpp" + +using namespace OpenVic2; + +Mapmode::Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func) + : HasIdentifier{ new_identifier }, index{ new_index }, colour_func{ new_colour_func } { + assert(colour_func != nullptr); +} + +Mapmode::index_t Mapmode::get_index() const { + return index; +} + +Mapmode::colour_func_t Mapmode::get_colour_func() const { + return colour_func; +} + +return_t Map::add_province(std::string const& identifier, Province::colour_t colour) { + if (provinces_locked) { + Logger::error("The map's province list has already been locked!"); + return FAILURE; + } + if (provinces.size() >= Province::MAX_INDEX) { + Logger::error("The map's province list is full - there can be at most ", Province::MAX_INDEX, " provinces"); + return FAILURE; + } + if (identifier.empty()) { + Logger::error("Empty province identifier for colour ", Province::colour_to_hex_string(colour)); + return FAILURE; + } + if (colour == Province::NULL_COLOUR || colour > Province::MAX_COLOUR) { + Logger::error("Invalid province colour: ", Province::colour_to_hex_string(colour)); + return FAILURE; + } + Province new_province{ static_cast(provinces.size() + 1), identifier, colour }; + Province const* old_province = get_province_by_identifier(identifier); + if (old_province != nullptr) { + Logger::error("Duplicate province identifiers: ", old_province->to_string(), " and ", new_province.to_string()); + return FAILURE; + } + old_province = get_province_by_colour(colour); + if (old_province != nullptr) { + Logger::error("Duplicate province colours: ", old_province->to_string(), " and ", new_province.to_string()); + return FAILURE; + } + provinces.push_back(new_province); + return SUCCESS; +} + +void Map::lock_provinces() { + provinces_locked = true; + Logger::info("Locked provinces after registering ", provinces.size()); +} + +return_t Map::set_water_province(std::string const& identifier) { + if (water_provinces_locked) { + Logger::error("The map's water provinces have already been locked!"); + return FAILURE; + } + Province* province = get_province_by_identifier(identifier); + if (province == nullptr) { + Logger::error("Unrecognised water province identifier: ", identifier); + return FAILURE; + } + if (province->is_water()) { + Logger::error("Province ", identifier, " is already a water province!"); + return FAILURE; + } + province->water = true; + water_province_count++; + return SUCCESS; +} + +void Map::lock_water_provinces() { + water_provinces_locked = true; + Logger::info("Locked water provinces after registering ", water_province_count); +} + +return_t Map::add_region(std::string const& identifier, std::vector const& province_identifiers) { + if (regions_locked) { + Logger::error("The map's region list has already been locked!"); + return FAILURE; + } + if (identifier.empty()) { + Logger::error("Empty region identifier!"); + return FAILURE; + } + if (provinces.empty()) { + Logger::error("Empty province list for region ", identifier); + return FAILURE; + } + return_t ret = SUCCESS; + Region new_region{ identifier }; + for (std::string const& province_identifier : province_identifiers) { + Province* province = get_province_by_identifier(province_identifier); + if (province != nullptr) { + if (new_region.contains_province(province)) { + Logger::error("Duplicate province identifier ", province_identifier); + ret = FAILURE; + } else { + size_t other_region_index = reinterpret_cast(province->get_region()); + if (other_region_index != 0) { + other_region_index--; + if (other_region_index < regions.size()) + Logger::error("Province ", province_identifier, " is already part of ", regions[other_region_index].get_identifier()); + else + Logger::error("Province ", province_identifier, " is already part of an unknown region with index ", other_region_index); + ret = FAILURE; + } else new_region.provinces.insert(province); + } + } else { + Logger::error("Invalid province identifier ", province_identifier); + ret = FAILURE; + } + } + if (!new_region.get_province_count()) { + Logger::error("No valid provinces in region's list"); + return FAILURE; + } + Region const* old_region = get_region_by_identifier(identifier); + if (old_region != nullptr) { + Logger::error("Duplicate region identifiers: ", old_region->get_identifier(), " and ", identifier); + return FAILURE; + } + + regions.push_back(new_region); + // 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(regions.size()); + for (Province* province : new_region.get_provinces()) + province->region = tmp_region_index; + return ret; +} + +void Map::lock_regions() { + regions_locked = true; + for (Region& region : regions) + for (Province* province : region.get_provinces()) + province->region = ®ion; + Logger::info("Locked regions after registering ", regions.size()); +} + +size_t Map::get_province_count() const { + return provinces.size(); +} + +Province* Map::get_province_by_index(Province::index_t index) { + return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; +} + +Province const* Map::get_province_by_index(Province::index_t index) const { + return index != Province::NULL_INDEX && index <= provinces.size() ? &provinces[index - 1] : nullptr; +} + +Province* Map::get_province_by_identifier(std::string const& identifier) { + if (!identifier.empty()) + for (Province& province : provinces) + if (province.get_identifier() == identifier) return &province; + return nullptr; +} + +Province const* Map::get_province_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (Province const& province : provinces) + if (province.get_identifier() == identifier) return &province; + return nullptr; +} + +Province* Map::get_province_by_colour(Province::colour_t colour) { + if (colour != Province::NULL_COLOUR) + for (Province& province : provinces) + if (province.get_colour() == colour) return &province; + return nullptr; +} + +Province const* Map::get_province_by_colour(Province::colour_t colour) const { + if (colour != Province::NULL_COLOUR) + for (Province const& province : provinces) + if (province.get_colour() == colour) return &province; + return nullptr; +} + +Province::index_t Map::get_province_index_at(size_t x, size_t y) const { + if (x < width && y < height) return province_index_image[x + y * width]; + return Province::NULL_INDEX; +} + +Region* Map::get_region_by_identifier(std::string const& identifier) { + if (!identifier.empty()) + for (Region& region : regions) + if (region.get_identifier() == identifier) return ®ion; + return nullptr; +} + +Region const* Map::get_region_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (Region const& region : regions) + if (region.get_identifier() == identifier) return ®ion; + return nullptr; +} + +static Province::colour_t colour_at(uint8_t const* colour_data, int32_t idx) { + return (colour_data[idx * 3] << 16) | (colour_data[idx * 3 + 1] << 8) | colour_data[idx * 3 + 2]; +} + +return_t Map::generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data) { + if (!province_index_image.empty()) { + Logger::error("Province index image has already been generated!"); + return FAILURE; + } + if (!provinces_locked) { + Logger::error("Province index image cannot be generated until after provinces are locked!"); + return FAILURE; + } + if (new_width < 1 || new_height < 1) { + Logger::error("Invalid province image dimensions: ", new_width, "x", new_height); + return FAILURE; + } + if (colour_data == nullptr) { + Logger::error("Province colour data pointer is null!"); + return FAILURE; + } + width = new_width; + height = new_height; + province_index_image.resize(width * height); + + std::vector province_checklist(provinces.size()); + return_t ret = SUCCESS; + std::unordered_set unrecognised_colours; + + for (int32_t y = 0; y < height; ++y) { + for (int32_t x = 0; x < width; ++x) { + const int32_t idx = x + y * width; + const Province::colour_t colour = colour_at(colour_data, idx); + if (x > 0) { + const int32_t jdx = idx - 1; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + if (y > 0) { + const int32_t jdx = idx - width; + if (colour_at(colour_data, jdx) == colour) { + province_index_image[idx] = province_index_image[jdx]; + continue; + } + } + Province const* province = get_province_by_colour(colour); + if (province != nullptr) { + const Province::index_t index = province->get_index(); + province_index_image[idx] = index; + province_checklist[index - 1] = true; + continue; + } + if (unrecognised_colours.find(colour) == unrecognised_colours.end()) { + unrecognised_colours.insert(colour); + Logger::error("Unrecognised province colour ", Province::colour_to_hex_string(colour), " at (", x, ", ", y, ")"); + ret = FAILURE; + } + province_index_image[idx] = Province::NULL_INDEX; + } + } + + for (size_t idx = 0; idx < province_checklist.size(); ++idx) { + if (!province_checklist[idx]) { + Logger::error("Province missing from shape image: ", provinces[idx].to_string()); + ret = FAILURE; + } + } + return ret; +} + +size_t Map::get_width() const { + return width; +} + +size_t Map::get_height() const { + return height; +} + +std::vector const& Map::get_province_index_image() const { + return province_index_image; +} + +return_t Map::add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func) { + if (identifier.empty()) { + Logger::error("Empty mapmode identifier!"); + return FAILURE; + } + if (colour_func == nullptr) { + Logger::error("Mapmode colour function is null for identifier: ", identifier); + return FAILURE; + } + Mapmode new_mapmode{ mapmodes.size(), identifier, colour_func }; + Mapmode const* old_mapmode = get_mapmode_by_identifier(identifier); + if (old_mapmode != nullptr) { + Logger::error("Duplicate mapmode identifiers: ", old_mapmode->get_identifier(), " and ", identifier); + return FAILURE; + } + mapmodes.push_back(new_mapmode); + return SUCCESS; +} + +size_t Map::get_mapmode_count() const { + return mapmodes.size(); +} + +Mapmode const* Map::get_mapmode_by_index(size_t index) const { + return index < mapmodes.size() ? &mapmodes[index] : nullptr; +} + +Mapmode const* Map::get_mapmode_by_identifier(std::string const& identifier) const { + if (!identifier.empty()) + for (Mapmode const& mapmode : mapmodes) + if (mapmode.get_identifier() == identifier) return &mapmode; + return nullptr; +} + +return_t Map::generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const { + if (target == nullptr) { + Logger::error("Mapmode colour target pointer is null!"); + return FAILURE; + } + if (index >= mapmodes.size()) { + Logger::error("Invalid mapmode index: ", index); + return FAILURE; + } + Mapmode const& mapmode = mapmodes[index]; + target += 4; // Skip past Province::NULL_INDEX + for (Province const& province : provinces) { + const Province::colour_t colour = mapmode.get_colour_func()(*this, province); + *target++ = (colour >> 16) & 0xFF; + *target++ = (colour >> 8) & 0xFF; + *target++ = colour & 0xFF; + *target++ = province.is_water() ? 0 : 255; + } + return SUCCESS; +} + +void Map::generate_province_buildings(BuildingManager const& manager) { + for (Province& province : provinces) + manager.generate_province_buildings(province.buildings); +} + +void Map::update_state(Date const& today) { + for (Province& province : provinces) + province.update_state(today); +} + +void Map::tick(Date const& today) { + for (Province& province : provinces) + province.tick(today); +} diff --git a/extension/src/openvic2/map/Map.hpp b/extension/src/openvic2/map/Map.hpp new file mode 100644 index 0000000..b6e7ac2 --- /dev/null +++ b/extension/src/openvic2/map/Map.hpp @@ -0,0 +1,73 @@ +#pragma once + +#include + +#include "openvic2/map/Region.hpp" + +namespace OpenVic2 { + + struct Mapmode : HasIdentifier { + friend struct Map; + + using colour_func_t = std::function; + using index_t = size_t; + private: + index_t index; + colour_func_t colour_func; + + Mapmode(index_t new_index, std::string const& new_identifier, colour_func_t new_colour_func); + public: + index_t get_index() const; + colour_func_t get_colour_func() const; + }; + + /* REQUIREMENTS: + * MAP-4 + */ + struct Map { + private: + std::vector provinces; + std::vector regions; + bool provinces_locked = false, water_provinces_locked = false, regions_locked = false; + size_t water_province_count = 0; + + size_t width = 0, height = 0; + std::vector province_index_image; + std::vector mapmodes; + public: + return_t add_province(std::string const& identifier, Province::colour_t colour); + void lock_provinces(); + return_t set_water_province(std::string const& identifier); + void lock_water_provinces(); + return_t add_region(std::string const& identifier, std::vector const& province_identifiers); + void lock_regions(); + + size_t get_province_count() const; + Province* get_province_by_index(Province::index_t index); + Province const* get_province_by_index(Province::index_t index) const; + Province* get_province_by_identifier(std::string const& identifier); + Province const* get_province_by_identifier(std::string const& identifier) const; + Province* get_province_by_colour(Province::colour_t colour); + Province const* get_province_by_colour(Province::colour_t colour) const; + Province::index_t get_province_index_at(size_t x, size_t y) const; + + Region* get_region_by_identifier(std::string const& identifier); + Region const* get_region_by_identifier(std::string const& identifier) const; + + return_t generate_province_index_image(size_t new_width, size_t new_height, uint8_t const* colour_data); + size_t get_width() const; + size_t get_height() const; + std::vector const& get_province_index_image() const; + + return_t add_mapmode(std::string const& identifier, Mapmode::colour_func_t colour_func); + size_t get_mapmode_count() const; + Mapmode const* get_mapmode_by_index(Mapmode::index_t index) const; + Mapmode const* get_mapmode_by_identifier(std::string const& identifier) const; + return_t generate_mapmode_colours(Mapmode::index_t index, uint8_t* target) const; + + void generate_province_buildings(BuildingManager const& manager); + + void update_state(Date const& today); + void tick(Date const& today); + }; +} diff --git a/extension/src/openvic2/map/Province.cpp b/extension/src/openvic2/map/Province.cpp new file mode 100644 index 0000000..c641b7e --- /dev/null +++ b/extension/src/openvic2/map/Province.cpp @@ -0,0 +1,67 @@ +#include "openvic2/map/Province.hpp" + +#include +#include +#include + +using namespace OpenVic2; + +Province::Province(index_t new_index, std::string const& new_identifier, colour_t new_colour) : + HasIdentifier{ new_identifier }, index{ new_index }, colour{ new_colour } { + assert(index != NULL_INDEX); + assert(colour != NULL_COLOUR); +} + +std::string Province::colour_to_hex_string(colour_t colour) { + std::ostringstream stream; + stream << std::hex << std::setfill('0') << std::setw(6) << colour; + return stream.str(); +} + +Province::index_t Province::get_index() const { + return index; +} + +Province::colour_t Province::get_colour() const { + return colour; +} + +Region* Province::get_region() const { + return region; +} + +bool Province::is_water() const { + return water; +} + +Province::life_rating_t Province::get_life_rating() const { + return life_rating; +} + +std::vector const& Province::get_buildings() const { + return buildings; +} + +return_t Province::expand_building(std::string const& building_type_identifier) { + for (Building& building : buildings) + if (building.get_type().get_identifier() == building_type_identifier) + return building.expand(); + return FAILURE; +} + +std::string Province::to_string() const { + std::stringstream stream; + stream << "(#" << std::to_string(index) << ", " << get_identifier() << ", 0x" << colour_to_hex_string(colour) << ")"; + return stream.str(); +} + +void Province::update_state(Date const& today) { + for (Building& building : buildings) + building.update_state(today); + +} + +void Province::tick(Date const& today) { + for (Building& building : buildings) + building.tick(today); +} diff --git a/extension/src/openvic2/map/Province.hpp b/extension/src/openvic2/map/Province.hpp new file mode 100644 index 0000000..79c6861 --- /dev/null +++ b/extension/src/openvic2/map/Province.hpp @@ -0,0 +1,45 @@ +#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: + index_t index; + colour_t colour; + Region* region = nullptr; + bool water = false; + life_rating_t life_rating = 0; + std::vector 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); + + 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; + std::vector 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); + }; +} diff --git a/extension/src/openvic2/map/Region.cpp b/extension/src/openvic2/map/Region.cpp new file mode 100644 index 0000000..3e5bee7 --- /dev/null +++ b/extension/src/openvic2/map/Region.cpp @@ -0,0 +1,26 @@ +#include "openvic2/map/Region.hpp" + +#include +#include + +using namespace OpenVic2; + +size_t ProvinceSet::get_province_count() const { + return provinces.size(); +} + +bool ProvinceSet::contains_province(Province const* province) const { + return province && std::find(provinces.begin(), provinces.end(), province) != provinces.end(); +} + +std::set const& ProvinceSet::get_provinces() const { + return provinces; +} + +Region::Region(std::string const& new_identifier) : HasIdentifier{ new_identifier } {} + +Province::colour_t Region::get_colour() const { + if (provinces.empty()) return 0xFF0000; + Province const* province = *provinces.cbegin(); + return province->get_colour(); +} diff --git a/extension/src/openvic2/map/Region.hpp b/extension/src/openvic2/map/Region.hpp new file mode 100644 index 0000000..2eec1cd --- /dev/null +++ b/extension/src/openvic2/map/Region.hpp @@ -0,0 +1,28 @@ +#pragma once + +#include + +#include "openvic2/map/Province.hpp" + +namespace OpenVic2 { + + struct ProvinceSet { + protected: + std::set provinces; + public: + size_t get_province_count() const; + bool contains_province(Province const* province) const; + std::set const& get_provinces() const; + }; + + /* REQUIREMENTS: + * MAP-6, MAP-44, MAP-48 + */ + struct Region : HasIdentifier, ProvinceSet { + friend struct Map; + private: + Region(std::string const& new_identifier); + public: + Province::colour_t get_colour() const; + }; +} diff --git a/extension/src/register_types.cpp b/extension/src/register_types.cpp index 10ed781..b99f1a8 100644 --- a/extension/src/register_types.cpp +++ b/extension/src/register_types.cpp @@ -4,7 +4,7 @@ #include "Checksum.hpp" #include "LoadLocalisation.hpp" -#include "MapSingleton.hpp" +#include "GameSingleton.hpp" #include "MapMesh.hpp" using namespace godot; @@ -12,7 +12,7 @@ using namespace OpenVic2; static Checksum* _checksum; static LoadLocalisation* _load_localisation; -static MapSingleton* _map_singleton; +static GameSingleton* _map_singleton; void initialize_openvic2_types(ModuleInitializationLevel p_level) { if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { @@ -27,9 +27,9 @@ void initialize_openvic2_types(ModuleInitializationLevel p_level) { _load_localisation = memnew(LoadLocalisation); Engine::get_singleton()->register_singleton("LoadLocalisation", LoadLocalisation::get_singleton()); - ClassDB::register_class(); - _map_singleton = memnew(MapSingleton); - Engine::get_singleton()->register_singleton("MapSingleton", MapSingleton::get_singleton()); + ClassDB::register_class(); + _map_singleton = memnew(GameSingleton); + Engine::get_singleton()->register_singleton("GameSingleton", GameSingleton::get_singleton()); ClassDB::register_class(); } @@ -45,7 +45,7 @@ void uninitialize_openvic2_types(ModuleInitializationLevel p_level) { Engine::get_singleton()->unregister_singleton("LoadLocalisation"); memdelete(_load_localisation); - Engine::get_singleton()->unregister_singleton("MapSingleton"); + Engine::get_singleton()->unregister_singleton("GameSingleton"); memdelete(_map_singleton); } @@ -60,4 +60,4 @@ extern "C" { return init_obj.init(); } -} \ No newline at end of file +} diff --git a/game/localisation/en_GB/menus.csv b/game/localisation/en_GB/menus.csv index 33e5c42..c637a39 100644 --- a/game/localisation/en_GB/menus.csv +++ b/game/localisation/en_GB/menus.csv @@ -63,3 +63,12 @@ GAMESESSIONMENU_QUIT_DIALOG_TEXT,Are you sure you want to quit and return to des DIALOG_OK,OK DIALOG_CANCEL,Cancel + +,, Province Overview Panel +province_MISSING,No Province +region_MISSING,No Region +building_MISSING,No Building +building_fort,Fort +building_naval_base,Naval Base +building_railroad,Railroad +EXPAND_PROVINCE_BUILDING,Expand diff --git a/game/localisation/en_GB/provinces.csv b/game/localisation/en_GB/provinces.csv index 814b4f9..8f1679d 100644 --- a/game/localisation/en_GB/provinces.csv +++ b/game/localisation/en_GB/provinces.csv @@ -1,51 +1,51 @@ ,, Europe -prov_britain_NAME,Britain -prov_ireland_NAME,Ireland -prov_iceland_NAME,Iceland -prov_corsica_NAME,Corsica -prov_sardinia_NAME,Sardinia -prov_sicily_NAME,Sicily -prov_malta_NAME,Malta -prov_cyprus_NAME,Cyprus -prov_greenland_NAME,Greenland -prov_baleares_NAME,Balearic Islands -prov_gotland_NAME,Gotland -prov_crete_NAME,Crete -prov_jan_mayen_NAME,Jan Mayen -prov_faroes_NAME,Faroe Islands -prov_mann_NAME,Isle of Mann -prov_shetlands_NAME,Shetlands -prov_orkney_NAME,Orkney -prov_channel_islands_NAME,Channel Islands -prov_madiera_NAME,Madiera -prov_canarias_NAME,Canarias -prov_sjaeland_NAME,Sjaeland -prov_bornholm_NAME,Bornholm -prov_bear_island_NAME,Bear Island -prov_pantelleria_NAME,Pantelleria -prov_iberia_NAME,Iberia -prov_scandinavia_NAME,Scandinavia -prov_jutland_NAME,Jutland -prov_fyn_NAME,Fyn -prov_hiiumaa_NAME,Hiiumaa -prov_saaremaa_NAME,Saaremaa -prov_italy_NAME,Italy -prov_elba_NAME,Elba -prov_france_NAME,France -prov_netherlands_NAME,Netherlands -prov_belgium_NAME,Belgium -prov_luxembourg_NAME,Luxembourg -prov_switzerland_NAME,Switzerland -prov_balkans_NAME,Balkans -prov_crimea_NAME,Crimea -prov_germany_NAME,Germany -prov_poland_NAME,Poland -prov_baltics_NAME,Baltics -prov_finland_NAME,Finland -prov_aland_NAME,Åland -prov_ukraine_NAME,Ukraine -prov_russia_NAME,Russia +prov_britain,Britain +prov_ireland,Ireland +prov_iceland,Iceland +prov_corsica,Corsica +prov_sardinia,Sardinia +prov_sicily,Sicily +prov_malta,Malta +prov_cyprus,Cyprus +prov_greenland,Greenland +prov_baleares,Balearic Islands +prov_gotland,Gotland +prov_crete,Crete +prov_jan_mayen,Jan Mayen +prov_faroes,Faroe Islands +prov_mann,Isle of Mann +prov_shetlands,Shetlands +prov_orkney,Orkney +prov_channel_islands,Channel Islands +prov_madiera,Madiera +prov_canarias,Canarias +prov_sjaeland,Sjaeland +prov_bornholm,Bornholm +prov_bear_island,Bear Island +prov_pantelleria,Pantelleria +prov_iberia,Iberia +prov_scandinavia,Scandinavia +prov_jutland,Jutland +prov_fyn,Fyn +prov_hiiumaa,Hiiumaa +prov_saaremaa,Saaremaa +prov_italy,Italy +prov_elba,Elba +prov_france,France +prov_netherlands,Netherlands +prov_belgium,Belgium +prov_luxembourg,Luxembourg +prov_switzerland,Switzerland +prov_balkans,Balkans +prov_crimea,Crimea +prov_germany,Germany +prov_poland,Poland +prov_baltics,Baltics +prov_finland,Finland +prov_aland,Åland +prov_ukraine,Ukraine +prov_russia,Russia ,, North America prov_north_america_NAME,North America @@ -92,154 +92,154 @@ prov_yellowknife_NAME,Yellowknife prov_iqaluit_NAME,Iqaluit ,, South America -prov_south_america_NAME,South America -prov_galapagos_NAME,Galapagos -prov_falklands_NAME,Falklands -prov_south_georgia_NAME,South Georgia +prov_south_america,South America +prov_galapagos,Galapagos +prov_falklands,Falklands +prov_south_georgia,South Georgia ,, Africa -prov_africa_NAME,Africa -prov_madagascar_NAME,Madagascar -prov_socotra_NAME,Socotra -prov_mauritius_NAME,Mauritius -prov_reunion_NAME,Réunion -prov_comoros_NAME,Comoros -prov_sao_tome_NAME,Sao Tome -prov_fernando_po_NAME,Fernando Po -prov_cape_verde_NAME,Cape Verde -prov_ascension_NAME,Ascension -prov_st_helena_NAME,St Helena -prov_tristan_da_cunha_NAME,Tristan da Cunha -prov_seychelles_NAME,Seychelles -prov_prince_edward_islands_NAME,Prince Edward Islands -prov_kerguelen_islands_NAME,Kerguelen Islands -prov_heard_island_NAME,Heard Island -prov_egypt_NAME,Egypt -prov_morocco_NAME,Morocco +prov_africa,Africa +prov_madagascar,Madagascar +prov_socotra,Socotra +prov_mauritius,Mauritius +prov_reunion,Réunion +prov_comoros,Comoros +prov_sao_tome,Sao Tome +prov_fernando_po,Fernando Po +prov_cape_verde,Cape Verde +prov_ascension,Ascension +prov_st_helena,St Helena +prov_tristan_da_cunha,Tristan da Cunha +prov_seychelles,Seychelles +prov_prince_edward_islands,Prince Edward Islands +prov_kerguelen_islands,Kerguelen Islands +prov_heard_island,Heard Island +prov_egypt,Egypt +prov_morocco,Morocco ,, Asia -prov_middle_east_NAME,Middle East -prov_ceylon_NAME,Ceylon -prov_formosa_NAME,Formosa -prov_sakhalin_NAME,Sakhalin -prov_maldives_NAME,Maldives -prov_hainan_NAME,Hainan -prov_hokkaido_NAME,Hokkaido -prov_diego_garcia_NAME,Diego Garcia -prov_philippines_NAME,Philippines -prov_india_NAME,India -prov_andamans_NAME,Andaman Islands -prov_nicobar_islands_NAME,Nicobar Islands -prov_indochina_NAME,Indochina -prov_korea_NAME,Korea -prov_okinawa_NAME,Okinawa -prov_yaeyama_NAME,Yaeyama -prov_kyushu_NAME,Kyushu -prov_shikoku_NAME,Shikoku -prov_japan_NAME,Japan -prov_kurils_NAME,Kuril Islands -prov_manchuria_NAME,Manchuria -prov_china_NAME,China -prov_central_asia_NAME,Central Asia -prov_siberia_NAME,Siberia -prov_iran_NAME,Iran -prov_anatolia_NAME,Anatolia +prov_middle_east,Middle East +prov_ceylon,Ceylon +prov_formosa,Formosa +prov_sakhalin,Sakhalin +prov_maldives,Maldives +prov_hainan,Hainan +prov_hokkaido,Hokkaido +prov_diego_garcia,Diego Garcia +prov_philippines,Philippines +prov_india,India +prov_andamans,Andaman Islands +prov_nicobar_islands,Nicobar Islands +prov_indochina,Indochina +prov_korea,Korea +prov_okinawa,Okinawa +prov_yaeyama,Yaeyama +prov_kyushu,Kyushu +prov_shikoku,Shikoku +prov_japan,Japan +prov_kurils,Kuril Islands +prov_manchuria,Manchuria +prov_china,China +prov_central_asia,Central Asia +prov_siberia,Siberia +prov_iran,Iran +prov_anatolia,Anatolia ,, Oceania -prov_oceania_NAME,Oceania -prov_indonesia_NAME,Indonesia -prov_north_island_NAME,North Island -prov_south_island_NAME,South Island -prov_tasmania_NAME,Tasmania -prov_australia_NAME,Australia -prov_hawaii_NAME,Hawaii +prov_oceania,Oceania +prov_indonesia,Indonesia +prov_north_island,North Island +prov_south_island,South Island +prov_tasmania,Tasmania +prov_australia,Australia +prov_hawaii,Hawaii ,, Lakes -prov_aral_sea_NAME,Aral Sea -prov_caspian_sea_NAME,Caspian Sea -prov_lake_ladoga_NAME,Lake Ladoga -prov_lake_ontario_NAME,Lake Ontario -prov_lake_erie_NAME,Lake Erie -prov_lake_huron_NAME,Lake Huron -prov_lake_michigan_NAME,Lake Michigan -prov_lake_superior_NAME,Lake Superior -prov_lake_baikal_NAME,Lake Baikal -prov_lake_woods_NAME,Lake of the Woods -prov_lake_manitoba_NAME,Lake Manitoba -prov_reindeer_lake_NAME,Reindeer Lake -prov_lake_ronge_NAME,Lac la Ronge -prov_lake_athabasca_NAME,Lake Athabasca -prov_great_slave_lake_NAME,Great Slave Lake -prov_great_bear_lake_NAME,Great Bear Lake +prov_aral_sea,Aral Sea +prov_caspian_sea,Caspian Sea +prov_lake_ladoga,Lake Ladoga +prov_lake_ontario,Lake Ontario +prov_lake_erie,Lake Erie +prov_lake_huron,Lake Huron +prov_lake_michigan,Lake Michigan +prov_lake_superior,Lake Superior +prov_lake_baikal,Lake Baikal +prov_lake_woods,Lake of the Woods +prov_lake_manitoba,Lake Manitoba +prov_reindeer_lake,Reindeer Lake +prov_lake_ronge,Lac la Ronge +prov_lake_athabasca,Lake Athabasca +prov_great_slave_lake,Great Slave Lake +prov_great_bear_lake,Great Bear Lake ,, Seas and Oceans -prov_azov_sea_NAME,Sea of Azov -prov_black_sea_NAME,Black Sea -prov_marmara_sea_NAME,Sea of Marmara -prov_agean_sea_NAME,Agean Sea -prov_ionian_sea_NAME,Ionian Sea -prov_adriatic_sea_NAME,Adriatic Sea -prov_tyrrhenian_sea_NAME,Tyrrhenian Sea -prov_east_mediterranean_NAME,East Mediterranean Sea -prov_central_mediterranean_NAME,Central Mediterranean Sea -prov_west_mediterranean_NAME,West Mediterranean Sea -prov_ligurian_sea_NAME,Ligurian Sea -prov_balearic_sea_NAME,Balearic Sea -prov_alboran_sea_NAME,Alboran Sea -prov_gulf_bothnia_NAME,Gulf of Bothnia -prov_gulf_finland_NAME,Gulf of Finland -prov_gulf_riga_NAME,Gulf of Riga -prov_baltic_sea_NAME,Baltic Sea -prov_danish_straits_NAME,Danish Straits -prov_english_channel_NAME,English Channel -prov_irish_sea_NAME,Irish Sea -prov_biscay_bay_NAME,Bay of Biscay -prov_north_sea_NAME,North Sea -prov_red_sea_NAME,Red Sea -prov_arabian_sea_NAME,Arabian Sea -prov_persian_gulf_NAME,Persian Gulf -prov_andaman_sea_NAME,Andaman Sea -prov_bay_bengal_NAME,Bay of Bengal -prov_okhotsk_sea_NAME,Sea of Okhotsk -prov_japan_sea_NAME,Sea of Japan -prov_east_china_sea_NAME,East China Sea -prov_south_china_sea_NAME,South China Sea -prov_philippine_sea_NAME,Philippine Sea -prov_celebes_sea_NAME,Celebes Sea -prov_java_sea_NAME,Java Sea -prov_banda_sea_NAME,Banda Sea -prov_arafura_sea_NAME,Arafura Sea -prov_gulf_mexico_NAME,Gulf of Mexico -prov_caribbean_sea_NAME,Caribbean Sea -prov_mozambique_channel_NAME,Mozambique Channel -prov_zanj_sea_NAME,Sea of Zanj -prov_kara_sea_NAME,Kara Sea -prov_barents_sea_NAME,Barents Sea -prov_norwegian_sea_NAME,Norwegian Sea -prov_greenland_sea_NAME,Greenland Sea -prov_labrador_sea_NAME,Labrador Sea -prov_hudson_bay_NAME,Hudson Bay -prov_gulf_st_lawrence_NAME,Gulf of St Lawrence -prov_gulf_alaska_NAME,Gulf of Alaska -prov_gulf_california_NAME,Gulf of California -prov_east_siberian_sea_NAME,East Siberian Sea -prov_sargasso_sea_NAME,Sargasso Sea -prov_gulf_guinea_NAME,Gulf of Guinea -prov_celtic_sea_NAME,Celtic Sea -prov_argentine_sea_NAME,Argentine Sea -prov_chilean_sea_NAME,Chilean Sea -prov_north_atlantic_NAME,North Atlantic Ocean -prov_central_atlantic_NAME,Central Atlantic Ocean -prov_south_atlantic_NAME,South Atlantic Ocean -prov_indian_ocean_NAME,Indian Ocean -prov_great_australian_bight_NAME,Great Australian Bight -prov_tasman_sea_NAME,Tasman Sea -prov_coral_sea_NAME,Coral Sea -prov_melanesia_NAME,Melanesia -prov_micronesia_NAME,Micronesia -prov_polynesia_NAME,Polynesia -prov_north_pacific_NAME,North Pacific Ocean -prov_south_pacific_NAME,South Pacific Ocean -prov_bering_sea_NAME,Bering Sea -prov_chukchi_sea_NAME,Chukchi Sea -prov_beaufort_sea_NAME,Beaufort Sea +prov_azov_sea,Sea of Azov +prov_black_sea,Black Sea +prov_marmara_sea,Sea of Marmara +prov_agean_sea,Agean Sea +prov_ionian_sea,Ionian Sea +prov_adriatic_sea,Adriatic Sea +prov_tyrrhenian_sea,Tyrrhenian Sea +prov_east_mediterranean,East Mediterranean Sea +prov_central_mediterranean,Central Mediterranean Sea +prov_west_mediterranean,West Mediterranean Sea +prov_ligurian_sea,Ligurian Sea +prov_balearic_sea,Balearic Sea +prov_alboran_sea,Alboran Sea +prov_gulf_bothnia,Gulf of Bothnia +prov_gulf_finland,Gulf of Finland +prov_gulf_riga,Gulf of Riga +prov_baltic_sea,Baltic Sea +prov_danish_straits,Danish Straits +prov_english_channel,English Channel +prov_irish_sea,Irish Sea +prov_biscay_bay,Bay of Biscay +prov_north_sea,North Sea +prov_red_sea,Red Sea +prov_arabian_sea,Arabian Sea +prov_persian_gulf,Persian Gulf +prov_andaman_sea,Andaman Sea +prov_bay_bengal,Bay of Bengal +prov_okhotsk_sea,Sea of Okhotsk +prov_japan_sea,Sea of Japan +prov_east_china_sea,East China Sea +prov_south_china_sea,South China Sea +prov_philippine_sea,Philippine Sea +prov_celebes_sea,Celebes Sea +prov_java_sea,Java Sea +prov_banda_sea,Banda Sea +prov_arafura_sea,Arafura Sea +prov_gulf_mexico,Gulf of Mexico +prov_caribbean_sea,Caribbean Sea +prov_mozambique_channel,Mozambique Channel +prov_zanj_sea,Sea of Zanj +prov_kara_sea,Kara Sea +prov_barents_sea,Barents Sea +prov_norwegian_sea,Norwegian Sea +prov_greenland_sea,Greenland Sea +prov_labrador_sea,Labrador Sea +prov_hudson_bay,Hudson Bay +prov_gulf_st_lawrence,Gulf of St Lawrence +prov_gulf_alaska,Gulf of Alaska +prov_gulf_california,Gulf of California +prov_east_siberian_sea,East Siberian Sea +prov_sargasso_sea,Sargasso Sea +prov_gulf_guinea,Gulf of Guinea +prov_celtic_sea,Celtic Sea +prov_argentine_sea,Argentine Sea +prov_chilean_sea,Chilean Sea +prov_north_atlantic,North Atlantic Ocean +prov_central_atlantic,Central Atlantic Ocean +prov_south_atlantic,South Atlantic Ocean +prov_indian_ocean,Indian Ocean +prov_great_australian_bight,Great Australian Bight +prov_tasman_sea,Tasman Sea +prov_coral_sea,Coral Sea +prov_melanesia,Melanesia +prov_micronesia,Micronesia +prov_polynesia,Polynesia +prov_north_pacific,North Pacific Ocean +prov_south_pacific,South Pacific Ocean +prov_bering_sea,Bering Sea +prov_chukchi_sea,Chukchi Sea +prov_beaufort_sea,Beaufort Sea diff --git a/game/localisation/en_GB/regions.csv b/game/localisation/en_GB/regions.csv index 8fe8943..258cce6 100644 --- a/game/localisation/en_GB/regions.csv +++ b/game/localisation/en_GB/regions.csv @@ -1,8 +1,8 @@ ,, Regions -region_europe_NAME,Europe -region_north_america_NAME,North America -region_south_america_NAME,South America -region_africa_NAME,Africa -region_asia_NAME,Asia -region_oceania_NAME,Oceania +region_europe,Europe +region_north_america,North America +region_south_america,South America +region_africa,Africa +region_asia,Asia +region_oceania,Oceania diff --git a/game/src/Autoload/Events.gd b/game/src/Autoload/Events.gd index dbd3f9f..0ee2eff 100644 --- a/game/src/Autoload/Events.gd +++ b/game/src/Autoload/Events.gd @@ -11,11 +11,12 @@ const _province_shape_file : String = "res://common/map/provinces.png" # REQUIREMENTS # * FS-333, FS-334, FS-335, FS-341 func _ready(): - if MapSingleton.load_province_identifier_file(_province_identifier_file) != OK: + if GameSingleton.load_province_identifier_file(_province_identifier_file) != OK: push_error("Failed to load province identifiers") - if MapSingleton.load_water_province_file(_water_province_file) != OK: + if GameSingleton.load_water_province_file(_water_province_file) != OK: push_error("Failed to load water provinces") - if MapSingleton.load_region_file(_region_file) != OK: + if GameSingleton.load_region_file(_region_file) != OK: push_error("Failed to load regions") - if MapSingleton.load_province_shape_file(_province_shape_file) != OK: + if GameSingleton.load_province_shape_file(_province_shape_file) != OK: push_error("Failed to load province shapes") + GameSingleton.finished_loading_data() diff --git a/game/src/GameSession/GameSession.gd b/game/src/GameSession/GameSession.gd index fe83a8a..2761815 100644 --- a/game/src/GameSession/GameSession.gd +++ b/game/src/GameSession/GameSession.gd @@ -5,7 +5,10 @@ extends Control func _ready(): Events.Options.load_settings_from_file() +func _process(delta : float): + GameSingleton.try_tick() + # REQUIREMENTS: # * SS-42 -func _on_game_session_menu_button_pressed(): +func _on_game_session_menu_button_pressed() -> void: _game_session_menu.visible = !_game_session_menu.visible diff --git a/game/src/GameSession/GameSessionMenu.gd b/game/src/GameSession/GameSessionMenu.gd index 8a76c0f..7d785ca 100644 --- a/game/src/GameSession/GameSessionMenu.gd +++ b/game/src/GameSession/GameSessionMenu.gd @@ -8,6 +8,7 @@ signal options_button_pressed # * SS-47 # * UIFUN-69 func _on_main_menu_confirmed() -> void: + # TODO - reset map when going back to main menu get_tree().change_scene_to_packed(_main_menu_scene) # REQUIREMENTS: diff --git a/game/src/GameSession/GameSpeedPanel.gd b/game/src/GameSession/GameSpeedPanel.gd index 8dc35d7..c203032 100644 --- a/game/src/GameSession/GameSpeedPanel.gd +++ b/game/src/GameSession/GameSpeedPanel.gd @@ -7,27 +7,32 @@ extends PanelContainer @export var _decrease_speed_button : Button @export var _increase_speed_button : Button -var is_game_paused : bool = true - # Called when the node enters the scene tree for the first time. func _ready(): - _update_playpause_button() + GameSingleton.state_updated.connect(_update_buttons) + _update_buttons() + +func _update_buttons(): + _play_pause_display_button.text = "⏸️" if GameSingleton.is_paused() else "▶" + + _increase_speed_button.disabled = not GameSingleton.can_increase_speed() + _decrease_speed_button.disabled = not GameSingleton.can_decrease_speed() -func _update_playpause_button(): - _play_pause_display_button.text = "⏸️" if is_game_paused else "▶" - print("Game is paused" if is_game_paused else "Game is advancing") + _longform_date_button.text = GameSingleton.get_longform_date() func _on_decrease_speed_button_pressed(): - print("Decrease speed") + GameSingleton.decrease_speed() + _update_buttons() func _on_increase_speed_button_pressed(): - print("Increase speed") + GameSingleton.increase_speed() + _update_buttons() func _on_play_pause_display_button_pressed(): - is_game_paused = !is_game_paused - _update_playpause_button() + GameSingleton.toggle_paused() + _update_buttons() func _on_longform_date_label_pressed(): - is_game_paused = !is_game_paused - _update_playpause_button() + GameSingleton.toggle_paused() + _update_buttons() diff --git a/game/src/GameSession/MapControlPanel.gd b/game/src/GameSession/MapControlPanel.gd index d5810c5..73d7e06 100644 --- a/game/src/GameSession/MapControlPanel.gd +++ b/game/src/GameSession/MapControlPanel.gd @@ -27,8 +27,8 @@ func _add_mapmode_button(identifier : String) -> void: func _ready(): _mapmode_button_group = ButtonGroup.new() _mapmode_button_group.pressed.connect(_mapmode_pressed) - for index in MapSingleton.get_mapmode_count(): - _add_mapmode_button(MapSingleton.get_mapmode_identifier(index)) + for index in GameSingleton.get_mapmode_count(): + _add_mapmode_button(GameSingleton.get_mapmode_identifier(index)) # REQUIREMENTS: # * UIFUN-10 @@ -39,7 +39,7 @@ func _on_game_session_menu_button_pressed() -> void: # * SS-76 # * UIFUN-129, UIFUN-133 func _mapmode_pressed(button : BaseButton) -> void: - MapSingleton.set_mapmode(button.tooltip_text) + GameSingleton.set_mapmode(button.tooltip_text) mapmode_changed.emit() func _on_map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) -> void: diff --git a/game/src/GameSession/MapView.gd b/game/src/GameSession/MapView.gd index ae49e82..ac060e1 100644 --- a/game/src/GameSession/MapView.gd +++ b/game/src/GameSession/MapView.gd @@ -1,6 +1,6 @@ extends Node3D -signal province_selected(identifier : String) +signal province_selected(index : int) signal map_view_camera_changed(near_left : Vector2, far_left : Vector2, far_right : Vector2, near_right : Vector2) const _action_north : StringName = &"map_north" @@ -21,7 +21,7 @@ const _shader_param_terrain_tile_factor : StringName = &"terrain_tile_factor" @export var _camera : Camera3D @export var _cardinal_move_speed : float = 1.0 -@export var _edge_move_threshold: float = 0.02 +@export var _edge_move_threshold: float = 0.01 @export var _edge_move_speed: float = 2.5 var _drag_anchor : Vector2 var _drag_active : bool = false @@ -53,7 +53,7 @@ var _viewport_dims : Vector2 = Vector2(1, 1) # ??? Strange Godot/GDExtension Bug ??? # Upon first opening a clone of this repo with the Godot Editor, -# if MapSingleton.get_province_index_image is called before MapMesh +# if GameSingleton.get_province_index_image is called before MapMesh # is referenced in the script below, then the editor will crash due # to a failed HashMap lookup. I'm not sure if this is a bug in the # editor, GDExtension, my own extension, or a combination of them. @@ -78,7 +78,7 @@ func _ready(): _map_shader_material = map_material # Province index texture - _map_province_index_image = MapSingleton.get_province_index_image() + _map_province_index_image = GameSingleton.get_province_index_image() if _map_province_index_image == null: push_error("Failed to get province index image!") return @@ -86,7 +86,7 @@ func _ready(): _map_shader_material.set_shader_parameter(_shader_param_province_index, province_index_texture) # Province colour texture - _map_province_colour_image = MapSingleton.get_province_colour_image() + _map_province_colour_image = GameSingleton.get_province_colour_image() if _map_province_colour_image == null: push_error("Failed to get province colour image!") return @@ -99,7 +99,7 @@ func _ready(): _map_mesh = _map_mesh_instance.mesh # Set map mesh size and get bounds - _map_image_size = Vector2(Vector2i(MapSingleton.get_width(), MapSingleton.get_height())) + _map_image_size = Vector2(Vector2i(GameSingleton.get_width(), GameSingleton.get_height())) _map_mesh.aspect_ratio = _map_image_size.x / _map_image_size.y _map_shader_material.set_shader_parameter(_shader_param_terrain_tile_factor, _map_image_size.y / 64.0) var map_mesh_aabb := _map_mesh.get_core_aabb() * _map_mesh_instance.transform @@ -120,7 +120,7 @@ func _notification(what : int): _on_mouse_exited_viewport() func _update_colour_texture() -> void: - MapSingleton.update_colour_image() + GameSingleton.update_colour_image() _map_province_colour_texture.update(_map_province_colour_image) func _world_to_map_coords(pos : Vector3) -> Vector2: @@ -151,10 +151,9 @@ func _unhandled_input(event : InputEvent): if _mouse_over_viewport and event.is_action_pressed(_action_click): # Check if the mouse is outside of bounds if _map_mesh.is_valid_uv_coord(_mouse_pos_map): - var selected_index := MapSingleton.get_province_index_from_uv_coords(_mouse_pos_map) + var selected_index := GameSingleton.get_province_index_from_uv_coords(_mouse_pos_map) _map_shader_material.set_shader_parameter(_shader_param_selected_index, selected_index) - var province_identifier := MapSingleton.get_province_identifier_from_uv_coords(_mouse_pos_map) - province_selected.emit(province_identifier) + province_selected.emit(selected_index) else: print("Clicked outside the map!") elif event.is_action_pressed(_action_drag): @@ -248,7 +247,7 @@ func _update_minimap_viewport() -> void: func _update_mouse_map_position() -> void: _mouse_pos_map = _viewport_to_map_coords(_mouse_pos_viewport) - var hover_index := MapSingleton.get_province_index_from_uv_coords(_mouse_pos_map) + var hover_index := GameSingleton.get_province_index_from_uv_coords(_mouse_pos_map) if _mouse_over_viewport: _map_shader_material.set_shader_parameter(_shader_param_hover_index, hover_index) diff --git a/game/src/GameSession/ProvinceOverviewPanel.gd b/game/src/GameSession/ProvinceOverviewPanel.gd index 4615df9..832f21c 100644 --- a/game/src/GameSession/ProvinceOverviewPanel.gd +++ b/game/src/GameSession/ProvinceOverviewPanel.gd @@ -2,32 +2,84 @@ extends Panel @export var _province_name_label : Label @export var _region_name_label : Label +@export var _buildings_container : Container -var _province_identifier: String = "": - get: return _province_identifier +const _missing_suffix : String = "_MISSING" + +var _selected_index : int: + get: return _selected_index set(v): - _province_identifier = v + _selected_index = v update_info() - -const _name_suffix : String = "_NAME" +var _province_info : Dictionary func _ready(): + GameSingleton.state_updated.connect(update_info) update_info() +enum { CANNOT_EXPAND, CAN_EXPAND, PREPARING, EXPANDING } + +func _expand_building(building_identifier : String) -> void: + if GameSingleton.expand_building(_selected_index, building_identifier) != OK: + push_error("Failed to expand ", building_identifier, " in province #", _selected_index); + +func _add_building(building : Dictionary) -> void: + const _building_key : StringName = &"building" + const _level_key : StringName = &"level" + const _expansion_state_key : StringName = &"expansion_state" + const _start_key : StringName = &"start" + const _end_key : StringName = &"end" + const _expansion_progress_key : StringName = &"expansion_progress" + + const _expand_province_building : String = "EXPAND_PROVINCE_BUILDING" + + var level_label := Label.new() + level_label.text = str(building.get(_level_key, 0)) + _buildings_container.add_child(level_label) + + var building_label := Label.new() + building_label.text = building.get(_building_key, _building_key + _missing_suffix) + _buildings_container.add_child(building_label) + + var expansion_state : int = building.get(_expansion_state_key, CANNOT_EXPAND) + if expansion_state == PREPARING or expansion_state == EXPANDING: + var progress_bar := ProgressBar.new() + progress_bar.max_value = 1 + progress_bar.value = building.get(_expansion_progress_key, 0) + progress_bar.size_flags_horizontal = Control.SIZE_EXPAND_FILL + _buildings_container.add_child(progress_bar) + else: + var expand_button := Button.new() + expand_button.text = _expand_province_building + expand_button.size_flags_horizontal = Control.SIZE_EXPAND_FILL + expand_button.disabled = expansion_state != CAN_EXPAND + expand_button.pressed.connect(func(): _expand_building(building_label.text)) + _buildings_container.add_child(expand_button) + func update_info() -> void: - if _province_identifier: - _province_name_label.text = _province_identifier + _name_suffix - var region_identifier := MapSingleton.get_region_identifier_from_province_identifier(_province_identifier) - if region_identifier: - _region_name_label.text = region_identifier + _name_suffix - else: - _region_name_label.text = "NO REGION" + const _province_key : StringName = &"province" + const _region_key : StringName = &"region" + const _life_rating_key : StringName = &"life_rating" + const _buildings_key : StringName = &"buildings" + + _province_info = GameSingleton.get_province_info_from_index(_selected_index) + if _province_info: + _province_name_label.text = _province_info.get(_province_key, _province_key + _missing_suffix) + _region_name_label.text = _province_info.get(_region_key, _region_key + _missing_suffix) + + for child in _buildings_container.get_children(): + _buildings_container.remove_child(child) + child.queue_free() + var buildings : Array = _province_info.get(_buildings_key, []) + for building in buildings: + _add_building(building) + show() else: hide() -func _on_province_selected(identifier : String) -> void: - _province_identifier = identifier +func _on_province_selected(index : int) -> void: + _selected_index = index func _on_close_button_pressed() -> void: - _province_identifier = "" + _selected_index = 0 diff --git a/game/src/GameSession/ProvinceOverviewPanel.tscn b/game/src/GameSession/ProvinceOverviewPanel.tscn index 7d21edc..dacdc4b 100644 --- a/game/src/GameSession/ProvinceOverviewPanel.tscn +++ b/game/src/GameSession/ProvinceOverviewPanel.tscn @@ -2,7 +2,7 @@ [ext_resource type="Script" path="res://src/GameSession/ProvinceOverviewPanel.gd" id="1_3n8k5"] -[node name="ProvinceOverviewPanel" type="Panel" node_paths=PackedStringArray("_province_name_label", "_region_name_label")] +[node name="ProvinceOverviewPanel" type="Panel" node_paths=PackedStringArray("_province_name_label", "_region_name_label", "_buildings_container")] editor_description = "UI-56" anchors_preset = 2 anchor_top = 1.0 @@ -13,6 +13,7 @@ grow_vertical = 0 script = ExtResource("1_3n8k5") _province_name_label = NodePath("VBoxContainer/ProvinceName") _region_name_label = NodePath("VBoxContainer/RegionName") +_buildings_container = NodePath("VBoxContainer/BuildingsContainer") [node name="VBoxContainer" type="VBoxContainer" parent="."] layout_mode = 1 @@ -27,15 +28,22 @@ offset_bottom = -5.0 [node name="ProvinceName" type="Label" parent="VBoxContainer"] editor_description = "UI-57" layout_mode = 2 -text = "PROVINCE_NAME" +text = "province_MISSING" vertical_alignment = 1 [node name="RegionName" type="Label" parent="VBoxContainer"] editor_description = "UI-58" layout_mode = 2 -text = "REGION_NAME" +text = "region_MISSING" vertical_alignment = 1 +[node name="HSeparator" type="HSeparator" parent="VBoxContainer"] +layout_mode = 2 + +[node name="BuildingsContainer" type="GridContainer" parent="VBoxContainer"] +layout_mode = 2 +columns = 3 + [node name="CloseButton" type="Button" parent="."] custom_minimum_size = Vector2(30, 30) layout_mode = 1 -- cgit v1.2.3-56-ga3b1