[REQUEST]Expose recipe.localised_name to LUA data stage

[DRY411S]

My Recycling Machines mod creates a recycling recipe for pretty much every recipe in game, including mods. Building the Recycling Recipe's localised name is a nightmare. Sometimes the original items name is in the locale file item-name section, sometimes it's in the entity-name. Mod authors aren't consistent about which section they use, in fact Vanilla isn't either. As a result, my mod has built up a lookup table to tell my code which section of the locale file to find the original item/entity name in. And in some cases I have to duplicate a mod's locale entry because it's in the 'wrong' section of the locale compared with other things in the same vanilla subgroup.

None of this would be necessary in my code if a recipe's localised_name property was exposed to LUA in the data stage.

Or alternatively, if the vanilla game forced mod authors to put names of things in the correct part of the locale file by erroring if they didn't. And if the devs were also consistent about where they put locale. (See 'Rail' for an example)

[steinio]

Localized Name is not existing in data stage. It's only visible in player guis.

What do you think happens if an english and a german player join the same Server with different data tables?

[eradicator]

Every items localised names should always be {"item-name.myitem"} unless specified differently in the prototype (which you can read at data stage) and unless the mod author forgot to put it into the locale.cfg in which case the game automatically tries to find it in __entity-name__ instead. So...what you really want would be i guess that the "automatic backup lookup" works for every localised string, because from what you say it sounds like it doesn't yet.

Care to quote the rail example btw?

[DRY411S]

Localized Name is not existing in data stage. It's only visible in player guis.

What do you think happens if an english and a german player join the same Server with different data tables?

They have the mod on their client and it uses the localisation from the client. My mod runs on their client so would pick up their localised strings.

[DRY411S]

Every items localised names should always be {"item-name.myitem"} unless specified differently in the prototype (which you can read at data stage)

Where can I find it in the prototype?

and unless the mod author forgot to put it into the locale.cfg in which case the game automatically tries to find it in __entity-name__ instead. So...what you really want would be i guess that the "automatic backup lookup" works for every localised string, because from what you say it sounds like it doesn't yet.

I do have a backup which is "Cannot find localised name" kind of message.

The type of things I've found are ( for example) the vanilla game might store the localised names of storage sub-grpup in the item-name section, but a mod author might create a storage chest in the same sub-group and put the localisation in the entity-name.

Care to quote the rail example btw?

Rail is localised in entity-name, everything else rail related in item-name (or vice versa, I am not on computer)

[DRY411S]

And then there's equipment-name locale section as well.

[steinio]

See viewtopic.php?f=28&t=32611&p=278509&hil ... ed#p207308

[DRY411S]

See viewtopic.php?f=28&t=32611&p=278509&hil ... ed#p207308

Thanks for that.

My specific requirements are quite simple. When players hover over one of my Recycling Recipes I want to set what the user sees to:

recyclingrecipe.localestring = {"recipe-name.recycledparts",{<the_locale_string_of what_I_am_recycling>}}

When the user hovers over the Recycling Recipe they should see (in English) "Recycled <original_item_name> parts"

It is not possible to know (reliably) where to find the <the_locale_string_of what_I_am_recycling> in the locale file. It can be any of item-name, entity-name, equipment-name and it is not predictable which one. The item's sub-group is a good pointer, but not 100% accurate. And mods do not follow the conventions either when adding to the locale files.

And then when Mods introduce new subgroups, I end up with giant lookup tables like this:

big lookup table

Code: Select all

