mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-22 22:13:35 +02:00
522 lines
17 KiB
C++
522 lines
17 KiB
C++
/*
|
|
* CObjectClassesHandler.cpp, part of VCMI engine
|
|
*
|
|
* Authors: listed in file AUTHORS in main folder
|
|
*
|
|
* License: GNU General Public License v2.0 or later
|
|
* Full text of license available in license.txt file, in main folder
|
|
*
|
|
*/
|
|
#include "StdInc.h"
|
|
#include "CObjectClassesHandler.h"
|
|
|
|
#include "../filesystem/Filesystem.h"
|
|
#include "../filesystem/CBinaryReader.h"
|
|
#include "../VCMI_Lib.h"
|
|
#include "../GameConstants.h"
|
|
#include "../constants/StringConstants.h"
|
|
#include "../CGeneralTextHandler.h"
|
|
#include "../GameSettings.h"
|
|
#include "../JsonNode.h"
|
|
#include "../CSoundBase.h"
|
|
|
|
#include "../mapObjectConstructors/CBankInstanceConstructor.h"
|
|
#include "../mapObjectConstructors/CRewardableConstructor.h"
|
|
#include "../mapObjectConstructors/CommonConstructors.h"
|
|
#include "../mapObjectConstructors/DwellingInstanceConstructor.h"
|
|
#include "../mapObjectConstructors/HillFortInstanceConstructor.h"
|
|
#include "../mapObjectConstructors/ShipyardInstanceConstructor.h"
|
|
#include "../mapObjects/CGCreature.h"
|
|
#include "../mapObjects/CGPandoraBox.h"
|
|
#include "../mapObjects/CQuest.h"
|
|
#include "../mapObjects/ObjectTemplate.h"
|
|
#include "../mapObjects/CGMarket.h"
|
|
#include "../mapObjects/MiscObjects.h"
|
|
#include "../mapObjects/CGHeroInstance.h"
|
|
#include "../mapObjects/CGTownInstance.h"
|
|
#include "../modding/IdentifierStorage.h"
|
|
#include "../modding/CModHandler.h"
|
|
#include "../modding/ModScope.h"
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
CObjectClassesHandler::CObjectClassesHandler()
|
|
{
|
|
#define SET_HANDLER_CLASS(STRING, CLASSNAME) handlerConstructors[STRING] = std::make_shared<CLASSNAME>;
|
|
#define SET_HANDLER(STRING, TYPENAME) handlerConstructors[STRING] = std::make_shared<CDefaultObjectTypeHandler<TYPENAME>>
|
|
|
|
// list of all known handlers, hardcoded for now since the only way to add new objects is via C++ code
|
|
//Note: should be in sync with registerTypesMapObjectTypes function
|
|
SET_HANDLER_CLASS("configurable", CRewardableConstructor);
|
|
SET_HANDLER_CLASS("dwelling", DwellingInstanceConstructor);
|
|
SET_HANDLER_CLASS("hero", CHeroInstanceConstructor);
|
|
SET_HANDLER_CLASS("town", CTownInstanceConstructor);
|
|
SET_HANDLER_CLASS("bank", CBankInstanceConstructor);
|
|
SET_HANDLER_CLASS("boat", BoatInstanceConstructor);
|
|
SET_HANDLER_CLASS("market", MarketInstanceConstructor);
|
|
SET_HANDLER_CLASS("hillFort", HillFortInstanceConstructor);
|
|
SET_HANDLER_CLASS("shipyard", ShipyardInstanceConstructor);
|
|
SET_HANDLER_CLASS("monster", CreatureInstanceConstructor);
|
|
SET_HANDLER_CLASS("resource", ResourceInstanceConstructor);
|
|
|
|
SET_HANDLER_CLASS("static", CObstacleConstructor);
|
|
SET_HANDLER_CLASS("", CObstacleConstructor);
|
|
|
|
SET_HANDLER("randomArtifact", CGArtifact);
|
|
SET_HANDLER("randomHero", CGHeroInstance);
|
|
SET_HANDLER("randomResource", CGResource);
|
|
SET_HANDLER("randomTown", CGTownInstance);
|
|
SET_HANDLER("randomMonster", CGCreature);
|
|
SET_HANDLER("randomDwelling", CGDwelling);
|
|
|
|
SET_HANDLER("generic", CGObjectInstance);
|
|
SET_HANDLER("artifact", CGArtifact);
|
|
SET_HANDLER("borderGate", CGBorderGate);
|
|
SET_HANDLER("borderGuard", CGBorderGuard);
|
|
SET_HANDLER("denOfThieves", CGDenOfthieves);
|
|
SET_HANDLER("event", CGEvent);
|
|
SET_HANDLER("garrison", CGGarrison);
|
|
SET_HANDLER("heroPlaceholder", CGHeroPlaceholder);
|
|
SET_HANDLER("keymaster", CGKeymasterTent);
|
|
SET_HANDLER("lighthouse", CGLighthouse);
|
|
SET_HANDLER("magi", CGMagi);
|
|
SET_HANDLER("mine", CGMine);
|
|
SET_HANDLER("obelisk", CGObelisk);
|
|
SET_HANDLER("pandora", CGPandoraBox);
|
|
SET_HANDLER("prison", CGHeroInstance);
|
|
SET_HANDLER("questGuard", CGQuestGuard);
|
|
SET_HANDLER("seerHut", CGSeerHut);
|
|
SET_HANDLER("sign", CGSignBottle);
|
|
SET_HANDLER("siren", CGSirens);
|
|
SET_HANDLER("monolith", CGMonolith);
|
|
SET_HANDLER("subterraneanGate", CGSubterraneanGate);
|
|
SET_HANDLER("whirlpool", CGWhirlpool);
|
|
SET_HANDLER("terrain", CGTerrainPatch);
|
|
|
|
#undef SET_HANDLER_CLASS
|
|
#undef SET_HANDLER
|
|
}
|
|
|
|
CObjectClassesHandler::~CObjectClassesHandler() = default;
|
|
|
|
std::vector<JsonNode> CObjectClassesHandler::loadLegacyData()
|
|
{
|
|
size_t dataSize = VLC->settings()->getInteger(EGameSettings::TEXTS_OBJECT);
|
|
|
|
CLegacyConfigParser parser(TextPath::builtin("Data/Objects.txt"));
|
|
auto totalNumber = static_cast<size_t>(parser.readNumber()); // first line contains number of objects to read and nothing else
|
|
parser.endLine();
|
|
|
|
for (size_t i = 0; i < totalNumber; i++)
|
|
{
|
|
auto * tmpl = new ObjectTemplate;
|
|
|
|
tmpl->readTxt(parser);
|
|
parser.endLine();
|
|
|
|
std::pair key(tmpl->id, tmpl->subid);
|
|
legacyTemplates.insert(std::make_pair(key, std::shared_ptr<const ObjectTemplate>(tmpl)));
|
|
}
|
|
|
|
objects.resize(256);
|
|
|
|
std::vector<JsonNode> ret(dataSize);// create storage for 256 objects
|
|
assert(dataSize == 256);
|
|
|
|
CLegacyConfigParser namesParser(TextPath::builtin("Data/ObjNames.txt"));
|
|
for (size_t i=0; i<256; i++)
|
|
{
|
|
ret[i]["name"].String() = namesParser.readString();
|
|
namesParser.endLine();
|
|
}
|
|
|
|
JsonNode cregen1;
|
|
JsonNode cregen4;
|
|
|
|
CLegacyConfigParser cregen1Parser(TextPath::builtin("data/crgen1"));
|
|
do
|
|
{
|
|
JsonNode subObject;
|
|
subObject["name"].String() = cregen1Parser.readString();
|
|
cregen1.Vector().push_back(subObject);
|
|
}
|
|
while(cregen1Parser.endLine());
|
|
|
|
CLegacyConfigParser cregen4Parser(TextPath::builtin("data/crgen4"));
|
|
do
|
|
{
|
|
JsonNode subObject;
|
|
subObject["name"].String() = cregen4Parser.readString();
|
|
cregen4.Vector().push_back(subObject);
|
|
}
|
|
while(cregen4Parser.endLine());
|
|
|
|
ret[Obj::CREATURE_GENERATOR1]["subObjects"] = cregen1;
|
|
ret[Obj::CREATURE_GENERATOR4]["subObjects"] = cregen4;
|
|
|
|
ret[Obj::REFUGEE_CAMP]["subObjects"].Vector().push_back(ret[Obj::REFUGEE_CAMP]);
|
|
ret[Obj::WAR_MACHINE_FACTORY]["subObjects"].Vector().push_back(ret[Obj::WAR_MACHINE_FACTORY]);
|
|
|
|
return ret;
|
|
}
|
|
|
|
void CObjectClassesHandler::loadSubObject(const std::string & scope, const std::string & identifier, const JsonNode & entry, ObjectClass * obj)
|
|
{
|
|
auto object = loadSubObjectFromJson(scope, identifier, entry, obj, obj->objects.size());
|
|
|
|
assert(object);
|
|
obj->objects.push_back(object);
|
|
|
|
registerObject(scope, obj->getJsonKey(), object->getSubTypeName(), object->subtype);
|
|
for(const auto & compatID : entry["compatibilityIdentifiers"].Vector())
|
|
registerObject(scope, obj->getJsonKey(), compatID.String(), object->subtype);
|
|
}
|
|
|
|
void CObjectClassesHandler::loadSubObject(const std::string & scope, const std::string & identifier, const JsonNode & entry, ObjectClass * obj, size_t index)
|
|
{
|
|
auto object = loadSubObjectFromJson(scope, identifier, entry, obj, index);
|
|
|
|
assert(object);
|
|
if (obj->objects.at(index) != nullptr)
|
|
throw std::runtime_error("Attempt to load already loaded object:" + identifier);
|
|
|
|
obj->objects.at(index) = object;
|
|
|
|
registerObject(scope, obj->getJsonKey(), object->getSubTypeName(), object->subtype);
|
|
for(const auto & compatID : entry["compatibilityIdentifiers"].Vector())
|
|
registerObject(scope, obj->getJsonKey(), compatID.String(), object->subtype);
|
|
}
|
|
|
|
TObjectTypeHandler CObjectClassesHandler::loadSubObjectFromJson(const std::string & scope, const std::string & identifier, const JsonNode & entry, ObjectClass * obj, size_t index)
|
|
{
|
|
assert(identifier.find(':') == std::string::npos);
|
|
assert(!scope.empty());
|
|
|
|
std::string handler = obj->handlerName;
|
|
if(!handlerConstructors.count(handler))
|
|
{
|
|
logMod->error("Handler with name %s was not found!", handler);
|
|
// workaround for potential crash - if handler does not exists, continue with generic handler that is used for objects without any custom logc
|
|
handler = "generic";
|
|
assert(handlerConstructors.count(handler) != 0);
|
|
}
|
|
|
|
auto createdObject = handlerConstructors.at(handler)();
|
|
|
|
createdObject->modScope = scope;
|
|
createdObject->typeName = obj->identifier;;
|
|
createdObject->subTypeName = identifier;
|
|
|
|
createdObject->type = obj->id;
|
|
createdObject->subtype = index;
|
|
createdObject->init(entry);
|
|
|
|
auto range = legacyTemplates.equal_range(std::make_pair(obj->id, index));
|
|
for (auto & templ : boost::make_iterator_range(range.first, range.second))
|
|
{
|
|
createdObject->addTemplate(templ.second);
|
|
}
|
|
legacyTemplates.erase(range.first, range.second);
|
|
|
|
logGlobal->debug("Loaded object %s(%d)::%s(%d)", obj->getJsonKey(), obj->id, identifier, index);
|
|
|
|
return createdObject;
|
|
}
|
|
|
|
ObjectClass::ObjectClass() = default;
|
|
ObjectClass::~ObjectClass() = default;
|
|
|
|
std::string ObjectClass::getJsonKey() const
|
|
{
|
|
return modScope + ':' + identifier;
|
|
}
|
|
|
|
std::string ObjectClass::getNameTextID() const
|
|
{
|
|
return TextIdentifier("object", modScope, identifier, "name").get();
|
|
}
|
|
|
|
std::string ObjectClass::getNameTranslated() const
|
|
{
|
|
return VLC->generaltexth->translate(getNameTextID());
|
|
}
|
|
|
|
std::unique_ptr<ObjectClass> CObjectClassesHandler::loadFromJson(const std::string & scope, const JsonNode & json, const std::string & name, size_t index)
|
|
{
|
|
auto obj = std::make_unique<ObjectClass>();
|
|
|
|
obj->modScope = scope;
|
|
obj->identifier = name;
|
|
obj->handlerName = json["handler"].String();
|
|
obj->base = json["base"];
|
|
obj->id = index;
|
|
|
|
VLC->generaltexth->registerString(scope, obj->getNameTextID(), json["name"].String());
|
|
|
|
obj->objects.resize(json["lastReservedIndex"].Float() + 1);
|
|
|
|
for (auto subData : json["types"].Struct())
|
|
{
|
|
if (!subData.second["index"].isNull())
|
|
{
|
|
const std::string & subMeta = subData.second["index"].meta;
|
|
|
|
if ( subMeta == "core")
|
|
{
|
|
size_t subIndex = subData.second["index"].Integer();
|
|
loadSubObject(subData.second.meta, subData.first, subData.second, obj.get(), subIndex);
|
|
}
|
|
else
|
|
{
|
|
logMod->error("Object %s:%s.%s - attempt to load object with preset index! This option is reserved for built-in mod", subMeta, name, subData.first );
|
|
loadSubObject(subData.second.meta, subData.first, subData.second, obj.get());
|
|
}
|
|
}
|
|
else
|
|
loadSubObject(subData.second.meta, subData.first, subData.second, obj.get());
|
|
}
|
|
|
|
if (obj->id == MapObjectID::MONOLITH_TWO_WAY)
|
|
generateExtraMonolithsForRMG(obj.get());
|
|
|
|
return obj;
|
|
}
|
|
|
|
void CObjectClassesHandler::loadObject(std::string scope, std::string name, const JsonNode & data)
|
|
{
|
|
objects.push_back(loadFromJson(scope, data, name, objects.size()));
|
|
|
|
VLC->identifiersHandler->registerObject(scope, "object", name, objects.back()->id);
|
|
}
|
|
|
|
void CObjectClassesHandler::loadObject(std::string scope, std::string name, const JsonNode & data, size_t index)
|
|
{
|
|
assert(objects.at(index) == nullptr); // ensure that this id was not loaded before
|
|
|
|
objects.at(index) = loadFromJson(scope, data, name, index);
|
|
VLC->identifiersHandler->registerObject(scope, "object", name, objects.at(index)->id);
|
|
}
|
|
|
|
void CObjectClassesHandler::loadSubObject(const std::string & identifier, JsonNode config, MapObjectID ID, MapObjectSubID subID)
|
|
{
|
|
config.setType(JsonNode::JsonType::DATA_STRUCT); // ensure that input is not NULL
|
|
assert(objects.at(ID.getNum()));
|
|
|
|
if ( subID.getNum() >= objects.at(ID.getNum())->objects.size())
|
|
objects.at(ID.getNum())->objects.resize(subID.getNum()+1);
|
|
|
|
JsonUtils::inherit(config, objects.at(ID.getNum())->base);
|
|
loadSubObject(config.meta, identifier, config, objects.at(ID.getNum()).get(), subID.getNum());
|
|
}
|
|
|
|
void CObjectClassesHandler::removeSubObject(MapObjectID ID, MapObjectSubID subID)
|
|
{
|
|
assert(objects.at(ID.getNum()));
|
|
objects.at(ID.getNum())->objects.at(subID.getNum()) = nullptr;
|
|
}
|
|
|
|
TObjectTypeHandler CObjectClassesHandler::getHandlerFor(MapObjectID type, MapObjectSubID subtype) const
|
|
{
|
|
try
|
|
{
|
|
if (objects.at(type.getNum()) == nullptr)
|
|
return objects.front()->objects.front();
|
|
|
|
auto subID = subtype.getNum();
|
|
if (type == Obj::PRISON)
|
|
subID = 0;
|
|
auto result = objects.at(type.getNum())->objects.at(subID);
|
|
|
|
if (result != nullptr)
|
|
return result;
|
|
}
|
|
catch (std::out_of_range & e)
|
|
{
|
|
// Leave catch block silently
|
|
}
|
|
|
|
std::string errorString = "Failed to find object of type " + std::to_string(type.getNum()) + "::" + std::to_string(subtype.getNum());
|
|
logGlobal->error(errorString);
|
|
throw std::runtime_error(errorString);
|
|
}
|
|
|
|
TObjectTypeHandler CObjectClassesHandler::getHandlerFor(const std::string & scope, const std::string & type, const std::string & subtype) const
|
|
{
|
|
std::optional<si32> id = VLC->identifiers()->getIdentifier(scope, "object", type);
|
|
if(id)
|
|
{
|
|
const auto & object = objects.at(id.value());
|
|
std::optional<si32> subID = VLC->identifiers()->getIdentifier(scope, object->getJsonKey(), subtype);
|
|
|
|
if (subID)
|
|
return object->objects.at(subID.value());
|
|
}
|
|
|
|
std::string errorString = "Failed to find object of type " + type + "::" + subtype;
|
|
logGlobal->error(errorString);
|
|
throw std::runtime_error(errorString);
|
|
}
|
|
|
|
TObjectTypeHandler CObjectClassesHandler::getHandlerFor(CompoundMapObjectID compoundIdentifier) const
|
|
{
|
|
return getHandlerFor(compoundIdentifier.primaryID, compoundIdentifier.secondaryID);
|
|
}
|
|
|
|
std::set<MapObjectID> CObjectClassesHandler::knownObjects() const
|
|
{
|
|
std::set<MapObjectID> ret;
|
|
|
|
for(auto & entry : objects)
|
|
if (entry)
|
|
ret.insert(entry->id);
|
|
|
|
return ret;
|
|
}
|
|
|
|
std::set<MapObjectSubID> CObjectClassesHandler::knownSubObjects(MapObjectID primaryID) const
|
|
{
|
|
std::set<MapObjectSubID> ret;
|
|
|
|
if (!objects.at(primaryID.getNum()))
|
|
{
|
|
logGlobal->error("Failed to find object %d", primaryID);
|
|
return ret;
|
|
}
|
|
|
|
for(const auto & entry : objects.at(primaryID.getNum())->objects)
|
|
if (entry)
|
|
ret.insert(entry->subtype);
|
|
|
|
return ret;
|
|
}
|
|
|
|
void CObjectClassesHandler::beforeValidate(JsonNode & object)
|
|
{
|
|
for (auto & entry : object["types"].Struct())
|
|
{
|
|
if (object.Struct().count("subObjects"))
|
|
{
|
|
const auto & vector = object["subObjects"].Vector();
|
|
|
|
if (entry.second.Struct().count("index"))
|
|
{
|
|
size_t index = entry.second["index"].Integer();
|
|
|
|
if (index < vector.size())
|
|
JsonUtils::inherit(entry.second, vector[index]);
|
|
}
|
|
}
|
|
|
|
JsonUtils::inherit(entry.second, object["base"]);
|
|
for (auto & templ : entry.second["templates"].Struct())
|
|
JsonUtils::inherit(templ.second, entry.second["base"]);
|
|
}
|
|
object.Struct().erase("subObjects");
|
|
}
|
|
|
|
void CObjectClassesHandler::afterLoadFinalization()
|
|
{
|
|
for(auto & entry : objects)
|
|
{
|
|
if (!entry)
|
|
continue;
|
|
|
|
for(const auto & obj : entry->objects)
|
|
{
|
|
if (!obj)
|
|
continue;
|
|
|
|
obj->afterLoadFinalization();
|
|
if(obj->getTemplates().empty())
|
|
logGlobal->warn("No templates found for %s:%s", entry->getJsonKey(), obj->getJsonKey());
|
|
}
|
|
}
|
|
}
|
|
|
|
void CObjectClassesHandler::generateExtraMonolithsForRMG(ObjectClass * container)
|
|
{
|
|
//duplicate existing two-way portals to make reserve for RMG
|
|
auto& portalVec = container->objects;
|
|
//FIXME: Monoliths in this vector can be already not useful for every terrain
|
|
const size_t portalCount = portalVec.size();
|
|
|
|
//Invalid portals will be skipped and portalVec size stays unchanged
|
|
for (size_t i = portalCount; portalVec.size() < 100; ++i)
|
|
{
|
|
auto index = static_cast<si32>(i % portalCount);
|
|
auto portal = portalVec[index];
|
|
auto templates = portal->getTemplates();
|
|
if (templates.empty() || !templates[0]->canBePlacedAtAnyTerrain())
|
|
{
|
|
continue; //Do not clone HoTA water-only portals or any others we can't use
|
|
}
|
|
|
|
//deep copy of noncopyable object :?
|
|
auto newPortal = std::make_shared<CDefaultObjectTypeHandler<CGMonolith>>();
|
|
newPortal->rmgInfo = portal->getRMGInfo();
|
|
newPortal->templates = portal->getTemplates();
|
|
newPortal->sounds = portal->getSounds();
|
|
newPortal->aiValue = portal->getAiValue();
|
|
newPortal->battlefield = portal->battlefield; //getter is not initialized at this point
|
|
newPortal->modScope = portal->modScope; //private
|
|
newPortal->typeName = portal->getTypeName();
|
|
newPortal->subTypeName = std::string("monolith") + std::to_string(portalVec.size());
|
|
newPortal->type = portal->getIndex();
|
|
|
|
// Inconsintent original indexing: monolith1 has index 0
|
|
newPortal->subtype = portalVec.size() - 1; //indexes must be unique, they are returned as a set
|
|
newPortal->blockVisit = portal->blockVisit;
|
|
newPortal->removable = portal->removable;
|
|
|
|
portalVec.push_back(newPortal);
|
|
|
|
registerObject(newPortal->modScope, container->getJsonKey(), newPortal->subTypeName, newPortal->subtype);
|
|
}
|
|
}
|
|
|
|
std::string CObjectClassesHandler::getObjectName(MapObjectID type, MapObjectSubID subtype) const
|
|
{
|
|
const auto handler = getHandlerFor(type, subtype);
|
|
if (handler && handler->hasNameTextID())
|
|
return handler->getNameTranslated();
|
|
|
|
if (objects.at(type.getNum()))
|
|
return objects.at(type.getNum())->getNameTranslated();
|
|
|
|
return objects.front()->getNameTranslated();
|
|
}
|
|
|
|
SObjectSounds CObjectClassesHandler::getObjectSounds(MapObjectID type, MapObjectSubID subtype) const
|
|
{
|
|
// TODO: these objects may have subID's that does not have associated handler:
|
|
// Prison: uses hero type as subID
|
|
// Hero: uses hero type as subID, but registers hero classes as subtypes
|
|
// Spell scroll: uses spell ID as subID
|
|
if(type == Obj::PRISON || type == Obj::HERO || type == Obj::SPELL_SCROLL)
|
|
subtype = 0;
|
|
|
|
if(objects.at(type.getNum()))
|
|
return getHandlerFor(type, subtype)->getSounds();
|
|
else
|
|
return objects.front()->objects.front()->getSounds();
|
|
}
|
|
|
|
std::string CObjectClassesHandler::getObjectHandlerName(MapObjectID type) const
|
|
{
|
|
if (objects.at(type.getNum()))
|
|
return objects.at(type.getNum())->handlerName;
|
|
else
|
|
return objects.front()->handlerName;
|
|
}
|
|
|
|
std::string CObjectClassesHandler::getJsonKey(MapObjectID type) const
|
|
{
|
|
if (objects.at(type.getNum()) != nullptr)
|
|
return objects.at(type.getNum())->getJsonKey();
|
|
|
|
logGlobal->warn("Unknown object of type %d!", type);
|
|
return objects.front()->getJsonKey();
|
|
}
|
|
|
|
VCMI_LIB_NAMESPACE_END
|