Module:VariantDetails

Documentation

This module provides the back end functionality of the Template:VariantDetails.

If the template is passed, this module creates a table using details from the following Modules:

• Module:Utils
• Module:ItemData
• Module:RecipeData

---

-- Credit:

local p = {}

-- Grabs args from the parent frame
-- Trims and parses the args into a table, then returns the table
function norm()
    local origArgs = mw.getCurrentFrame():getParent().args
    local args = {}
    
    for k, v in pairs( origArgs ) do
        v = mw.text.trim( tostring( v ) )
        if v ~= '' then
            args[k] = v
        end
    end
    
    return args
end

-- build a variant card
function buildVariant( variantName )
	-- variant cards require itemData
	local itemData = require( "Module:ItemData" )
	
	-- check to see if module loaded
	if (itemData == nil) then
		return "Item Data not loaded"
	end -- if itemData does not exist
	
	-- get the item data tables
	local itemList = itemData.items
	
	-- get the variant from the list
	local variant = itemList[variantName]
	
	-- variant does not exist as an item then just return
	if variant == nil then
		return "No variant here"
	end
	
    local itemType = variant.type
	local itemEN = string.sub (itemType, 1, -5)
	local itemimagename = string.gsub(itemEN, ' ', '')
    
    -- string used to build the card
    local card = '{|class=\"card mb-3\" style=\"background: #d1ecf1; border: 5px solid #7BC2CE; width: fit-content;\"\n'
    
	-- Name of card
	card = card .. '|- style=\"color: white; background-color: #1165AF; text-align: center;\"\n| colspan=\"2\" | \'\'\'<big>' .. variantName .. '</big>\'\'\'\n'

	-- Variant: Icon Image
	local image = 'NoImage.png|link=https://wiki.play.eco/index.php?title=Special:Upload&wpDestFile=' .. itemimagename .. '_Icon.png|[[Category:Pages_with_missing_icon]]'
	
-- find the image file if it exists	
	if mw.title.makeTitle('File', itemimagename .. '_Icon.png').file.exists then
		image = itemimagename .. '_Icon.png'
	elseif mw.title.makeTitle('File', itemimagename .. '_Icon.jpg').file.exists then
		image = itemimagename .. '_Icon.jpg'
	end -- if image file found
	
	-- create image cell	
	card = card .. '|-\n| colspan=\"2\" style=\"padding: 10px;\" | <div class="iconContainer"><div class="iconStack">[[File:' .. image .. '|frameless|class=iconBlue]]</div><div class=iconBorder style=\"position:absolute;\"></div></div> \n'
			
	-- 'Housing' section (if there is a Room Category)
	if variant.roomCategory ~= nil then  
		-- Housing Header
		card = card .. '|- style=\"background-color: #4688C0; text-align: center;\"\n| colspan=\"2\" | \'\'\'Housing\'\'\'\n'
    
		--roomCategory
		card = card .. '|-\n| Room Category:\n| style=\"text-align: right; padding: 3px;\" | ' .. variant.roomCategory .. '\n'

		if variant.roomCategory ~= 'Industrial' then
			if variant.furnitureType ~= nil then 
			--furnitureType
			card = card .. '|-\n| Furniture Type:\n| style=\"text-align: right; padding: 3px;\" | ' .. variant.furnitureType .. '\n'
            
			--Value of the object
			card = card .. '|-\n| Value:\n| style=\"text-align: right; padding: 3px;\" | ' .. variant.skillValue .. '\n'
            
			--Dim. Return % of Object  
			card = card .. '|-\n| Dim. Return %:\n| style=\"text-align: right; padding: 3px;\" | ' .. variant.repeatsDepreciation .. '\n'    
			end
		end
		
		-- check for industrial
		if variant.roomCategory == 'Industrial' then
			card = card .. '|- style=\"background-color: red; text-align: center;\"\n| colspan=\"2\" | \'\'\'ALL ROOM VALUE LOST\'\'\'\n'
		end
	end
			
	-- Object Placed Image
	local image = 'NoImage.png|link=https://wiki.play.eco/index.php?title=Special:Upload&wpDestFile=' .. itemimagename .. '_Placed.png|[[Category:Pages_with_missing_placed]]'
	if mw.title.makeTitle('File', itemimagename .. '_Placed.png').file.exists then
		image = itemimagename .. '_Placed.png'
	elseif mw.title.makeTitle('File', itemimagename .. '_Placed.jpg').file.exists then
		image = itemimagename .. '_Placed.jpg'
	end
	card = card .. '|-\n| colspan=\"2\" style=\"padding: 10px;\" | [[File:' .. image .. '|center|border|240px]]\n'
		
	card = card .. '|}'
		
	return card	
end

-- build all variant cards
function p.main( args )  
	local args = norm()
	
	-- check that all necessary arguments are passed correctly
    if args.name == nil or args.name == '' then
        return '\'name\' must be specified.'
    end
    
	-- name passed in will be the default recipe variant
	local defaultName = args.name
	
	-- need both crafting recipes to find variants
	local recipeData =  require( "Module:CraftingRecipes" )
	
	-- get the tables from the modules
	local recipeList = recipeData.recipes
	
	-- get the main recipe
	local defaultRecipe = recipeList[defaultName]
	
	-- break if defaultName not found
	if (defaultRecipe == nil) then
		return defaultName .. " could not be found in the recipe data"
	end -- if default is nil
	
	-- get the variants for the recipe
	local variants = defaultRecipe.variants
	local numberOfVariants = defaultRecipe.numberOfVariants
	
	-- break if no variants. return blank to not break page flow.
	if (numberOfVariants == nil or #numberOfVariants <= 1) then
		return "No Variants to find"
	end -- if variants don't exist
	
	-- create variable to store returned text
	local text = ""
	
	for i=1, #variants do		
		--skip the default variant
		if (variants[i] ~= defaultName) then
			-- build the text for each variant
			text = text .. buildVariant(variants[i]) .. " "
		end -- if variant is not default
	end -- for each variant
	
	return text
end	
	
return p