Module:PerkSearchController - Revision history

76561197969631737: changed filtering to make new list instead of edit parameter

2023-12-04T03:33:44Z

changed filtering to make new list instead of edit parameter

← Older revision		Revision as of 03:33, 4 December 2023
Line 112:		Line 112:
	end		end

			local newList = {}
	-- Remove any that do not have the specified source.		-- Remove any that do not have the specified source.
	for i, perkID in ~~pairs~~(listOfIDs) do		for _, perkID in ipairs(listOfIDs) do

	if ~~not~~ PerksData.isAnySource(perkID, source) then		if PerksData.isAnySource(perkID, source) then
	~~listOfIDs[i] = nil~~		table.insert(newList, perkID)
	end		end
	end		end

	return ~~listOfIDs~~		return newList
	end		end

Line 139:		Line 140:
	end		end

			local newList = {}
	-- Remove any that do not have the specified rarity.		-- Remove any that do not have the specified rarity.
	for i, perkID in ~~pairs~~(listOfIDs) do		for _, perkID in ipairs(listOfIDs) do

	if ~~not~~ PerksData.isRarityMatchByID(perkID, rarity) then		if PerksData.isRarityMatchByID(perkID, rarity) then
	~~listOfIDs[i] = nil~~		table.insert(newList, perkID)
	end		end
	end		end

	return ~~listOfIDs~~		return newList
	end		end

76561197969631737: should now draw a dash in last column where n/a

2023-12-04T03:22:56Z

should now draw a dash in last column where n/a

76561197969631737: wrong variable used

2023-12-04T03:18:32Z

wrong variable used

← Older revision		Revision as of 03:18, 4 December 2023
Line 257:		Line 257:
	end		end

	local numPerks = #~~perkIDsList~~		local numPerks = #filteredList
	local isFromTrader = isAnyFromTrader(~~perkIDsList~~)		local isFromTrader = isAnyFromTrader(filteredList)

	PerkSearchResultsView.startViewForSearchResults(searchTerm, source, rarity, displayOverride, numPerks, isFromTrader)		PerkSearchResultsView.startViewForSearchResults(searchTerm, source, rarity, displayOverride, numPerks, isFromTrader)

76561197969631737: fixing search logic I hope

2023-12-04T03:16:25Z

fixing search logic I hope

← Older revision		Revision as of 03:16, 4 December 2023
Line 287:		Line 287:
	local rarity = frame.args.rarity		local rarity = frame.args.rarity
	local displayOverride = frame.args.display		local displayOverride = frame.args.display

			-- Convert empty strings on these only to nil
			if source == "" then
			source = nil
			end
			if rarity == "" then
			rarity = nil
			end

	if perkID and perkID ~= "" then		if perkID and perkID ~= "" then

76561197969631737: fixed the union method

2023-12-04T03:12:32Z

fixed the union method

← Older revision		Revision as of 03:12, 4 December 2023
Line 35:		Line 35:
	local function findUnion(list1, list2)		local function findUnion(list1, list2)

	local ~~union~~ = {}		local unionList = {}

			-- Have to check before adding them to not add duplicates.
			local checkList = {}
	for _, value in ipairs(list2) do		for _, value in ipairs(list2) do
	table.insert(~~union~~, value)		table.insert(unionList, value)
			checkList[value] = true
	end		end

	~~-- Have to check before adding them to not add duplicates.~~
	for _, value in ipairs(list1) do		for _, value in ipairs(list1) do
	~~for _, alreadyValue in ipairs(list2) do~~		if not checkList[value] then
	if value ~~~= alreadyValue~~ then		table.insert(unionList, value)
	table.insert(~~union~~, value)		checkList[value] = true
	~~end~~
	end		end
	end		end

	return ~~union~~		return unionList
	end		end

76561197969631737: fixed small error in main method logic

2023-12-03T15:36:06Z

fixed small error in main method logic

← Older revision		Revision as of 15:36, 3 December 2023
Line 286:		Line 286:
	local displayOverride = frame.args.display		local displayOverride = frame.args.display

	if id and id ~= "" then		if perkID and perkID ~= "" then
	return renderFromID(perkID, displayOverride)		return renderFromID(perkID, displayOverride)
	else		else

76561197969631737: Updated the docs

2023-12-03T15:19:54Z

Updated the docs

Show changes

76561197969631737: Created to manage searching perks

2023-12-03T15:11:29Z

Created to manage searching perks

New page

