Module:Rb row/common - Revision history

Nydauron: Adds preamble on what modules use this common file

2024-12-18T23:57:03Z

Adds preamble on what modules use this common file

← Older revision		Revision as of 23:57, 18 December 2024
Line 1:		Line 1:
			-- This module is used in both "Irb row" and "Rrb row" modules. If a non-backwards
			-- compatible change is made to this file, please ensure both modules are tested
			-- and updated accordingly.
	local p = {}		local p = {}

Nydauron: Reformats function docs; adds return type and description

2024-12-18T23:32:13Z

Reformats function docs; adds return type and description

← Older revision		Revision as of 23:32, 18 December 2024
Line 1:		Line 1:
	local p = {}		local p = {}

	-- @param conditionType string the type of condition. Should match one either eventCancelledValue or eventNotHeldValue.		---@param conditionType string the type of condition. Should match one either eventCancelledValue or eventNotHeldValue.
	-- @param columnCount number The number of columns that the row will span		---@param columnCount number The number of columns that the row will span
	-- @param enableColumnColor boolean Whether the background color of the cell should be shown. Varies based on the type of condition (conditionType).		---@param enableColumnColor boolean Whether the background color of the cell should be shown. Varies based on the type of condition (conditionType).
	-- @param eventCancelledValue string The string literal that represents that the event was cancelled		---@param eventCancelledValue string The string literal that represents that the event was cancelled
	-- @param eventNotHeldValue string The string literal that represents that the event was not held		---@param eventNotHeldValue string The string literal that represents that the event was not held
	-- @param conditionReason string? Specifies the reason as to why the condition happened		---@param conditionReason string? Specifies the reason as to why the condition happened
	-- @param conditionMessageOverride string? Overrides the default condition template with a custom ~~reasonmessage~~		---@param conditionMessageOverride string? Overrides the default condition template with a custom reason message
			---@return mw.html # The table cell ("td")
	function p.generateConditionRow(conditionType, columnCount, enableColumnColor, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)		function p.generateConditionRow(conditionType, columnCount, enableColumnColor, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)
	local conditionCell = mw.html.create("td")		local conditionCell = mw.html.create("td")

Nydauron: Adds background color option to condition row rendering

2024-12-18T23:17:28Z

Adds background color option to condition row rendering

← Older revision		Revision as of 23:17, 18 December 2024
Line 3:		Line 3:
	-- @param conditionType string the type of condition. Should match one either eventCancelledValue or eventNotHeldValue.		-- @param conditionType string the type of condition. Should match one either eventCancelledValue or eventNotHeldValue.
	-- @param columnCount number The number of columns that the row will span		-- @param columnCount number The number of columns that the row will span
			-- @param enableColumnColor boolean Whether the background color of the cell should be shown. Varies based on the type of condition (conditionType).
	-- @param eventCancelledValue string The string literal that represents that the event was cancelled		-- @param eventCancelledValue string The string literal that represents that the event was cancelled
	-- @param eventNotHeldValue string The string literal that represents that the event was not held		-- @param eventNotHeldValue string The string literal that represents that the event was not held
	-- @param conditionReason string? Specifies the reason as to why the condition happened		-- @param conditionReason string? Specifies the reason as to why the condition happened
	-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage		-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage
	function p.generateConditionRow(conditionType, columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)		function p.generateConditionRow(conditionType, columnCount, enableColumnColor, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)
	local conditionCell = mw.html.create("td")		local conditionCell = mw.html.create("td")
	conditionCell:attr("colspan", tostring(columnCount))		conditionCell:attr("colspan", tostring(columnCount))
Line 15:		Line 16:
	if conditionType == eventCancelledValue then		if conditionType == eventCancelledValue then
	isValidCondition = true		isValidCondition = true
			if enableColumnColor then
			conditionCell:css({["background"] = "#ffdddd"})
			end
	text = "Cancelled"		text = "Cancelled"
	elseif conditionType == eventNotHeldValue then		elseif conditionType == eventNotHeldValue then
	isValidCondition = true		isValidCondition = true
			if enableColumnColor then
			conditionCell:css({["background"] = "#ffdead"})
			end
	text = "Not held"		text = "Not held"
	end		end

Nydauron: Removes variable definition in favor of argument

2024-12-18T17:45:25Z

Removes variable definition in favor of argument

