Skip to content

Add support for Runeforged/mastered unique variants #2511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vaisest wants to merge 1 commit into
base: dev
Choose a base branch
from
+236 −16
Open

Add support for Runeforged/mastered unique variants #2511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 126 additions & 0 deletions spec/System/TestItemVariants_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,4 +445,130 @@ describe("Versioned item variants", function()
assert.equals(10, restored.baseModList:Sum("BASE", nil, "Life"))
end)
end)

describe("Base Variant selection (separate from mod variants)", function()
it("selects a base independently from an independent variant", function()
local item = new("Item"):Item([[
Rarity: Unique
Base Variant Independent Test
{base:1}Gold Ring
{base:2}Iron Ring
Base Variant: Gold
Base Variant: Iron
Selected Base Variant: 2
Variant: Life
Variant: Mana
Selected Variant: 2
Implicits: 0
{variant:1}+10 to maximum Life
{variant:2}+20 to maximum Mana
]])
assert.equals("Iron Ring", item.baseName)
assert.equals(0, item.baseModList:Sum("BASE", nil, "Life"))
assert.equals(20, item.baseModList:Sum("BASE", nil, "Mana"))

-- Changing the mod variant does not affect the selected base
item.variant = 1
item:BuildAndParseRaw()
assert.equals("Iron Ring", item.baseName)
assert.equals(10, item.baseModList:Sum("BASE", nil, "Life"))

-- Changing the base variant does not affect the selected mod variant
item.selectedBase = 1
item:BuildAndParseRaw()
assert.equals("Gold Ring", item.baseName)
assert.equals(10, item.baseModList:Sum("BASE", nil, "Life"))

assert.matches("Base Variant: Gold", item.raw, 1, true)
assert.matches("Base Variant: Iron", item.raw, 1, true)
assert.matches("Selected Base Variant: 1", item.raw, 1, true)
assert.matches("{base:1}Gold Ring", item.raw, 1, true)
assert.matches("{base:2}Iron Ring", item.raw, 1, true)

local restored = new("Item"):Item(item.raw)
assert.equals("Gold Ring", restored.baseName)
assert.equals(1, restored.variant)
end)

it("selects a base independently from the selected version", function()
local item = new("Item"):Item([[
Rarity: Unique
Versioned Base Variant Test
{version:1}{base:1}Gold Ring
{version:1}{base:2}Iron Ring
{version:2}Ruby Ring
Version: Legacy
Version: Current
Selected Version: 1
Base Variant: Gold
Base Variant: Iron
Selected Base Variant: 2
Implicits: 0
{version:1}+10 to maximum Life
{version:2}+20 to maximum Life
]])
assert.equals("Iron Ring", item.baseName)
assert.equals(10, item.baseModList:Sum("BASE", nil, "Life"))

-- Changing the base variant does not affect the selected version's mods
item.selectedBase = 1
item:BuildAndParseRaw()
assert.equals("Gold Ring", item.baseName)
assert.equals(10, item.baseModList:Sum("BASE", nil, "Life"))

-- A version without per-base lines falls back to its one base regardless of the base variant selection
item.selectedVersion = 2
item:BuildAndParseRaw()
assert.equals("Ruby Ring", item.baseName)
assert.equals(20, item.baseModList:Sum("BASE", nil, "Life"))

item.selectedVersion = 1
item:BuildAndParseRaw()
assert.matches("{base:1}{version:1}Gold Ring", item.raw, 1, true)
assert.matches("Selected Base Variant: 1", item.raw, 1, true)

local restored = new("Item"):Item(item.raw)
assert.equals("Gold Ring", restored.baseName)
assert.equals(1, restored.selectedVersion)
end)

it("selects a base independently from grouped variants", function()
local item = new("Item"):Item([[
Rarity: Unique
Grouped Base Variant Test
{base:1}Gold Ring
{base:2}Iron Ring
Base Variant: Gold
Base Variant: Iron
Selected Base Variant: 2
Variant: Life
Variant: Mana
Implicits: 0
{variant:1}{group:1}+10 to maximum Life
{variant:2}{group:1}+20 to maximum Mana
]])
assert.equals("Iron Ring", item.baseName)
assert.same({ 1 }, item.variantGroupSelections)
assert.equals(10, item.baseModList:Sum("BASE", nil, "Life"))

-- Changing the variant group selection does not affect the selected base
item.variantGroupSelections[1] = 2
item:BuildAndParseRaw()
assert.equals("Iron Ring", item.baseName)
assert.equals(20, item.baseModList:Sum("BASE", nil, "Mana"))

-- Changing the base variant does not affect the variant group selection
item.selectedBase = 1
item:BuildAndParseRaw()
assert.equals("Gold Ring", item.baseName)
assert.equals(20, item.baseModList:Sum("BASE", nil, "Mana"))

assert.matches("{base:1}Gold Ring", item.raw, 1, true)
assert.matches("Selected Base Variant: 1", item.raw, 1, true)

local restored = new("Item"):Item(item.raw)
assert.equals("Gold Ring", restored.baseName)
assert.same({ 2 }, restored.variantGroupSelections)
end)
end)
end)
53 changes: 46 additions & 7 deletions src/Classes/Item.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,11 @@ end
local variantSelectionSpecNames = {
["Version"] = true,
["Variant"] = true,
["Base Variant"] = true,
["Selected Version"] = true,
["Selected Variant Group"] = true,
["Selected Variant"] = true,
["Selected Base Variant"] = true,
}