locale_section = 	{
						--
						-- Vanilla
						--
						["recycling-machine"] = "entity-name.",
						["module"] = "item-name.",
						["logistic-network"] = "entity-name.",
						["gun"] = "item-name.",
						["transport"] = "entity-name.",
						["barrel"] = "item-name.",
						["equipment"] = "equipment-name.",
						["production-machine"] = "entity-name.",
						["defensive-structure"] = "entity-name.",
						["circuit-network"] = "item-name.",
						["energy-pipe-distribution"] = "entity-name.",
						["inserter"] = "entity-name.",
						["extraction-machine"] = "entity-name.",
						["belt"] = "entity-name.",
						["energy"] = "entity-name.",
						["smelting-machine"] = "entity-name.",
						["intermediate-product"] = "item-name.",
						["storage"] = "entity-name.",
						["tool"] = "item-name.",
						["science-pack"] = "item-name.",
						["ammo"] = "item-name.",
						["capsule"] = "item-name.",
						["armor"] = "item-name.",
						--
						-- Bob's Mods
						--
						-- Bob's Logistics
						["bob-storage"] = "entity-name.",
						["bob-belt"] = "item-name.",
						["bob-smart-inserter"] = "entity-name.",
						["bob-purple-inserter"] = "entity-name.",
						["pipe"] = "entity-name.",
						["pipe-to-ground"] = "entity-name.",
						["bob-transport"] = "entity-name.",
						["bob-logistic-robots"] = "entity-name.",
						["bob-logistic-roboport"] = "entity-name.",
						["bob-roboport-parts"] = "item-name.",
						-- Bob's Modules
						["module-intermediates"] = "item-name.",
						["speed-module"] = "item-name.",
						["effectivity-module"] = "item-name.",
						["productivity-module"] = "item-name.",
						["pollution-create-module"] = "item-name.",
						["pollution-clean-module"] = "item-name.",
						["raw-speed-module"] = "item-name.",
						["raw-speed-module-combine"] = "item-name.",
						["green-module"] = "item-name.",
						["green-module-combine"] = "item-name.",
						["raw-productivity-module"] = "item-name.",
						["raw-productivity-module-combine"] = "item-name.",
						["god-module"] = "item-name.",
						["module-beacon"] = "entity-name.",
						-- Bob's Power
						["bob-energy-boiler"] = "entity-name.",
						["bob-energy-steam-engine"] = "entity-name.",
						["bob-energy-solar-panel"] = "entity-name.",
						["bob-energy-accumulator"] = "entity-name.",
						-- Bob's Electronics
						["bob-fluid"] = "fluid-name.",
						["bob-resource-products"] = "item-name.",
						["bob-resource"] = "item-name.",
						["bob-resource-chemical"] = "item-name.",
						["bob-material-smelting"] = "item-name.",
						["bob-material-chemical"] = "item-name.",
						["bob-alloy"] = "item-name.",
						["bob-electronic-components"] = "item-name.",
						["bob-boards"] = "item-name.",
						["bob-electronic-boards"] = "item-name.",
						-- Bob's Warfare
						["bob-resource"] = "item-name.",
						["bob-ammo-parts"] = "item-name.",
						["bob-intermediates"] = "item-name.",
						["bob-robot-parts"] = "item-name.",
						["bob-gun"] = "item-name.",
						["bob-ammo"] = "item-name.",
						["bob-capsule"] = "item-name.",
						["bob-combat-robots"] = "item-name.",
						["bob-armor"] = "item-name.",
						["bob-equipment"] = "item-name.",
						-- Bob's Plates
						["bob-pump"] = "entity-name.",
						["bob-smelting-machine"] = "entity-name.",
						["bob-production-machine"] = "entity-name.",
						["bob-assembly-machine"] = "entity-name.",
						["bob-chemical-machine"] = "entity-name.",
						["bob-electrolyser-machine"] = "entity-name.",
						["bob-fluid"] = "fluid-name.",
						["bob-fluid-electrolysis"] = "entity-name.",
						["bob-gas-bottle"] = "item-name.",
						["bob-empty-gas-bottle"] = "item-name.",
						["bob-barrel"] = "item-name.",
						["bob-empty-barrel"] = "item-name.",
						["bob-canister"] = "item-name.",
						["bob-empty-canister"] = "item-name.",
						["bob-bearings"] = "item-name.",
						-- Bob's Greenhouse
						["bob-greenhouse"] = "entity-name.",
						["bob-greenhouse-items"] = "item-name.",
						-- Bob's Assembling Machines
						["bob-assembly-machine"] = "entity-name.",
						["bob-chemical-machine"] = "entity-name.",
						["bob-electrolyser-machine"] = "entity-name.",
						["bob-refinery-machine"] = "entity-name.",
						--
						-- Orbital Ion Cannon
						--
						-- Has a fix in my locale.cfg file
						--
						-- 5dim Mods
						--
						-- 5dim transport
						["liquid-store"] = "entity-name.",
						["store-solid"] = "entity-name.",
						["transport-belt"] = "entity-name.",
						["transport-ground"] = "entity-name.",
						["transport-ground-30"] = "entity-name.",
						["transport-ground-50"] = "entity-name.",
						["transport-splitters"] = "entity-name.",
						["transport-pipe-ground"] = "entity-name.",
						["transport-pipe-ground-30"] = "entity-name.",
						["transport-pipe-ground-50"] = "entity-name.",
						-- 5dim resources
						["masher"] = "entity-name.",
						-- 5dim mining
						["liquid-pump"] = "entity-name.",
						["mining-speed"] = "entity-name.",
						["mining-range"] = "entity-name.",
						-- 5dim automization
						["liquid-refinery"] = "entity-name.",
						["liquid-plant"] = "entity-name.",
						-- 5dim core
						-- Rocket silo locale also added
						["intermediate-lab"] = "item-name.",
						["intermediate-misc"] = "item-name.",
						["intermediate-chip"] = "item-name.",
						["intermediate-silo"] = "item-name.",
						["furnace-coal"] = "entity-name.",
						["furnace-electric"] = "entity-name.",
						["assembling-machine"] = "entity-name.",
						["lab"] = "item-name.",
						["pick"] = "item-name.",
						-- 5dim energy
						["energy-engine-1"] = "entity-name.",
						["energy-boiler"] = "entity-name.",
						["energy-offshore-pump"] = "entity-name.",
						["energy-small-pump"] = "entity-name.",
						["energy-accumulator"] = "entity-name.",
						["energy-solar-panel"] = "entity-name.",
						["energy-pole"] = "entity-name.",
						["energy-lamp"] = "entity-name.",
						-- 5dim inserters
						-- Filter inserter locale also added
						["inserters-burner"] = "entity-name.",
						["inserters-speed1"] = "entity-name.",
						["inserters-speed2"] = "entity-name.",
						["inserters-speed3"] = "entity-name.",
						["inserters-smart"] = "item-name.",
						["inserters-right"] = "item-name.",
						["inserters-left"] = "item-name.",
						-- 5dim logistic
						["logistic-robot"] = "entity-name.",
						["logistic-robot-c"] = "entity-name.",
						["logistic-roboport"] = "entity-name.",
						["logistic-pasive"] = "entity-name.",
						["logistic-requester"] = "entity-name.",
						["logistic-storage"] = "entity-name.",
						["logistic-active"] = "entity-name.",
						["logistic-wire"] = "item-name.",
						["logistic-beacon"] = "entity-name.",
						["logistic-comb"] = "entity-name.",
						["repair"] = "item-name.",
						-- 5dim module
						["speed"] = "item-name.",
						["effectivity"] = "item-name.",
						["productivity"] = "item-name.",
						["pollution"] = "item-name.",
						["welder"] = "item-name.",
						-- 5dim trains
						["trains-rails"] = "entity-name.",
						["trains-locomotive"] = "entity-name.",
						["trains-misc"] = "entity-name.",
						-- 5dim battlefield
						["defense-gun"] = "entity-name.",
						["defense-laser"] = "entity-name.",
						["defense-flame"] = "entity-name.",
						["defense-wall"] = "entity-name.",
						["defense-gate"] = "entity-name.",
						["defense-radar"] = "entity-name.",
						-- 5dim armor
						["armor-bullet"] = "item-name.",
						["armor-shotgun"] = "item-name.",
						["armor-rocket"] = "item-name.",
						["armor-flame"] = "item-name.",
						["armor-capsule"] = "item-name.",
						["armor-armor"] = "item-name.",
						["armor-dmg"] = "equipment-name.",
						["armor-util"] = "equipment-name.",
						-- 5dim vehicle
						-- tank locale also added
						["vehicles-car"] = "entity-name.",
						["vehicles-truck"] = "entity-name.",
						["vehicles-air"] = "entity-name.",
						["vehicles-tank"] = "item-name.",
						["vehicles-boat"] = "entity-name.",
						["vehicles-arty"] = "item-name.",
						-- 5dim decoration
						["decoration-banner"] = "entity-name.",
						["decoration-arrow"] = "entity-name.",
						["decoration-letter"] = "entity-name.",
						--
						-- Yuoki
						--
						-- Yuoki Industries
						-- y_drillhead locale also added
						-- y_toolhead locale also added
						["y_line1"] = "entity-name.",
						["y_line2"] = "entity-name.",
						["y-c_mud"] = "item-name.",
						["yuoki-formpress"] = "entity-name.",
						["y-storage"] = "entity-name.",
						["yuoki-archaeology"] = "item-name.",
						["y-defense"] = "entity-name.",
						["y-parts"] = "item-name.",
						["y_defense_walls"] = "entity-name.",
						["y-ammo"] = "item-name.",
						["y_line9"] = "entity-name.",
						["y-tools"] = "item-name.",
						-- Yuoki Energy
						["y-lamps"] = "entity-name.",
						["y-fame"] = "item-name.",
						["y-energy"] = "entity-name.",
						["y-energy-2"] = "entity-name.",
						["y-electric"] = "item-name.",
						["y-battery-single-use1"] = "item-name.",
						["y-tech"] = "entity-name.",
						["y-coal-brikett"] = "item-name.",
						["y-fuel"] = "item-name.",
						["y-coal-dust"] = "item-name.",
						["y-boiler"] = "entity-name.",
						["y-module"] = "item-name.",
						["ye_science_blue"] = "entity-name.",
						["ypfw_trader_sign"] = "entity-name.",
						["y_mastercrafted"] = "entity-name.",
						--Yuoki Atomics
						["y-stargate-r"] = "item-name.",
						["y_greensign"] = "item-name.",
						["y_rwtechsign"] = "item-name.",
						-- Yuoki Liquids
						["y-fluid-storage"] = "entity-name.",
						["y-unicomp-a2"] = "entity-name.",
						["y-unicomp-raw"] = "entity-name.",
						["y-pipe"] = "entity-name.",
						["y_refine_machinery"] = "entity-name.",
						["y_refine_parts"] = "entity-name.",
						["y_structure_vessel"] = "item-name.",
						["y_refine_material"] = "item-name.",
						--["name"] = "thing-name.",
					}

