Module:Abilities/Grid

File:Template-info.png Documentation

[purge]

Creates a grid where some cells can be highlighted. The center is always white unless highlighted by another color.

This module is used by Module:Abilities.

Arguments

• mark: all or comma separated list of indices to highlight, e.g. 7,8,9.
• markSource: comma separated list of indices to highlight as effect source, e.g. 7,8,9.

Indices

1	2	3	4	5
6	7	8	9	10
11	12	13	14	15
16	17	18	19	20
21	22	23	24	25

Examples

mark = 7,8,9,12,14 mark = 7,8,9,12,14 | markSource=18 mark = all

The above documentation is transcluded from Module:Abilities/Grid/doc. (edit | history)

---

local p = {}

function p.grid(f)
	-- when called via a template calling invoke
	return p.create(f:getParent().args)
end

function p.gridInvoke(f)
	-- when called with {{#invoke:Abilities/Grid|gridInvoke|mark=1}}
	return p.create(f.args)
end
		             
function p.create(args)
	-- columns and rows are fixed to 5 for now
    local columns = 5 --args.columns or 5
    local rows = 5 --args.rows or 5
    
    -- indexing fields: starting top left with 1, counting up row by row
    local totalCellCount = columns * rows;
    local centerIndex = math.floor(totalCellCount / 2) + 1
    
    local classDefinitions = {
    	['center'] = 'influence-center',
    	['1'] = 'influence-blue',
    	['all'] = 'influence-red',
    	['source'] = 'influence-source'
    	}
    
    local mark = args['mark'] or ''
    local markSource = args['markSource'] or ''
    local markAllCells = string.find(mark, 'all') ~= nil
    local markCells = {}
    for i in string.gmatch(mark, '%d+') do
    	markCells[tonumber(i)] = true
    end
    local markCellsSource = {}
    for i in string.gmatch(markSource, '%d+') do
    	markCellsSource[tonumber(i)] = true
    end
	
	local gridCells = {}
	for i = 1, totalCellCount do
		local classes = {}
    	if i == centerIndex then
    		table.insert(classes, classDefinitions['center'])
    	end
		if markAllCells then
    		table.insert(classes, classDefinitions['all'])
    	end
		if markCells[i] then
    		table.insert(classes, classDefinitions['1'])
		end
		local classStyling = ''
		if #classes > 0 then
			classStyling = ' class="'..table.concat(classes, ' ')..'"'
		end
		
		local sourceMarker = ''
		if markCellsSource[i] then
			sourceMarker = '<span class="'..classDefinitions['source']..'"/>'
		end
		
		table.insert(gridCells, '<div'..classStyling..'>'..sourceMarker..'</div>')
	end
	
    return '<div class="influence-grid" title="The center square represents the unit.&#010;Colored squares represent units affected by the effect&#010;Circles represent units needed for the effect.">'..
    table.concat(rowsResult)..'</div>'
end

return p