feat(port): Implement GLOBALLY_UNIQUE

data/json/overmap/overmap_special/aircraft_carrier.json

@@ -201,6 +201,6 @@
     "city_distance": [ -1, 1000 ],
     "locations": [ "lake_surface" ],
     "occurrences": [ 75, 100 ],
-    "flags": [ "CLASSIC", "LAKE", "MAN_MADE", "UNIQUE", "MILITARY", "ELECTRIC_GRID" ]
+    "flags": [ "CLASSIC", "LAKE", "MAN_MADE", "UNIQUE", "MILITARY", "ELECTRIC_GRID", "GLOBALLY_UNIQUE" ]
   }
 ]

data/json/overmap/overmap_special/specials.json

@@ -1796,7 +1796,7 @@
     "city_distance": [ 3, -1 ],
     "city_sizes": [ 4, -1 ],
     "occurrences": [ 50, 100 ],
-    "flags": [ "UNIQUE" ]
+    "flags": [ "ELECTRIC_GRID", "UNIQUE", "GLOBALLY_UNIQUE" ]
   },
   {
     "type": "overmap_special",
@@ -5624,7 +5624,7 @@
     "city_distance": [ 5, -1 ],
     "city_sizes": [ 4, -1 ],
     "occurrences": [ 10, 100 ],
-    "flags": [ "MILITARY", "UNIQUE", "ELECTRIC_GRID" ]
+    "flags": [ "MILITARY", "UNIQUE", "ELECTRIC_GRID", "GLOBALLY_UNIQUE" ]
   },
   {
     "type": "overmap_special",

src/overmap.cpp

@@ -2840,7 +2840,7 @@
                 copy.insert( nested.second );
                 std::optional<overmap_special_id> recures = check_recursion( nested.second, copy );
                 if( recures ) {
                     return *recures;
                 }
             }
         }
@@ -3290,7 +3290,7 @@
     map_layer &this_layer = layer[z + OVERMAP_DEPTH];
     for( const auto &extra : this_layer.extras ) {
         const std::string extra_text = extra.id.c_str();
         if( match_include_exclude( extra_text, text ) ) {
             extra_locations.push_back( project_combine( pos(), extra.p ) );
         }
     }
@@ -5501,6 +5501,11 @@
         return false;
     }
 
+    if( special.has_flag( "GLOBALLY_UNIQUE" ) &&
+        overmap_buffer.contains_unique_special( special.id ) ) {
+        return false;
+    }
+
     const std::vector<overmap_special_locations> fixed_terrains = special.required_locations();
 
     return std::all_of( fixed_terrains.begin(), fixed_terrains.end(),
@@ -5538,6 +5543,10 @@
         assert( can_place_special( special, p, dir, must_be_unexplored ) );
     }
 
+    if( special.has_flag( "GLOBALLY_UNIQUE" ) ) {
+        overmap_buffer.add_unique_special( special.id );
+    }
+
     const bool grid = special.has_flag( "ELECTRIC_GRID" );
 
     special_placement_result result = special.place( *this, p, dir );