If my mod is doing this all wrong, and there is a way to reliably know where to find localestring, please somebody tell me.

Although my request is for the actual string to be exposed in LUA data stage, just the locale section would be as good.

[eradicator]

Every items localised names should always be {"item-name.myitem"} unless specified differently in the prototype (which you can read at data stage)

Where can I find it in the prototype?

.localised_name but to avoid confusion: this is only available if the mod explicitly overrides default behavior (base game does this in some places such as barreling recipes) by specifiying that in the data stage.

and unless the mod author forgot to put it into the locale.cfg in which case the game automatically tries to find it in __entity-name__ instead. So...what you really want would be i guess that the "automatic backup lookup" works for every localised string, because from what you say it sounds like it doesn't yet.

I do have a backup which is "Cannot find localised name" kind of message.

How do you even detect if you could find a localised name or not? You're not supposed to be able to do that.

The type of things I've found are ( for example) the vanilla game might store the localised names of storage sub-grpup in the item-name section, but a mod author might create a storage chest in the same sub-group and put the localisation in the entity-name.

Care to quote the rail example btw?

Rail is localised in entity-name, everything else rail related in item-name (or vice versa, I am not on computer)

Rail is kinda weird anyway with how it internally works \o/. And as i said before a mod author doesn't purposely store stuff in entity-name, they just forget to put an item-name. Basically from what i know the game does:

