Something went wrong. Try again.
OpenMW is an open implementation of the Morrowind engine
Something went wrong. Try again.
10 kB · 346 lines
C++
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347#include "loadcell.hpp"
#include <limits>#include <list>#include <string>
#include <components/debug/debuglog.hpp>#include <components/misc/concepts.hpp>#include <components/misc/strings/algorithm.hpp>
#include "esmreader.hpp"#include "esmwriter.hpp"
namespace ESM{ namespace { ///< Translate 8bit/24bit code (stored in refNum.mIndex) into a proper refNum void adjustRefNum(RefNum& refNum, const ESMReader& reader) { uint32_t 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{ const StringRefId Cell::sDefaultWorldspaceId("sys::default");
template <Misc::SameAsWithoutCvref<Cell::DATAstruct> T> void decompose(T&& v, const auto& f) { f(v.mFlags, v.mX, v.mY); }
template <Misc::SameAsWithoutCvref<Cell::AMBIstruct> T> void decompose(T&& v, const auto& f) { f(v.mAmbient, v.mSunlight, v.mFog, v.mFogDensity); }
// 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); }
const ESM::RefId& Cell::updateId() { mId = generateIdForCell(isExterior(), mName, getGridX(), getGridY()); return mId; }
ESM::RefId Cell::generateIdForCell(bool exterior, std::string_view cellName, int x, int y) { if (!exterior) { return ESM::RefId::stringRefId(cellName); } else { return ESM::RefId::esm3ExteriorCell(x, y); } }
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().toInt()) { case SREC_NAME: mName = esm.getHString(); break; case fourCC("DATA"): esm.getSubComposite(mData); hasData = true; break; case SREC_DELE: esm.skipHSub(); isDeleted = true; break; default: esm.cacheSubName(); isLoaded = true; break; } }
if (!hasData) esm.fail("Missing DATA subrecord");
updateId(); }
void Cell::loadCell(ESMReader& esm, bool saveContext) { bool overriding = !mName.empty(); bool isLoaded = false; mHasAmbi = false; mHasWaterHeightSub = false; while (!isLoaded && esm.hasMoreSubs()) { esm.getSubName(); switch (esm.retSubName().toInt()) { case fourCC("INTV"): int32_t waterl; esm.getHT(waterl); mHasWaterHeightSub = true; mWater = static_cast<float>(waterl); break; case fourCC("WHGT"): float waterLevel; esm.getHT(waterLevel); mHasWaterHeightSub = true; if (!std::isfinite(waterLevel)) { if (!overriding) mWater = std::numeric_limits<float>::max(); Log(Debug::Warning) << "Warning: Encountered invalid water level in cell " << mName << " defined in " << esm.getContext().filename; } else mWater = waterLevel; break; case fourCC("AMBI"): esm.getSubComposite(mAmbi); mHasAmbi = true; break; case fourCC("RGNN"): mRegion = esm.getRefId(); break; case fourCC("NAM5"): esm.getHT(mMapColor); break; case fourCC("NAM0"): 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.writeNamedComposite("DATA", mData);
if (isDeleted) { esm.writeHNString("DELE", "", 3); return; }
if (mData.mFlags & Interior) { // Try to avoid saving ambient information when it's unnecessary. // This is to fix black lighting and flooded water // in resaved cell records that lack this information. if (mHasWaterHeightSub) esm.writeHNT("WHGT", mWater); if (mData.mFlags & QuasiEx) esm.writeHNOCRefId("RGNN", mRegion); else if (mHasAmbi) esm.writeNamedComposite("AMBI", mAmbi); } else { esm.writeHNOCRefId("RGNN", mRegion); if (mMapColor != 0) esm.writeHNT("NAM5", mMapColor); } }
void Cell::saveTempMarker(ESMWriter& esm, int32_t tempCount) const { if (tempCount != 0) esm.writeHNT("NAM0", tempCount); }
void Cell::restore(ESMReader& esm, size_t iCtx) const { esm.restoreContext(mContextList.at(iCtx)); }
std::string Cell::getDescription() const { const auto& nameString = mName; if (mData.mFlags & Interior) return nameString;
std::string cellGrid = "(" + std::to_string(mData.mX) + ", " + std::to_string(mData.mY) + ")"; if (!mName.empty()) return nameString + ' ' + cellGrid; // FIXME: should use sDefaultCellname GMST instead, but it's not available in this scope std::string region = !mRegion.empty() ? mRegion.getRefIdString() : "Wilderness";
return region + ' ' + cellGrid; }
bool Cell::getNextRef(ESMReader& esm, CellRef& ref, bool& isDeleted) { isDeleted = false;
// TODO: Try and document reference numbering, I don't think this has been done anywhere else. if (!esm.hasMoreSubs()) return false;
// MVRF are FRMR are present in pairs. MVRF indicates that following FRMR describes moved CellRef. // This function has to skip all moved CellRefs therefore read all such pairs to ignored values. while (esm.isNextSub("MVRF")) { MovedCellRef movedCellRef; esm.getHT(movedCellRef.mRefNum.mIndex); esm.getHNOT(movedCellRef.mTarget, "CNDT"); CellRef skippedCellRef; if (!esm.peekNextSub("FRMR")) return false; bool skippedDeleted; skippedCellRef.load(esm, skippedDeleted); }
if (esm.peekNextSub("FRMR")) { ref.load(esm, isDeleted);
// TODO: should count the number of temp refs and validate the number
// Identify references belonging to a parent file and adapt the ID accordingly. adjustRefNum(ref.mRefNum, esm); return true; } return false; }
bool Cell::getNextRef( ESMReader& esm, CellRef& cellRef, bool& deleted, MovedCellRef& movedCellRef, bool& moved, GetNextRefMode mode) { deleted = false; moved = false;
if (!esm.hasMoreSubs()) return false;
if (esm.isNextSub("MVRF")) { moved = true; getNextMVRF(esm, movedCellRef); }
if (!esm.peekNextSub("FRMR")) return false;
if ((!moved && mode == GetNextRefMode::LoadOnlyMoved) || (moved && mode == GetNextRefMode::LoadOnlyNotMoved)) { skipLoadCellRef(esm); return true; }
cellRef.load(esm, deleted); adjustRefNum(cellRef.mRefNum, esm);
return true; }
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 = ESM::RefId(); mWater = 0; mMapColor = 0; mRefNumCounter = 0;
mData.mFlags = 0; mData.mX = 0; mData.mY = 0;
mHasAmbi = true; mHasWaterHeightSub = true; mAmbi.mAmbient = 0; mAmbi.mSunlight = 0; mAmbi.mFog = 0; mAmbi.mFogDensity = 0; }
}