---
--- Module for searching data on perks and displaying results
---
--- @module PerkSearchController
local PerkSearchController = {}

local PerkSearchResultsView = require("Module:PerkSearchResultsView")

local PerksData = require("Module:PerksData")

--region Private member variables

--endregion

--region Private constants

--endregion

--region Private methods

---
--- Takes two lists and returns the intersection of the two. Slightly more
--- efficient if the second list is smaller than the first.
---
---@param list1 table a flat table (list of values)
---@param list2 table another flat table
---@return table a similarly flat table consisting only of the values that are in both provided lists
local function findIntersection(list1, list2)

local intersection = {}

-- Create a new mapping to efficiently check for existence in list2 by
-- checking the same ID in the next loop.
local setList2 = {}
for _, value in ipairs(list2 or {}) do
setList2[value] = true
end

-- Check for intersection and populate the result table.
for _, valueToFind in ipairs(list1 or {}) do
if setList2[valueToFind] then
table.insert(intersection, valueToFind)
end
end

if #intersection == 0 then
return nil
end

return intersection
end

---
--- Takes two lists and returns the union of the two.
---
---@param list1 table a flat table (list of values)
---@param list2 table another flat table
---@return table a similarly flat table consisting of the values of both lists
local function findUnion(list1, list2)

local union = {}

for _, value in ipairs(list2) do
table.insert(union, value)
end

-- Have to check before adding them to not add duplicates.
for _, value in ipairs(list1) do
for _, alreadyValue in ipairs(list2) do
if value ~= alreadyValue then
table.insert(union, value)
end
end
end

return union
end

---
--- Runs through the provided list of IDs and returns true if any are from
--- a Trader.
---
---@param perkIDsList table list of perkIDs
---@return boolean whether any in the list are from a Trader
local function isAnyFromTrader(perkIDsList)

-- Should never be nil at runtime.
if not perkIDsList then
error("Invalid list of perk IDs.")
end

for _, perkID in ipairs(perkIDsList) do

if PerksData.isFromTraderByID(perkID) then
return true
end
end

return false
end

---
--- Searches through perks for matches in descriptions and names and returns
--- the results of both merged into one list.
---
---@param searchTerm string the terms to search for
---@return table a list of perk IDs that match
local function searchAllNamesAndDescriptions(searchTerm)

local listFromSearchingNames = PerksData.getAllPerkIDsWhereName(searchTerm)
local listFromSearchingDescriptions = PerksData.getAllPerkIDsWhereDescription(searchTerm)

return findUnion(listFromSearchingDescriptions, listFromSearchingNames)
end

local function buildRowsForPerks(perkList, displayOverride)

for _, perkID in ipairs(perkList or {}) do

local perkName = PerksData.getNameByID(perkID)
local description = PerksData.getDescriptionByID(perkID)
local iconFilename = PerksData.getIconByID(perkID)
local rarity = PerksData.getRarityByID(perkID)
local price = PerksData.getPriceByID(perkID)

local sourceCornerstone = PerksData.isFromCornerstoneByID(perkID)
local sourceEvent = PerksData.isFromEventByID(perkID)
local sourceOrder = PerksData.isFromOrderByID(perkID)
local sourceTrader = PerksData.isFromTraderByID(perkID)

PerkSearchResultsView.addRowForPerk(displayOverride, perkName,
description, iconFilename, rarity, price,
sourceCornerstone, sourceEvent, sourceOrder, sourceTrader)
end
end

local function filterAllSources(listOfIDs, source)

-- Remove any that do not have the specified source.
for i, perkID in pairs(listOfIDs) do

if not PerksData.isAnySource(perkID, source) then
listOfIDs[i] = nil
end
end
end

local function filterAllRarities(listOfIDs, rarity)

-- Remove any that do not have the specified rarity.
for i, perkID in pairs(listOfIDs) do

if not PerksData.isRarityMatchByID(perkID, rarity) then
listOfIDs[i] = nil
end
end
end

function PerkSearchController.renderFromID(perkID, displayOverride)

local perkName = PerksData.getNameByID(perkID)

if not perkName then
return "No perk found with ID " .. perkID .. "."
end

local isFromTrader = PerksData.isFromTraderByID(perkID)

PerkSearchResultsView.startViewForPerk(perkName, displayOverride, isFromTrader)

buildRowsForPerks( { perkID }, displayOverride )

return PerkSearchResultsView.endView(displayOverride)
end

function PerkSearchController.renderFromName(name, displayOverride)

local perkIDsList = PerksData.getAllPerkIDsByName(name)