1) look if the prototype specified .localised_name. if not ->
2) look if there is a locale item-type.item-name. if not ->
3) look if there is a locale item-place-result-type.item-place-result-name (place result would be "entity" for lost of things, but could be equipment too, or nothing)

edit:
Testing around with cursor_stack.prototype.localised_name it might be that 2) and 3) are the other way around, so that it looks if there is a place result first. If that is the case you should be able to fix (almost?) all "irregulars" automatically. Also looking at your lookup table it looks like your going by item subgroup where you should be looking for item type imho. So try (pseudocode)
if item.placeable then placeable-result-name, else item-name.

[DRY411S]

Not TL:DR, plenty to think about thank you, and too much to break out individually and comment.

However, item-type is never going to work in this scenario. There are so few compared with sub-groups, as I think my lookup table shows.

Type item is divided into groups then into sub-groups. But there are other types that are not 'item' that are also recyclable.

Types hierachy

Code: Select all

-- These are the types found in development
-- Mods may invent more, but not likely
-- TODO: Maybe let people decide what they want to recycle to unclutter the menus
-- TODO: Would need a GUI or trigger mods
local validtypes =	{	
						"ammo",
						"armor",
						"capsule",
						--"fluid",
						"gun",
						"item",
						"mining-tool",
						"module",
						"repair-tool",
						"tool",
						-- Yuoki (is also used by vanilla but there are no recipes)
						"container"
					}
