Find or create overmap special after overmap generation #27142

ralreegorganon · 2018-12-17T08:47:02Z

Summary

SUMMARY: Interface "Find or create overmap special after overmap generation"

Purpose of change

This series of changes enables finding and creating overmap specials after overmap generation has been completed. The initial use of this will be in JSONizing mission starts, to be used by the infrastructure added in #27037. Additionally, it makes the debug placement of overmap specials behave more like the placement during overmap generation.

Describe the solution

This is accomplished through a handful of inter-related infrastructure changes documented in their individual commits, but generally speaking this:

Adds new functions to overmap and overmapbuffer to allow determining whether or not a given overmap terrain has been explored and had mapgen run on it
Updates overmap special placement and associated overmap connection simple pathfinding to allow specifying whether or not a location must be unexplored when evaluating it for placement
Updates the overmap terrain "find" methods on overmapbuffer to allow specifying that a given overmap terrain must be part of a given special to be considered a match
Adds place_special methods to overmapbuffer to allow it to either unconditionally place a special at a specified location and rotation, or place a special using the existing overmap special placement algorithm (with the ability to leverage the aforementioned infrastructure changes so the placement happens out of the player's explored areas)
Uses the previous changes to update the debug placement of overmap specials to behave more like those placed during overmap generation (e.g. record special -> omt association, generate road connections)
Uses the previous changes in mission_start::reveal_refugee_center to make it overmap special aware, so that it will consider the special when searching for the refugee center, and will create it if it can't find it.

Describe alternatives you've considered

This set of changes stops short of reworking the entirety of mission_start to utilize these changes where appropriate; that is an in-progress follow up effort.

There are some deficiencies in overmap special placement as it relates to placement done after overmap generation versus during overmap generation (specifically around the overmap connections and subterranean locations) which can be iterated on in future work--things like lab creation, sewer and subway creation, and their associated connections all have a second pass that happens after the specials are placed during overmap generation, but that doesn't occur here.

Additional context

This doesn't wildly change the actual overmap special placement algorithm, so when specials are placed after the fact, they suffer from all limitations it currently has, plus the additional limitations of being restricted in where it can place things due to not considering areas that have already been explored, plus all of the existing specials taking up space.

To mitigate this some, I allowed the "overmap special frequency" to be based on the size of the special being placed rather than fixed at the constant value used during overmap generation. This effectively means that smaller specials have more possible locations and thus a better chance at being placed.

In my testing, this has worked out well enough, and the actual biggest factor in how successful it will be in placing the special is how restrictive the criteria for a special are. A city size 16, spacing 0 world with a special that is large, has subterranean entries, requires existing overmap connections, must be placed an exact distance from a city, and which has restrictive allowed terrains will always be difficult to place.

I also don't think this set of changes precludes us revisiting "mandatory" specials for missions and having those be included during overmap generation, preempting all the other special placements.

For testing, an easy test is to edit specials.json and set the occurrences for the evac_center special to "occurrences" : [0, 0],, and then use the evac computer's "Contact Us" entry.

Finally, a quick before/after screenshot of the test case above where the evac center doesn't exist until we try and locate it in using the computer.

And zoomed in on the local area that actually changed...

BevapDin · 2018-12-17T19:35:44Z

src/overmap.cpp

+        return false;
+    }
+
+    const bool is_generated = MAPBUFFER.lookup_submap( omt_to_sm_copy( loc ) ) != nullptr;


This does not match. inbounds above takes local coordinates, but MAPBUFFER::lookup_submap requires a global variable. You need to add overmap::loc (converted to the correct coordinate system).

Updated. Thanks for catching that.

BevapDin · 2018-12-17T19:38:58Z

src/overmapbuffer.cpp

