function for generating 0.18+ compatible icons

[Honktown]

0.17 - > 0.18 changed many default icon sizes from 32x32 to 64x64. This creates a lot of issues. Took some time to work out code for shifting, scaling, and layering differently sized icons. This code is covered by the Unlicense. The function edits the original icon table in-place, which if not desired, can be easily changed to make a new table and return that instead. Works with recipes AND technologies.

Had some issues with table.deepcopy for a different mod, don't know why. Added helper function "table.deepestcopy".

https://pastebin.com/gZ94ePzZ

the code

Code: Select all

table.deepestcopy = function (tablein)
  -- use to copy a non-referential table, will break for infinitely referential tables
  local tableout = {}
  local key = nil
  local thing = nil

  for key, thing in pairs(tablein) do
    if type(thing) == "table" then
      tableout[key] = table.deepestcopy(thing)
    else
      tableout[key] = thing
    end
  end

  return tableout
end

local local_create_icon = function(base_icons, new_icons, options)
	if type(base_icons) ~= "table" then return base_icons end
	if type(options) ~= "table" then options = {} end
	local icon = nil

	if not options.rescale then options.rescale = 1 end
	if not options.origin then options.origin = {0,0} end
	if not new_icons then
		if options.from ~= nil and type(options.from) == "table" then
			if options.from.icons then new_icons = options.from.icons
			elseif options.from.icon then new_icons = {{icon = options.from.icon}}
			else error("Table given had no icons.") end

			for _, icon in pairs(new_icons) do
				if not icon.icon_size then icon.icon_size = options.from.icon_size end
				if not icon.icon_size then error("Had icon "..icon.icon.." but size is missing.")
				end
			end
		else
		  error("Couldn't build icons: no icons and no table to build from.")
		end
	end

	local icons = table.deepestcopy(new_icons)

	for _, icon in pairs(base_icons) do
		if not icon.scale then icon.scale = 1 end
		if not icon.shift then icon.shift = {0,0} end
	end

	if options.type == nil or options.type == "recipe" then
		for _, icon in pairs(icons) do
			if not icon.icon_size then icon.icon_size = 32 end
		end
    end

	local extra_scale
	for _, icon in pairs(icons) do
		if not icon.scale then icon.scale = 1 end
		if not icon.shift then icon.shift = {0,0} end

		extra_scale = 1
		if base_icons[1] then
			if (base_icons[1].icon_size * base_icons[1].scale) ~= (icon.icon_size * icon.scale) then
				extra_scale = (base_icons[1].icon_size * base_icons[1].scale) / (icon.icon_size)
			end
		else
			if (icons[1].icon_size * icons[1].scale) ~= (icon.icon_size * icon.scale) then
				extra_scale = (icons[1].icon_size * icons[1].scale) / (icon.icon_size)
			end
		end

		icon.shift[1] = icon.shift[1]/icon.scale
		icon.shift[2] = icon.shift[2]/icon.scale

		icon.scale = icon.scale * options.rescale * extra_scale
		icon.shift[1] = icon.shift[1] * icon.scale + options.origin[1] * icon.scale * icon.icon_size
		icon.shift[2] = icon.shift[2] * icon.scale + options.origin[2] * icon.scale * icon.icon_size
	end

	for _, icon in pairs(icons) do
		table.insert(base_icons, icon)
	end
--[[
	for _, icon in pairs(base_icons) do
		if icon.shift and icon.shift[1] == 0 and icon.shift[2] == 0 then icon.shift = nil end
		if icon.scale and icon.scale == 1 then icon.scale = nil end
	end
--]]
	return base_icons
end

Example use (I have permission to share):

Code: Select all

local local_create_container = function(item,x)
	-- pre-existing icon, adding new icons from item
	local base_contain_icons = {
		{
			icon = "__modmash__/graphics/icons/super-container.png",
			icon_size = 32
		}}
	local contain_icons = create_icon(base_contain_icons, nil, {from = item, rescale = .5})


	-- using existing icons, adding new after
	local base_uncontain_icons = {}
	local uncontain_icons = create_icon(base_uncontain_icons,nil,{from = item})
	uncontain_icons = create_icon(base_uncontain_icons,{{icon = "__modmash__/graphics/icons/super-container.png", icon_size = 32, scale = .5, shift = {5,5}}})
...

The above code is not the best example. It was adapted from previous code, and since the original table is edited, there's no need to return/assign from the function. The function reflects this (edits in place but returns table).

"options" is a table: "rescale", value between 0-1 to scale newly added icons, "origin", a position { x, y } between -1 and +1 which moves the icon proportionally in the frame, "from", to do the annoying icon, icon_size, icons[1].icon_size logic. If 'type = "recipe"' is passed, all un-sized icons are converted to 32. (explicit compatibility for the 32 -> 64 icon size change from 0.17 -> 0.18)

Short list of all options: { rescale = 1, origin = { 0, 0 }, from = item, type = "recipe" }

Notes: The function works for recipes and technologies, which interpret the same icons table differently. The incoming icons table could be anything that uses the icon/icon.size/icons description, which includes 'tool' and whatnot. There may be some issues with shifting - I don't have good tests for it. Any comments/issues would be very appreciated.

Commented loop "cleans" things that were added to reduce if not/branches. For one-time icons, the function can be used, serpent.block the result, and then use the result instead of calling the function. In the case of modmash, the icons are dynamically generated, so the function is kept.

Results:

icons from above snippet of code

before-after_1.jpg (539.53 KiB) Viewed 892 times

icons from other set of code

before-after_2.jpg (526.58 KiB) Viewed 892 times

I'm often online with Discord for immediate issues: Honktown#2912