if not perkIDsList or #perkIDsList == 0 then
return "No perk found with name " .. name .. "."
end

local numPerks = #perkIDsList
local isFromTrader = isAnyFromTrader(perkIDsList)

PerkSearchResultsView.startViewForName(name, displayOverride, numPerks, isFromTrader)

buildRowsForPerks(perkIDsList, displayOverride)

return PerkSearchResultsView.endView(displayOverride)
end

function PerkSearchController.renderSearch(searchTerm, source, rarity, displayOverride)

local starterList = searchAllNamesAndDescriptions(searchTerm)

local filteredList = starterList
if source ~= nil then
filteredList = filterAllSources(filteredList, source)
end
if rarity ~= nil then
filteredList = filterAllRarities(filteredList, rarity)
end

if not filteredList or #filteredList == 0 then
return "No perk found with specified search criteria."
end

local numPerks = #perkIDsList
local isFromTrader = isAnyFromTrader(perkIDsList)

PerkSearchResultsView.startViewForSearchResults(searchTerm, source, rarity, displayOverride, numPerks, isFromTrader)

buildRowsForPerks(filteredList, displayOverride)

return PerkSearchResultsView.endView(displayOverride)
end

--endregion

--region Public methods

function PerkSearchController.searchResults(frame)

-- Extract the template parameters.
local perkID = frame.args.id or frame.args[1]
local name = frame.args.name
local searchTerm = frame.args.search
local source = frame.args.source
local rarity = frame.args.rarity
local displayOverride = frame.args.display

if id and id ~= "" then
return PerkSearchController.renderFromID(perkID, displayOverride)
else
if name and name ~= "" then
return PerkSearchController.renderFromName(name, displayOverride)
else
if searchTerm and searchTerm ~= "" then
return PerkSearchController.renderSearch(searchTerm, source, rarity, displayOverride)
else
return "Unknown parameter in Perk Search template."
end
end
end
end

--endregion

return PerkSearchController

← Older revision		Revision as of 03:22, 4 December 2023
Line 158:		Line 158:
	---@param perkList table list of perk IDs		---@param perkList table list of perk IDs
	---@param displayOverride string how to display, if not default		---@param displayOverride string how to display, if not default
	local function buildRowsForPerks(perkList, displayOverride)		---@param hasLastColumn boolean whether to write the last column
			local function buildRowsForPerks(perkList, displayOverride, hasLastColumn)

	for _, perkID in ipairs(perkList or {}) do		for _, perkID in ipairs(perkList or {}) do
Line 175:		Line 176:
	PerkSearchResultsView.addRowForPerk(displayOverride, perkName,		PerkSearchResultsView.addRowForPerk(displayOverride, perkName,
	description, iconFilename, rarity, price,		description, iconFilename, rarity, price,
	sourceCornerstone, sourceEvent, sourceOrder, sourceTrader)		sourceCornerstone, sourceEvent, sourceOrder, sourceTrader, hasLastColumn)
	end		end
	end		end
Line 199:		Line 200:
	PerkSearchResultsView.startViewForPerk(perkName, displayOverride, isFromTrader)		PerkSearchResultsView.startViewForPerk(perkName, displayOverride, isFromTrader)

	buildRowsForPerks( { perkID }, displayOverride )		buildRowsForPerks( { perkID }, displayOverride, isFromTrader)

	return PerkSearchResultsView.endView(displayOverride)		return PerkSearchResultsView.endView(displayOverride)
Line 225:		Line 226:
	PerkSearchResultsView.startViewForName(perkName, displayOverride, numPerks, isFromTrader)		PerkSearchResultsView.startViewForName(perkName, displayOverride, numPerks, isFromTrader)

	buildRowsForPerks(perkIDsList, displayOverride)		buildRowsForPerks(perkIDsList, displayOverride, isFromTrader)

	return PerkSearchResultsView.endView(displayOverride)		return PerkSearchResultsView.endView(displayOverride)
Line 262:		Line 263:
	PerkSearchResultsView.startViewForSearchResults(searchTerm, source, rarity, displayOverride, numPerks, isFromTrader)		PerkSearchResultsView.startViewForSearchResults(searchTerm, source, rarity, displayOverride, numPerks, isFromTrader)

	buildRowsForPerks(filteredList, displayOverride)		buildRowsForPerks(filteredList, displayOverride, isFromTrader)

	return PerkSearchResultsView.endView(displayOverride)		return PerkSearchResultsView.endView(displayOverride)