--
-- Unsupported type in v0.12
--
if GameVersion ~= "0.12" then
	-- New in v0.13
	table.insert(validtypes,"rail-planner")
end

if GameVersion == "0.15" then
	-- New type in v0.15 for vehicles
	table.insert(validtypes,"item-with-entity-data")
end

-- These are the subgroups that cannot be recycled
local invalidsubgroups = {	
							"raw-material",
							"terrain",
							"fluid-recipes",
                            -- New in 0.15
                            "raw-resource",
                            "fill-barrel",
                            "empty-barrel",
							-- Yuoki
							"y-raw-material",
							-- Bob's Mods
							"bob-gems-ore",
							"bob-gems-raw",
							"bob-gems-cut",
							"bob-gems-polished",
						}

-- These are the vanilla groups. Those in the table that are not commented have no recipes attached to them that we want to reverse
local invalid_item_groups = {
							--"combat",
							"enemies",
							"environment",
							"fluids",
							--"intermediate-products",
							--"logistics",
							"other",
							--"production",
							"signals",
							}

-- Used as a basis for locale determination. These were the v0.12 vanilla sub-groups found in development, left here for reference.
-- Mods produce others, v0.13 appears to have more. Mod subgroups will need to be handled for locale translation
validsubgroups =	{	
							-- "recycling-machine",
							-- "module",
							-- "logistic-network",
							-- "gun",
							-- "transport",
							-- "barrel",
							-- "equipment",
							-- "production-machine",
							-- "defensive-structure",
							-- "circuit-network",
							-- "energy-pipe-distribution",
							-- "inserter",
							-- "extraction-machine",
							-- "belt",
							-- "energy",
							-- "smelting-machine",
							-- "intermediate-product",
							-- "storage"
					}

[eradicator]

However, item-type is never going to work in this scenario. :) There are so few compared with sub-groups, as I think my lookup table shows.

Well but it is, or rather, you don't even need item-type. In fact i just wrote a function that correctly generates all locale names for vanilla + xanders (and a few small ones) mods items as far as i can tell. The only things that don't generate correctly in control stage are barrels and the blueprint, but i know that those have .localised_name specified in the prototype, so it's easy to read in data stage.

Code: Select all

/c
print('\n\n\n\n\n')
for k,v in pairs(game.item_prototypes) do
  local real = v.localised_name[1]
  local derived
  
  if v.place_result then
    derived = 'entity-name.'..v.place_result.name
  
  elseif v.place_as_equipment_result then
    derived = 'equipment-name.'..v.place_as_equipment_result.name
   
  -- elseif v.localised_name then --data stage only
    -- derived = v.localised_name
   
  else
    derived = 'item-name.'..v.name
    end
  
  
  if real ~= derived then
    print('Failed: ',k,real,derived)
    end


end

[DRY411S]

Thanks I'll study this more after a goods night sleep.

Is the game data structure available in the data stage of the ermmm... game?

[eradicator]

Is the game data structure available in the data stage of the ermmm... game?

Nope. That was just for demonstration. In data you have direct access to data.raw after all.

[DRY411S]

Your code works 100% in vanilla, and almost 100% with all the mods I've tried thank you.

Where it doesn't work with mods, should I be suggesting to the mod authors that they change their locale file?

[eradicator]

Your code works 100% in vanilla, and almost 100% with all the mods I've tried thank you.

Where it doesn't work with mods, should I be suggesting to the mod authors that they change their locale file?

I have no clue, that would depend highly on what kind of item/mod that is. I'd rather assume there's some erorr/edge case that my code is still missing. Care to post examples?

Also i just noticed there's one major bug in my code in that it checks v.localised_name last when it should be checked first (i.e. before place_result), mostly because i tested in control stage :P.

