mirror of
https://github.com/OpenMW/openmw.git
synced 2025-10-31 16:56:42 +00:00
250 lines
9.5 KiB
C++
250 lines
9.5 KiB
C++
#ifndef _ESM_GMST_H
|
|
#define _ESM_GMST_H
|
|
|
|
#include "esm_reader.hpp"
|
|
#include "defs.hpp"
|
|
|
|
namespace ESM {
|
|
|
|
/*
|
|
* Game setting, with automatic cleaning of "dirty" entries.
|
|
*
|
|
*/
|
|
|
|
struct GameSetting
|
|
{
|
|
std::string id;
|
|
|
|
// One of these is used depending on the variable type
|
|
std::string str;
|
|
int i;
|
|
float f;
|
|
VarType type;
|
|
|
|
// Set to true if this is a 'dirty' entry which should be ignored
|
|
bool dirty;
|
|
|
|
/*
|
|
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.
|
|
*/
|
|
|
|
// Some handy macros
|
|
#define cI(s,x) { if(id == (s)) return (i == (x)); }
|
|
#define cF(s,x) { if(id == (s)) return (f == (x)); }
|
|
#define cS(s,x) { if(id == (s)) return (str == (x)); }
|
|
|
|
/*
|
|
Checks for dirty tribunal values. These will be ignored if found
|
|
in any file except when they are found in "Tribunal.esm".
|
|
*/
|
|
bool isDirtyTribunal()
|
|
{
|
|
/*
|
|
Here, id contains the game setting name, and we check the
|
|
setting for certain values. If it matches, this is a "dirty"
|
|
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.
|
|
*/
|
|
|
|
// 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 id
|
|
cS("sEffectSummonFabricant", id);// 'Summon Fabricant'
|
|
return false;
|
|
}
|
|
|
|
// Bloodmoon variant
|
|
bool isDirtyBloodmoon()
|
|
{
|
|
// 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 id
|
|
cS("sMagicCreature01ID", id); // 'BM_wolf_grey_summon'
|
|
cS("sMagicCreature02ID", id); // 'BM_bear_black_summon'
|
|
cS("sMagicCreature03ID", id); // 'BM_wolf_bone_summon'
|
|
cS("sMagicCreature04ID", id); // same
|
|
cS("sMagicCreature05ID", id); // same
|
|
cS("sEffectSummonCreature01", id); // 'Calf Wolf'
|
|
cS("sEffectSummonCreature02", id); // 'Calf Bear'
|
|
cS("sEffectSummonCreature03", id); // 'Summon Bonewolf'
|
|
cS("sEffectSummonCreature04", id); // same
|
|
cS("sEffectSummonCreature05", id); // 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;
|
|
}
|
|
|
|
#undef cI
|
|
#undef cF
|
|
#undef cS
|
|
|
|
void load(ESMReader &esm)
|
|
{
|
|
assert(id != "");
|
|
|
|
dirty = false;
|
|
|
|
// We are apparently allowed to be empty
|
|
if(!esm.hasMoreSubs())
|
|
{
|
|
type = VT_None;
|
|
return;
|
|
}
|
|
|
|
// Load some data
|
|
esm.getSubName();
|
|
NAME n = esm.retSubName();
|
|
if(n == "STRV")
|
|
{
|
|
str = esm.getHString();
|
|
type = VT_String;
|
|
}
|
|
else if(n == "INTV")
|
|
{
|
|
esm.getHT(i);
|
|
type = VT_Int;
|
|
}
|
|
else if(n == "FLTV")
|
|
{
|
|
esm.getHT(f);
|
|
type = VT_Float;
|
|
}
|
|
else
|
|
esm.fail("Unwanted subrecord type");
|
|
|
|
int spf = esm.getSpecial();
|
|
|
|
// Check if this is one of the dirty values mentioned above. If it
|
|
// is, we set the dirty 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() ) )
|
|
dirty = true;
|
|
}
|
|
};
|
|
}
|
|
#endif
|