factoriomods/space-exploration_0.5.80/space-exploration/scripts/spaceship-clone.lua

local SpaceshipClone = {}

SpaceshipClone.types_excluded = {
  "rocket-silo-rocket", "cliff", "tile-ghost"
}

SpaceshipClone.types_vehicles = { -- move players inside these vehicles when ships teleport
  "car", "spider-vehicle", "locomotive", "cargo-wagon", "fluid-wagon"
}

SpaceshipClone.types_passengers = { -- move players that are passengers of these vehicles when ships teleport
  "car", "spider-vehicle"
}

--- Builds the arrays of entities that are cared about
--- for the purposes of grounding/spacing - intended to be
--- cached but not done yet
function SpaceshipClone.build_spaced_grounded_table()
  SpaceshipClone.spaced_names = {}
  SpaceshipClone.unspaced_names = {}
  SpaceshipClone.grounded_names = {}
  SpaceshipClone.ungrounded_names = {}
  for name, prototype in pairs(game.entity_prototypes) do
    if string.find(name, name_suffix_spaced, 1, true) then
      table.insert(SpaceshipClone.spaced_names, name)
      table.insert(SpaceshipClone.unspaced_names, util.replace(name, name_suffix_spaced, ""))
    elseif string.find(name, name_suffix_grounded, 1, true) then
      table.insert(SpaceshipClone.grounded_names, name)
      table.insert(SpaceshipClone.ungrounded_names, util.replace(name, name_suffix_grounded, ""))
    end
  end
end

--- Grounds or ungrounds entities
--- Used to ensure that entities space buildings can't have space recipes on the ground
--- and similar things. Swaps entities betweened normal, spaced, and grounded versions
---@param from_surface any surface the clone is coming from
---@param to_surface any surface the clone is going to
---@param from_zone any zone the clone is coming from
---@param to_zone any zone the clone is going to
---@param from_area any area on the from_surface the clone is coming from
---@param to_area any area on the to_surface the clone is going to
function SpaceshipClone.ground_unground_entities(from_surface, to_surface, from_zone, to_zone, from_area, to_area)
  SpaceshipClone.build_spaced_grounded_table()
  if Zone.is_space(from_zone) ~= Zone.is_space(to_zone) then
    if Zone.is_space(to_zone) then
      local entities_for_unspaced = to_surface.find_entities_filtered{name = SpaceshipClone.unspaced_names, area = to_area}
      for _, entity in pairs(entities_for_unspaced) do
        swap_structure(entity, entity.name..name_suffix_spaced)
      end
      local entities_for_grounded = to_surface.find_entities_filtered{name = SpaceshipClone.grounded_names, area = to_area}
      for _, entity in pairs(entities_for_grounded) do
        swap_structure(entity, util.replace(entity.name, name_suffix_grounded, ""))
      end
    else
      local entities_for_ungrounded = to_surface.find_entities_filtered{name = SpaceshipClone.ungrounded_names, area = to_area}
      for _, entity in pairs(entities_for_ungrounded) do
        swap_structure(entity, entity.name..name_suffix_grounded)
      end
      local entities_for_spaced = to_surface.find_entities_filtered{name = SpaceshipClone.spaced_names, area = to_area}
      for _, entity in pairs(entities_for_spaced) do
        swap_structure(entity, util.replace(entity.name, name_suffix_spaced, ""))
      end
    end
  end
end

--- Enqueues chunk generation requests for the area being cloned to
---@param spaceship Spaceship the spaceship data
---@param clone_from LuaSurface surface to clone from
---@param clone_to LuaSurface surface to clone to
---@param clone_delta any the delta between the spaceship's position on clone_from and the target spaceship position on clone_to
function SpaceshipClone.enqueue_generate_clone_to_area(spaceship, clone_from, clone_to, clone_delta)
  local clone_to_area = {
    left_top = {x = spaceship.known_bounds.left_top.x + clone_delta.dx, y = spaceship.known_bounds.left_top.y + clone_delta.dy},
    right_bottom = {x = spaceship.known_bounds.right_bottom.x + clone_delta.dx, y = spaceship.known_bounds.right_bottom.y + clone_delta.dy},
  }

  local clone_from_zone = Zone.from_surface(clone_from)
  local clone_to_zone = Zone.from_surface(clone_to)

  -- force generate chunks in the area being cloned to
  local x_force_gen_modifier = 0
  if clone_to_zone and clone_to_zone.type == "spaceship" then
    x_force_gen_modifier = SpaceshipObstacles.particle_spawn_range
  end
  local y_force_gen_modifier_sub = 0
  local y_force_gen_modifier_add = 0
  if clone_to_zone and clone_to_zone.type == "spaceship" then
    y_force_gen_modifier_sub = SpaceshipObstacles.particle_spawn_range + 20
    y_force_gen_modifier_add = SpaceshipObstacles.particle_spawn_range + 32
  end
  local requests_made = 0
  for x=clone_to_area.left_top.x-32-x_force_gen_modifier,clone_to_area.right_bottom.x+32+x_force_gen_modifier,32 do
    for y=clone_to_area.left_top.y-32-y_force_gen_modifier_sub,clone_to_area.right_bottom.y+32+y_force_gen_modifier_add,32 do
      clone_to.request_to_generate_chunks({x=x,y=y},1)
      requests_made = requests_made + 1
    end
  end
  return requests_made
