Item types

[darkfrei]

Hi all,

why are we have a lot of item types?

I've made some table:

Code: Select all

 item_type_list = {
  "ammo",
  "armor",
  "gun",
  "item",
  "capsule",
  "repair-tool",
  "mining-tool",
  "item-with-entity-data",
  "rail-planner",
  "tool",
  "blueprint",
  "deconstruction-item",
  "blueprint-book",
  "selection-tool",
  "item-with-tags",
  "item-with-label",
  "item-with-inventory",
  "module"
}

or this item can be called as

Code: Select all

local item = 
	data.raw.item[result_name] 
	or data.raw["item-with-entity-data"][result_name] 
	or data.raw["mining-tool"][result_name] 
	or data.raw["gun"][result_name] 
	or data.raw["ammo"][result_name] 
	or data.raw["armor"][result_name] 
	or data.raw["repair-tool"][result_name] 
	or data.raw["mining-tool"][result_name] 
	or data.raw["capsule"][result_name] 
	or data.raw["fluid"][result_name] 
	or data.raw["module"][result_name] 
	or data.raw["rail-planner"][result_name] 
	or data.raw["tool"][result_name] 
	or data.raw["blueprint"][result_name] 
	or data.raw["deconstruction-item"][result_name] 
	or data.raw["blueprint-book"][result_name] 
	or data.raw["selection-tool"][result_name] 
	or data.raw["item-with-tags"][result_name] 
	or data.raw["item-with-label"][result_name] 
	or data.raw["item-with-inventory"][result_name] 

and now you can change, for example, item.stack_size

It's looks a little bit too complicated.

[Bilka]

Hi all,

why are we have a lot of item types?

Because they each have their own specific function. You don't need iron plates to be able to have the ability to have a durability or an inventory, that would only add to the save file size and also decrease performance. So they are of a type that can't have those attributes. Here is an overview of the item types which shows what item types inherit properties from where:

Item.png (32.26 KiB) Viewed 4020 times

It's looks a little bit too complicated.

How is that complicated? There are a lot of types, but whenever they share attributes, those attributes are of the same format. Maybe it's annoying for the average mod author, but it's definitely not complicated to just iterate through all possible types.

Fluids aren't items btw

[darkfrei]

Fluids aren't items btw

Thanks for your answer.

It was a part of function, where item was called from recipe result for checking that compared item_stack_size and result_amount.

Code: Select all

if result_amount > item.stack_size then
	item.stack_size = result_amount
end

And liquids will be ignored.

[eradicator]

If you already have a list of possible item types why not just iterate through it instead of that "or or or" block?

Code: Select all

local item_type_list = ... --as in opening post

local function get_item_prototype(item_name)
  for _,typ in pairs(item_type_list) do
    local prot = data.raw[typ][item_name]
    if prot then return prot end
    end
  end
  
local item = get_item_prototype(result_name)

[bobingabout]

I suppose the most confusing thing about multiple item types is that when you want to access the item type, you need to use the extra info.

data.raw.tool["science-pack-1"].icon

Yet when you want to add it to a recipe, you only explicitly use item or fluid

{type = "item", name = "science-pack-1", amount = 1}

[eradicator]

I suppose the most confusing thing about multiple item types is that when you want to access the item type, you need to use the extra info.

