Merge pull request jodli#7 from Silari/Linked-Chest-Belt

Add linked chest/belts

Author: Silari

changelog.txt

@@ -2,9 +2,11 @@
 Version: 1.8.1
 Date: 2023-02-22
   Features:
-    - Added a version of the Loader1x1 - same speed/usage as the other loader, but 1x1 in size, enabling smaller builds.
     - Added a recipe for the vanilla infinity chest, as well as requester and provider variants. Setting the infinity filters will cause them to always maintain supplies of at most/at least/exactly the amount set, and a checkbox will void any contents that aren't in the infinity filters. Since they are vanilla entities, they'll be handled in engine rather than via LUA. They serve as excellent replacements to the duplicator chest and duplicator provider chest.
         - Many of the chests were converted to use this prototype internally to drastically reduce UPS costs - details are below.
+    - Added a version of the Loader1x1 - same speed/usage as the other loader, but 1x1 in size, enabling smaller builds.
+    - Added a version of the linked chest. Any two chests that are set to the same id, via the checkboxes seen when opening them, will share the inventory contents.
+    - Added a version of linked belts. Copying the settings of one and pasting it to another will set them as an input/output pair. Speed is the same as the loaders to maintain throughput.
   Changes:
     - Removed belt immunity equipment. This is a vanilla item now, no need for a recipe. We don't have one for all the other regular items.
     - Removed fluid-unknown from fluid source recipes. It's not a real fluid and there's no need for it.

defines.lua