end

--- Clones a spaceship from its current location to a new location (deletes the original as part of the cloning)
---@param spaceship Spaceship the spaceship data
---@param clone_from LuaSurface surface to clone from
---@param clone_to LuaSurface surface to clone to
---@param clone_delta any the delta between the spaceship's position on clone_from and the target spaceship position on clone_to
---@param post_clone_to any the callback function to call once the clone completes
function SpaceshipClone.clone(spaceship, clone_from, clone_to, clone_delta, post_clone_cb)
  local clone_from_area = {
    left_top = {x = spaceship.known_bounds.left_top.x, y = spaceship.known_bounds.left_top.y},
    right_bottom = {x = spaceship.known_bounds.right_bottom.x, y = spaceship.known_bounds.right_bottom.y},
  }
  local clone_to_area = {
    left_top = {x = spaceship.known_bounds.left_top.x + clone_delta.dx, y = spaceship.known_bounds.left_top.y + clone_delta.dy},
    right_bottom = {x = spaceship.known_bounds.right_bottom.x + clone_delta.dx, y = spaceship.known_bounds.right_bottom.y + clone_delta.dy},
  }
  local clone_from_zone = Zone.from_surface(clone_from)
  local clone_to_zone = Zone.from_surface(clone_to)

  -- flag for cloning in progress
  spaceship.is_cloning = true

  -- if somehow we didn't generate all of the chunks before this call is made, forcibly create them
  clone_to.force_generate_chunk_requests()

  -- get players out of vehicles
  local vehicle_drivers = {}
  local vehicle_passengers = {}
  local vehicles = clone_from.find_entities_filtered{
    type = SpaceshipClone.types_vehicles,
    area = clone_from_area
  }
  for _, vehicle in pairs(vehicles) do
    local vehicle_x = math.floor(vehicle.position.x)
    local vehicle_y = math.floor(vehicle.position.y)
    local value = spaceship.known_tiles[vehicle_x] and spaceship.known_tiles[vehicle_x][vehicle_y]
    if value == Spaceship.tile_status.floor_console_connected then
      local driver = vehicle.get_driver()
      vehicle.set_driver(nil)
      if driver then
        if driver.is_player() then driver = driver.character end -- sets to nil if required
      end
      if driver and driver.valid then
        table.insert(vehicle_drivers, {
          vehicle_name = vehicle.name,
          vehicle_position = vehicle.position,
          driver_name = driver.name,
          driver_position = driver.position
        })
      end
      if util.table_contains(SpaceshipClone.types_passengers, vehicle.type) then
        local passenger = vehicle.get_passenger()
        vehicle.set_passenger(nil)
        if passenger then
          if passenger.is_player() then passenger = passenger.character end -- sets to nil if required
        end
        if passenger and passenger.valid then
          table.insert(vehicle_passengers, {
            vehicle_name = vehicle.name,
            vehicle_position = vehicle.position,
            passenger_name = passenger.name,
            passenger_position = passenger.position
          })
        end
      end
    end
  end

  -- store locomotive status (automatic vs normal)
  local locomotive_settings = {}
  for _, locomotive in pairs(clone_from.find_entities_filtered{
    type = "locomotive",
    area = clone_from_area
  }) do
    local locomotive_x = math.floor(locomotive.position.x)
    local locomotive_y = math.floor(locomotive.position.y)
    local value = spaceship.known_tiles[locomotive_x] and spaceship.known_tiles[locomotive_x][locomotive_y]
    if value == Spaceship.tile_status.floor_console_connected then
      table.insert(locomotive_settings, {
        name = locomotive.name,
        position = locomotive.position,
        manual_mode = locomotive.train.manual_mode
      })
    end
  end

  -- copy the ship tiles
  local change_tiles_zone = {}
  for x=spaceship.known_bounds.left_top.x,spaceship.known_bounds.right_bottom.x do
    for y=spaceship.known_bounds.left_top.y,spaceship.known_bounds.right_bottom.y do
      local value = spaceship.known_tiles[x] and spaceship.known_tiles[x][y]
      if value == Spaceship.tile_status.floor_console_connected
      or value == Spaceship.tile_status.bulkhead_console_connected then
        local position = {
          x = x + clone_delta.dx,
          y = y + clone_delta.dy
        }
        table.insert(change_tiles_zone, {name = "se-spaceship-floor", position = position})
      end
    end
  end
  clone_to.set_tiles(change_tiles_zone, true)

  -- destroy the shield projections
  local destroy_names = {}
  for _, name in pairs(remote.call("shield-projector", "get_sub_entity_names")) do
    table.insert(destroy_names, name)
  end
  -- check nearby the ship since we need to capture all shield projector barriers which don't count towards the known_bounds
  local expanded_clone_from_area = util.area_extend(clone_from_area, 15)
  local destroy_entities = clone_from.find_entities_filtered{
    name = destroy_names,
    area = expanded_clone_from_area -- shield projector barriers can be outside the range of the ship bounding box
  }
  for _, entity in pairs(destroy_entities) do
    entity.destroy()
  end

  -- clone spaceship to new position
  local clone_positions = {}
  for x=spaceship.known_bounds.left_top.x,spaceship.known_bounds.right_bottom.x do
    for y=spaceship.known_bounds.left_top.y,spaceship.known_bounds.right_bottom.y do
      local value = spaceship.known_tiles[x] and spaceship.known_tiles[x][y]
      if value == Spaceship.tile_status.floor_console_connected
      or value == Spaceship.tile_status.bulkhead_console_connected then
        table.insert(clone_positions, {x=x,y=y})
      end
    end
  end
  clone_from.clone_brush{
    source_offset = {0,0},
    destination_offset = {clone_delta.dx,clone_delta.dy},
    destination_surface = clone_to,
    clone_tiles = false,
    clone_entities = true,
    clone_decoratives = false,
    clear_destination_entities = false,
    clear_destination_decoratives = false,
    expand_map = true,
    source_positions = clone_positions
  }

  -- Pause inserters, workaround for https://forums.factorio.com/viewtopic.php?f=58&t=89035
  local condition_entities = clone_to.find_entities_filtered{
    type = Spaceship.types_to_restore,
    area = clone_to_area
  }
  spaceship.entities_to_restore = spaceship.entities_to_restore or {}
  spaceship.entities_to_restore_tick = game.tick + Spaceship.time_to_restore
  for _, entity in pairs(condition_entities) do
    table.insert(spaceship.entities_to_restore, {
      entity = entity,
      active=entity.active
    })
    entity.active = false
  end

  -- clean out of map tiles in the clone area
  local bad_tiles = clone_to.find_tiles_filtered{
    name = {name_out_of_map_tile},
    area = clone_to_area
  }
  local set_tiles = {}
  for _, tile in pairs(bad_tiles) do
    table.insert(set_tiles, {
      position = tile.position,
      name = name_space_tile
    })
    clone_to.set_hidden_tile(tile.position, name_space_tile)
  end
  clone_to.set_tiles(set_tiles)

  -- transfer the ship console
  local old_console = spaceship.console
  local clone_console_position = {
    x = spaceship.console.position.x + clone_delta.dx,
    y = spaceship.console.position.y + clone_delta.dy
  }
  local console_clone = clone_to.find_entity(Spaceship.name_spaceship_console, clone_console_position)
  spaceship.console = console_clone
  spaceship.console_output = nil
  old_console.destroy()

  -- using safe_destroy (which raises the script_raised_destroy) even causes the destruction part of the code take ~10x longer
  -- but if we don't do this (and silently destroy the entities) we can break mod compatibility
  local change_tiles_from = {}
  local change_tiles_to = {}
  local area_table = {left_top = {}, right_bottom = {}}
  for _, clone_position in pairs(clone_positions) do
    local x = clone_position.x
    local y = clone_position.y
    -- part of the spaceship so remove from clone_from surface
    local under_tile = clone_from.get_hidden_tile({x=x,y=y})
    if under_tile == nil or Spaceship.is_floor(under_tile) then
      under_tile = "landfill" -- fallback
    end
    table.insert(change_tiles_from, {name = under_tile, position = {x=x,y=y}})
    local left_top = area_table.left_top
    local right_bottom = area_table.right_bottom
    left_top.x = x
    left_top.y = y
    right_bottom.x = x + 1
    right_bottom.y = y + 1
    local entities = clone_from.find_entities_filtered{area = area_table}
    for _, entity in pairs(entities) do
      if entity.valid then
        if entity.type == "character" then
          local position = {
            x = entity.position.x + clone_delta.dx,
            y = entity.position.y + clone_delta.dy
          }
          local clone = clone_to.find_entity(entity.name, position)
          if clone and entity.player then
            entity.player.teleport(clone.position, clone_to)
            util.safe_destroy(clone)
          else
            for _, playerdata in pairs(global.playerdata) do
              if playerdata.character == entity then
                playerdata.character = clone
              end
            end
            util.safe_destroy(entity)
          end
        elseif util.table_contains(SpaceshipClone.types_excluded, entity.type) then
          -- this is a cliff, rocket, tile ghost, or something that should not change surfaces.
          -- remove the copy from the target surface instead of destroying the original
          local position = {
            x = entity.position.x + clone_delta.dx,
            y = entity.position.y + clone_delta.dy
          }
          local clone = clone_to.find_entity(entity.name, position)
          if clone then
            util.safe_destroy(clone)
          end
        elseif entity.name == mod_prefix .. "spaceship-wall" then
          -- this does not raise any event!
          -- it will silently destroy the entity
          -- if any mod was tracking the ship walls, it will get borked by this
          -- why do potentially other-mod breaking thing?
          -- we do this for performance reasons because raising events is expensive
          entity.destroy()
        else
          util.safe_destroy(entity)
        end
      end
    end
  end
  clone_from.set_tiles(change_tiles_from, true)
  clone_to.set_tiles(change_tiles_to, true)

  -- non-space vehicles must be deactivated in space, and reactivated on land
  local cars = clone_to.find_entities_filtered{
    type = {"car"},
    area = clone_to_area
  }
  for _, car in pairs(cars) do
    if not string.find(car.name, mod_prefix.."space") then
      car.active = Zone.is_space(clone_to_zone)
    end
  end

  -- turn off engines since the ship is no longer moving immediately after cloning
  Spaceship.deactivate_engines(spaceship)

  -- fix some composite entities that don't clone nicely
  CondenserTurbine.reset_surface(clone_to, clone_to_area)
  Nexus.reset_surface(clone_to, clone_to_area)
  LinkedContainer.update()

  -- ground and unground entities
  SpaceshipClone.ground_unground_entities(clone_from, clone_to, clone_from_zone, clone_to_zone, clone_from_area, clone_to_area)

  -- put players back in vehicles
  for _, vehicle_driver in pairs(vehicle_drivers) do
    local vehicle_position = {x=vehicle_driver.vehicle_position.x+clone_delta.dx,y=vehicle_driver.vehicle_position.y+clone_delta.dy}
    local driver_position = {x=vehicle_driver.driver_position.x+clone_delta.dx,y=vehicle_driver.driver_position.y+clone_delta.dy}
    local vehicle = clone_to.find_entity(vehicle_driver.vehicle_name, vehicle_position)
    local driver = clone_to.find_entity(vehicle_driver.driver_name, driver_position)
    if vehicle and driver then
      vehicle.set_driver(driver)
    end
  end
  for _, vehicle_passenger in pairs(vehicle_passengers) do
    local vehicle_position = {x=vehicle_passenger.vehicle_position.x+clone_delta.dx,y=vehicle_passenger.vehicle_position.y+clone_delta.dy}
    local passenger_position = {x=vehicle_passenger.passenger_position.x+clone_delta.dx,y=vehicle_passenger.passenger_position.y+clone_delta.dy}
    local vehicle = clone_to.find_entity(vehicle_passenger.vehicle_name, vehicle_position)
    local passenger = clone_to.find_entity(vehicle_passenger.passenger_name, passenger_position)
    if vehicle and passenger then
      vehicle.set_passenger(passenger)
    end
  end

  -- set locomotive status (automatic vs normal)
  for _, locomotive in pairs(locomotive_settings) do
    local locomotive_x = math.floor(locomotive.position.x)
    local locomotive_y = math.floor(locomotive.position.y)
    local value = spaceship.known_tiles[locomotive_x] and spaceship.known_tiles[locomotive_x][locomotive_y]
    if value == Spaceship.tile_status.floor_console_connected then
      local position = {x=locomotive.position.x+clone_delta.dx,y=locomotive.position.y+clone_delta.dy}
      local other = clone_to.find_entity(locomotive.name, position)
      if other and other.valid and other.train then
        other.train.manual_mode = locomotive.manual_mode
      end
    end
  end

  -- turn on the new shield projectors
  remote.call("shield-projector", "find_on_surface", {
    surface = clone_to,
    area = clone_to_area
  })

  -- play ship whooshing sound
  for _, player in pairs(game.connected_players) do
    if player.surface.index == clone_from.index or player.surface.index == clone_to.index then
      player.play_sound{path = "se-spaceship-woosh", volume = 1}
    end
  end

  -- flag for cloning in progress
  spaceship.is_cloning = false

  Spaceship.start_integrity_check(spaceship)
  Spaceship.update_output_combinator(spaceship)

  -- clean up for after the clone completes
  if post_clone_cb then post_clone_cb(spaceship, clone_from, clone_to, clone_delta) end
end

return SpaceshipClone