mirror of
https://github.com/TES3MP/openmw-tes3mp.git
synced 2025-01-15 15:19:55 +00:00
7393e3def6
ESM::Cell's getDescription() method was modified by aa5161f99e despite being used heavily by TES3MP. All instances of it in the TES3MP code have now been changed into the newly added getShortDescription() that is identical to the previous getDescription().
316 lines
8.9 KiB
C++
316 lines
8.9 KiB
C++
#include "loadcell.hpp"
|
|
|
|
#include <string>
|
|
#include <list>
|
|
|
|
#include <boost/concept_check.hpp>
|
|
|
|
#include <components/misc/stringops.hpp>
|
|
|
|
#include "esmreader.hpp"
|
|
#include "esmwriter.hpp"
|
|
#include "defs.hpp"
|
|
#include "cellid.hpp"
|
|
|
|
namespace
|
|
{
|
|
///< Translate 8bit/24bit code (stored in refNum.mIndex) into a proper refNum
|
|
void adjustRefNum (ESM::RefNum& refNum, ESM::ESMReader& reader)
|
|
{
|
|
unsigned int local = (refNum.mIndex & 0xff000000) >> 24;
|
|
|
|
// If we have an index value that does not make sense, assume that it was an addition
|
|
// by the present plugin (but a faulty one)
|
|
if (local && local <= reader.getParentFileIndices().size())
|
|
{
|
|
// If the most significant 8 bits are used, then this reference already exists.
|
|
// In this case, do not spawn a new reference, but overwrite the old one.
|
|
refNum.mIndex &= 0x00ffffff; // delete old plugin ID
|
|
refNum.mContentFile = reader.getParentFileIndices()[local-1];
|
|
}
|
|
else
|
|
{
|
|
// This is an addition by the present plugin. Set the corresponding plugin index.
|
|
refNum.mContentFile = reader.getIndex();
|
|
}
|
|
}
|
|
}
|
|
|
|
namespace ESM
|
|
{
|
|
unsigned int Cell::sRecordId = REC_CELL;
|
|
|
|
// Some overloaded compare operators.
|
|
bool operator== (const MovedCellRef& ref, const RefNum& refNum)
|
|
{
|
|
return ref.mRefNum == refNum;
|
|
}
|
|
|
|
bool operator== (const CellRef& ref, const RefNum& refNum)
|
|
{
|
|
return ref.mRefNum == refNum;
|
|
}
|
|
|
|
void Cell::load(ESMReader &esm, bool &isDeleted, bool saveContext)
|
|
{
|
|
loadNameAndData(esm, isDeleted);
|
|
loadCell(esm, saveContext);
|
|
}
|
|
|
|
void Cell::loadNameAndData(ESMReader &esm, bool &isDeleted)
|
|
{
|
|
isDeleted = false;
|
|
|
|
blank();
|
|
|
|
bool hasData = false;
|
|
bool isLoaded = false;
|
|
while (!isLoaded && esm.hasMoreSubs())
|
|
{
|
|
esm.getSubName();
|
|
switch (esm.retSubName().intval)
|
|
{
|
|
case ESM::SREC_NAME:
|
|
mName = esm.getHString();
|
|
break;
|
|
case ESM::FourCC<'D','A','T','A'>::value:
|
|
esm.getHT(mData, 12);
|
|
hasData = true;
|
|
break;
|
|
case ESM::SREC_DELE:
|
|
esm.skipHSub();
|
|
isDeleted = true;
|
|
break;
|
|
default:
|
|
esm.cacheSubName();
|
|
isLoaded = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!hasData)
|
|
esm.fail("Missing DATA subrecord");
|
|
|
|
mCellId.mPaged = !(mData.mFlags & Interior);
|
|
|
|
if (mCellId.mPaged)
|
|
{
|
|
mCellId.mWorldspace = ESM::CellId::sDefaultWorldspace;
|
|
mCellId.mIndex.mX = mData.mX;
|
|
mCellId.mIndex.mY = mData.mY;
|
|
}
|
|
else
|
|
{
|
|
mCellId.mWorldspace = Misc::StringUtils::lowerCase (mName);
|
|
mCellId.mIndex.mX = 0;
|
|
mCellId.mIndex.mY = 0;
|
|
}
|
|
}
|
|
|
|
void Cell::loadCell(ESMReader &esm, bool saveContext)
|
|
{
|
|
bool isLoaded = false;
|
|
mHasAmbi = false;
|
|
while (!isLoaded && esm.hasMoreSubs())
|
|
{
|
|
esm.getSubName();
|
|
switch (esm.retSubName().intval)
|
|
{
|
|
case ESM::FourCC<'I','N','T','V'>::value:
|
|
int waterl;
|
|
esm.getHT(waterl);
|
|
mWater = static_cast<float>(waterl);
|
|
mWaterInt = true;
|
|
break;
|
|
case ESM::FourCC<'W','H','G','T'>::value:
|
|
esm.getHT(mWater);
|
|
mWaterInt = false;
|
|
break;
|
|
case ESM::FourCC<'A','M','B','I'>::value:
|
|
esm.getHT(mAmbi);
|
|
mHasAmbi = true;
|
|
break;
|
|
case ESM::FourCC<'R','G','N','N'>::value:
|
|
mRegion = esm.getHString();
|
|
break;
|
|
case ESM::FourCC<'N','A','M','5'>::value:
|
|
esm.getHT(mMapColor);
|
|
break;
|
|
case ESM::FourCC<'N','A','M','0'>::value:
|
|
esm.getHT(mRefNumCounter);
|
|
break;
|
|
default:
|
|
esm.cacheSubName();
|
|
isLoaded = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (saveContext)
|
|
{
|
|
mContextList.push_back(esm.getContext());
|
|
esm.skipRecord();
|
|
}
|
|
}
|
|
|
|
void Cell::postLoad(ESMReader &esm)
|
|
{
|
|
// Save position of the cell references and move on
|
|
mContextList.push_back(esm.getContext());
|
|
esm.skipRecord();
|
|
}
|
|
|
|
void Cell::save(ESMWriter &esm, bool isDeleted) const
|
|
{
|
|
esm.writeHNCString("NAME", mName);
|
|
esm.writeHNT("DATA", mData, 12);
|
|
|
|
if (isDeleted)
|
|
{
|
|
esm.writeHNCString("DELE", "");
|
|
return;
|
|
}
|
|
|
|
if (mData.mFlags & Interior)
|
|
{
|
|
if (mWaterInt) {
|
|
int water =
|
|
(mWater >= 0) ? (int) (mWater + 0.5) : (int) (mWater - 0.5);
|
|
esm.writeHNT("INTV", water);
|
|
} else {
|
|
esm.writeHNT("WHGT", mWater);
|
|
}
|
|
|
|
if (mData.mFlags & QuasiEx)
|
|
esm.writeHNOCString("RGNN", mRegion);
|
|
else
|
|
{
|
|
// Try to avoid saving ambient lighting information when it's unnecessary.
|
|
// This is to fix black lighting in resaved cell records that lack this information.
|
|
if (mHasAmbi)
|
|
esm.writeHNT("AMBI", mAmbi, 16);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
esm.writeHNOCString("RGNN", mRegion);
|
|
if (mMapColor != 0)
|
|
esm.writeHNT("NAM5", mMapColor);
|
|
}
|
|
|
|
if (mRefNumCounter != 0)
|
|
esm.writeHNT("NAM0", mRefNumCounter);
|
|
}
|
|
|
|
void Cell::restore(ESMReader &esm, int iCtx) const
|
|
{
|
|
esm.restoreContext(mContextList.at (iCtx));
|
|
}
|
|
|
|
std::string Cell::getDescription() const
|
|
{
|
|
if (mData.mFlags & Interior)
|
|
return mName;
|
|
|
|
std::string cellGrid = "(" + std::to_string(mData.mX) + ", " + std::to_string(mData.mY) + ")";
|
|
if (!mName.empty())
|
|
return mName + ' ' + cellGrid;
|
|
// FIXME: should use sDefaultCellname GMST instead, but it's not available in this scope
|
|
std::string region = !mRegion.empty() ? mRegion : "Wilderness";
|
|
|
|
return region + ' ' + cellGrid;
|
|
}
|
|
|
|
/*
|
|
Start of tes3mp addition
|
|
|
|
Add a method that returns cell descriptions in OpenMW's previous way, because it was widely
|
|
used in TES3MP
|
|
*/
|
|
std::string Cell::getShortDescription() const
|
|
{
|
|
if (mData.mFlags & Interior)
|
|
{
|
|
return mName;
|
|
}
|
|
else
|
|
{
|
|
return std::to_string(mData.mX) + ", " + std::to_string(mData.mY);
|
|
}
|
|
}
|
|
/*
|
|
End of tes3mp addition
|
|
*/
|
|
|
|
bool Cell::getNextRef(ESMReader &esm, CellRef &ref, bool &isDeleted, bool ignoreMoves, MovedCellRef *mref)
|
|
{
|
|
isDeleted = false;
|
|
|
|
// TODO: Try and document reference numbering, I don't think this has been done anywhere else.
|
|
if (!esm.hasMoreSubs())
|
|
return false;
|
|
|
|
// NOTE: We should not need this check. It is a safety check until we have checked
|
|
// more plugins, and how they treat these moved references.
|
|
if (esm.isNextSub("MVRF"))
|
|
{
|
|
if (ignoreMoves)
|
|
{
|
|
esm.getHT (mref->mRefNum.mIndex);
|
|
esm.getHNOT (mref->mTarget, "CNDT");
|
|
adjustRefNum (mref->mRefNum, esm);
|
|
}
|
|
else
|
|
{
|
|
// skip rest of cell record (moved references), they are handled elsewhere
|
|
esm.skipRecord(); // skip MVRF, CNDT
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (esm.peekNextSub("FRMR"))
|
|
{
|
|
ref.load (esm, isDeleted);
|
|
|
|
// Identify references belonging to a parent file and adapt the ID accordingly.
|
|
adjustRefNum (ref.mRefNum, esm);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool Cell::getNextMVRF(ESMReader &esm, MovedCellRef &mref)
|
|
{
|
|
esm.getHT(mref.mRefNum.mIndex);
|
|
esm.getHNOT(mref.mTarget, "CNDT");
|
|
|
|
adjustRefNum (mref.mRefNum, esm);
|
|
|
|
return true;
|
|
}
|
|
|
|
void Cell::blank()
|
|
{
|
|
mName.clear();
|
|
mRegion.clear();
|
|
mWater = 0;
|
|
mWaterInt = false;
|
|
mMapColor = 0;
|
|
mRefNumCounter = 0;
|
|
|
|
mData.mFlags = 0;
|
|
mData.mX = 0;
|
|
mData.mY = 0;
|
|
|
|
mHasAmbi = true;
|
|
mAmbi.mAmbient = 0;
|
|
mAmbi.mSunlight = 0;
|
|
mAmbi.mFog = 0;
|
|
mAmbi.mFogDensity = 0;
|
|
}
|
|
|
|
const CellId& Cell::getCellId() const
|
|
{
|
|
return mCellId;
|
|
}
|
|
}
|