@@ -100,6 +100,8 @@ creative_mode_defines.names.entities = {
     void_storage_chest = creative_mode_defines.name_prefix .. "void-storage-chest",
     super_loader = creative_mode_defines.name_prefix .. "super-loader",
     super_loader2 = creative_mode_defines.name_prefix .. "super-loader2",
+    linked_chest = creative_mode_defines.name_prefix .. "linked-chest",
+    linked_belt = creative_mode_defines.name_prefix .. "linked-belt",
     creative_cargo_wagon = creative_mode_defines.name_prefix .. "creative-cargo-wagon",
     duplicating_cargo_wagon = creative_mode_defines.name_prefix .. "duplicating-cargo-wagon",
     void_cargo_wagon = creative_mode_defines.name_prefix .. "void-cargo-wagon",
@@ -164,6 +166,8 @@ creative_mode_defines.names.items = {
     void_storage_chest = creative_mode_defines.name_prefix .. "void-storage-chest",
     super_loader = creative_mode_defines.name_prefix .. "super-loader",
     super_loader2 = creative_mode_defines.name_prefix .. "super-loader2",
+    linked_chest = creative_mode_defines.name_prefix .. "linked-chest",
+    linked_belt = creative_mode_defines.name_prefix .. "linked-belt",
     creative_cargo_wagon = creative_mode_defines.name_prefix .. "creative-cargo-wagon",
     duplicating_cargo_wagon = creative_mode_defines.name_prefix .. "duplicating-cargo-wagon",
     void_cargo_wagon = creative_mode_defines.name_prefix .. "void-cargo-wagon",
@@ -248,6 +252,8 @@ creative_mode_defines.names.recipes = {
     void_storage_chest = creative_mode_defines.name_prefix .. "void-storage-chest",
     super_loader = creative_mode_defines.name_prefix .. "super-loader",
     super_loader2 = creative_mode_defines.name_prefix .. "super-loader2",
+    linked_chest = creative_mode_defines.name_prefix .. "linked-chest",
+    linked_belt = creative_mode_defines.name_prefix .. "linked-belt",
     creative_cargo_wagon = creative_mode_defines.name_prefix .. "creative-cargo-wagon",
     duplicating_cargo_wagon = creative_mode_defines.name_prefix .. "duplicating-cargo-wagon",
     void_cargo_wagon = creative_mode_defines.name_prefix .. "void-cargo-wagon",

locale/en/base.cfg

@@ -68,6 +68,8 @@ creative-mod_void-chest=A chest that removes all items inside it.\nClears conten
 creative-mod_void-storage-chest=A storage chest that removes all items inside it.\nClears contents upon removed.
 creative-mod_super-loader=A super fast loader that can easily compress the transport belt in front of it. When used with infinity chests, you have a low-performance-cost solution for testing throughput with transport a belt system.
 creative-mod_super-loader2=A super fast loader1x1 that can easily compress the transport belt in front of it. When used with infinity chests, you have a low-performance-cost solution for testing throughput with transport a belt system.
+creative-mod_linked-chest=Shares an inventory with other linked chests that have the setting. Set the ID by checking the boxes - any chests where the same boxes are checked/unchecked are linked.
+creative-mod_linked-belt=A belt that can connect to another belt of the same type, anywhere on any surface. To setup, copy the settings (__CONTROL__copy-entity-settings__) of the belt you wish to be the input then paste them (__CONTROL__paste-entity-settings__) on the belt you want to be the output.
 creative-mod_creative-cargo-wagon=A cargo wagon that contains all items in the game and can auto refill itself. Its last slot can be used for voiding unwanted items. (May need to place more than one to get more items.)\nClears contents upon removal.
 creative-mod_duplicating-cargo-wagon=A cargo wagon that duplicates the item in its first slot.\nClears contents upon removal.
 creative-mod_void-cargo-wagon=A cargo wagon that removes all items inside it.\nClears contents upon removal.

prototypes/entity.lua

@@ -351,6 +351,53 @@ local function logistic_container(entity_name, item_name, icon_name, picture_nam
     }
 end
 
+-- Makes a new linked chest
+local function linkedchest(entity_name, item_name, inventory_size)
+    --We make minimal changes to this, we just want it to be our own entity in case anything messes with the vanilla one.
+    local newchest = table.deepcopy(data.raw["linked-container"]["linked-chest"])
+    newchest.type = "linked-container"
+    newchest.name = entity_name
+    newchest.flags = {"placeable-player", "player-creation"}
+    newchest.minable = {
+            mining_time = 0.5,
+            result = item_name
+    }
+    newchest.max_health = 150
+    newchest.fast_replaceable_group = "container"
+    newchest.gui_mode = "admins"
+    newchest.additional_pastable_entities = additional_pastable_entities
+    if inventory_size then
+        newchest.inventory_size = inventory_size
+    end
+    newchest.erase_contents_when_mined = true
+    newchest.circuit_wire_max_distance = 1000
+    newchest.localised_name = {"entity-name.linked-chest"}
+    return newchest
+end
+
+-- Makes a new linked belt
+local function linkedbelt(entity_name, item_name)
+    local newbelt = table.deepcopy(data.raw["linked-belt"]["linked-belt"])
+    newbelt.type = "linked-belt"
+    newbelt.name = entity_name
+    newbelt.flags = {"placeable-player", "player-creation"}
+    newbelt.minable = {
+            mining_time = 0.5,
+            result = item_name
+    }
+    newbelt.max_health = 150
+    newbelt.fast_replaceable_group = "container"
+    newbelt.gui_mode = "admins"
+    newbelt.additional_pastable_entities = additional_pastable_entities
+    newbelt.circuit_wire_max_distance = 1000
+    newbelt.localised_name = {"entity-name.linked-belt"}
+    newbelt.allow_copy_paste = true
+    newbelt.additional_pastable_entities = {entity_name}
+    newbelt.speed = 1
+    
+    return newbelt
+end
+
 -- Generates data for cargo wagon according to the given data.
 local function cargo_wagon(entity_name, item_name, tint, additional_pastable_entities, inventory_size)
     return {
@@ -1233,6 +1280,10 @@ data:extend({
     },
     ending_patch = ending_patch_prototype
 }, 
+-- Linked Chest
+             linkedchest(creative_mode_defines.names.entities.linked_chest, creative_mode_defines.names.items.linked_chest),
+-- Linked Belt
+             linkedbelt(creative_mode_defines.names.entities.linked_belt, creative_mode_defines.names.items.linked_belt),
 -- Creative Cargo Wagon
              cargo_wagon(creative_mode_defines.names.entities.creative_cargo_wagon,
     creative_mode_defines.names.items.creative_cargo_wagon, {

prototypes/item.lua

@@ -161,10 +161,34 @@ data:extend(
 			icon = creative_mode_defines.mod_directory .. "/graphics/icons/super-loader.png",
 			flags = {flags_quickbar},
 			subgroup = creative_mode_defines.names.item_subgroups.items,
-			order = "i",
+			order = "i1",
 			place_result = creative_mode_defines.names.entities.super_loader2,
 			stack_size = 50
 		},
+		{
+			-- Linked Chest
+			type = "item",
+			name = creative_mode_defines.names.items.linked_chest,
+			icon_size = data.raw.item["linked-chest"].icon_size,
+			icon = data.raw.item["linked-chest"].icon,
+			flags = {flags_quickbar},
+			subgroup = creative_mode_defines.names.item_subgroups.items,
+			order = "a5",
+			place_result = creative_mode_defines.names.entities.linked_chest,
+			stack_size = 50
+		},
+		{
+			-- Linked Belt
+			type = "item",
+			name = creative_mode_defines.names.items.linked_belt,
+			icon_size = data.raw.item["linked-belt"].icon_size,
+			icon = data.raw.item["linked-belt"].icon,
+			flags = {flags_quickbar},
+			subgroup = creative_mode_defines.names.item_subgroups.items,
+			order = "i2",
+			place_result = creative_mode_defines.names.entities.linked_belt,
+			stack_size = 50
+		},
 		-----------------------------------------------------------------------------
 
 		{

prototypes/recipe.lua

@@ -110,6 +110,22 @@ data:extend(
 			result = creative_mode_defines.names.items.super_loader2,
 			enabled = false
 		},
+		{
+			-- Linked Chest
+			type = "recipe",
+			name = creative_mode_defines.names.recipes.linked_chest,
+			ingredients = {},
+			result = creative_mode_defines.names.items.linked_chest,
+			enabled = false
+		},
+		{
+			-- Linked Belt
+			type = "recipe",
+			name = creative_mode_defines.names.recipes.linked_belt,
+			ingredients = {},
+			result = creative_mode_defines.names.items.linked_belt,
+			enabled = false
+		},
 		-----------------------------------------------------------------------------
 
 		{

scripts/events.lua

@@ -509,6 +509,19 @@ local function on_entity_settings_pasted(event)
         item_void.on_entity_copied_pasted(event.source, event.destination)
         return
     end
+    
+    if event.source.name == creative_mode_defines.names.entities.linked_belt and
+        event.destination.name == creative_mode_defines.names.entities.linked_belt then
+        -- Remove their previous links, if any.
+        event.source.disconnect_linked_belts()
+        event.destination.disconnect_linked_belts()
+        -- Setup these belts as input and output, respectively.
+        event.source.linked_belt_type = "input"
+        event.destination.linked_belt_type = "output"
+        -- then connect them to each other. This overrides any previous settings.
+        event.source.connect_linked_belts(event.destination)
+        return
+    end
 end
 
 -- Callback of the on_player_created event, which is invoked after a player is created.