← Older revision		Revision as of 17:45, 18 December 2024
Line 8:		Line 8:
	-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage		-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage
	function p.generateConditionRow(conditionType, columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)		function p.generateConditionRow(conditionType, columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)
	~~local conditionType = args[conditionArgKey]~~
	local conditionCell = mw.html.create("td")		local conditionCell = mw.html.create("td")
	conditionCell:attr("colspan", tostring(columnCount))		conditionCell:attr("colspan", tostring(columnCount))

Nydauron: Adds missing undefined variable

2024-12-18T17:44:53Z

Adds missing undefined variable

← Older revision		Revision as of 17:44, 18 December 2024
Line 1:		Line 1:
	local p = {}		local p = {}

			-- @param conditionType string the type of condition. Should match one either eventCancelledValue or eventNotHeldValue.
	-- @param columnCount number The number of columns that the row will span		-- @param columnCount number The number of columns that the row will span
	-- @param eventCancelledValue string The string literal that represents that the event was cancelled		-- @param eventCancelledValue string The string literal that represents that the event was cancelled
Line 6:		Line 7:
	-- @param conditionReason string? Specifies the reason as to why the condition happened		-- @param conditionReason string? Specifies the reason as to why the condition happened
	-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage		-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage
	function p.generateConditionRow(columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)		function p.generateConditionRow(conditionType, columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)
			local conditionType = args[conditionArgKey]
	local conditionCell = mw.html.create("td")		local conditionCell = mw.html.create("td")
	conditionCell:attr("colspan", tostring(columnCount))		conditionCell:attr("colspan", tostring(columnCount))

			local isValidCondition = false
			local text = ""
			if conditionType == eventCancelledValue then
			isValidCondition = true
			text = "Cancelled"
			elseif conditionType == eventNotHeldValue then
			isValidCondition = true
			text = "Not held"
			end

	~~local isValidCondition = false~~		if isValidCondition then
	~~local text = ""~~		if conditionMessageOverride ~= nil then
	if ~~conditionType == eventCancelledValue then~~		text = string.format("''%s %s''", text, conditionMessageOverride)
	isValidCondition ~~= true~~		elseif conditionReason ~= nil then
	~~text = "Cancelled"~~		text = string.format("''%s due to %s''", text, conditionReason)
	~~elseif conditionType == eventNotHeldValue~~ then
	~~isValidCondition = true~~
	~~text = "Not held"~~
	~~end~~

	~~if isValidCondition then~~
	if conditionMessageOverride ~= nil then
	text = string.format("''%s %s''", text, conditionMessageOverride)
	elseif conditionReason ~= nil then
	text = string.format("''%s due to %s''", text, conditionReason)
	~~else~~
	~~text = string.format("''%s''", text)~~
	~~end~~
	else		else
	~~mw.addWarning(~~string.format("~~Condition can only be %s or~~ %s", ~~eventCancelledValue, eventNotHeldValue)~~)		text = string.format("''%s''", text)
	end		end
	conditionCell:wikitext(text)		else
	return conditionCell		mw.addWarning(string.format("Condition can only be %s or %s", eventCancelledValue, eventNotHeldValue))
			end
			conditionCell:wikitext(text)
			return conditionCell
	end		end

	return p		return p

Nydauron: Adds generateConditonRow method

2024-12-18T17:41:01Z

Adds generateConditonRow method

New page

local p = {}

-- @param columnCount number The number of columns that the row will span
-- @param eventCancelledValue string The string literal that represents that the event was cancelled
-- @param eventNotHeldValue string The string literal that represents that the event was not held
-- @param conditionReason string? Specifies the reason as to why the condition happened
-- @param conditionMessageOverride string? Overrides the default condition template with a custom reasonmessage
function p.generateConditionRow(columnCount, eventCancelledValue, eventNotHeldValue, conditionReason, conditionMessageOverride)
local conditionCell = mw.html.create("td")
conditionCell:attr("colspan", tostring(columnCount))

local isValidCondition = false
local text = ""
if conditionType == eventCancelledValue then
isValidCondition = true
text = "Cancelled"
elseif conditionType == eventNotHeldValue then
isValidCondition = true
text = "Not held"
end

if isValidCondition then
if conditionMessageOverride ~= nil then
text = string.format("''%s %s''", text, conditionMessageOverride)
elseif conditionReason ~= nil then
text = string.format("''%s due to %s''", text, conditionReason)
else
text = string.format("''%s''", text)
end
else
mw.addWarning(string.format("Condition can only be %s or %s", eventCancelledValue, eventNotHeldValue))
end
conditionCell:wikitext(text)
return conditionCell
end

return p