Module:ChapChars

Contains three functions for use with {{ChapChars}}: newunits manages the new unit tables, and oldunits manages the required, available, and undeployable character sections; additionally, returning is a deprecated function that is no longer used.

---

local p = {}

function p.returning(frame)
	-- Naming the input
	local in_args = frame:getParent().args
	
	-- Determines whether or not to use "small"
	local size = ""
	local game = tostring(in_args["game#"])
	if game:find("%c", -1) ~= nil then -- if game ends with a control character
		game = game:sub(1, -2)
	end
	if tonumber(game) ~= nil or game == "wa" then
		game = "fe" .. game
	end
	local trs = game:sub(1, 3) == "trs"
	local num = game:sub(-2) -- sets "num" to third and later characters in first input
	
	if tonumber(num) ~= nil then -- if the third and later characters are numbers (e.g. "fe01" is true, "fewa" is false)
		num = tonumber(num)
	else
		num = 0
	end
	
	if num > 5 or trs then -- games 1–5 and Warriors are false; games 6–16 and TRS are true
		size = "Small "
	end
	
	-- Begins construction of output
	local args = {}; images = {}; links = {}
	local hdr = "[[File:" .. size .. "portrait " -- Start of an image link
	local link = " " .. game .. ".png|link=" -- Middle portion of an image link
	if trs then
		link = link .. "TearRingSaga:"
	end
	local ftr = "|x80px]]" -- End of link
	local output = hdr -- starts output with header value
	
	-- loops through the input and turns it into a list of images and one of links
	local i = 0
	for k, v in pairs(in_args) do
		if v:find("%c", -1) ~= nil then -- if an input ends with a control character
			v = v:sub(1, -2) -- removes last character
		end
		if k:sub(-7) == "article" then -- checks if last seven characters are "article"
			links[tonumber(k:sub(7,-8))] = v
		elseif k:sub(1,6) == "return" then -- checks if first six characters are "return"
			images[tonumber(k:sub(7))] = mw.ustring.lower(v)
			links[tonumber(k:sub(7))] = mw.ustring.lower(v)
		end
	end
	
	if images[1] == nil then -- true if images[1] is empty, which should only happen if return1 is not set
		return "None" -- ends the program
	end
	
	-- Turns the previous two lists into one list of partial links
	for k in pairs(images) do
		args[k] = images[k] .. link .. links[k] -- creates the middle portion of the link
	end
	
	table.remove(args, 1) -- The first bit of args[] is a link for the platform, this removes that
	
	-- takes list created above and turns it into useable wikitext
	output = output .. table.concat(args, ftr .. hdr)
	
	-- returns completed image set
	return output .. ftr

end

return p