openmw/components/esm4/loadrefr.cpp

/*
  Copyright (C) 2015-2016, 2018, 2020-2021 cc9cii

  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.

  cc9cii cc9c@iinet.net.au

  Much of the information on the data structures are based on the information
  from Tes4Mod:Mod_File_Format and Tes5Mod:File_Formats but also refined by
  trial & error.  See http://en.uesp.net/wiki for details.

*/
#include "loadrefr.hpp"

#include <stdexcept>

#include "reader.hpp"
// #include "writer.hpp"

void ESM4::Reference::load(ESM4::Reader& reader)
{
    mId = reader.hdr().record.getFormId();
    reader.adjustFormId(mId);
    mFlags = reader.hdr().record.flags;
    mParentFormId = reader.currCell(); // NOTE: only for persistent refs?
    mParent = ESM::RefId::formIdRefId(mParentFormId);

    // TODO: Let the engine apply this? Saved games?
    // mInitiallyDisabled = ((mFlags & ESM4::Rec_Disabled) != 0) ? true : false;
    std::uint32_t esmVer = reader.esmVersion();
    bool isFONV = esmVer == ESM::VER_132 || esmVer == ESM::VER_133 || esmVer == ESM::VER_134;

    FormId mid;
    FormId sid;

    while (reader.getSubRecordHeader())
    {
        const ESM4::SubRecordHeader& subHdr = reader.subRecordHeader();
        switch (subHdr.typeId)
        {
            case ESM4::SUB_EDID:
                reader.getZString(mEditorId);
                break;
            case ESM4::SUB_FULL:
                reader.getLocalizedString(mFullName);
                break;
            case ESM4::SUB_NAME:
            {
                FormId BaseId;
                reader.getFormId(BaseId);
                mBaseObj = ESM::RefId::formIdRefId(BaseId);
#if 0
                if (mFlags & ESM4::Rec_Disabled)
                    std::cout << "REFR disable at start " << formIdToString(mFormId) <<
                        " baseobj " << formIdToString(mBaseObj) <<
                        " " << (mEditorId.empty() ? "" : mEditorId); // FIXME
#endif
                // if (mBaseObj == 0x20) // e.g. FO3 mFormId == 0x0007E90F
                // if (mBaseObj == 0x17)
                // std::cout << mEditorId;
                break;
            }
            case ESM4::SUB_DATA:
                reader.get(mPos);
                break;
            case ESM4::SUB_XSCL:
                reader.get(mScale);
                break;
            case ESM4::SUB_XOWN:
                reader.getFormId(mOwner);
                break;
            case ESM4::SUB_XGLB:
                reader.getFormId(mGlobal);
                break;
            case ESM4::SUB_XRNK:
                reader.get(mFactionRank);
                break;
            case ESM4::SUB_XESP:
            {
                reader.getFormId(mEsp.parent);
                reader.get(mEsp.flags);
                // std::cout << "REFR  parent: " << formIdToString(mEsp.parent) << " ref " << formIdToString(mFormId)
                // << /g", 0x" << std::hex << (mEsp.flags & 0xff);// FIXME
                break;
            }
            case ESM4::SUB_XTEL:
            {
                reader.getFormId(mDoor.destDoor);
                reader.get(mDoor.destPos);
                if (esmVer == ESM::VER_094 || esmVer == ESM::VER_170 || isFONV)
                    reader.get(mDoor.flags); // not in Obvlivion
                // std::cout << "REFR  dest door: " << formIdToString(mDoor.destDoor);// FIXME
                break;
            }
            case ESM4::SUB_XSED:
            {
                // 1 or 4 bytes
                if (subHdr.dataSize == 1)
                {
                    uint8_t data;
                    reader.get(data);
                    // std::cout << "REFR XSED " << std::hex << (int)data;
                    break;
                }
                else if (subHdr.dataSize == 4)
                {
                    uint32_t data;
                    reader.get(data);
                    // std::cout << "REFR XSED " << std::hex << (int)data;
                    break;
                }

                // std::cout << "REFR XSED dataSize: " << subHdr.dataSize;// FIXME
                reader.skipSubRecordData();
                break;
            }
            case ESM4::SUB_XLOD:
            {
                // 12 bytes
                if (subHdr.dataSize == 12)
                {
                    float data, data2, data3;
                    reader.get(data);
                    reader.get(data2);
                    reader.get(data3);
                    // bool hasVisibleWhenDistantFlag = (mFlags & 0x00008000) != 0; // currently unused
                    //  some are trees, e.g. 000E03B6, mBaseObj 00022F32, persistent, visible when distant
                    //  some are doors, e.g. 000270F7, mBaseObj 000CD338, persistent, initially disabled
                    //  (this particular one is an Oblivion Gate)
                    // std::cout << "REFR XLOD " << std::hex << (int)data << " " << (int)data2 << " " << (int)data3 <<
                    // std::endl;
                    break;
                }
                // std::cout << "REFR XLOD dataSize: " << subHdr.dataSize;// FIXME
                reader.skipSubRecordData();
                break;
            }
            case ESM4::SUB_XACT:
            {
                if (subHdr.dataSize == 4)
                {
                    uint32_t data;
                    reader.get(data);
                    // std::cout << "REFR XACT " << std::hex << (int)data;
                    break;
                }

                // std::cout << "REFR XACT dataSize: " << subHdr.dataSize;// FIXME
                reader.skipSubRecordData();
                break;
            }
            case ESM4::SUB_XRTM: // formId
            {
                // seems like another ref, e.g. 00064583 has base object 00000034 which is "XMarkerHeading"
                // e.g. some are doors (prob. quest related)
                //    MS94OblivionGateRef XRTM : 00097C88
                //    MQ11SkingradGate    XRTM : 00064583
                //    MQ11ChorrolGate     XRTM : 00188770
                //    MQ11LeyawiinGate    XRTM : 0018AD7C
                //    MQ11AnvilGate       XRTM : 0018D452
                //    MQ11BravilGate      XRTM : 0018AE1B
                // e.g. some are XMarkerHeading
                //    XRTM : 000A4DD7 in OblivionRDCavesMiddleA05 (maybe spawn points?)
                FormId marker;
                reader.getFormId(marker);
                // std::cout << "REFR " << mEditorId << " XRTM : " << formIdToString(marker);// FIXME
                break;
            }
            case ESM4::SUB_TNAM: // reader.get(mMapMarker); break;
            {
                if (subHdr.dataSize != sizeof(mMapMarker))
                    // reader.skipSubRecordData(); // FIXME: FO3
                    reader.getFormId(mid);
                else
                    reader.get(mMapMarker); // TES4

                break;
            }
            case ESM4::SUB_XMRK:
                mIsMapMarker = true;
                break; // all have mBaseObj 0x00000010 "MapMarker"
            case ESM4::SUB_FNAM:
            {
                // std::cout << "REFR " << ESM::printName(subHdr.typeId) << " skipping..."
                // << /gsubHdr.dataSize;
                reader.skipSubRecordData();
                break;
            }
            case ESM4::SUB_XTRG: // formId
            {
                reader.getFormId(mTargetRef);
                // std::cout << "REFR XRTG : " << formIdToString(id);// FIXME
                break;
            }
            case ESM4::SUB_CNAM:
                reader.getFormId(mAudioLocation);
                break; // FONV
            case ESM4::SUB_XRDO: // FO3
            {
                reader.get(mRadio.rangeRadius);
                reader.get(mRadio.broadcastRange);
                reader.get(mRadio.staticPercentage);
                reader.getFormId(mRadio.posReference);

                break;
            }
            case ESM4::SUB_SCRO: // FO3
            {
                reader.getFormId(sid);
                // if (mFormId == 0x0016b74B)
                // std::cout << "REFR SCRO : " << formIdToString(sid);// FIXME
                break;
            }
            case ESM4::SUB_XLOC:
            {
                mIsLocked = true;
                std::int8_t dummy; // FIXME: very poor code

                reader.get(mLockLevel);
                reader.get(dummy);
                reader.get(dummy);
                reader.get(dummy);
                FormId keyForm;
                reader.getFormId(keyForm);
                mKey = ESM::RefId::formIdRefId(keyForm);
                reader.get(dummy); // flag?
                reader.get(dummy);
                reader.get(dummy);
                reader.get(dummy);
                if (subHdr.dataSize == 16)
                    reader.skipSubRecordData(4); // Oblivion (sometimes), flag?
                else if (subHdr.dataSize == 20) // Skyrim, FO3
                    reader.skipSubRecordData(8); // flag?

                break;
            }
            // lighting
            case ESM4::SUB_LNAM: // lighting template formId
            case ESM4::SUB_XLIG: // struct, FOV, fade, etc
            case ESM4::SUB_XEMI: // LIGH formId
            case ESM4::SUB_XRDS: // Radius or Radiance
            case ESM4::SUB_XRGB:
            case ESM4::SUB_XRGD: // tangent data?
            case ESM4::SUB_XALP: // alpha cutoff
            //
            case ESM4::SUB_XPCI: // formId
            case ESM4::SUB_XLCM:
            case ESM4::SUB_XCNT:
            case ESM4::SUB_ONAM:
            case ESM4::SUB_VMAD:
            case ESM4::SUB_XPRM:
            case ESM4::SUB_INAM:
            case ESM4::SUB_PDTO:
            case ESM4::SUB_SCHR:
            case ESM4::SUB_SCTX:
            case ESM4::SUB_XAPD:
            case ESM4::SUB_XAPR:
            case ESM4::SUB_XCVL:
            case ESM4::SUB_XCZA:
            case ESM4::SUB_XCZC:
            case ESM4::SUB_XEZN:
            case ESM4::SUB_XFVC:
            case ESM4::SUB_XHTW:
            case ESM4::SUB_XIS2:
            case ESM4::SUB_XLCN:
            case ESM4::SUB_XLIB:
            case ESM4::SUB_XLKR:
            case ESM4::SUB_XLRM:
            case ESM4::SUB_XLRT:
            case ESM4::SUB_XLTW:
            case ESM4::SUB_XMBO:
            case ESM4::SUB_XMBP:
            case ESM4::SUB_XMBR:
            case ESM4::SUB_XNDP:
            case ESM4::SUB_XOCP:
            case ESM4::SUB_XPOD:
            case ESM4::SUB_XPPA:
            case ESM4::SUB_XPRD:
            case ESM4::SUB_XPWR:
            case ESM4::SUB_XRMR:
            case ESM4::SUB_XSPC:
            case ESM4::SUB_XTNM:
            case ESM4::SUB_XTRI:
            case ESM4::SUB_XWCN:
            case ESM4::SUB_XWCU:
            case ESM4::SUB_XATR: // Dawnguard only?
            case ESM4::SUB_XHLT: // Unofficial Oblivion Patch
            case ESM4::SUB_XCHG: // thievery.exp
            case ESM4::SUB_XHLP: // FO3
            case ESM4::SUB_XAMT: // FO3
            case ESM4::SUB_XAMC: // FO3
            case ESM4::SUB_XRAD: // FO3
            case ESM4::SUB_XIBS: // FO3
            case ESM4::SUB_XORD: // FO3
            case ESM4::SUB_XCLP: // FO3
            case ESM4::SUB_SCDA: // FO3
            case ESM4::SUB_RCLR: // FO3
            case ESM4::SUB_BNAM: // FONV
            case ESM4::SUB_MMRK: // FONV
            case ESM4::SUB_MNAM: // FONV
            case ESM4::SUB_NNAM: // FONV
            case ESM4::SUB_XATO: // FONV
            case ESM4::SUB_SCRV: // FONV
            case ESM4::SUB_SCVR: // FONV
            case ESM4::SUB_SLSD: // FONV
            case ESM4::SUB_XSRF: // FONV
            case ESM4::SUB_XSRD: // FONV
            case ESM4::SUB_WMI1: // FONV
            case ESM4::SUB_XLRL: // Unofficial Skyrim Patch
                // if (mFormId == 0x0007e90f) // XPRM XPOD
                // if (mBaseObj == 0x17) //XPRM XOCP occlusion plane data XMBO bound half extents
                reader.skipSubRecordData();
                break;
            default:
                throw std::runtime_error("ESM4::REFR::load - Unknown subrecord " + ESM::printName(subHdr.typeId));
        }
    }
    // if (mFormId == 0x0016B74B) // base is TACT vCasinoUltraLuxeRadio in cell ULCasino
    // std::cout << "REFR SCRO " << formIdToString(sid);
}

// void ESM4::Reference::save(ESM4::Writer& writer) const
//{
// }

void ESM4::Reference::blank() {}