Dimensional travel for vehicles

Author: kevingranade

data/json/debug/teleportation.json

@@ -0,0 +1,70 @@
+[
+  {
+    "type": "effect_on_condition",
+    "id": "EOC_PERAMBULATE_VEHICLE",
+    "//": "Example EOC that shifts a vehicle to the test dimension",
+    "effect": [
+      {
+        "if": { "current_dimension": "" },
+        "then": { "set_string_var": "test", "target_var": { "u_val": "destination_dimension" } },
+        "else": { "set_string_var": "", "target_var": { "u_val": "destination_dimension" } }
+      },
+      {
+        "u_travel_to_dimension": { "u_val": "destination_dimension" },
+        "region_type": { "u_val": "test" },
+        "take_vehicle": true,
+        "fail_message": "The Perambulator shivers but does not move.",
+        "success_message": "In a flash of light the surroundings outside the Perambulator are changed!."
+      },
+      { "u_message": { "u_val": "destination_dimension" } },
+      { "if": { "current_dimension": "" }, "then": { "u_message": "home sweet home" } }
+    ]
+  },
+  {
+    "id": "dimensional_perambulator",
+    "type": "ITEM",
+    "category": "veh_parts",
+    "name": { "str": "dimensional perambulator" },
+    "description": "A perambulator, for perambulating through dimensions",
+    "weight": "1 kg",
+    "volume": "5 L",
+    "material": [ "lc_steel" ],
+    "symbol": "#",
+    "color": "dark_gray"
+  },
+  {
+    "id": "dimensional_perambulator",
+    "type": "vehicle_part",
+    "name": { "str": "Dimensional Perambulator" },
+    "item": "dimensional_perambulator",
+    "location": "center",
+    "categories": [ "utility" ],
+    "durability": 100,
+    "description": "A perambulator, for perambulating through dimensions",
+    "flags": [ "EOC_ACTIVATION" ],
+    "activatable_eoc": "EOC_PERAMBULATE_VEHICLE",
+    "variants": [ { "symbols": "#", "symbols_broken": "X" } ]
+  },
+  {
+    "id": "dimensional_bathyscape",
+    "//": "Test vehicle for dimensional travel",
+    "type": "vehicle",
+    "name": "Sir Pemberton Smythe's Dimensional Bathyscape",
+    "blueprint": [
+      [ "---" ],
+      [ "+#|" ],
+      [ "---" ]
+    ],
+    "parts": [
+      { "x": -1, "y": -1, "parts": [ "hdframe", "board", "roof" ] },
+      { "x": -1, "y": 0, "parts": [ "hdframe", { "part": "tank", "fuel": "gasoline" }, "roof" ] },
+      { "x": -1, "y": 1, "parts": [ "hdframe", "engine_v6", "alternator_car", "roof" ] },
+      { "x": 0, "y": -1, "parts": [ "hdframe", "door", "roof", "battery_car" ] },
+      { "x": 0, "y": 0, "parts": [ "hdframe", "seat", "controls" ] },
+      { "x": 0, "y": 1, "parts": [ "hdframe", "roof", "dimensional_perambulator" ] },
+      { "x": 1, "y": -1, "parts": [ "hdframe", "board", "roof" ] },
+      { "x": 1, "y": 0, "parts": [ "hdframe", "board", "roof" ] },
+      { "x": 1, "y": 1, "parts": [ "hdframe", "board", "roof" ] }
+    ]
+  }
+]

data/json/vehicleparts/vp_flags.json

@@ -54,6 +54,11 @@
     "type": "json_flag",
     "info": "With a seat or saddle, you drive from here.  You can 'e'xamine the tile to access the controls, or use the vehicle control key (default '^')."
   },
