1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*
Copyright (C) 2015-2016, 2018-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 "loadcell.hpp"
#include <cfloat> // FLT_MAX for gcc
#include <limits>
#include <stdexcept>
#include "grouptype.hpp"
#include "reader.hpp"
// #include "writer.hpp"
#include <components/esm/refid.hpp>
float ESM4::Cell::sInvalidWaterLevel = -200000.f;
// TODO: Try loading only EDID and XCLC (along with mFormId, mFlags and mParent)
//
// But, for external cells we may be scanning the whole record since we don't know if there is
// going to be an EDID subrecord. And the vast majority of cells are these kinds.
//
// So perhaps some testing needs to be done to see if scanning and skipping takes
// longer/shorter/same as loading the subrecords.
void ESM4::Cell::load(ESM4::Reader& reader)
{
ESM::FormId formId = reader.getFormIdFromHeader();
mId = formId;
mFlags = reader.hdr().record.flags;
mParent = reader.currWorld();
mWaterHeight = sInvalidWaterLevel;
reader.clearCellGrid(); // clear until XCLC FIXME: somehow do this automatically?
// Sometimes cell 0,0 does not have an XCLC sub record (e.g. ToddLand 000009BF)
// To workaround this issue put a default value if group is "exterior sub cell" and its
// grid from label is "0 0". Note the reversed X/Y order (no matter since they're both 0
// anyway).
if (reader.grp().type == ESM4::Grp_ExteriorSubCell && reader.grp().label.grid[1] == 0
&& reader.grp().label.grid[0] == 0)
{
ESM4::CellGrid currCellGrid;
currCellGrid = Grid{ 0, 0 };
reader.setCurrCellGrid(currCellGrid); // side effect: sets mCellGridValid true
}
// WARN: we need to call setCurrCell (and maybe setCurrCellGrid?) again before loading
// cell child groups if we are loading them after restoring the context
// (may be easier to update the context before saving?)
reader.setCurrCell(formId); // save for LAND (and other children) to access later
std::uint32_t esmVer = reader.esmVersion();
bool isSkyrim = (esmVer == ESM::VER_170 || esmVer == ESM::VER_094);
while (reader.getSubRecordHeader())
{
const ESM4::SubRecordHeader& subHdr = reader.subRecordHeader();
switch (subHdr.typeId)
{
case ESM::fourCC("EDID"):
{
if (!reader.getZString(mEditorId))
throw std::runtime_error("CELL EDID data read error");
#if 0
std::string padding;
padding.insert(0, reader.stackSize()*2, ' ');
std::cout << padding << "CELL Editor ID: " << mEditorId << std::endl;
#endif
break;
}
case ESM::fourCC("XCLC"):
{
//(X, Y) grid location of the cell followed by flags. Always in
// exterior cells and never in interior cells.
//
// int32 - X
// int32 - Y
// uint32 - flags (high bits look random)
//
// 0x1 - Force Hide Land Quad 1
// 0x2 - Force Hide Land Quad 2
// 0x4 - Force Hide Land Quad 3
// 0x8 - Force Hide Land Quad 4
uint32_t flags;
reader.get(mX);
reader.get(mY);
if (subHdr.dataSize == 12)
reader.get(flags);
// Remember cell grid for later (loading LAND, NAVM which should be CELL temporary children)
// Note that grids only apply for external cells. For interior cells use the cell's formid.
reader.setCurrCellGrid(Grid{ static_cast<int16_t>(mX), static_cast<int16_t>(mY) });
break;
}
case ESM::fourCC("FULL"):
reader.getLocalizedString(mFullName);
break;
case ESM::fourCC("DATA"):
{
if (subHdr.dataSize == 2)
reader.get(mCellFlags);
else
{
if (subHdr.dataSize != 1)
throw std::runtime_error("CELL unexpected DATA flag size");
std::uint8_t value = 0;
reader.get(value);
mCellFlags = value;
}
break;
}
case ESM::fourCC("XCLR"): // for exterior cells
{
mRegions.resize(subHdr.dataSize / sizeof(ESM::FormId32));
for (std::vector<ESM::FormId>::iterator it = mRegions.begin(); it != mRegions.end(); ++it)
{
reader.getFormId(*it);
#if 0
std::string padding;
padding.insert(0, reader.stackSize()*2, ' ');
std::cout << padding << "region: " << std::hex << *it << std::endl;
#endif
}
break;
}
case ESM::fourCC("XOWN"):
{
switch (subHdr.dataSize)
{
case 4:
reader.getFormId(mOwner);
break;
case 12:
{
reader.getFormId(mOwner);
std::uint32_t dummy;
reader.get(dummy); // Unknown
reader.get(dummy); // No crime flag, FO4
break;
}
default:
reader.skipSubRecordData();
break;
}
break;
}
case ESM::fourCC("XGLB"):
reader.getFormId(mGlobal);
break; // Oblivion only?
case ESM::fourCC("XCCM"):
reader.getFormId(mClimate);
break;
case ESM::fourCC("XCWT"):
reader.getFormId(mWater);
break;
case ESM::fourCC("XCLW"):
reader.get(mWaterHeight);
break;
case ESM::fourCC("XCLL"):
{
switch (subHdr.dataSize)
{
case 36: // TES4
reader.get(&mLighting, 36);
break;
case 40: // FO3/FNV
case 92: // TES5 (FIXME)
case 136: // FO4 (FIXME)
reader.get(mLighting);
reader.skipSubRecordData(subHdr.dataSize - 40);
break;
default:
reader.skipSubRecordData();
break;
}
break;
}
case ESM::fourCC("XCMT"):
reader.get(mMusicType);
break; // Oblivion only?
case ESM::fourCC("LTMP"):
reader.getFormId(mLightingTemplate);
break;
case ESM::fourCC("LNAM"):
reader.get(mLightingTemplateFlags);
break; // seems to always follow LTMP
case ESM::fourCC("XCMO"):
reader.getFormId(mMusic);
break;
case ESM::fourCC("XCAS"):
reader.getFormId(mAcousticSpace);
break;
case ESM::fourCC("TVDT"):
case ESM::fourCC("MHDT"):
case ESM::fourCC("XCGD"):
case ESM::fourCC("XNAM"):
case ESM::fourCC("XLCN"):
case ESM::fourCC("XWCS"):
case ESM::fourCC("XWCU"):
case ESM::fourCC("XWCN"):
case ESM::fourCC("XCIM"):
case ESM::fourCC("XEZN"):
case ESM::fourCC("XWEM"):
case ESM::fourCC("XILL"):
case ESM::fourCC("XRNK"):
case ESM::fourCC("XCET"): // FO3
case ESM::fourCC("IMPF"): // FO3 Zeta
case ESM::fourCC("CNAM"): // FO4
case ESM::fourCC("PCMB"): // FO4
case ESM::fourCC("RVIS"): // FO4
case ESM::fourCC("VISI"): // FO4
case ESM::fourCC("XGDR"): // FO4
case ESM::fourCC("XILW"): // FO4
case ESM::fourCC("XCRI"): // FO4
case ESM::fourCC("XPRI"): // FO4
case ESM::fourCC("ZNAM"): // FO4
reader.skipSubRecordData();
break;
default:
throw std::runtime_error("ESM4::CELL::load - Unknown subrecord " + ESM::printName(subHdr.typeId));
}
}
if (isSkyrim) // Skyrim seems to have broken water level records. But the subrecord exists so it
// shouldn't be skipped.
{
mWaterHeight = sInvalidWaterLevel;
}
mReaderContext = reader.getContext();
}
// void ESM4::Cell::save(ESM4::Writer& writer) const
//{
// }
void ESM4::Cell::blank() {}
|