I thought about this for "a bit" (and i'd better not say for how long) and i think i found an acceptable solution. Using the list of prototype types that the game internally treats as items (i.e enforces unique naming above, etc):

Code: Select all

item_types = { --index of prototype types that will be redirected to "item"
  "gun"    , "blueprint"     , "item-with-tags"        ,
  "ammo"   , "repair-tool"   , "item-with-label"       ,
  "tool"   , "mining-tool"   , "item-with-inventory"   ,
  "armor"  , "rail-planner"  , "item-with-entity-data" ,
  "module" , "blueprint-book", "deconstruction-item"   ,
  "capsule", "selection-tool"
}

We can then use the function i posted above and define it as an __index method for data.raw.item like this:

Code: Select all

local meta = getmetatable(data.raw.item) or {}
meta.__index = function(_,item_name)
  for _,typ in pairs(item_types) do
    local prot = data.raw[typ][item_name]
    if prot then return prot end
    end
  end
setmetatable(data.raw.item,meta)

The __index method is called every time we try to access data.raw.item with a key that doesn't exist, i.e. because it's of one of the other prototype types. It then searches through all the item_types and returns a pointer to the table of the item found. So we can now access all of the above types from data.raw.item:

Code: Select all

--any type listed in item_types can now be accessed like it was an "item"
data.raw.item['combat-shotgun'].attack_parameters.range = 60
print(data.raw.item["science-pack-1"].order)

Simply put above code at the start of your data.lua and it should work.

[darkfrei]

So, this code makes item type table, example of result [0.15.35] is in the spoiler

Code: Select all

make_item_type_table ()
	local item_type_list = {"ammo","armor","gun","item","capsule","repair-tool","mining-tool","item-with-entity-data","rail-planner","tool","blueprint","deconstruction-item","blueprint-book","selection-tool","item-with-tags","item-with-label","item-with-inventory","module"}
	item_type_table = {}
		for i, item_type_name in pairs (item_type_list) do
			for item_name, item in pairs (data.raw[item_type_name]) do
				item_type_table[item_name] = item_type_name
			end
		end
	log ('item_type_table = ' .. serpent.block(item_type_table, {comment = false}))
end

item_type_table

Code: Select all

item_type_table = {
  accumulator = "item",
  ["advanced-circuit"] = "item",
  ["arithmetic-combinator"] = "item",
  ["assembling-machine-1"] = "item",
  ["assembling-machine-2"] = "item",
  ["assembling-machine-3"] = "item",
  ["atomic-bomb"] = "ammo",
  battery = "item",
  ["battery-equipment"] = "item",
  ["battery-mk2-equipment"] = "item",
  beacon = "item",
  ["belt-immunity-equipment"] = "item",
  ["big-electric-pole"] = "item",
  blueprint = "blueprint",
  ["blueprint-book"] = "blueprint-book",
  boiler = "item",
  ["burner-inserter"] = "item",
  ["burner-mining-drill"] = "item",
  ["cannon-shell"] = "ammo",
  car = "item-with-entity-data",
  ["cargo-wagon"] = "item-with-entity-data",
  centrifuge = "item",
  ["chemical-plant"] = "item",
  ["cluster-grenade"] = "capsule",
  coal = "item",
  coin = "item",
  ["combat-shotgun"] = "gun",
  computer = "item",
  concrete = "item",
  ["constant-combinator"] = "item",
  ["construction-robot"] = "item",
  ["copper-cable"] = "item",
  ["copper-ore"] = "item",
  ["copper-plate"] = "item",
  ["crude-oil-barrel"] = "item",
  ["decider-combinator"] = "item",
  ["deconstruction-planner"] = "deconstruction-item",
  ["defender-capsule"] = "capsule",
  ["destroyer-capsule"] = "capsule",
  ["discharge-defense-equipment"] = "item",
  ["discharge-defense-remote"] = "capsule",
  ["distractor-capsule"] = "capsule",
  ["dummy-selection-tool"] = "selection-tool",
  ["effectivity-module"] = "module",
  ["effectivity-module-2"] = "module",
  ["effectivity-module-3"] = "module",
  ["electric-energy-interface"] = "item",
  ["electric-engine-unit"] = "item",
  ["electric-furnace"] = "item",
  ["electric-mining-drill"] = "item",
  ["electronic-circuit"] = "item",
  ["empty-barrel"] = "item",
  ["energy-shield-equipment"] = "item",
  ["energy-shield-mk2-equipment"] = "item",
  ["engine-unit"] = "item",
  ["exoskeleton-equipment"] = "item",
  ["explosive-cannon-shell"] = "ammo",
  ["explosive-rocket"] = "ammo",
  ["explosive-uranium-cannon-shell"] = "ammo",
  explosives = "item",
  ["express-loader"] = "item",
  ["express-splitter"] = "item",
  ["express-transport-belt"] = "item",
  ["express-underground-belt"] = "item",
  ["fast-inserter"] = "item",
  ["fast-loader"] = "item",
  ["fast-splitter"] = "item",
  ["fast-transport-belt"] = "item",
  ["fast-underground-belt"] = "item",
  ["filter-inserter"] = "item",
  ["firearm-magazine"] = "ammo",
  flamethrower = "gun",
  ["flamethrower-ammo"] = "ammo",
  ["flamethrower-turret"] = "item",
  ["fluid-wagon"] = "item-with-entity-data",
  ["flying-robot-frame"] = "item",
  ["fusion-reactor-equipment"] = "item",
  gate = "item",
  ["green-wire"] = "item",
  grenade = "capsule",
  ["gun-turret"] = "item",
  ["hazard-concrete"] = "item",
  ["heat-exchanger"] = "item",
  ["heat-pipe"] = "item",
  ["heavy-armor"] = "armor",
  ["heavy-oil-barrel"] = "item",
  ["high-tech-science-pack"] = "tool",
  inserter = "item",
  ["iron-axe"] = "mining-tool",
  ["iron-chest"] = "item",
  ["iron-gear-wheel"] = "item",
  ["iron-ore"] = "item",
  ["iron-plate"] = "item",
  ["iron-stick"] = "item",
  ["item-with-inventory"] = "item-with-inventory",
  ["item-with-label"] = "item-with-label",
  ["item-with-tags"] = "item-with-tags",
  lab = "item",
  ["land-mine"] = "item",
  landfill = "item",
  ["laser-turret"] = "item",
  ["light-armor"] = "armor",
  ["light-oil-barrel"] = "item",
  loader = "item",
  locomotive = "item-with-entity-data",
  ["logistic-chest-active-provider"] = "item",
  ["logistic-chest-passive-provider"] = "item",
  ["logistic-chest-requester"] = "item",
  ["logistic-chest-storage"] = "item",
  ["logistic-robot"] = "item",
  ["long-handed-inserter"] = "item",
  ["low-density-structure"] = "item",
  ["lubricant-barrel"] = "item",
  ["medium-electric-pole"] = "item",
  ["military-science-pack"] = "tool",
  ["modular-armor"] = "armor",
  ["night-vision-equipment"] = "item",
  ["nuclear-reactor"] = "item",
  ["offshore-pump"] = "item",
  ["oil-refinery"] = "item",
  ["personal-laser-defense-equipment"] = "item",
  ["personal-roboport-equipment"] = "item",
  ["personal-roboport-mk2-equipment"] = "item",
  ["petroleum-gas-barrel"] = "item",
  ["piercing-rounds-magazine"] = "ammo",
  ["piercing-shotgun-shell"] = "ammo",
  pipe = "item",
  ["pipe-to-ground"] = "item",
  pistol = "gun",
  ["plastic-bar"] = "item",
  ["player-port"] = "item",
  ["poison-capsule"] = "capsule",
  ["power-armor"] = "armor",
  ["power-armor-mk2"] = "armor",
  ["power-switch"] = "item",
  ["processing-unit"] = "item",
  ["production-science-pack"] = "tool",
  ["productivity-module"] = "module",
  ["productivity-module-2"] = "module",
  ["productivity-module-3"] = "module",
  ["programmable-speaker"] = "item",
  pump = "item",
  pumpjack = "item",
  radar = "item",
  rail = "rail-planner",
  ["rail-chain-signal"] = "item",
  ["rail-signal"] = "item",
  railgun = "gun",
  ["railgun-dart"] = "ammo",
  ["raw-fish"] = "capsule",
  ["raw-wood"] = "item",
  ["red-wire"] = "item",
  ["repair-pack"] = "repair-tool",
  roboport = "item",
  rocket = "ammo",
  ["rocket-control-unit"] = "item",
  ["rocket-fuel"] = "item",
  ["rocket-launcher"] = "gun",
  ["rocket-part"] = "item",
  ["rocket-silo"] = "item",
  satellite = "item",
  ["science-pack-1"] = "tool",
  ["science-pack-2"] = "tool",
  ["science-pack-3"] = "tool",
  shotgun = "gun",
  ["shotgun-shell"] = "ammo",
  ["simple-entity-with-force"] = "item",
  ["simple-entity-with-owner"] = "item",
  ["slowdown-capsule"] = "capsule",
  ["small-electric-pole"] = "item",
  ["small-lamp"] = "item",
  ["small-plane"] = "item",
  ["solar-panel"] = "item",
  ["solar-panel-equipment"] = "item",
  ["solid-fuel"] = "item",
  ["space-science-pack"] = "tool",
  ["speed-module"] = "module",
  ["speed-module-2"] = "module",
  ["speed-module-3"] = "module",
  splitter = "item",
  ["stack-filter-inserter"] = "item",
  ["stack-inserter"] = "item",
  ["steam-engine"] = "item",
  ["steam-turbine"] = "item",
  ["steel-axe"] = "mining-tool",
  ["steel-chest"] = "item",
  ["steel-furnace"] = "item",
  ["steel-plate"] = "item",
  stone = "item",
  ["stone-brick"] = "item",
  ["stone-furnace"] = "item",
  ["stone-wall"] = "item",
  ["storage-tank"] = "item",
  ["submachine-gun"] = "gun",
  substation = "item",
  sulfur = "item",
  ["sulfuric-acid-barrel"] = "item",
  tank = "item-with-entity-data",
  ["tank-cannon"] = "gun",
  ["tank-flamethrower"] = "gun",
  ["tank-machine-gun"] = "gun",
  ["train-stop"] = "item",
  ["transport-belt"] = "item",
  ["underground-belt"] = "item",
  ["uranium-235"] = "item",
  ["uranium-238"] = "item",
  ["uranium-cannon-shell"] = "ammo",
  ["uranium-fuel-cell"] = "item",
  ["uranium-ore"] = "item",
  ["uranium-rounds-magazine"] = "ammo",
  ["used-up-uranium-fuel-cell"] = "item",
  ["vehicle-machine-gun"] = "gun",
  ["water-barrel"] = "item",
  wood = "item",
  ["wooden-chest"] = "item"
}

[eradicator]

That fixed table approach will not work for any items created after you create the table. That is why my __index method looks up the prototype each time.