[DRY411S]

It doesn't work with the valve in Bob's Logistics mod, or with either of the items in the Rail Loader Mod.

It's very irritating that there are occasional glitches in the odd Mod here and there.

bob-valve.png (219.45 KiB) Viewed 5830 times

railloader.png (225.09 KiB) Viewed 5830 times

[eradicator]

Can you dump the prototypes of those two (and the relevant config sections?) and post them here? (Also did you fix the bug i mentiond above?)

(Also unrelated...why does the total raw tooptip show player ports :P)

Edit:
Oh, and the code of the function you're actually using in data stage. I have a hunch about some problematic details that i'd like to check.

[DRY411S]

Can you dump the prototypes of those two (and the relevant config sections?) and post them here? (Also did you fix the bug i mentiond above?)

The code runs fine without any fix. If I'd tested for localised_name earlier in the logic, then Bob's Valve would not be an issue, I agree. I will change it as you suggest.

There are very, very few prototypes with localised_name in vanilla, and most of them I don't recycle anyway (like barrels with fluids in for example, I recycle only empty barrels).

Here's a logfile dump of every data.raw.item (including those in mods I'm testing with). There are 38 items with localised_name set.

factorio-current.log

(326.1 KiB) Downloaded 80 times

(Also unrelated...why does the total raw tooptip show player ports )

Don't understand

Edit:
Oh, and the code of the function you're actually using in data stage. I have a hunch about some problematic details that i'd like to check.

The code with old lookup code commented out to preserve it just in case

Code: Select all

	-- Localise the reversed recipe name by wrapping the original localised text
	-- with "Recycled <localised_text> parts"
	function localise_text(item,recipe,result)
		-- if locale_section[item.subgroup] then
			-- localestring = {"recipe-name.recycledparts",{locale_section[item.subgroup] .. result}}
            -- -- log(localestring)
		-- else
			-- -- Show the user the name of the unsupported subgroup,
			-- -- when they hover over the Recycling Recipes
			-- -- for future bug reporting and enhancement
			-- localestring = {"recipe-name.recycledunknown", {item.subgroup}}
            -- -- log(serpent.block(localestring))
		-- end
        
        -- New in 0.16.6, not implemented for 0.15 stream
        local derived
        if item.place_result then
            derived = 'entity-name.'..item.name
        elseif item.placed_as_equipment_result then
            derived = 'equipment-name.'..item.name
        elseif item.localised_name then
            derived = item.localised_name
        else
            derived = 'item-name.'..item.name
        end
            
        localestring = {"recipe-name.recycledparts",{derived}}            
        
	end --localise_text

[eradicator]

The code runs fine without any fix. If I'd tested for localised_name earlier in the logic, then Bob's Valve would not be an issue, I agree. I will change it as you suggest.
There are very, very few prototypes with localised_name in vanilla, and most of them I don't recycle anyway (like barrels with fluids in for example, I recycle only empty barrels).

Well, no. It doesn't run fine, it has a bug :P. And there's no reason to not fix the bug. Also just because vanilla doesn't use localised_name that often doesn't mean you can just ignore it. I use it in some places for example to generate names because static names don't work in some cases. Other mods do this too.

Here's the hopefully 100% correct version:

Code: Select all

local derived --courtesy of eradicator
  if item.localised_name then
      derived = item.localised_name
  elseif item.place_result then
      derived = 'entity-name.'..item.place_result
  elseif item.placed_as_equipment_result then
      derived = 'equipment-name.'..item.placed_as_equipment_result
  else
      derived = 'item-name.'..item.name
  end

As i expected there was another issue. You were still using item-name when you really need to use the place-result name. This only seems to work because in vanilla and most mods they happen to be the same. Also i tested for the very rare case in which an equipment is also placeable as entity, in that case it uses the entity name, so no changes are needed for that.

[DRY411S]

Yes it doesn't run fine, it does have a bug. This is what happens when I try to compose a post in between testing, work and 10 family members arriving for the weekend at various intervals.

Thanks for the new code including the cheeky acknowledgement comment. Rest assured the released version will fully recognise your help in fixing this, and in the changelog, not just buried in code.

Mods can close this request. Eradicator has shown how this requested feature is not necessary.