+  {
+    "id": "EOC_ACTIVATION",
+    "type": "json_flag",
+    "info": "Enables an associated EOC to be triggered from the vehicle control menu."
+  },
   {
     "id": "SMART_ENGINE_CONTROLLER",
     "type": "json_flag",

src/game.cpp

@@ -11496,7 +11496,8 @@ void game::vertical_move( int movez, bool force, bool peeking )
 
 bool game::travel_to_dimension( const std::string &new_prefix,
                                 const std::string &region_type,
-                                const std::vector<npc *> &npc_travellers )
+                                const std::vector<npc *> &npc_travellers,
+                                vehicle *veh )
 {
     map &here = get_map();
     avatar &player = get_avatar();
@@ -11527,9 +11528,14 @@ bool game::travel_to_dimension( const std::string &new_prefix,
     for( monster &critter : all_monsters() ) {
         despawn_monster( critter );
     }
+    bool controlling_vehicle = player.controlling_vehicle;
     if( player.in_vehicle ) {
         here.unboard_vehicle( player.pos_bub() );
     }
+    std::unique_ptr<vehicle> vehicle_ref;
+    if( veh != nullptr ) {
+        vehicle_ref = here.detach_vehicle( veh );
+    }
     // Make sure we don't mess up savedata if for some reason maps can't be saved
     if( !save_maps() || !save_dimension_data() ) {
         return false;
@@ -11541,6 +11547,7 @@ bool game::travel_to_dimension( const std::string &new_prefix,
     here.rebuild_vehicle_level_caches();
     // Inputting an empty string to the text input EOC fails
     // so i'm using 'default' as empty/main dimension
+    std::string old_prefix = dimension_prefix;
     if( new_prefix != "default" ) {
         dimension_prefix = new_prefix;
     } else {
@@ -11570,15 +11577,26 @@ bool game::travel_to_dimension( const std::string &new_prefix,
     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
+    bool undo_shift = false;
+    if( vehicle_ref ) {
+        undo_shift = here.place_vehicle( std::move( vehicle_ref ) );
+    }
+    // Without this vehicles only load in after walking around a bit
     here.reset_vehicles_sm_pos();
+    if( here.veh_at( player.pos_bub() ) ) {
+        here.board_vehicle( player.pos_bub(), &player );
+        player.controlling_vehicle = controlling_vehicle;
+    }
     load_npcs();
     // Handle static monsters
     here.spawn_monsters( true, true );
     // updates the weather, if the weather settings are different in the new world
     weather.weather_override = WEATHER_NULL;
     weather.set_nextweather( calendar::turn );
     update_overmap_seen();
+    if( undo_shift ) {
+        travel_to_dimension( old_prefix, region_type, npc_travellers, veh );
+    }
     return true;
 }
 

src/game.h

@@ -333,9 +333,10 @@ class game
          * Moves the player to an alternate dimension.
          * @param prefix identifies the dimension and its properties.
          * @param npc_travellers vector of NPCs that should be brought along when travelling to another dimension
+         * @param veh pointer to a vehicle to bring along.
          */
         bool travel_to_dimension( const std::string &prefix, const std::string &region_type,
-                                  const std::vector<npc *> &npc_travellers );
+                                  const std::vector<npc *> &npc_travellers, vehicle *veh = nullptr );
         /**
          * Retrieve the identifier of the current dimension.
          * TODO: this should be a dereferencable id that gives properties of the dimension.

src/map.cpp

@@ -459,6 +459,30 @@ VehicleList map::get_vehicles()
                          tripoint_bub_ms( SEEX * my_MAPSIZE, SEEY * my_MAPSIZE, OVERMAP_HEIGHT ) );
 }
 
+bool map::place_vehicle( std::unique_ptr<vehicle> &&new_vehicle )
+{
+    bool collision = false;
+    // This works in the dimension shift case specifically because
+    // the old map origin and the new map origin are the same,
+    // if that is no longer the case something else will need to happen here.
+    tripoint_bub_ms vehicle_origin = new_vehicle->pos_bub( *this );
+    for( std::pair<const point_rel_ms, std::vector<int>> &mount_point : new_vehicle->relative_parts ) {
+        if( impassable( vehicle_origin + mount_point.first ) ) {
+            collision = true;
+            break;
+        }
+    }
+    submap *place_on_submap = get_submap_at_grid( new_vehicle->sm_pos - get_abs_sub().xy() );
+    if( place_on_submap == nullptr ) {
+        debugmsg( "Tried to add vehicle at %s but the submap is not loaded",
+                  new_vehicle->sm_pos.to_string() );
+    } else {
+        place_on_submap->ensure_nonuniform();
+        place_on_submap->vehicles.push_back( std::move( new_vehicle ) );
+    }
+    return collision;
+}
+
 void map::rebuild_vehicle_level_caches()
 {
     clear_vehicle_level_caches();

src/map.h

@@ -761,6 +761,7 @@ class map
 
         // Vehicles: Common to 2D and 3D
         VehicleList get_vehicles();
+        bool place_vehicle( std::unique_ptr<vehicle> &&new_vehicle );
         void add_vehicle_to_cache( vehicle * );
         void clear_vehicle_point_from_cache( vehicle *veh, const tripoint_bub_ms &pt );
         // clears all vehicle level caches

src/npctalk.cpp

@@ -7705,8 +7705,11 @@ talk_effect_fun_t::func f_travel_to_dimension( const JsonObject &jo, std::string
     str_or_var region_type_var;
     optional( jo, false, "region_type", region_type_var, "default" );
 
+    bool take_vehicle = false;;
+    optional( jo, false, "take_vehicle", take_vehicle );
+
     return [fail_message, success_message, dimension_prefix, npc_travel_filter,
-                  npc_travel_radius, region_type_var]( dialogue const & d ) {
+                  npc_travel_radius, region_type_var, take_vehicle]( dialogue const & d ) {
         Creature *teleporter = d.actor( false )->get_creature();
         if( teleporter ) {
             std::string region_type = region_type_var.evaluate( d );
@@ -7734,8 +7737,17 @@ talk_effect_fun_t::func f_travel_to_dimension( const JsonObject &jo, std::string
                         }
                     } );
                 }
+                vehicle *veh = nullptr;
+                if( take_vehicle ) {
+                    const optional_vpart_position vp_here = get_map().veh_at( teleporter->pos_bub() );
+                    if( !vp_here ) {
+                        teleporter->add_msg_if_player( fail_message.evaluate( d ) );
+                        return;
+                    }
+                    veh = &vp_here->vehicle();
+                }
                 // returns False if fail
-                if( g->travel_to_dimension( prefix, region_type, travellers ) ) {
+                if( g->travel_to_dimension( prefix, region_type, travellers, veh ) ) {
                     teleporter->add_msg_if_player( success_message.evaluate( d ) );
                 } else {
                     teleporter->add_msg_if_player( fail_message.evaluate( d ) );

src/veh_type.cpp

@@ -269,6 +269,7 @@ void vpart_info::load( const JsonObject &jo, const std::string_view src )
     optional( jo, was_loaded, "comfort", comfort, 0 );
     optional( jo, was_loaded, "floor_bedding_warmth", floor_bedding_warmth, 0_C_delta );
     optional( jo, was_loaded, "bonus_fire_warmth_feet", bonus_fire_warmth_feet, 0.6_C_delta );
+    optional( jo, was_loaded, "activatable_eoc", activatable_eoc );
 
     int enchant_num = 0;
     for( JsonValue jv : jo.get_array( "enchantments" ) ) {

src/veh_type.h

@@ -334,6 +334,7 @@ class vpart_info
         std::optional<vpslot_terrain_transform> transform_terrain_info;
         //Enchantments
         std::vector<enchantment_id> enchantments;
+        std::optional<effect_on_condition_id> activatable_eoc;
 
         std::set<std::pair<itype_id, int>> get_pseudo_tools() const;
 

src/veh_utils.cpp

@@ -492,9 +492,13 @@ bool veh_menu::query()
 
     chosen._on_submit();
 
-    veh.refresh( );
-    here.invalidate_visibility_cache();
-    here.invalidate_map_cache( here.get_abs_sub().z() );
+    // There's probably a better way to detect this?
+    // If we're swapping dimensions the veh reference has been invalidated.
+    if( !g->swapping_dimensions ) {
+        veh.refresh( );
+        here.invalidate_visibility_cache();
+        here.invalidate_map_cache( here.get_abs_sub().z() );
+    }
 
     return chosen._keep_menu_open;
 }