Please note that some information on this wiki is still based on the demo version.
If you notice any errors, feel free to correct them.

Module:Abilities/Grid

From Super Fantasy Kingdom Official Wiki
Revision as of 11:34, 18 November 2023 by wgg>Cadaei (simplified mark arguments)

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 Script error: The function "gridInvoke" does not exist. mark = 7,8,9,12,14 | markSource=18 Script error: The function "gridInvoke" does not exist. mark = all Script error: The function "gridInvoke" does not exist.


local p = {}

function p.grid(f)
	return p.create(f:getParent().args)
end
		             
function p.create(args)
    local columns = args.columns or 5
    local rows = args.rows or 5
    
    -- indexing fields: starting top left with 1, counting up row by row
    local centerIndex = math.floor(columns * rows / 2) + 1
    
    local classDefinitions = {
    	['center'] = 'influence-center',
    	['1'] = 'influence-blue',
    	['all'] = 'influence-red'
    	}
    
    local mark = args['mark'] or ''
    local markAllCells = mark == 'all'
    local markCells = {}
    for i in string.gmatch(mark, '%d+') do
    	markCells[i] = true
    end
	
    local rowsResult = {}
    local index = 0
    for x=1, columns do
    	local fieldsResult = {}
    	for y=1, rows do
    		index = index + 1
    		local classes = {}
    		local useCustomClasses = false
    		if index == centerIndex then
    			table.insert(classes, classDefinitions['center'])
    			useCustomClasses = true
    		end
			if markAllCells then
    			table.insert(classes, classDefinitions['all'])
    			useCustomClasses = true
    		end
			if markCells[index] then
    			table.insert(classes, classDefinitions['1'])
    			useCustomClasses = true
			end
			local classStyling = ''
			if useCustomClasses then
				classStyling = ' class="'..table.concat(classes, ' ')..'"'
			end
			
			table.insert(fieldsResult, '<td'..classStyling..'></td>')
    	end
    	table.insert(rowsResult, '<tr>'..table.concat(fieldsResult)..'</tr>')
    end
    return '<table class="influence-table" title="The center square represents the hero, colored squares represent heroes affected by the effect.">'..table.concat(rowsResult)..'</table>'
end

return p