mirror of
https://github.com/DarkflameUniverse/DarkflameServer.git
synced 2026-10-02 10:53:44 +00:00
69093c6816
Before version 30 (PrePreAlpha) a zone file's scene is only a u32 scene ID, with no scene file name (LuzReader::ReadScenes, 1.10.64: revision < 30 reads the ID alone; LuzFile::ReadLUZFile treats anything below 20 as 20). The reader read a file name and then an ID for those versions, which is not the format, and the world could not load such a zone's scenes anyway. Reading one now throws a runtime_error that says why, before anything else is read. No zone file of any client on disk is older than 30 except an unnamed editor stub (a res/.luz, version 20). Check in game: every world loads as before. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
225 lines
9.9 KiB
C++
225 lines
9.9 KiB
C++
#include <gtest/gtest.h>
|
|
|
|
#include <cstring>
|
|
#include <sstream>
|
|
|
|
#include "LevelFile.h"
|
|
#include "ZoneFile.h"
|
|
|
|
namespace {
|
|
// Little-endian file bytes, as the client's files are laid out
|
|
struct ZoneBytes {
|
|
std::string data;
|
|
template<typename T> ZoneBytes& Put(T value) { data.append(reinterpret_cast<const char*>(&value), sizeof(T)); return *this; }
|
|
template<typename T> void At(size_t pos, T value) { std::memcpy(data.data() + pos, &value, sizeof(T)); }
|
|
ZoneBytes& Text(const std::string& text) { Put<uint8_t>(static_cast<uint8_t>(text.size())); data += text; return *this; }
|
|
ZoneBytes& Wide(const std::string& text) { Put<uint8_t>(static_cast<uint8_t>(text.size())); for (char c : text) Put<uint16_t>(static_cast<uint16_t>(c)); return *this; }
|
|
ZoneBytes& Point(float x, float y, float z) { return Put(x).Put(y).Put(z); }
|
|
void Object(uint32_t version, uint32_t lot, float x, const std::string& settings) {
|
|
Put<int64_t>(lot * 10).Put<int32_t>(static_cast<int32_t>(lot));
|
|
if (version >= 38) Put<int32_t>(0); // node type
|
|
if (version >= 32) Put<uint32_t>(0); // glom ID
|
|
Point(x, 0, 0).Put(1.0f).Put(0.0f).Put(0.0f).Put(0.0f).Put(1.0f); // position, rotation, scale
|
|
Put<uint32_t>(static_cast<uint32_t>(settings.size()));
|
|
for (char c : settings) Put<uint16_t>(static_cast<uint16_t>(c));
|
|
Put<uint32_t>(0);
|
|
}
|
|
};
|
|
|
|
std::string SampleZone() {
|
|
ZoneBytes w;
|
|
w.Put<uint32_t>(41).Put<uint32_t>(3).Put<uint32_t>(1150); // version, revision, world
|
|
w.Point(1, 2, 3).Put(1.0f).Put(0.0f).Put(0.0f).Put(0.0f); // spawn point and rotation
|
|
w.Put<uint32_t>(1);
|
|
w.Text("scene.lvl").Put<uint32_t>(7).Put<uint32_t>(2).Text("Global").Put<uint8_t>(1).Put<uint8_t>(2).Put<uint8_t>(3);
|
|
w.Put<uint8_t>(0).Text("zone.raw").Text("Name").Text("Description"); // no zone boundaries
|
|
w.Put<uint32_t>(1);
|
|
for (int i = 0; i < 2; i++) w.Put<uint64_t>(1).Point(0, 0, 0);
|
|
w.Put<uint32_t>(0).Put<uint32_t>(1).Put<uint32_t>(3);
|
|
// Movement: its config is waypoint commands (spaces dropped from the name)
|
|
w.Put<uint32_t>(18).Wide("Patrol").Put<uint32_t>(0).Put<uint32_t>(0).Put<uint32_t>(0);
|
|
w.Put<uint32_t>(1).Point(5, 0, 5).Put<uint32_t>(1).Wide("de lay").Wide(" 2 ");
|
|
// Spawner: its config is LDF
|
|
w.Put<uint32_t>(18).Wide("Spawner").Put<uint32_t>(4).Put<uint32_t>(0).Put<uint32_t>(0);
|
|
w.Put<int32_t>(6010).Put<uint32_t>(10).Put<int32_t>(1).Put<uint32_t>(1).Put<int64_t>(123).Put<uint8_t>(1);
|
|
w.Put<uint32_t>(1).Point(1, 1, 1).Put(1.0f).Put(0.0f).Put(0.0f).Put(0.0f).Put<uint32_t>(1).Wide("spawner_node_id").Wide("1:4");
|
|
// Property
|
|
w.Put<uint32_t>(8).Wide("PropertyPath").Put<uint32_t>(2).Put<uint32_t>(0).Put<uint32_t>(0);
|
|
w.Put<int32_t>(0).Put<int32_t>(1000).Put<uint32_t>(0).Put<uint64_t>(1100);
|
|
w.Wide("Block Yard");
|
|
w.Put<uint32_t>(4); for (char c : std::string("Desc")) w.Put<uint16_t>(static_cast<uint16_t>(c));
|
|
w.Put<int32_t>(0).Put<uint32_t>(0).Put(1.0f).Put<uint32_t>(0).Put<uint32_t>(0).Point(0, 0, 0).Put(128.0f);
|
|
w.Put<uint32_t>(3).Point(0, 0, 0).Point(10, 0, 0).Point(10, 0, 10);
|
|
return w.data;
|
|
}
|
|
}
|
|
|
|
TEST(ZoneFileTests, ReadsScenesAndPaths) {
|
|
std::istringstream stream(SampleZone());
|
|
ZoneFile zone;
|
|
zone.Read(stream);
|
|
EXPECT_FALSE(stream.fail());
|
|
EXPECT_EQ(zone.fileFormatVersion, ZoneFile::FileFormatVersion::Latest);
|
|
EXPECT_EQ(zone.worldID, 1150u);
|
|
EXPECT_EQ(zone.spawnpoint, NiPoint3(1, 2, 3));
|
|
ASSERT_EQ(zone.scenes.size(), 1u);
|
|
EXPECT_EQ(zone.scenes[0].filename, "scene.lvl");
|
|
EXPECT_EQ(zone.scenes[0].id, 7u);
|
|
EXPECT_EQ(zone.scenes[0].sceneType, 2u);
|
|
EXPECT_EQ(zone.zoneRawPath, "zone.raw");
|
|
ASSERT_EQ(zone.sceneTransitions.size(), 1u);
|
|
EXPECT_EQ(zone.sceneTransitions[0].points.size(), 2u);
|
|
ASSERT_EQ(zone.paths.size(), 3u);
|
|
|
|
const auto& patrol = zone.paths[0].pathWaypoints.at(0);
|
|
ASSERT_EQ(patrol.commands.size(), 1u);
|
|
EXPECT_EQ(patrol.commands[0].command, eWaypointCommandType::DELAY);
|
|
EXPECT_EQ(patrol.commands[0].data, "2");
|
|
|
|
const auto& spawner = zone.paths[1];
|
|
EXPECT_EQ(spawner.spawner.spawnedLOT, 6010);
|
|
EXPECT_EQ(spawner.spawner.spawnerObjID, 123);
|
|
EXPECT_EQ(spawner.pathWaypoints.at(0).config.find(u"spawner_node_id")->second->GetValueAsString(), "4");
|
|
|
|
const auto& property = zone.paths[2];
|
|
EXPECT_EQ(property.pathType, PathType::Property);
|
|
EXPECT_EQ(property.property.displayName, "Block Yard");
|
|
EXPECT_EQ(property.property.displayDesc, "Desc");
|
|
EXPECT_EQ(property.property.maxBuildHeight, 128.0f);
|
|
EXPECT_EQ(property.pathWaypoints.size(), 3u);
|
|
}
|
|
|
|
// Boundary lines sit between the scenes and the terrain file's name
|
|
TEST(ZoneFileTests, ReadsZoneBoundaries) {
|
|
ZoneBytes w;
|
|
w.Put<uint32_t>(41).Put<uint32_t>(3).Put<uint32_t>(1150);
|
|
w.Point(0, 0, 0).Put(1.0f).Put(0.0f).Put(0.0f).Put(0.0f);
|
|
w.Put<uint32_t>(1);
|
|
w.Text("scene.lvl").Put<uint32_t>(0).Put<uint32_t>(0).Text("Global").Put<uint8_t>(0).Put<uint8_t>(0).Put<uint8_t>(0);
|
|
w.Put<uint8_t>(2);
|
|
w.Point(1, 0, 0).Point(10, 20, 30).Put<uint16_t>(1100).Put<uint16_t>(7).Put<uint32_t>(4).Point(5, 6, 7);
|
|
w.Point(0, 0, -1).Point(-1, -2, -3).Put<uint16_t>(1200).Put<uint16_t>(0).Put<uint32_t>(0).Point(0, 0, 0);
|
|
w.Text("zone.raw").Text("Name").Text("Description");
|
|
w.Put<uint32_t>(0).Put<uint32_t>(0).Put<uint32_t>(1).Put<uint32_t>(0); // no transitions, no paths
|
|
|
|
std::istringstream stream(w.data);
|
|
ZoneFile zone;
|
|
zone.Read(stream);
|
|
EXPECT_FALSE(stream.fail());
|
|
ASSERT_EQ(zone.zoneBoundaries.size(), 2u);
|
|
const auto& boundary = zone.zoneBoundaries[0];
|
|
EXPECT_EQ(boundary.normal, NiPoint3(1, 0, 0));
|
|
EXPECT_EQ(boundary.point, NiPoint3(10, 20, 30));
|
|
EXPECT_EQ(boundary.destZoneID, LWOZONEID(1100, 7, 0));
|
|
EXPECT_EQ(boundary.destSceneID, 4u);
|
|
EXPECT_EQ(boundary.spawnLocation, NiPoint3(5, 6, 7));
|
|
EXPECT_EQ(zone.zoneBoundaries[1].destZoneID, LWOZONEID(1200, 0, 0));
|
|
EXPECT_EQ(zone.zoneRawPath, "zone.raw");
|
|
EXPECT_EQ(zone.zoneName, "Name");
|
|
EXPECT_EQ(zone.zoneDesc, "Description");
|
|
}
|
|
|
|
// From LateAlpha (37) on the scene count is a u32 (some LUP zones are 37)
|
|
TEST(ZoneFileTests, LateAlphaSceneCountIsAU32) {
|
|
ZoneBytes w;
|
|
w.Put<uint32_t>(37).Put<uint32_t>(1).Put<uint32_t>(20022); // version, revision, world; no spawn point before 38
|
|
w.Put<uint32_t>(1);
|
|
w.Text("scene.lvl").Put<uint32_t>(5).Put<uint32_t>(0).Text("Global Scene").Put<uint8_t>(0).Put<uint8_t>(0).Put<uint8_t>(0);
|
|
w.Put<uint8_t>(0).Text("zone.raw").Text("Name").Text("Description");
|
|
w.Put<uint32_t>(0).Put<uint32_t>(8).Put<uint32_t>(1).Put<uint32_t>(0); // no transitions, no paths
|
|
|
|
std::istringstream stream(w.data);
|
|
ZoneFile zone;
|
|
zone.Read(stream);
|
|
EXPECT_FALSE(stream.fail());
|
|
ASSERT_EQ(zone.scenes.size(), 1u);
|
|
EXPECT_EQ(zone.scenes[0].filename, "scene.lvl");
|
|
EXPECT_EQ(zone.scenes[0].id, 5u);
|
|
EXPECT_EQ(zone.zoneRawPath, "zone.raw");
|
|
}
|
|
|
|
// Before version 30 a scene is only an ID, with no file to load
|
|
TEST(ZoneFileTests, VersionsBeforePrePreAlphaThrow) {
|
|
ZoneBytes w;
|
|
w.Put<uint32_t>(20).Put<uint32_t>(53).Put<uint8_t>(1).Put<uint32_t>(53).Put<uint8_t>(0).Text(".raw");
|
|
std::istringstream stream(w.data);
|
|
ZoneFile zone;
|
|
EXPECT_THROW(zone.Read(stream), std::runtime_error);
|
|
EXPECT_TRUE(zone.scenes.empty());
|
|
}
|
|
|
|
TEST(ZoneFileTests, ShortFilesThrowOrFail) {
|
|
const auto zone = SampleZone();
|
|
for (const size_t length : { size_t{ 3 }, size_t{ 40 }, zone.size() / 2, zone.size() - 1 }) {
|
|
std::istringstream stream(zone.substr(0, length));
|
|
ZoneFile file;
|
|
bool threw = false;
|
|
try { file.Read(stream); } catch (const std::runtime_error&) { threw = true; }
|
|
EXPECT_TRUE(threw || stream.fail()) << length;
|
|
}
|
|
}
|
|
|
|
// Chunked files lay their objects out by the file info chunk's version
|
|
TEST(LevelFileTests, ReadsChunkedObjects) {
|
|
ZoneBytes w;
|
|
const auto chunk = [&w](uint32_t id) {
|
|
const auto start = w.data.size();
|
|
w.Put<uint32_t>(0x4B4E4843).Put<uint32_t>(id).Put<uint16_t>(1).Put<uint16_t>(0).Put<uint32_t>(0).Put<uint32_t>(0);
|
|
w.At<uint32_t>(start + 16, static_cast<uint32_t>(w.data.size()));
|
|
return start;
|
|
};
|
|
const auto end = [&w](size_t start) { w.At<uint32_t>(start + 12, static_cast<uint32_t>(w.data.size() - start)); };
|
|
const auto info = chunk(LevelFile::FileInfo);
|
|
w.Put<uint32_t>(41).Put<uint32_t>(9).Put<uint32_t>(0).Put<uint32_t>(0).Put<uint32_t>(0);
|
|
end(info);
|
|
const auto objects = chunk(LevelFile::SceneObjectData);
|
|
w.Put<uint32_t>(2);
|
|
w.Object(41, 4945, 10, "respawnname=0:NS_LW_Portal\nloadOnClientOnly=7:1");
|
|
w.Object(41, 176, -4, "spawntemplate=1:6010");
|
|
end(objects);
|
|
|
|
std::istringstream stream(w.data);
|
|
LevelFile level;
|
|
level.Read(stream);
|
|
EXPECT_EQ(level.chunkHeaders.at(LevelFile::FileInfo).fileInfo.revision, 9u);
|
|
ASSERT_EQ(level.objects.size(), 2u);
|
|
EXPECT_EQ(level.objects[0].lot, 4945);
|
|
EXPECT_EQ(level.objects[0].position.x, 10.0f);
|
|
EXPECT_EQ(level.objects[0].settings.find(u"respawnname")->second->GetValueAsString(), "NS_LW_Portal");
|
|
EXPECT_EQ(level.objects[1].id, 1760);
|
|
EXPECT_EQ(level.objects[1].settings.find(u"spawntemplate")->second->GetValueAsString(), "6010");
|
|
}
|
|
|
|
// Some live scenes (e.g. Nimbus Station's Gnarled Forest launch pad) are from before chunks
|
|
TEST(LevelFileTests, ReadsFilesWithoutChunks) {
|
|
ZoneBytes w;
|
|
w.Put<uint16_t>(30).Put<uint16_t>(0).Put<uint8_t>(1); // version, type, important
|
|
w.data.append(48 + 12, '\0'); // version 30 settings the world skips
|
|
w.Put<uint32_t>(0); // no skydome
|
|
w.Put<uint32_t>(1);
|
|
w.Object(30, 4945, 3, "respawnname=0:NS_GF");
|
|
|
|
std::istringstream stream(w.data);
|
|
LevelFile level;
|
|
level.Read(stream);
|
|
ASSERT_EQ(level.objects.size(), 1u);
|
|
EXPECT_EQ(level.objects[0].position.x, 3.0f);
|
|
EXPECT_EQ(level.objects[0].settings.find(u"respawnname")->second->GetValueAsString(), "NS_GF");
|
|
EXPECT_EQ(level.chunkHeaders.count(LevelFile::SceneObjectData), 1u);
|
|
}
|
|
|
|
TEST(LevelFileTests, DamagedFilesKeepWhatWasRead) {
|
|
ZoneBytes w;
|
|
w.Put<uint16_t>(30).Put<uint16_t>(0).Put<uint8_t>(1);
|
|
w.data.append(48 + 12, '\0');
|
|
w.Put<uint32_t>(0).Put<uint32_t>(2);
|
|
w.Object(30, 1, 0, "a=0:b");
|
|
w.Object(30, 2, 0, "c=0:d");
|
|
w.data.resize(w.data.size() - 2); // cut into the last object
|
|
|
|
std::istringstream stream(w.data);
|
|
LevelFile level;
|
|
EXPECT_THROW(level.Read(stream), std::runtime_error);
|
|
EXPECT_EQ(level.objects.size(), 1u);
|
|
}
|