1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-22 22:13:35 +02:00
vcmi/lib/rewardable/Info.cpp
Ivan Savenko b85ccccb37 Minor refactoring of translations:
- removed unsuccessful and broken validation of translations
- pass JsonNode when registering strings to provide information on mod
source
2024-10-06 19:42:15 +00:00

540 lines
18 KiB
C++

/*
* Info.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 "Info.h"
#include "Configuration.h"
#include "Limiter.h"
#include "Reward.h"
#include "../texts/CGeneralTextHandler.h"
#include "../IGameCallback.h"
#include "../json/JsonRandom.h"
#include "../mapObjects/IObjectInterface.h"
#include "../modding/IdentifierStorage.h"
#include <vstd/RNG.h>
VCMI_LIB_NAMESPACE_BEGIN
namespace {
MetaString loadMessage(const JsonNode & value, const TextIdentifier & textIdentifier, EMetaText textSource = EMetaText::ADVOB_TXT )
{
MetaString ret;
if (value.isVector())
{
for(const auto & entry : value.Vector())
{
if (entry.isNumber())
ret.appendLocalString(textSource, static_cast<ui32>(entry.Float()));
if (entry.isString())
ret.appendRawString(entry.String());
}
return ret;
}
if (value.isNumber())
{
ret.appendLocalString(textSource, static_cast<ui32>(value.Float()));
return ret;
}
if (value.String().empty())
return ret;
if (value.String()[0] == '@')
ret.appendTextID(value.String().substr(1));
else
ret.appendTextID(textIdentifier.get());
return ret;
}
bool testForKey(const JsonNode & value, const std::string & key)
{
for(const auto & reward : value["rewards"].Vector())
{
if (!reward[key].isNull())
return true;
}
return false;
}
}
void Rewardable::Info::init(const JsonNode & objectConfig, const std::string & objectName)
{
objectTextID = objectName;
auto loadString = [&](const JsonNode & entry, const TextIdentifier & textID){
if (entry.isString() && !entry.String().empty() && entry.String()[0] != '@')
VLC->generaltexth->registerString(entry.getModScope(), textID, entry);
};
parameters = objectConfig;
for(size_t i = 0; i < parameters["rewards"].Vector().size(); ++i)
{
const JsonNode message = parameters["rewards"][i]["message"];
loadString(message, TextIdentifier(objectName, "rewards", i));
}
for(size_t i = 0; i < parameters["onVisited"].Vector().size(); ++i)
{
const JsonNode message = parameters["onVisited"][i]["message"];
loadString(message, TextIdentifier(objectName, "onVisited", i));
}
for(size_t i = 0; i < parameters["onEmpty"].Vector().size(); ++i)
{
const JsonNode message = parameters["onEmpty"][i]["message"];
loadString(message, TextIdentifier(objectName, "onEmpty", i));
}
loadString(parameters["onSelectMessage"], TextIdentifier(objectName, "onSelect"));
loadString(parameters["description"], TextIdentifier(objectName, "description"));
loadString(parameters["notVisitedTooltip"], TextIdentifier(objectName, "notVisitedText"));
loadString(parameters["visitedTooltip"], TextIdentifier(objectName, "visitedTooltip"));
loadString(parameters["onVisitedMessage"], TextIdentifier(objectName, "onVisited"));
loadString(parameters["onEmptyMessage"], TextIdentifier(objectName, "onEmpty"));
loadString(parameters["onGuardedMessage"], TextIdentifier(objectName, "onGuarded"));
}
Rewardable::LimitersList Rewardable::Info::configureSublimiters(Rewardable::Configuration & object, vstd::RNG & rng, IGameCallback * cb, const JsonNode & source) const
{
Rewardable::LimitersList result;
for (const auto & input : source.Vector())
{
auto newLimiter = std::make_shared<Rewardable::Limiter>();
configureLimiter(object, rng, cb, *newLimiter, input);
result.push_back(newLimiter);
}
return result;
}
void Rewardable::Info::configureLimiter(Rewardable::Configuration & object, vstd::RNG & rng, IGameCallback * cb, Rewardable::Limiter & limiter, const JsonNode & source) const
{
auto const & variables = object.variables.values;
JsonRandom randomizer(cb);
limiter.dayOfWeek = randomizer.loadValue(source["dayOfWeek"], rng, variables);
limiter.daysPassed = randomizer.loadValue(source["daysPassed"], rng, variables);
limiter.heroExperience = randomizer.loadValue(source["heroExperience"], rng, variables);
limiter.heroLevel = randomizer.loadValue(source["heroLevel"], rng, variables);
limiter.canLearnSkills = source["canLearnSkills"].Bool();
limiter.manaPercentage = randomizer.loadValue(source["manaPercentage"], rng, variables);
limiter.manaPoints = randomizer.loadValue(source["manaPoints"], rng, variables);
limiter.resources = randomizer.loadResources(source["resources"], rng, variables);
limiter.primary = randomizer.loadPrimaries(source["primary"], rng, variables);
limiter.secondary = randomizer.loadSecondaries(source["secondary"], rng, variables);
limiter.artifacts = randomizer.loadArtifacts(source["artifacts"], rng, variables);
limiter.spells = randomizer.loadSpells(source["spells"], rng, variables);
limiter.canLearnSpells = randomizer.loadSpells(source["canLearnSpells"], rng, variables);
limiter.creatures = randomizer.loadCreatures(source["creatures"], rng, variables);
limiter.players = randomizer.loadColors(source["colors"], rng, variables);
limiter.heroes = randomizer.loadHeroes(source["heroes"], rng);
limiter.heroClasses = randomizer.loadHeroClasses(source["heroClasses"], rng);
limiter.allOf = configureSublimiters(object, rng, cb, source["allOf"] );
limiter.anyOf = configureSublimiters(object, rng, cb, source["anyOf"] );
limiter.noneOf = configureSublimiters(object, rng, cb, source["noneOf"] );
}
void Rewardable::Info::configureReward(Rewardable::Configuration & object, vstd::RNG & rng, IGameCallback * cb, Rewardable::Reward & reward, const JsonNode & source) const
{
auto const & variables = object.variables.values;
JsonRandom randomizer(cb);
reward.resources = randomizer.loadResources(source["resources"], rng, variables);
reward.heroExperience = randomizer.loadValue(source["heroExperience"], rng, variables);
reward.heroLevel = randomizer.loadValue(source["heroLevel"], rng, variables);
reward.manaDiff = randomizer.loadValue(source["manaPoints"], rng, variables);
reward.manaOverflowFactor = randomizer.loadValue(source["manaOverflowFactor"], rng, variables);
reward.manaPercentage = randomizer.loadValue(source["manaPercentage"], rng, variables, -1);
reward.movePoints = randomizer.loadValue(source["movePoints"], rng, variables);
reward.movePercentage = randomizer.loadValue(source["movePercentage"], rng, variables, -1);
reward.removeObject = source["removeObject"].Bool();
reward.bonuses = randomizer.loadBonuses(source["bonuses"]);
reward.guards = randomizer.loadCreatures(source["guards"], rng, variables);
reward.primary = randomizer.loadPrimaries(source["primary"], rng, variables);
reward.secondary = randomizer.loadSecondaries(source["secondary"], rng, variables);
reward.artifacts = randomizer.loadArtifacts(source["artifacts"], rng, variables);
reward.spells = randomizer.loadSpells(source["spells"], rng, variables);
reward.creatures = randomizer.loadCreatures(source["creatures"], rng, variables);
if(!source["spellCast"].isNull() && source["spellCast"].isStruct())
{
reward.spellCast.first = randomizer.loadSpell(source["spellCast"]["spell"], rng, variables);
reward.spellCast.second = source["spellCast"]["schoolLevel"].Integer();
}
if (!source["revealTiles"].isNull())
{
auto const & entry = source["revealTiles"];
reward.revealTiles = RewardRevealTiles();
reward.revealTiles->radius = randomizer.loadValue(entry["radius"], rng, variables);
reward.revealTiles->hide = entry["hide"].Bool();
reward.revealTiles->scoreSurface = randomizer.loadValue(entry["surface"], rng, variables);
reward.revealTiles->scoreSubterra = randomizer.loadValue(entry["subterra"], rng, variables);
reward.revealTiles->scoreWater = randomizer.loadValue(entry["water"], rng, variables);
reward.revealTiles->scoreRock = randomizer.loadValue(entry["rock"], rng, variables);
}
for ( auto node : source["changeCreatures"].Struct() )
{
CreatureID from(VLC->identifiers()->getIdentifier(node.second.getModScope(), "creature", node.first).value());
CreatureID dest(VLC->identifiers()->getIdentifier(node.second.getModScope(), "creature", node.second.String()).value());
reward.extraComponents.emplace_back(ComponentType::CREATURE, dest);
reward.creaturesChange[from] = dest;
}
}
void Rewardable::Info::configureResetInfo(Rewardable::Configuration & object, vstd::RNG & rng, Rewardable::ResetInfo & resetParameters, const JsonNode & source) const
{
resetParameters.period = static_cast<ui32>(source["period"].Float());
resetParameters.visitors = source["visitors"].Bool();
resetParameters.rewards = source["rewards"].Bool();
}
void Rewardable::Info::configureVariables(Rewardable::Configuration & object, vstd::RNG & rng, IGameCallback * cb, const JsonNode & source) const
{
JsonRandom randomizer(cb);
for(const auto & category : source.Struct())
{
for(const auto & entry : category.second.Struct())
{
JsonNode preset = object.getPresetVariable(category.first, entry.first);
const JsonNode & input = preset.isNull() ? entry.second : preset;
int32_t value = -1;
if (category.first == "number")
value = randomizer.loadValue(input, rng, object.variables.values);
if (category.first == "artifact")
value = randomizer.loadArtifact(input, rng, object.variables.values).getNum();
if (category.first == "spell")
value = randomizer.loadSpell(input, rng, object.variables.values).getNum();
if (category.first == "primarySkill")
value = randomizer.loadPrimary(input, rng, object.variables.values).getNum();
if (category.first == "secondarySkill")
value = randomizer.loadSecondary(input, rng, object.variables.values).getNum();
object.initVariable(category.first, entry.first, value);
}
}
}
void Rewardable::Info::replaceTextPlaceholders(MetaString & target, const Variables & variables) const
{
for (const auto & variable : variables.values )
{
if( boost::algorithm::starts_with(variable.first, "spell"))
target.replaceName(SpellID(variable.second));
if( boost::algorithm::starts_with(variable.first, "secondarySkill"))
target.replaceName(SecondarySkill(variable.second));
}
}
void Rewardable::Info::replaceTextPlaceholders(MetaString & target, const Variables & variables, const VisitInfo & info) const
{
if (!info.reward.guards.empty())
{
replaceTextPlaceholders(target, variables);
CreatureID strongest = info.reward.guards.at(0).getId();
for (const auto & guard : info.reward.guards )
{
if (strongest.toEntity(VLC)->getFightValue() < guard.getId().toEntity(VLC)->getFightValue())
strongest = guard.getId();
}
target.replaceNamePlural(strongest); // FIXME: use singular if only 1 such unit is in guards
MetaString loot;
for (GameResID it : GameResID::ALL_RESOURCES())
{
if (info.reward.resources[it] != 0)
{
loot.appendRawString("%d %s");
loot.replaceNumber(info.reward.resources[it]);
loot.replaceName(it);
}
}
for (const auto & artifact : info.reward.artifacts )
{
loot.appendRawString("%s");
loot.replaceName(artifact);
}
for (const auto & spell : info.reward.spells )
{
loot.appendRawString("%s");
loot.replaceName(spell);
}
for (const auto & secondary : info.reward.secondary )
{
loot.appendRawString("%s");
loot.replaceName(secondary.first);
}
target.replaceRawString(loot.buildList());
}
else
{
for (const auto & artifact : info.reward.artifacts )
target.replaceName(artifact);
for (const auto & spell : info.reward.spells )
target.replaceName(spell);
for (const auto & secondary : info.reward.secondary )
target.replaceName(secondary.first);
replaceTextPlaceholders(target, variables);
}
}
void Rewardable::Info::configureRewards(
Rewardable::Configuration & object,
vstd::RNG & rng,
IGameCallback * cb,
const JsonNode & source,
Rewardable::EEventType event,
const std::string & modeName) const
{
for(size_t i = 0; i < source.Vector().size(); ++i)
{
const JsonNode & reward = source.Vector().at(i);
if (!reward["appearChance"].isNull())
{
const JsonNode & chance = reward["appearChance"];
std::string diceID = std::to_string(chance["dice"].Integer());
auto diceValue = object.getVariable("dice", diceID);
if (!diceValue.has_value())
{
const JsonNode & preset = object.getPresetVariable("dice", diceID);
if (preset.isNull())
object.initVariable("dice", diceID, rng.nextInt(0, 99));
else
object.initVariable("dice", diceID, preset.Integer());
diceValue = object.getVariable("dice", diceID);
}
assert(diceValue.has_value());
if (!chance["min"].isNull())
{
int min = static_cast<int>(chance["min"].Float());
if (min > *diceValue)
continue;
}
if (!chance["max"].isNull())
{
int max = static_cast<int>(chance["max"].Float());
if (max <= *diceValue)
continue;
}
}
Rewardable::VisitInfo info;
configureLimiter(object, rng, cb, info.limiter, reward["limiter"]);
configureReward(object, rng, cb, info.reward, reward);
info.visitType = event;
info.message = loadMessage(reward["message"], TextIdentifier(objectTextID, modeName, i));
info.description = loadMessage(reward["description"], TextIdentifier(objectTextID, "description", modeName, i), EMetaText::GENERAL_TXT);
replaceTextPlaceholders(info.message, object.variables, info);
replaceTextPlaceholders(info.description, object.variables, info);
object.info.push_back(info);
}
}
void Rewardable::Info::configureObject(Rewardable::Configuration & object, vstd::RNG & rng, IGameCallback * cb) const
{
object.info.clear();
object.variables.values.clear();
configureVariables(object, rng, cb, parameters["variables"]);
configureRewards(object, rng, cb, parameters["rewards"], Rewardable::EEventType::EVENT_FIRST_VISIT, "rewards");
configureRewards(object, rng, cb, parameters["onVisited"], Rewardable::EEventType::EVENT_ALREADY_VISITED, "onVisited");
configureRewards(object, rng, cb, parameters["onEmpty"], Rewardable::EEventType::EVENT_NOT_AVAILABLE, "onEmpty");
object.onSelect = loadMessage(parameters["onSelectMessage"], TextIdentifier(objectTextID, "onSelect"));
object.description = loadMessage(parameters["description"], TextIdentifier(objectTextID, "description"));
object.notVisitedTooltip = loadMessage(parameters["notVisitedTooltip"], TextIdentifier(objectTextID, "notVisitedTooltip"), EMetaText::GENERAL_TXT);
object.visitedTooltip = loadMessage(parameters["visitedTooltip"], TextIdentifier(objectTextID, "visitedTooltip"), EMetaText::GENERAL_TXT);
if (object.notVisitedTooltip.empty())
object.notVisitedTooltip.appendTextID("core.genrltxt.353");
if (object.visitedTooltip.empty())
object.visitedTooltip.appendTextID("core.genrltxt.352");
if (!parameters["onVisitedMessage"].isNull())
{
Rewardable::VisitInfo onVisited;
onVisited.visitType = Rewardable::EEventType::EVENT_ALREADY_VISITED;
onVisited.message = loadMessage(parameters["onVisitedMessage"], TextIdentifier(objectTextID, "onVisited"));
replaceTextPlaceholders(onVisited.message, object.variables);
object.info.push_back(onVisited);
}
if (!parameters["onEmptyMessage"].isNull())
{
Rewardable::VisitInfo onEmpty;
onEmpty.visitType = Rewardable::EEventType::EVENT_NOT_AVAILABLE;
onEmpty.message = loadMessage(parameters["onEmptyMessage"], TextIdentifier(objectTextID, "onEmpty"));
replaceTextPlaceholders(onEmpty.message, object.variables);
object.info.push_back(onEmpty);
}
if (!parameters["onGuardedMessage"].isNull())
{
Rewardable::VisitInfo onGuarded;
onGuarded.visitType = Rewardable::EEventType::EVENT_GUARDED;
onGuarded.message = loadMessage(parameters["onGuardedMessage"], TextIdentifier(objectTextID, "onGuarded"));
replaceTextPlaceholders(onGuarded.message, object.variables);
object.info.push_back(onGuarded);
}
configureResetInfo(object, rng, object.resetParameters, parameters["resetParameters"]);
object.canRefuse = parameters["canRefuse"].Bool();
object.showScoutedPreview = parameters["showScoutedPreview"].Bool();
object.guardsLayout = parameters["guardsLayout"].String();
object.coastVisitable = parameters["coastVisitable"].Bool();
if(parameters["showInInfobox"].isNull())
object.infoWindowType = EInfoWindowMode::AUTO;
else
object.infoWindowType = parameters["showInInfobox"].Bool() ? EInfoWindowMode::INFO : EInfoWindowMode::MODAL;
auto visitMode = parameters["visitMode"].String();
for(int i = 0; i < Rewardable::VisitModeString.size(); ++i)
{
if(Rewardable::VisitModeString[i] == visitMode)
{
object.visitMode = i;
break;
}
}
auto selectMode = parameters["selectMode"].String();
for(int i = 0; i < Rewardable::SelectModeString.size(); ++i)
{
if(Rewardable::SelectModeString[i] == selectMode)
{
object.selectMode = i;
break;
}
}
if (object.visitMode == Rewardable::VISIT_LIMITER)
configureLimiter(object, rng, cb, object.visitLimiter, parameters["visitLimiter"]);
}
bool Rewardable::Info::givesResources() const
{
return testForKey(parameters, "resources");
}
bool Rewardable::Info::givesExperience() const
{
return testForKey(parameters, "gainedExp") || testForKey(parameters, "gainedLevels");
}
bool Rewardable::Info::givesMana() const
{
return testForKey(parameters, "manaPoints") || testForKey(parameters, "manaPercentage");
}
bool Rewardable::Info::givesMovement() const
{
return testForKey(parameters, "movePoints") || testForKey(parameters, "movePercentage");
}
bool Rewardable::Info::givesPrimarySkills() const
{
return testForKey(parameters, "primary");
}
bool Rewardable::Info::givesSecondarySkills() const
{
return testForKey(parameters, "secondary");
}
bool Rewardable::Info::givesArtifacts() const
{
return testForKey(parameters, "artifacts");
}
bool Rewardable::Info::givesCreatures() const
{
return testForKey(parameters, "spells");
}
bool Rewardable::Info::givesSpells() const
{
return testForKey(parameters, "creatures");
}
bool Rewardable::Info::givesBonuses() const
{
return testForKey(parameters, "bonuses");
}
bool Rewardable::Info::hasGuards() const
{
return testForKey(parameters, "guards");
}
const JsonNode & Rewardable::Info::getParameters() const
{
return parameters;
}
VCMI_LIB_NAMESPACE_END