function ItemClass:HasVariantGroups()
Expand Down Expand Up @@ -450,6 +452,7 @@ function ItemClass:GetUniqueDBItem()
return dbItem
end
end
---@alias ItemRarity "NORMAL"|"MAGIC"|"RARE"|"UNIQUE"|"RELIC"
---@class ModLine A modifier line on an item. An in-game mod can translate to multiple ModLines.
---@field modList Mod[]
---@field line string The actual text for the line. This might describe a range of values, in which case applyRange() can be used with this and the range value to get a ranged line.
Expand All @@ -462,6 +465,7 @@ end
---@field versionList table<number, boolean>?
---@field variantGroupList table<number, boolean>?
---@field modId string?
---@field rarity ItemRarity Defaults to unique, if not given in item string or constructor.

local getRangedModList
-- Parse raw item data and extract item name, base type, quality, and modifiers
Expand Down Expand Up @@ -566,6 +570,7 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
local implicitLines = 0
local skippedRuneLines = 0
self.variantList = nil
self.baseList = nil
self.versionList = nil
-- group ID -> variant ID -> eligible version IDs; version 0 means every version.
---@type table<number, table<number, table<number, boolean>>>
Expand All @@ -580,6 +585,10 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
if specName == "Version" then
self.versionList = self.versionList or { }
t_insert(self.versionList, specVal)
elseif specName == "Base Variant" then
self.baseList = self.baseList or {}
self.selectedBase = self.selectedBase or 1
t_insert(self.baseList, specVal)
elseif specName == "Variant" then
self.variantList = self.variantList or { }
-- This has to be kept for backwards compatibility
Expand All @@ -594,18 +603,22 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
end
elseif specName == "Selected Variant" then
self.variant = specToNumber(specVal)
elseif specName == "Selected Base Variant" then
self.selectedBase = specToNumber(specVal)
end
end