@@ -5573,7 +5582,7 @@
                 auto points = connection_cache->get_closests( elem.connection->id, rp.z(), rp.xy() );
                 int attempts = 0;
                 for( const point_om_omt &pos : points ) {
                     if( ( linked = build_connection( pos, rp.xy(), rp.z(), *elem.connection,
                                                      must_be_unexplored, initial_dir ) ) ||
                         ++attempts > 10 ) {
                         break;
@@ -5590,7 +5599,7 @@
                         !check_ot( elem.connection->id->default_terrain.str(), ot_match_type::type, p ) ) {
                         continue;
                     }
                     if( ( linked = build_connection( p.xy(), rp.xy(), rp.z(), *elem.connection,
                                                      must_be_unexplored, initial_dir ) ) ||
                         ++attempts > 10 ) {
                         break;
@@ -5941,10 +5950,18 @@
         const float rate = is_true_center && special.has_flag( "ENDGAME" ) ? 1 :
                            zone_ratio[current];
 
+        const bool unique = iter.special_details->has_flag( "UNIQUE" );
+        const bool globally_unique = iter.special_details->has_flag( "GLOBALLY_UNIQUE" );
+
         int amount_to_place;
-        if( special.has_flag( "UNIQUE" ) ) {
+        if( unique || globally_unique ) {
+            const overmap_special_id &id = iter.special_details->id;
+            const overmap_special_placement_constraints &constraints = iter.special_details->get_constraints();
+
             int chance = roll_remainder( min * rate );
-            amount_to_place = x_in_y( chance, max ) ? 1 : 0;
+            //FINGERS CROSSED EMOGI
+            amount_to_place = x_in_y( min, max ) && ( !globally_unique ||
+                              !overmap_buffer.contains_unique_special( id ) ) ? 1 : 0;
         } else {
             // Number of instances normalized to terrain ratio
             float real_max = std::max( static_cast<float>( min ), max * rate );

src/overmapbuffer.cpp

@@ -208,6 +208,7 @@
 {
     overmaps.clear();
     known_non_existing.clear();
+    placed_unique_specials.clear();
     last_requested_overmap = nullptr;
 }
 
@@ -660,7 +661,7 @@
 void overmapbuffer::ter_set( const tripoint_abs_omt &p, const oter_id &id )
 {
     const overmap_with_local_coords om_loc = get_om_global( p );
     return om_loc.om->ter_set( om_loc.local, id );
 }
 
 std::string *overmapbuffer::join_used_at( const std::pair<tripoint_abs_omt, cube_direction> &p )
@@ -947,6 +948,19 @@
     return om_loc.om->check_overmap_special_type( id, om_loc.local );
 }
 
+void overmapbuffer::add_unique_special( const overmap_special_id &id )
+{
+    if( contains_unique_special( id ) ) {
+        debugmsg( "Unique overmap special placed more than once: %s", id.str() );
+    }
+    placed_unique_specials.emplace( id );
+}
+
+bool overmapbuffer::contains_unique_special( const overmap_special_id &id ) const
+{
+    return placed_unique_specials.find( id ) != placed_unique_specials.end();
+}
+
 static omt_find_params assign_params(
     const std::string &type, int const radius, bool must_be_seen,
     ot_match_type match_type, bool existing_overmaps_only,
@@ -1189,7 +1203,7 @@
     const point_rel_om offset = end - start;
 
     std::vector<overmap *> result;
     result.reserve( ( offset.x() + 1 ) * ( offset.y() + 1 ) );
 
     for( int x = start.x(); x <= end.x(); ++x ) {
         for( int y = start.y(); y <= end.y(); ++y ) {

src/overmapbuffer.h

@@ -9,11 +9,13 @@
 #include <set>
 #include <string>
 #include <unordered_map>
+#include <unordered_set>
 #include <utility>
 #include <vector>
 
 #include "coordinates.h"
 #include "enums.h"
+#include "json.h"
 #include "memory_fast.h"
 #include "overmap_types.h"
 #include "point.h"
@@ -518,6 +520,9 @@ class overmapbuffer
         // Cached result of previous call to overmapbuffer::get_existing
         overmap mutable *last_requested_overmap;
 
+        // Set of globally unique overmap specials that have already been placed
+        std::unordered_set<overmap_special_id> placed_unique_specials;
+
         /**
          * Get a list of notes in the (loaded) overmaps.
          * @param z only this specific z-level is search for notes.
@@ -551,6 +556,24 @@ class overmapbuffer
                                 const tripoint_abs_omt &loc );
         bool check_overmap_special_type_existing( const overmap_special_id &id,
                 const tripoint_abs_omt &loc );
+
+        /**
+         * Adds the given globally unique overmap special to the list of placed specials.
+         */
+        void add_unique_special( const overmap_special_id &id );
+        /**
+         * Returns true if the given globally unique overmap special has already been placed.
+         */
+        bool contains_unique_special( const overmap_special_id &id ) const;
+        /**
+         * Writes the placed unique specials as a JSON value.
+         */
+        void serialize_placed_unique_specials( JsonOut &json ) const;
+        /**
+         * Reads placed unique specials from JSON and overwrites the global value.
+         */
+        void deserialize_placed_unique_specials( JsonIn &jsin );
+
     private:
         /**
          * Go thorough the monster groups of the overmap and move out-of-bounds

src/savegame.cpp

@@ -34,6 +34,7 @@
 #include "output.h"
 #include "overmap.h"
 #include "overmap_types.h"
+#include "overmapbuffer.h"
 #include "popup.h"
 #include "regional_settings.h"
 #include "scent_map.h"
@@ -1167,6 +1168,8 @@ void game::unserialize_master( std::istream &fin )
                 jsin.read( *faction_manager_ptr );
             } else if( name == "seed" ) {
                 jsin.read( seed );
+            } else if( name == "placed_unique_specials" ) {
+                overmap_buffer.deserialize_placed_unique_specials( jsin );
             } else if( name == "weather" ) {
                 JsonObject w = jsin.get_object();
                 w.read( "lightning", get_weather().lightning_active );
@@ -1202,6 +1205,9 @@ void game::serialize_master( std::ostream &fout )
         json.member( "active_missions" );
         mission::serialize_all( json );
 
+        json.member( "placed_unique_specials" );
+        overmap_buffer.serialize_placed_unique_specials( json );
+
         json.member( "factions", *faction_manager_ptr );
         json.member( "seed", seed );
 
@@ -1283,3 +1289,17 @@ void Creature_tracker::serialize( JsonOut &jsout ) const
     }
     jsout.end_array();
 }
+
+void overmapbuffer::serialize_placed_unique_specials( JsonOut &json ) const
+{
+    json.write_as_array( placed_unique_specials );
+}
+
+void overmapbuffer::deserialize_placed_unique_specials( JsonIn &jsin )
+{
+    placed_unique_specials.clear();
+    jsin.start_array();
+    while( !jsin.end_array() ) {
+        placed_unique_specials.emplace( jsin.get_string() );
+    }
+}