Merge pull request #82924 from Blueflowerss/isekai

dimensional travel (isekai the return)

Author: GuardianDll

data/json/effects_on_condition/example_eocs.json

@@ -518,5 +518,31 @@
       { "math": [ "ITEM_POWER_PERC = n_val('power_percentage')" ] },
       { "u_message": "<global_val:ITEM_POWER> / <global_val:ITEM_POWER_MAX> (<global_val:ITEM_POWER_PERC>%)" }
     ]
+  },
+  {
+    "type": "effect_on_condition",
+    "id": "EOC_dimension_swap_test",
+    "//": "shifts the character to a new dimension",
+    "global": true,
+    "effect": [
+      {
+        "set_string_var": "",
+        "string_input": {
+          "title": { "str": "teleport to dimension named:" },
+          "description": { "str": "'default' returns you to main dimension" },
+          "width": 30
+        },
+        "target_var": { "u_val": "destination_dimension" }
+      },
+      { "u_location_variable": { "u_val": "tele_test" }, "x_adjust": 0, "y_adjust": 0 },
+      {
+        "u_teleport": { "u_val": "tele_test" },
+        "dimension_prefix": { "u_val": "destination_dimension" },
+        "fail_message": "your body doesn't move",
+        "success_message": "This place feels different."
+      },
+      { "u_message": { "u_val": "destination_dimension" } },
+      { "if": { "u_in_dimension": "" }, "then": { "u_message": "home sweet home" } }
+    ]
   }
 ]

doc/JSON/EFFECT_ON_CONDITION.md

@@ -4299,6 +4299,7 @@ You or NPC is teleported to `target_var` coordinates
 | "fail_message" | optional | string or [variable object](#variable-object) | message, that would be printed, if teleportation was failed, like if coordinates contained creature or impassable obstacle (like wall) | 
 | "force" | optional | boolean | default false; if true, teleportation can't fail - any creature, that stand on target coordinates, would be brutally telefragged, and if impassable obstacle occur, the closest point would be picked instead |
 | "force_safe" | optional | boolean | default false; if true, teleportation cannot^(tm) fail.  If there is a creature or obstacle at the target coordinate, the closest passable point within 5 horizontal tiles is picked instead.  If there is no point, the creature remains where they are.
+| "dimension_prefix" | optional | string | default ""; if a value is specified, will teleport the player to a dimension named after the prefix. Currently very WIP |
 
 ##### Valid talkers:
 

src/avatar.cpp

@@ -250,6 +250,11 @@ void avatar::load_map_memory()
     player_map_memory->load( pos_abs() );
 }
 
+void avatar::clear_map_memory()
+{
+    player_map_memory->clear();
+}
+
 void avatar::prepare_map_memory_region( const tripoint_abs_ms &p1, const tripoint_abs_ms &p2 )
 {
     player_map_memory->prepare_region( p1, p2 );

src/avatar.h

@@ -99,6 +99,7 @@ class avatar : public Character
         void deserialize( const JsonObject &data ) override;
         bool save_map_memory();
         void load_map_memory();
+        void clear_map_memory();
 
         // newcharacter.cpp
         bool create( character_type type, const std::string &tempname = "" );

src/condition.cpp

@@ -673,6 +673,14 @@ conditional_t::func f_is_wearing( const JsonObject &jo, std::string_view member,
     };
 }
 
+conditional_t::func f_in_dimension( const JsonObject &jo, std::string_view member )
+{
+    str_or_var dimension_prefix = get_str_or_var( jo.get_member( member ), member, true );
+    return [dimension_prefix]( const_dialogue const & d ) {
+        return ( g->get_dimension_prefix() == dimension_prefix.evaluate( d ) );
+    };
+}
+
 conditional_t::func f_has_item( const JsonObject &jo, std::string_view member, bool is_npc )
 {
     str_or_var item_id = get_str_or_var( jo.get_member( member ), member, true );
@@ -2416,6 +2424,7 @@ parsers = {
     {"u_has_part_temp", "npc_has_part_temp", jarg::member | jarg::array, &conditional_fun::f_has_part_temp },
     {"u_is_wearing", "npc_is_wearing", jarg::member, &conditional_fun::f_is_wearing },
     {"is_outside", jarg::member, &conditional_fun::f_tile_is_outside },
+    {"u_in_dimension", jarg::member, &conditional_fun::f_in_dimension },
     {"u_has_item", "npc_has_item", jarg::member, &conditional_fun::f_has_item },
     {"u_has_item_with_flag", "npc_has_item_with_flag", jarg::member, &conditional_fun::f_has_item_with_flag },
     {"u_has_items", "npc_has_items", jarg::member, &conditional_fun::f_has_items },

src/do_turn.cpp

@@ -482,7 +482,10 @@ bool do_turn()
         g->gamemode->per_turn();
         calendar::turn += 1_turns;
     }
-
+    //used for dimension swapping
+    if( g->swapping_dimensions ) {
+        g->swapping_dimensions = false;
+    }
     play_music( music::get_music_id_string() );
 
     // starting a new turn, clear out temperature cache

src/game.cpp

@@ -1,4 +1,5 @@
 #include "game.h"
+#include "map_memory.h"
 
 #include <algorithm>
 #include <bitset>
@@ -3186,6 +3187,15 @@ void game::load_master()
     } );
 }
 