+            const tripoint s_loc( origin.x + dist - i, origin.y + dist, z );
+            if( is_findable_location( s_loc, type, must_be_seen, allow_subtype_matches, existing_overmaps_only,
+                                      om_special ) ) {
+                return tripoint( s_loc );


Suggested change

return tripoint( s_loc );

return s_loc;

Done. I had done it correctly for the first entry (n_loc)--just an oversight to have not done it for the other three.

BevapDin · 2018-12-17T19:39:37Z

src/overmapbuffer.cpp

+            const tripoint w_loc( origin.x - dist, origin.y + dist - i, z );
+            if( is_findable_location( w_loc, type, must_be_seen, allow_subtype_matches, existing_overmaps_only,
+                                      om_special ) ) {
+                return tripoint( w_loc );


same here and below with e_loc

Done as noted above.

BevapDin · 2018-12-17T19:42:07Z

src/overmapbuffer.cpp

+        for( const auto &special_placement : batch ) {
+            if( special_placement.instances_placed > 0 ) {
+                // It was placed, lets get outta here.
+                placed = true;


You can return true from here instead of using the variable placed.

Night-Pryanik · 2018-12-18T08:38:35Z

src/mission_start.cpp

+
+    // We couldn't find the special, so let's try and place it.
+    if( center_pos == overmap::invalid_tripoint ) {
+        bool placed = overmap_buffer.place_special( os_evac_center, your_pos, OMAPX * 5 );


Could be const.

Adds a new struct which contains a pointer to an overmap and a tripoint local to the overmap. Added new methods for getting an overmap with coordinates projected to the local coordinate system when provided with a global overmap terrain tripoint coordinate. Has both get_ and get_existing varieties.

Add new methods to overmap and overmap buffer to allow checking whether or not a given overmap terrain location has been generated, which can be used to inform code that wants to change the overmap but only wants to do so if the location hasn't been generated already.

…plored Also allow forcing placement of overmap special even when it doesn't meet criteria (primarily to be used in the debug menu placement of overmap specials).

Allows for placement of a specific special at a specified location and orientation, or simply specifying a special to be placed and deferring placement to the overmap's placement algorithm.

This brings debug placement more in line with the placement done during map generation, e.g. it will make connections, record placement into the data structure tying overmap terrains to the special that placed them, and so on.

ZhilkinSerg added Missions Quests and missions Map / Mapgen Overmap, Mapgen, Map extras, Map display [C++] Changes (can be) made in C++. Previously named `Code` labels Dec 17, 2018

BevapDin reviewed Dec 17, 2018

View reviewed changes

ralreegorganon force-pushed the find-or-create-overmap-special-after-mapgen branch from 546314a to 4c6e9d8 Compare December 17, 2018 20:23

Night-Pryanik reviewed Dec 18, 2018

View reviewed changes

ZhilkinSerg self-assigned this Dec 18, 2018

ralreegorganon added 7 commits December 18, 2018 20:31

Optionally restrict overmap special pathfinding and placement to unex…

d4ed21f

…plored Also allow forcing placement of overmap special even when it doesn't meet criteria (primarily to be used in the debug menu placement of overmap specials).

Update overmapbuffer terrain finds to optionally consider special

93edbd1

Add place_special methods to overmapbuffer

295ac95

Allows for placement of a specific special at a specified location and orientation, or simply specifying a special to be placed and deferring placement to the overmap's placement algorithm.

Use overmapbuffer.place_special in debug special placement

eb1f4a9

This brings debug placement more in line with the placement done during map generation, e.g. it will make connections, record placement into the data structure tying overmap terrains to the special that placed them, and so on.

Make mission_start::reveal_refugee_center overmap special aware

3828433

ralreegorganon force-pushed the find-or-create-overmap-special-after-mapgen branch from 4c6e9d8 to 3828433 Compare December 19, 2018 05:43

ZhilkinSerg merged commit 3b7a52e into CleverRaven:master Dec 19, 2018

ZhilkinSerg removed their assignment Dec 19, 2018

ralreegorganon mentioned this pull request Dec 21, 2018

Enable JSONized placement of overmap specials at mission start #27205

Merged

ralreegorganon deleted the find-or-create-overmap-special-after-mapgen branch April 7, 2020 16:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Find or create overmap special after overmap generation #27142

Find or create overmap special after overmap generation #27142

ralreegorganon commented Dec 17, 2018

BevapDin Dec 17, 2018

ralreegorganon Dec 17, 2018

BevapDin Dec 17, 2018

ralreegorganon Dec 17, 2018

BevapDin Dec 17, 2018

ralreegorganon Dec 17, 2018

BevapDin Dec 17, 2018

ralreegorganon Dec 17, 2018

Night-Pryanik Dec 18, 2018

ralreegorganon Dec 19, 2018

Find or create overmap special after overmap generation #27142

Find or create overmap special after overmap generation #27142

Conversation

ralreegorganon commented Dec 17, 2018

Summary

Purpose of change

Describe the solution

Describe alternatives you've considered

Additional context

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment