New save format #7050
New save format #7050
Conversation
Uses the Path of Exile BaseItemType.Id for the gem in gemId (as it always has been). The skillId attribute is also kept and maps to the gems variant primary GrantedEffect.Id. Adds a new attribute called variantId that maps to the variant of the game, eg. Arc, ArcAltX, or ArcAltY. This is to help identify which variant is used rather than relying on every gem variant having its own unique granted effect. For the majority of gems skillId and variantId are the same, but it is not true for every case.
| local function setupGem(gem, gemId) | ||
| gem.id = gemId | ||
| gem.grantedEffect = data.skills[gem.grantedEffectId] | ||
| data.gemForSkill[gem.grantedEffect] = gemId | ||
| data.gemsByGameId[gem.gameId] = data.gemsByGameId[gem.gameId] or {} | ||
| data.gemsByGameId[gem.gameId][gem.variantId] = gem |
There was a problem hiding this comment.
Could we just make this map's inner key be grantedEffectId? That way we don't need to add variantId to the save file format. Then in SkillsTab.lua you can skip the if statement and loop and do possibleVariants[child.attrib.skillId]
There was a problem hiding this comment.
The reason I chose to use the variant id over the granted effect was that it better mapped to what we actually wanted to identify, the variant of the gem. While right now the primary granted effect is unique and does work as well, it may not always be the case. For example, they can be (accidentally) swapped so that what is now GrantedEffect could become GrantedEffect2 and vice versa or if GGG decides to add "Arc of Combination" that grants both Arc and ArcAltX or similar.
All in all it just felt like the safer and most future-proof way to identify which gem was being used and since it is very desirable to support old save formats, picking the one least likely to change seemed like the path forward.
There is also the point of third party tools which parse and use our save format. If we could get some feedback from them it could help nail down the best format to use.
There was a problem hiding this comment.
Well reasoned, and if we're going to change our format, adding the variant explicitly seems like a solid way forward. I'll throw the question in discord to the other third party tool devs about format
Uses the Path of Exile
BaseItemType.Idfor thegemIdsave format attribute in the<Gem>element as it always has been. TheskillIdattribute is also kept and maps to the gem's variant primaryGrantedEffect.Id. Adds a new attribute calledvariantIdthat maps to the variant of the gem (GemVariants[n].Id), eg. Arc, ArcAltX, or ArcAltY. This is to help identify which variant is used rather than relying on every gem variant having its own unique granted effect.During loading if there is no (known)
gemIdorvariantIdit falls back to looking atskillIdand eventually by name, as before.For the a lot of gems
skillIdandvariantIdare the same but it is not true for every case, especially support gems.Hopefully by relying on the game's identifiers rather than the internal key of the
Data/Gems.luatable we are both more free to refactor the internals of the application as well as being more aligned with how the game identifies gems and their variants. It should also make it easier for 3rd party developers to understand which skill gems are used.