forked from teamnwah/openmw-tes3coop
Remove 'GMST fixing' for dirty GMST records
The 'fixing' for so-called dirty GMSTs does not work properly in its current state anyway, so it should be removed. Fixing the 'GMST fixing' might not be possible, because whether or not a GMST is 'dirty' depends on the language version of MW. Therefore different 'fixing' algorithms would be required for the different MW localisations, and I do not see a good reason why GMST values should be hard-coded in the GMST load procedure. In my opinion, it only clutters the code. Last but not least, I believe that it is not the task of the engine to clean ESM files from dirty entries. That is a job for the modders, who should only release clean ESM/ESP files in the first place. The engine should not need to worry about whether a file is 'dirty' or not. That is why I believe a feature for cleaning ESM/ESP files shall not be part of the engine.
This commit is contained in:
Thoronador
parent
f0f521a4e0
commit
32f051d61d
2 changed files with 1 additions and 198 deletions
|
|
@ -10,138 +10,10 @@
|
|||
namespace ESM
|
||||
{
|
||||
|
||||
/// \todo Review GMST "fixing". Probably remove completely or at least make it optional. Its definitely not
|
||||
/// working properly in its current state and I doubt it can be fixed without breaking other stuff.
|
||||
|
||||
// Some handy macros
|
||||
#define cI(s,x) { label = (s); boost::algorithm::to_lower(label); if (mId == label) return (mI == (x)); }
|
||||
#define cF(s,x) { label = (s); boost::algorithm::to_lower(label); if (mId == label) return (mF == (x)); }
|
||||
#define cS(s,x) { label = (s); boost::algorithm::to_lower(label); if (mId == label) return (mStr == (x)); }
|
||||
|
||||
bool GameSetting::isDirtyTribunal()
|
||||
{
|
||||
/*
|
||||
Here, mId contains the game setting name, and we check the
|
||||
setting for certain values. If it matches, this is a "mDirty"
|
||||
entry. The correct entry (as defined in Tribunal and Bloodmoon
|
||||
esms) are given in the comments. Many of the values are correct,
|
||||
and are marked as 'same'. We still ignore them though, as they
|
||||
are still in the wrong file and might override custom values
|
||||
from other mods.
|
||||
*/
|
||||
|
||||
std::string label;
|
||||
// Strings
|
||||
cS("sProfitValue", "Profit Value"); // 'Profit:'
|
||||
cS("sEditNote", "Edit Note"); // same
|
||||
cS("sDeleteNote", "Delete Note?"); // same
|
||||
cS("sMaxSale", "Max Sale"); // 'Seller Max'
|
||||
cS("sMagicFabricantID", "Fabricant"); // 'Fabricant_summon'
|
||||
cS("sTeleportDisabled",
|
||||
"Teleportation magic does not work here.");// same
|
||||
cS("sLevitateDisabled",
|
||||
"Levitation magic does not work here."); // same
|
||||
cS("sCompanionShare", "Companion Share"); // 'Share'
|
||||
cS("sCompanionWarningButtonOne",
|
||||
"Let the mercenary quit."); // same
|
||||
cS("sCompanionWarningButtonTwo",
|
||||
"Return to Companion Share display."); // same
|
||||
cS("sCompanionWarningMessage",
|
||||
"Your mercenary is poorer now than when he contracted with you. Your mercenary will quit if you do not give him gold or goods to bring his Profit Value to a positive value.");
|
||||
// 'Your mercenary is poorer now than when he contracted with
|
||||
// you. Your mercenary will quit if you do not give him gold
|
||||
// or goods to bring his Profit to a positive value.'
|
||||
// [The difference here is "Profit Value" -> "Profit"]
|
||||
|
||||
// Strings that matches the mId
|
||||
cS("sEffectSummonFabricant", "sEffectSummonFabricant");// 'Summon Fabricant'
|
||||
return false;
|
||||
}
|
||||
|
||||
// Bloodmoon variant
|
||||
bool GameSetting::isDirtyBloodmoon()
|
||||
{
|
||||
std::string label;
|
||||
// Strings
|
||||
cS("sWerewolfPopup", "Werewolf"); // same
|
||||
cS("sWerewolfRestMessage",
|
||||
"You cannot rest in werewolf form."); // same
|
||||
cS("sWerewolfRefusal",
|
||||
"You cannot do this as a werewolf."); // same
|
||||
cS("sWerewolfAlarmMessage",
|
||||
"You have been detected changing from a werewolf state.");
|
||||
// 'You have been detected as a known werewolf.'
|
||||
|
||||
// Strings that matches the mId
|
||||
cS("sMagicCreature01ID", "sMagicCreature01ID"); // 'BM_wolf_grey_summon'
|
||||
cS("sMagicCreature02ID", "sMagicCreature02ID"); // 'BM_bear_black_summon'
|
||||
cS("sMagicCreature03ID", "sMagicCreature03ID"); // 'BM_wolf_bone_summon'
|
||||
cS("sMagicCreature04ID", "sMagicCreature04ID"); // same
|
||||
cS("sMagicCreature05ID", "sMagicCreature05ID"); // same
|
||||
cS("sEffectSummonCreature01", "sEffectSummonCreature01"); // 'Calf Wolf'
|
||||
cS("sEffectSummonCreature02", "sEffectSummonCreature02"); // 'Calf Bear'
|
||||
cS("sEffectSummonCreature03", "sEffectSummonCreature03"); // 'Summon Bonewolf'
|
||||
cS("sEffectSummonCreature04", "sEffectSummonCreature04"); // same
|
||||
cS("sEffectSummonCreature05", "sEffectSummonCreature05"); // same
|
||||
|
||||
// Integers
|
||||
cI("iWereWolfBounty", 10000); // 1000
|
||||
cI("iWereWolfFightMod", 100); // same
|
||||
cI("iWereWolfFleeMod", 100); // same
|
||||
cI("iWereWolfLevelToAttack", 20); // same
|
||||
|
||||
// Floats
|
||||
cF("fFleeDistance", 3000); // same
|
||||
cF("fCombatDistanceWerewolfMod", 0.3); // same
|
||||
cF("fWereWolfFatigue", 400); // same
|
||||
cF("fWereWolfEnchant", 1); // 0
|
||||
cF("fWereWolfArmorer", 1); // 0
|
||||
cF("fWereWolfBlock", 1); // 0
|
||||
cF("fWereWolfSneak", 1); // 95
|
||||
cF("fWereWolfDestruction", 1); // 0
|
||||
cF("fWereWolfEndurance", 150); // same
|
||||
cF("fWereWolfConjuration", 1); // 0
|
||||
cF("fWereWolfRestoration", 1); // 0
|
||||
cF("fWereWolfAthletics", 150); // 50
|
||||
cF("fWereWolfLuck", 1); // 25
|
||||
cF("fWereWolfSilverWeaponDamageMult", 1.5); // 2
|
||||
cF("fWereWolfMediumArmor", 1); // 0
|
||||
cF("fWereWolfShortBlade", 1); // 0
|
||||
cF("fWereWolfAcrobatics", 150); // 80
|
||||
cF("fWereWolfSpeechcraft", 1); // 0
|
||||
cF("fWereWolfAlteration", 1); // 0
|
||||
cF("fWereWolfIllusion", 1); // 0
|
||||
cF("fWereWolfLongBlade", 1); // 0
|
||||
cF("fWereWolfMarksman", 1); // 0
|
||||
cF("fWereWolfHandtoHand", 100); // same
|
||||
cF("fWereWolfIntellegence", 1); // 0
|
||||
cF("fWereWolfAlchemy", 1); // 0
|
||||
cF("fWereWolfUnarmored", 100); // same
|
||||
cF("fWereWolfAxe", 1); // 0
|
||||
cF("fWereWolfRunMult", 1.5); // 1.3
|
||||
cF("fWereWolfMagicka", 100); // same
|
||||
cF("fWereWolfAgility", 150); // same
|
||||
cF("fWereWolfBluntWeapon", 1); // 0
|
||||
cF("fWereWolfSecurity", 1); // 0
|
||||
cF("fWereWolfPersonality", 1); // 0
|
||||
cF("fWereWolfMerchantile", 1); // 0
|
||||
cF("fWereWolfHeavyArmor", 1); // 0
|
||||
cF("fWereWolfSpear", 1); // 0
|
||||
cF("fWereWolfStrength", 150); // same
|
||||
cF("fWereWolfHealth", 2); // same
|
||||
cF("fWereWolfMysticism", 1); // 0
|
||||
cF("fWereWolfLightArmor", 1); // 0
|
||||
cF("fWereWolfWillPower", 1); // 0
|
||||
cF("fWereWolfSpeed", 150); // 90
|
||||
return false;
|
||||
}
|
||||
|
||||
void GameSetting::load(ESMReader &esm)
|
||||
{
|
||||
assert(mId != "");
|
||||
|
||||
mDirty = false;
|
||||
|
||||
// We are apparently allowed to be empty
|
||||
if (!esm.hasMoreSubs())
|
||||
{
|
||||
|
|
@ -169,17 +41,8 @@ void GameSetting::load(ESMReader &esm)
|
|||
}
|
||||
else
|
||||
esm.fail("Unwanted subrecord type");
|
||||
|
||||
int spf = esm.getSpecial();
|
||||
|
||||
// Check if this is one of the mDirty values mentioned above. If it
|
||||
// is, we set the mDirty flag. This will ONLY work if you've set
|
||||
// the 'id' string correctly before calling load().
|
||||
|
||||
if ((spf != SF_Tribunal && isDirtyTribunal()) || (spf != SF_Bloodmoon
|
||||
&& isDirtyBloodmoon()))
|
||||
mDirty = true;
|
||||
}
|
||||
|
||||
void GameSetting::save(ESMWriter &esm)
|
||||
{
|
||||
switch(mType)
|
||||
|
|
|
|||
|
|
@ -25,66 +25,6 @@ struct GameSetting
|
|||
float mF;
|
||||
VarType mType;
|
||||
|
||||
// Set to true if this is a 'dirty' entry which should be ignored
|
||||
bool mDirty;
|
||||
|
||||
/*
|
||||
These functions check if this game setting is one of the "dirty"
|
||||
GMST records found in many mods. These are due to a serious bug in
|
||||
the official TES3 editor. It only occurs in the newer editor
|
||||
versions that came with Tribunal and Bloodmoon, and only if a
|
||||
modder tries to make a mod without loading the corresponding
|
||||
expansion master file. For example, if you have Tribunal installed
|
||||
and try to make a mod without loading Tribunal.esm, the editor
|
||||
will insert these GMST records as a replacement for the entries it
|
||||
cannot find in the ESMs.
|
||||
|
||||
The values of these "dirty" records differ in general from their
|
||||
values as defined in Tribunal.esm and Bloodmoon.esm, and are
|
||||
always set to the same "default" values. Most of these values are
|
||||
nonsensical, ie. changing the "Seller Max" string to "Max Sale",
|
||||
or change the stats of werewolves to useless values like 1. Some
|
||||
of them break certain spell effects.
|
||||
|
||||
It is most likely that these values are just leftover values from
|
||||
an early stage of development that are inserted as default values
|
||||
by the editor code. They are supposed to be overridden when the
|
||||
correct esm file is loaded. When it isn't loaded however, you get
|
||||
stuck with the initial value, and this gets written to every mod
|
||||
by the editor, for some reason.
|
||||
|
||||
Bethesda themselves have fallen for this bug. If you install both
|
||||
Tribunal and Bloodmoon, the updated Tribunal.esm will contain the
|
||||
dirty GMST settings from Bloodmoon, and Bloodmoon.esm will contain
|
||||
some of the dirty settings from Tribunal. In other words, this bug
|
||||
affects the game EVEN IF YOU DO NOT USE ANY MODS!
|
||||
|
||||
The guys at Bethesda are well aware of this bug (and many others),
|
||||
as the mod community and fan base complained about them for a long
|
||||
time. But unfortunately it was never fixed.
|
||||
|
||||
There are several tools available to help modders remove these
|
||||
records from their files, but not all modders use them, and they
|
||||
really shouldn't have to. In this file we choose instead to reject
|
||||
all the corrupt values at load time.
|
||||
|
||||
These functions checks if the current game setting is one of the
|
||||
"dirty" ones as described above. TODO: I have not checked this
|
||||
against other sources yet, do that later. Currently recognizes 22
|
||||
values for tribunal and 50 for bloodmoon. Legitimate GMSTs in mods
|
||||
(setting values other than the default "dirty" ones) are not
|
||||
affected and will work correctly.
|
||||
*/
|
||||
|
||||
/*
|
||||
Checks for dirty tribunal values. These will be ignored if found
|
||||
in any file except when they are found in "Tribunal.esm".
|
||||
*/
|
||||
bool isDirtyTribunal();
|
||||
|
||||
// Bloodmoon variant
|
||||
bool isDirtyBloodmoon();
|
||||
|
||||
void load(ESMReader &esm);
|
||||
|
||||
int getInt() const;
|
||||
|
|
|
|||
Loading…
Reference in a new issue