+bool game::load_dimension_data()
+{
+    const cata_path datafile = PATH_INFO::current_dimension_save_path() / SAVE_DIMENSION_DATA;
+    // If dimension_data.gsav doesn't exist, return false
+    return read_from_file_optional( datafile, [this, &datafile]( std::istream & is ) {
+        unserialize_dimension_data( datafile, is );
+    } );
+}
+
 bool game::load( const std::string &world )
 {
     world_generator->init();
@@ -3229,6 +3239,13 @@ bool game::load( const save_t &name )
                     load_master();
                 }
             },
+            {
+                _( "Dimension data" ), [&]()
+                {
+                    // Load up dimension specific data (ie; weather, overmapstate)
+                    load_dimension_data();
+                }
+            },
             {
                 _( "Character save" ), [&]()
                 {
@@ -3471,7 +3488,14 @@ bool game::save_factions_missions_npcs()
         serialize_master( fout );
     }, _( "factions data" ) );
 }
-
+//Saves per-dimension data like Weather and overmapbuffer state
+bool game::save_dimension_data()
+{
+    cata_path data_file = PATH_INFO::current_dimension_save_path() / SAVE_DIMENSION_DATA;
+    return write_to_file( data_file, [&]( std::ostream & fout ) {
+        serialize_dimension_data( fout );
+    }, _( "dimension data" ) );
+}
 bool game::save_maps()
 {
     map &here = get_map();
@@ -3641,6 +3665,7 @@ bool game::save()
         if( !save_player_data() ||
             !save_achievements() ||
             !save_factions_missions_npcs() ||
+            !save_dimension_data() ||
             !save_maps() ||
             !get_auto_pickup().save_character() ||
             !get_auto_notes_settings().save( true ) ||
@@ -5698,7 +5723,7 @@ bool game::revive_corpse( const tripoint_bub_ms &p, item &it, int radius )
     }
     // If this is not here, the game may attempt to spawn a monster before the map exists,
     // leading to it querying for furniture, and crashing.
-    if( g->new_game ) {
+    if( g->new_game || g->swapping_dimensions ) {
         return false;
     }
     if( it.has_flag( flag_FIELD_DRESS ) || it.has_flag( flag_FIELD_DRESS_FAILED ) ||
@@ -11480,7 +11505,7 @@ void game::place_player_overmap( const tripoint_abs_omt &om_dest, bool move_play
     here.spawn_monsters( true ); // Static monsters
     update_overmap_seen();
     // update weather now as it could be different on the new location
-    weather.nextweather = calendar::turn;
+    weather.set_nextweather( calendar::turn );
     if( move_player ) {
         place_player( player_pos );
     }
@@ -12711,6 +12736,67 @@ void game::vertical_move( int movez, bool force, bool peeking )
     cata_event_dispatch::avatar_moves( old_abs_pos, u, here );
 }
 
+bool game::travel_to_dimension( const std::string &new_prefix )
+{
+    map &here = get_map();
+    avatar &player = get_avatar();
+    unload_npcs();
+    save_dimension_data();
+    for( monster &critter : all_monsters() ) {
+        despawn_monster( critter );
+    }
+    if( player.in_vehicle ) {
+        here.unboard_vehicle( player.pos_bub() );
+    }
+    // Make sure we don't mess up savedata if for some reason maps can't be saved
+    if( !save_maps() ) {
+        return false;
+    }
+    player.save_map_memory();
+    for( int z = -OVERMAP_DEPTH; z <= OVERMAP_HEIGHT; z++ ) {
+        here.clear_vehicle_list( z );
+    }
+    here.rebuild_vehicle_level_caches();
+    // Inputting an empty string to the text input EOC fails
+    // so i'm using 'default' as empty/main dimension
+    if( new_prefix != "default" ) {
+        dimension_prefix = new_prefix;
+    } else {
+        dimension_prefix.clear();
+    }
+    // Load in data specific to the dimension (like weather)
+    //if( !load_dimension_data() ) {
+    // dimension data file not found/created yet
+    /* handle weather instance switching when I have dimensions with different region settings,
+     right now they're all the same and it's hard to tell if it's working or not. */
+    // weather.set_nextweather( calendar::turn );
+    //}
+    // Clear the immediate game area around the player
+    MAPBUFFER.clear();
+    // hack to prevent crashes from temperature checks
+    // This returns to false in 'on_turn()' so it should be fine?
+    swapping_dimensions = true;
+    // Clear the overmap
+    overmap_buffer.clear();
+    // load/create new overmap
+    overmap_buffer.get( point_abs_om{} );
+    // clear map memory from the previous dimension
+    player.clear_map_memory();
+    // Load map memory in new dimension, if there is any
+    player.load_map_memory();
+    // Loads submaps and invalidate related caches
+    here.load( tripoint_abs_sm( here.get_abs_sub() ), false );
+
+    here.invalidate_visibility_cache();
+    //without this vehicles only load in after walking around a bit
+    here.reset_vehicles_sm_pos();
+    load_npcs();
+    // Handle static monsters
+    here.spawn_monsters( true, true );
+    update_overmap_seen();
+    return true;
+}
+
 void game::start_hauling( const tripoint_bub_ms &pos )
 {
     map &here = get_map();
@@ -13690,6 +13776,20 @@ cata_path PATH_INFO::world_base_save_path()
     return world_generator->active_world->folder_path();
 }
 
+cata_path PATH_INFO::current_dimension_save_path()
+{
+    std::string dimension_prefix = g->get_dimension_prefix();
+    if( !dimension_prefix.empty() ) {
+        return PATH_INFO::world_base_save_path() / "dimensions" / dimension_prefix;
+    }
+    return PATH_INFO::world_base_save_path();
+}
+
+cata_path PATH_INFO::current_dimension_player_save_path()
+{
+    return PATH_INFO::current_dimension_save_path() / base64_encode( get_avatar().get_save_id() );
+}
+
 void game::shift_destination_preview( const point_rel_ms &delta )
 {
     for( tripoint_bub_ms &p : destination_preview ) {

src/game.h

@@ -241,6 +241,8 @@ class game
         void serialize_json( std::ostream &fout ); // for save
         void unserialize( std::istream &fin, const cata_path &path ); // for load
         void unserialize( std::string fin ); // for load
+        void unserialize_dimension_data( const cata_path &file_name, std::istream &fin ); // for load
+        void unserialize_dimension_data( const JsonValue &jv ); // for load
         void unserialize_master( const cata_path &file_name, std::istream &fin ); // for load
         void unserialize_master( const JsonValue &jv ); // for load
     private:
@@ -326,6 +328,20 @@ class game
          */
         void vertical_move( int z, bool force, bool peeking = false );
         void start_hauling( const tripoint_bub_ms &pos );
+
+        /**
+         * Moves the player to an alternate dimension.
+         * The prefix identifies the dimension and its properties.
+         */
+        bool travel_to_dimension( const std::string &prefix );
+        /**
+         * Retrieve the identifier of the current dimension.
+         * TODO: this should be a dereferencable id that gives properties of the dimension.
+         */
+        std::string get_dimension_prefix() {
+            return dimension_prefix;
+        }
+
         /** Returns the other end of the stairs (if any). May query, affect u etc.
         * @param pos Disable queries and msgs if not the same position as player.
         */
@@ -897,7 +913,10 @@ class game
         //private save functions.
         // returns false if saving failed for whatever reason
         bool save_factions_missions_npcs();
+        bool save_dimension_data();
+        bool load_dimension_data();
         void reset_npc_dispositions();
+        void serialize_dimension_data( std::ostream &fout );
         void serialize_master( std::ostream &fout );
         // returns false if saving failed for whatever reason
         bool save_maps();
@@ -1350,6 +1369,13 @@ class game
         bool can_pulp_corpse( const Character &you, const mtype &corpse_mtype );
         bool can_pulp_corpse( const pulp_data &pd );
         bool can_pulp_acid_corpse( const Character &you, const mtype &corpse_mtype );
+
+        //currently used as a hacky workaround for dimension swapping
+        bool swapping_dimensions = false; // NOLINT (cata-serialize)
+    private:
+        // Stores the currently occupoed dimension.
+        // TODO: should be an id instead of a string.
+        std::string dimension_prefix;
 };
 
 // Returns temperature modifier from direct heat radiation of nearby sources

src/item.cpp

@@ -13594,7 +13594,7 @@ bool item::process_temperature_rot( float insulation, const tripoint_bub_ms &pos
 
         units::temperature_delta temp_mod;
         // Toilets and vending machines will try to get the heat radiation and convection during mapgen and segfault.
-        if( !g->new_game ) {
+        if( !g->new_game && !g->swapping_dimensions ) {
             temp_mod = get_heat_radiation( pos );
             temp_mod += get_convection_temperature( pos );
             temp_mod += here.get_temperature_mod( pos );

src/main.cpp

@@ -60,6 +60,9 @@
 #include "type_id.h"
 #include "ui_manager.h"
 #include "cata_imgui.h"
+#if defined(MACOSX) || defined(__CYGWIN__)
+#   include <unistd.h> // getpid()
+#endif
 
 #if defined(EMSCRIPTEN)
 #include <emscripten.h>