/* * CObjectHandler.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 "CGObjectInstance.h" #include "CGHeroInstance.h" #include "ObjectTemplate.h" #include "../gameState/CGameState.h" #include "../texts/CGeneralTextHandler.h" #include "../IGameCallback.h" #include "../constants/StringConstants.h" #include "../TerrainHandler.h" #include "../mapObjectConstructors/AObjectTypeHandler.h" #include "../mapObjectConstructors/CObjectClassesHandler.h" #include "../mapping/CMap.h" #include "../networkPacks/PacksForClient.h" #include "../serializer/JsonSerializeFormat.h" #include VCMI_LIB_NAMESPACE_BEGIN //TODO: remove constructor CGObjectInstance::CGObjectInstance(IGameCallback *cb): IObjectInterface(cb), pos(-1,-1,-1), ID(Obj::NO_OBJ), subID(-1), tempOwner(PlayerColor::UNFLAGGABLE), blockVisit(false), removable(false) { } //must be instantiated in .cpp file for access to complete types of all member fields CGObjectInstance::~CGObjectInstance() = default; MapObjectID CGObjectInstance::getObjGroupIndex() const { return ID; } MapObjectSubID CGObjectInstance::getObjTypeIndex() const { return subID; } int3 CGObjectInstance::anchorPos() const { return pos; } int3 CGObjectInstance::getTopVisiblePos() const { return anchorPos() - appearance->getTopVisibleOffset(); } void CGObjectInstance::setOwner(const PlayerColor & ow) { tempOwner = ow; } void CGObjectInstance::setAnchorPos(int3 newPos) { pos = newPos; } int CGObjectInstance::getWidth() const { return appearance->getWidth(); } int CGObjectInstance::getHeight() const { return appearance->getHeight(); } bool CGObjectInstance::visitableAt(const int3 & testPos) const { return anchorPos().z == testPos.z && appearance->isVisitableAt(anchorPos().x - testPos.x, anchorPos().y - testPos.y); } bool CGObjectInstance::blockingAt(const int3 & testPos) const { return anchorPos().z == testPos.z && appearance->isBlockedAt(anchorPos().x - testPos.x, anchorPos().y - testPos.y); } bool CGObjectInstance::coveringAt(const int3 & testPos) const { return anchorPos().z == testPos.z && appearance->isVisibleAt(anchorPos().x - testPos.x, anchorPos().y - testPos.y); } std::set CGObjectInstance::getBlockedPos() const { std::set ret; for(int w=0; wisBlockedAt(w, h)) ret.insert(int3(anchorPos().x - w, anchorPos().y - h, anchorPos().z)); } } return ret; } const std::set & CGObjectInstance::getBlockedOffsets() const { return appearance->getBlockedOffsets(); } void CGObjectInstance::setType(MapObjectID newID, MapObjectSubID newSubID) { auto position = visitablePos(); auto oldOffset = getVisitableOffset(); auto &tile = cb->gameState()->map->getTile(position); //recalculate blockvis tiles - new appearance might have different blockmap than before cb->gameState()->map->removeBlockVisTiles(this, true); auto handler = VLC->objtypeh->getHandlerFor(newID, newSubID); if(!handler->getTemplates(tile.getTerrainID()).empty()) { appearance = handler->getTemplates(tile.getTerrainID())[0]; } else { logGlobal->warn("Object %d:%d at %s has no templates suitable for terrain %s", newID, newSubID, visitablePos().toString(), tile.getTerrain()->getNameTranslated()); appearance = handler->getTemplates()[0]; // get at least some appearance since alternative is crash } bool needToAdjustOffset = false; // FIXME: potentially unused code - setType is NOT called when releasing hero from prison // instead, appearance update & pos adjustment occurs in GiveHero::applyGs needToAdjustOffset |= this->ID == Obj::PRISON && newID == Obj::HERO; needToAdjustOffset |= newID == Obj::MONSTER; if(needToAdjustOffset) { // adjust position since object visitable offset might have changed auto newOffset = getVisitableOffset(); pos = pos - oldOffset + newOffset; } this->ID = Obj(newID); this->subID = newSubID; cb->gameState()->map->addBlockVisTiles(this); } void CGObjectInstance::pickRandomObject(vstd::RNG & rand) { // no-op } void CGObjectInstance::initObj(vstd::RNG & rand) { // no-op } void CGObjectInstance::setProperty( ObjProperty what, ObjPropertyID identifier ) { setPropertyDer(what, identifier); // call this before any actual changes (needed at least for dwellings) switch(what) { case ObjProperty::OWNER: tempOwner = identifier.as(); break; case ObjProperty::BLOCKVIS: // Never actually used in code, but possible in ERM blockVisit = identifier.getNum(); break; case ObjProperty::ID: ID = identifier.as(); break; } } TObjectTypeHandler CGObjectInstance::getObjectHandler() const { return VLC->objtypeh->getHandlerFor(ID, subID); } std::string CGObjectInstance::getTypeName() const { return getObjectHandler()->getTypeName(); } std::string CGObjectInstance::getSubtypeName() const { return getObjectHandler()->getSubTypeName(); } void CGObjectInstance::setPropertyDer( ObjProperty what, ObjPropertyID identifier ) {} int3 CGObjectInstance::getSightCenter() const { return visitablePos(); } int CGObjectInstance::getSightRadius() const { return 3; } int3 CGObjectInstance::getVisitableOffset() const { if (!isVisitable()) logGlobal->debug("Attempt to access visitable offset on a non-visitable object!"); return appearance->getVisitableOffset(); } void CGObjectInstance::giveDummyBonus(const ObjectInstanceID & heroID, BonusDuration::Type duration) const { GiveBonus gbonus; gbonus.bonus.type = BonusType::NONE; gbonus.id = heroID; gbonus.bonus.duration = duration; gbonus.bonus.source = BonusSource::OBJECT_TYPE; gbonus.bonus.sid = BonusSourceID(ID); cb->giveHeroBonus(&gbonus); } std::string CGObjectInstance::getObjectName() const { return VLC->objtypeh->getObjectName(ID, subID); } std::optional CGObjectInstance::getAmbientSound(vstd::RNG & rng) const { const auto & sounds = VLC->objtypeh->getObjectSounds(ID, subID).ambient; if(!sounds.empty()) return sounds.front(); // TODO: Support randomization of ambient sounds return std::nullopt; } std::optional CGObjectInstance::getVisitSound(vstd::RNG & rng) const { const auto & sounds = VLC->objtypeh->getObjectSounds(ID, subID).visit; if(!sounds.empty()) return *RandomGeneratorUtil::nextItem(sounds, rng); return std::nullopt; } std::optional CGObjectInstance::getRemovalSound(vstd::RNG & rng) const { const auto & sounds = VLC->objtypeh->getObjectSounds(ID, subID).removal; if(!sounds.empty()) return *RandomGeneratorUtil::nextItem(sounds, rng); return std::nullopt; } std::string CGObjectInstance::getHoverText(PlayerColor player) const { auto text = getObjectName(); if (tempOwner.isValidPlayer()) text += "\n" + VLC->generaltexth->arraytxt[23 + tempOwner.getNum()]; return text; } std::string CGObjectInstance::getHoverText(const CGHeroInstance * hero) const { return getHoverText(hero->tempOwner); } std::string CGObjectInstance::getPopupText(PlayerColor player) const { return getHoverText(player); } std::string CGObjectInstance::getPopupText(const CGHeroInstance * hero) const { return getHoverText(hero); } std::vector CGObjectInstance::getPopupComponents(PlayerColor player) const { return {}; } std::vector CGObjectInstance::getPopupComponents(const CGHeroInstance * hero) const { return getPopupComponents(hero->getOwner()); } void CGObjectInstance::onHeroVisit( const CGHeroInstance * h ) const { switch(ID.toEnum()) { case Obj::SANCTUARY: { //You enter the sanctuary and immediately feel as if a great weight has been lifted off your shoulders. You feel safe here. h->showInfoDialog(114); } break; case Obj::TAVERN: { cb->showObjectWindow(this, EOpenWindowMode::TAVERN_WINDOW, h, true); } break; } } int3 CGObjectInstance::visitablePos() const { if (!isVisitable()) logGlobal->debug("Attempt to access visitable position on a non-visitable object!"); return pos - getVisitableOffset(); } bool CGObjectInstance::isVisitable() const { return appearance->isVisitable(); } bool CGObjectInstance::isBlockedVisitable() const { // TODO: Read from json return blockVisit; } bool CGObjectInstance::isRemovable() const { // TODO: Read from json return removable; } bool CGObjectInstance::isCoastVisitable() const { return false; } bool CGObjectInstance::passableFor(PlayerColor color) const { return false; } void CGObjectInstance::updateFrom(const JsonNode & data) { } void CGObjectInstance::serializeJson(JsonSerializeFormat & handler) { //only save here, loading is handled by map loader if(handler.saving) { std::string ourTypeName = getTypeName(); std::string ourSubtypeName = getSubtypeName(); handler.serializeString("type", ourTypeName); handler.serializeString("subtype", ourSubtypeName); handler.serializeInt("x", pos.x); handler.serializeInt("y", pos.y); handler.serializeInt("l", pos.z); JsonNode app; appearance->writeJson(app, false); handler.serializeRaw("template", app, std::nullopt); } { auto options = handler.enterStruct("options"); serializeJsonOptions(handler); } } void CGObjectInstance::afterAddToMap(CMap * map) { //nothing here } void CGObjectInstance::afterRemoveFromMap(CMap * map) { //nothing here } void CGObjectInstance::serializeJsonOptions(JsonSerializeFormat & handler) { //nothing here } void CGObjectInstance::serializeJsonOwner(JsonSerializeFormat & handler) { handler.serializeId("owner", tempOwner, PlayerColor::NEUTRAL); } BattleField CGObjectInstance::getBattlefield() const { return VLC->objtypeh->getHandlerFor(ID, subID)->getBattlefield(); } const IOwnableObject * CGObjectInstance::asOwnable() const { return nullptr; } VCMI_LIB_NAMESPACE_END