openmw/components/esm3/cellref.cpp

#include "cellref.hpp"

#include <components/debug/debuglog.hpp>

#include "esmreader.hpp"
#include "esmwriter.hpp"

void ESM::RefNum::load(ESMReader& esm, bool wide, ESM::NAME tag)
{
    if (wide)
        esm.getHNT(*this, tag, 8);
    else
        esm.getHNT(mIndex, tag);
}

void ESM::RefNum::save(ESMWriter &esm, bool wide, ESM::NAME tag) const
{
    if (wide)
        esm.writeHNT (tag, *this, 8);
    else
    {
        if (isSet() && !hasContentFile())
            Log(Debug::Error) << "Generated RefNum can not be saved in 32bit format";
        int refNum = (mIndex & 0xffffff) | ((hasContentFile() ? mContentFile : 0xff)<<24);
        esm.writeHNT (tag, refNum, 4);
    }
}


void ESM::CellRef::load (ESMReader& esm, bool &isDeleted, bool wideRefNum)
{
    loadId(esm, wideRefNum);
    loadData(esm, isDeleted);
}

void ESM::CellRef::loadId (ESMReader& esm, bool wideRefNum)
{
    // According to Hrnchamd, this does not belong to the actual ref. Instead, it is a marker indicating that
    // the following refs are part of a "temp refs" section. A temp ref is not being tracked by the moved references system.
    // Its only purpose is a performance optimization for "immovable" things. We don't need this, and it's problematic anyway,
    // because any item can theoretically be moved by a script.
    if (esm.isNextSub ("NAM0"))
        esm.skipHSub();

    blank();

    mRefNum.load (esm, wideRefNum);

    mRefID = esm.getHNOString ("NAME");
    if (mRefID.empty())
    {
        Log(Debug::Warning) << "Warning: got CellRef with empty RefId in " << esm.getName() << " 0x" << std::hex << esm.getFileOffset();
    }
}

void ESM::CellRef::loadData(ESMReader &esm, bool &isDeleted)
{
    isDeleted = false;

    bool isLoaded = false;
    while (!isLoaded && esm.hasMoreSubs())
    {
        esm.getSubName();
        switch (esm.retSubName().toInt())
        {
            case ESM::fourCC("UNAM"):
                esm.getHT(mReferenceBlocked);
                break;
            case ESM::fourCC("XSCL"):
                esm.getHT(mScale);
                mScale = std::clamp(mScale, 0.5f, 2.0f);
                break;
            case ESM::fourCC("ANAM"):
                mOwner = esm.getHString();
                break;
            case ESM::fourCC("BNAM"):
                mGlobalVariable = esm.getHString();
                break;
            case ESM::fourCC("XSOL"):
                mSoul = esm.getHString();
                break;
            case ESM::fourCC("CNAM"):
                mFaction = esm.getHString();
                break;
            case ESM::fourCC("INDX"):
                esm.getHT(mFactionRank);
                break;
            case ESM::fourCC("XCHG"):
                esm.getHT(mEnchantmentCharge);
                break;
            case ESM::fourCC("INTV"):
                esm.getHT(mChargeInt);
                break;
            case ESM::fourCC("NAM9"):
                esm.getHT(mGoldValue);
                break;
            case ESM::fourCC("DODT"):
                esm.getHT(mDoorDest);
                mTeleport = true;
                break;
            case ESM::fourCC("DNAM"):
                mDestCell = esm.getHString();
                break;
            case ESM::fourCC("FLTV"):
                esm.getHT(mLockLevel);
                break;
            case ESM::fourCC("KNAM"):
                mKey = esm.getHString();
                break;
            case ESM::fourCC("TNAM"):
                mTrap = esm.getHString();
                break;
            case ESM::fourCC("DATA"):
                esm.getHT(mPos, 24);
                break;
            case ESM::fourCC("NAM0"):
            {
                esm.skipHSub();
                break;
            }
            case ESM::SREC_DELE:
                esm.skipHSub();
                isDeleted = true;
                break;
            default:
                esm.cacheSubName();
                isLoaded = true;
                break;
        }
    }

    if (mLockLevel == 0 && !mKey.empty())
    {
        mLockLevel = UnbreakableLock;
        mTrap.clear();
    }
}

void ESM::CellRef::save (ESMWriter &esm, bool wideRefNum, bool inInventory, bool isDeleted) const
{
    mRefNum.save (esm, wideRefNum);

    esm.writeHNCString("NAME", mRefID);

    if (isDeleted) {
        esm.writeHNString("DELE", "", 3);
        return;
    }

    if (mScale != 1.0) {
        esm.writeHNT("XSCL", std::clamp(mScale, 0.5f, 2.0f));
    }

    if (!inInventory)
        esm.writeHNOCString("ANAM", mOwner);

    esm.writeHNOCString("BNAM", mGlobalVariable);
    esm.writeHNOCString("XSOL", mSoul);

    if (!inInventory)
    {
        esm.writeHNOCString("CNAM", mFaction);
        if (mFactionRank != -2)
        {
            esm.writeHNT("INDX", mFactionRank);
        }
    }

    if (mEnchantmentCharge != -1)
        esm.writeHNT("XCHG", mEnchantmentCharge);

    if (mChargeInt != -1)
        esm.writeHNT("INTV", mChargeInt);

    if (mGoldValue > 1)
        esm.writeHNT("NAM9", mGoldValue);

    if (!inInventory && mTeleport)
    {
        esm.writeHNT("DODT", mDoorDest);
        esm.writeHNOCString("DNAM", mDestCell);
    }

    if (!inInventory && mLockLevel != 0) {
        esm.writeHNT("FLTV", mLockLevel);
    }

    if (!inInventory)
    {
        esm.writeHNOCString ("KNAM", mKey);
        esm.writeHNOCString ("TNAM", mTrap);
    }

    if (mReferenceBlocked != -1)
        esm.writeHNT("UNAM", mReferenceBlocked);

    if (!inInventory)
        esm.writeHNT("DATA", mPos, 24);
}

void ESM::CellRef::blank()
{
    mRefNum.unset();
    mRefID.clear();
    mScale = 1;
    mOwner.clear();
    mGlobalVariable.clear();
    mSoul.clear();
    mFaction.clear();
    mFactionRank = -2;
    mChargeInt = -1;
    mChargeIntRemainder = 0.0f;
    mEnchantmentCharge = -1;
    mGoldValue = 1;
    mDestCell.clear();
    mLockLevel = 0;
    mKey.clear();
    mTrap.clear();
    mReferenceBlocked = -1;
    mTeleport = false;

    for (int i=0; i<3; ++i)
    {
        mDoorDest.pos[i] = 0;
        mDoorDest.rot[i] = 0;
        mPos.pos[i] = 0;
        mPos.rot[i] = 0;
    }
}