local variantSpec = rawLine:match("{variant:([^}]*)}")
local versionSpec = rawLine:match("{version:([^}]*)}")
local groupSpec = rawLine:match("{group:([^}]*)}")
if variantSpec or versionSpec or groupSpec then
local baseSpec = rawLine:match("{base:([^}]*)}")
if variantSpec or versionSpec or groupSpec or baseSpec then
local selectionTags = {
line = rawLine,
variantList = variantSpec and parseIdSpec(variantSpec) or nil,
versionList = versionSpec and parseIdSpec(versionSpec) or nil,
variantGroupList = groupSpec and parseIdSpec(groupSpec, true) or nil,
baseList = baseSpec and parseIdSpec(baseSpec) or nil,
}
selectionTagsByLine[lineIndex] = selectionTags
end
Expand Down Expand Up @@ -879,6 +892,8 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
self.variantAlt4 = specToNumber(specVal)
elseif specName == "Selected Alt Variant Five" then
self.variantAlt5 = specToNumber(specVal)
elseif specName == "Selected Base Variant" then
self.selectedBase = specToNumber(specVal)
elseif specName == "Allow Duplicate Variants" then
self.allowDuplicateVariants = specVal == "true"
elseif specName == "Has Variants" or specName == "Selected Variants" then
Expand Down Expand Up @@ -968,6 +983,8 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
modLine.variantList = selectionTags and selectionTags.variantList or parseIdSpec(val)
elseif k == "version" then
modLine.versionList = selectionTags and selectionTags.versionList or parseIdSpec(val)
elseif k == "base" then
modLine.baseVariantList = selectionTags and selectionTags.baseList or parseIdSpec(val)
elseif k == "group" then
modLine.variantGroupList = selectionTags and selectionTags.variantGroupList or parseIdSpec(val, true)
elseif k == "tags" then
Expand Down Expand Up @@ -1054,21 +1071,23 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
baseName = "Two-Toned Boots (Armour/Energy Shield)"
end
local base = data.itemBases[baseName]
if baseName:find("Runeforged") or baseName:find("Runemastered") then
self.runicItem = true
end
if base then
-- Items with variants can have multiple bases
self.baseLines[baseName] = {
line = baseName,
variantList = modLine.variantList,
baseVariantList = modLine.baseVariantList,
versionList = modLine.versionList,
variantGroupList = modLine.variantGroupList,
}
-- Set the actual base if variant matches or doesn't have variants
local usesVersionedOrGroupedVariants = self:UsesVersionedOrGroupedVariants()
local baseMatches = usesVersionedOrGroupedVariants and self:CheckModLineVariant(modLine)
or (not usesVersionedOrGroupedVariants and (not self.variant or not modLine.variantList or modLine.variantList[self.variant]))
or (not usesVersionedOrGroupedVariants and
((not self.variant or not modLine.variantList or modLine.variantList[self.variant])
and (not self.selectedBase or not modLine.baseVariantList or modLine.baseVariantList[self.selectedBase])
)
)
if baseMatches then
self.baseName = baseName
if not (self.rarity == "NORMAL" or self.rarity == "MAGIC") then
Expand Down Expand Up @@ -1356,6 +1375,9 @@ function ItemClass:ParseRaw(raw, rarity, highQuality)
::continue::
l = l + 1
end
if self.baseName and (self.baseName:find("Runeforged") or self.baseName:find("Runemastered")) then
self.runicItem = true
end
if self.baseName and self.title then
self.name = self.title .. ", " .. self.baseName:gsub(" %(.+%)","")
end
Expand Down Expand Up @@ -1967,6 +1989,9 @@ function ItemClass:BuildRaw()
if modLine.versionList then
prependToAllLines("{version:" .. makeIdSpec(modLine.versionList) .. "}")
end
if modLine.baseVariantList then
prependToAllLines("{base:" .. makeIdSpec(modLine.baseVariantList) .. "}")
end
if not hasNewSelection and modLine.modTags and #modLine.modTags > 0 then
line = "{tags:" .. table.concat(modLine.modTags, ",") .. "}" .. line
end
Expand All @@ -1980,6 +2005,14 @@ function ItemClass:BuildRaw()
t_insert(rawLines, "Selected Version: " .. self.selectedVersion)
end
end
if self.baseList then
for _, baseName in ipairs(self.baseList) do
t_insert(rawLines, "Base Variant: " .. baseName)
end
if self.selectedBase then
t_insert(rawLines, "Selected Base Variant: " .. self.selectedBase)
end
end
if self.variantList then
for _, variantName in ipairs(self.variantList) do
t_insert(rawLines, "Variant: " .. variantName)
Expand All @@ -1998,7 +2031,7 @@ function ItemClass:BuildRaw()
end

for _, baseLine in pairs(self.baseLines or { }) do
if baseLine.variantList or baseLine.versionList or baseLine.variantGroupList then
if baseLine.variantList or baseLine.versionList or baseLine.variantGroupList or baseLine.baseVariantList then
writeModLine(baseLine)
end
end
Expand Down Expand Up @@ -2028,7 +2061,7 @@ function ItemClass:BuildRaw()
end
if not self.variantList then
for _, baseLine in pairs(self.baseLines or { }) do
if baseLine.versionList or baseLine.variantGroupList then
if baseLine.versionList or baseLine.variantGroupList or baseLine.baseVariantList then
writeModLine(baseLine)
end
end
Expand Down Expand Up @@ -2291,6 +2324,9 @@ function ItemClass:CheckModLineVariant(modLine)
if modLine.versionList and (not self.selectedVersion or not modLine.versionList[self.selectedVersion]) then
return false
end
if modLine.baseVariantList and (not self.selectedBase or not modLine.baseVariantList[self.selectedBase]) then
return false
end
if modLine.variantGroupList then
if not modLine.variantList then
return false
Expand All @@ -2308,6 +2344,9 @@ function ItemClass:CheckModLineVariant(modLine)
end
return not modLine.variantList
end
if self.baseList and modLine.baseVariantList then
return modLine.baseVariantList[self.selectedBase]
end
return not modLine.variantList
or modLine.variantList[self.variant]
or (self.hasAltVariant and modLine.variantList[self.variantAlt])
Expand Down
Loading
Loading