1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-01-10 15:39:02 +00:00
OpenMW/apps/openmw/mwdialogue/dialoguemanagerimp.cpp
elsid b5ec584be2
Replace ESM::RefId::sEmpty by default constructed RefId where possible
Static const is only required to provide a reference or a pointer when it is not
possible with default constructed temporary.
2023-02-18 01:07:15 +01:00

762 lines
26 KiB
C++

#include "dialoguemanagerimp.hpp"
#include <algorithm>
#include <list>
#include <optional>
#include <sstream>
#include <components/debug/debuglog.hpp>
#include <components/esm3/dialoguestate.hpp>
#include <components/esm3/esmwriter.hpp>
#include <components/esm3/loaddial.hpp>
#include <components/esm3/loadfact.hpp>
#include <components/esm3/loadinfo.hpp>
#include <components/compiler/errorhandler.hpp>
#include <components/compiler/exception.hpp>
#include <components/compiler/locals.hpp>
#include <components/compiler/output.hpp>
#include <components/compiler/scanner.hpp>
#include <components/compiler/scriptparser.hpp>
#include <components/interpreter/defines.hpp>
#include <components/interpreter/interpreter.hpp>
#include <components/settings/settings.hpp>
#include "../mwbase/environment.hpp"
#include "../mwbase/journal.hpp"
#include "../mwbase/mechanicsmanager.hpp"
#include "../mwbase/scriptmanager.hpp"
#include "../mwbase/soundmanager.hpp"
#include "../mwbase/windowmanager.hpp"
#include "../mwbase/world.hpp"
#include "../mwworld/class.hpp"
#include "../mwworld/containerstore.hpp"
#include "../mwworld/esmstore.hpp"
#include "../mwscript/compilercontext.hpp"
#include "../mwscript/extensions.hpp"
#include "../mwscript/interpretercontext.hpp"
#include "../mwmechanics/actorutil.hpp"
#include "../mwmechanics/creaturestats.hpp"
#include "../mwmechanics/npcstats.hpp"
#include "filter.hpp"
#include "hypertextparser.hpp"
namespace MWDialogue
{
DialogueManager::DialogueManager(
const Compiler::Extensions& extensions, Translation::Storage& translationDataStorage)
: mTranslationDataStorage(translationDataStorage)
, mCompilerContext(MWScript::CompilerContext::Type_Dialogue)
, mErrorHandler()
, mTalkedTo(false)
, mOriginalDisposition(0)
, mCurrentDisposition(0)
, mPermanentDispositionChange(0)
{
mChoice = -1;
mIsInChoice = false;
mGoodbye = false;
mCompilerContext.setExtensions(&extensions);
}
void DialogueManager::clear()
{
mKnownTopics.clear();
mTalkedTo = false;
mOriginalDisposition = 0;
mCurrentDisposition = 0;
mPermanentDispositionChange = 0;
}
void DialogueManager::addTopic(const ESM::RefId& topic)
{
mKnownTopics.insert(topic);
}
std::vector<ESM::RefId> DialogueManager::parseTopicIdsFromText(const std::string& text)
{
std::vector<ESM::RefId> topicIdList;
std::vector<HyperTextParser::Token> hypertext = HyperTextParser::parseHyperText(text);
for (std::vector<HyperTextParser::Token>::iterator tok = hypertext.begin(); tok != hypertext.end(); ++tok)
{
std::string topicId = Misc::StringUtils::lowerCase(tok->mText);
if (tok->isExplicitLink())
{
// calculation of standard form for all hyperlinks
size_t asterisk_count = HyperTextParser::removePseudoAsterisks(topicId);
for (; asterisk_count > 0; --asterisk_count)
topicId.append("*");
topicId = mTranslationDataStorage.topicStandardForm(topicId);
}
topicIdList.push_back(ESM::RefId::stringRefId(topicId));
}
return topicIdList;
}
void DialogueManager::addTopicsFromText(const std::string& text)
{
updateActorKnownTopics();
for (const auto& topicId : parseTopicIdsFromText(text))
{
if (mActorKnownTopics.count(topicId))
mKnownTopics.insert(topicId);
}
}
void DialogueManager::updateOriginalDisposition()
{
if (mActor.getClass().isNpc())
{
const auto& stats = mActor.getClass().getNpcStats(mActor);
// Disposition changed by script; discard our preconceived notions
if (stats.getBaseDisposition() != mCurrentDisposition)
{
mCurrentDisposition = stats.getBaseDisposition();
mOriginalDisposition = mCurrentDisposition;
}
}
}
bool DialogueManager::startDialogue(const MWWorld::Ptr& actor, ResponseCallback* callback)
{
updateGlobals();
// Dialogue with dead actor (e.g. through script) should not be allowed.
if (actor.getClass().getCreatureStats(actor).isDead())
return false;
mLastTopic = ESM::RefId();
// Note that we intentionally don't reset mPermanentDispositionChange
mChoice = -1;
mIsInChoice = false;
mGoodbye = false;
mChoices.clear();
mActor = actor;
MWMechanics::CreatureStats& creatureStats = actor.getClass().getCreatureStats(actor);
mTalkedTo = creatureStats.hasTalkedToPlayer();
mActorKnownTopics.clear();
// greeting
const MWWorld::Store<ESM::Dialogue>& dialogs
= MWBase::Environment::get().getWorld()->getStore().get<ESM::Dialogue>();
Filter filter(actor, mChoice, mTalkedTo);
for (MWWorld::Store<ESM::Dialogue>::iterator it = dialogs.begin(); it != dialogs.end(); ++it)
{
if (it->mType == ESM::Dialogue::Greeting)
{
// Search a response (we do not accept a fallback to "Info refusal" here)
if (const ESM::DialInfo* info = filter.search(*it, false))
{
creatureStats.talkedToPlayer();
if (!info->mSound.empty())
{
// TODO play sound
}
MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
callback->addResponse("", Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
executeScript(info->mResultScript, mActor);
mLastTopic = it->mId;
addTopicsFromText(info->mResponse);
return true;
}
}
}
return false;
}
std::optional<Interpreter::Program> DialogueManager::compile(const std::string& cmd, const MWWorld::Ptr& actor)
{
bool success = true;
std::optional<Interpreter::Program> program;
try
{
mErrorHandler.reset();
mErrorHandler.setContext("[dialogue script]");
std::istringstream input(cmd + "\n");
Compiler::Scanner scanner(mErrorHandler, input, mCompilerContext.getExtensions());
Compiler::Locals locals;
const ESM::RefId& actorScript = actor.getClass().getScript(actor);
if (!actorScript.empty())
{
// grab local variables from actor's script, if available.
locals = MWBase::Environment::get().getScriptManager()->getLocals(actorScript);
}
Compiler::ScriptParser parser(mErrorHandler, mCompilerContext, locals, false);
scanner.scan(parser);
if (!mErrorHandler.isGood())
success = false;
if (success)
program = parser.getProgram();
}
catch (const Compiler::SourceException& /* error */)
{
// error has already been reported via error handler
success = false;
}
catch (const std::exception& error)
{
Log(Debug::Error) << std::string("Dialogue error: An exception has been thrown: ") + error.what();
success = false;
}
if (!success)
{
Log(Debug::Error) << "Error: compiling failed (dialogue script): \n" << cmd << "\n";
}
return program;
}
void DialogueManager::executeScript(const std::string& script, const MWWorld::Ptr& actor)
{
if (const std::optional<Interpreter::Program> program = compile(script, actor))
{
try
{
MWScript::InterpreterContext interpreterContext(&actor.getRefData().getLocals(), actor);
Interpreter::Interpreter interpreter;
MWScript::installOpcodes(interpreter);
interpreter.run(*program, interpreterContext);
}
catch (const std::exception& error)
{
Log(Debug::Error) << std::string("Dialogue error: An exception has been thrown: ") + error.what();
}
}
}
bool DialogueManager::inJournal(const ESM::RefId& topicId, const ESM::RefId& infoId) const
{
const MWDialogue::Topic* topicHistory = nullptr;
MWBase::Journal* journal = MWBase::Environment::get().getJournal();
for (auto it = journal->topicBegin(); it != journal->topicEnd(); ++it)
{
if (it->first == topicId)
{
topicHistory = &it->second;
break;
}
}
if (!topicHistory)
return false;
for (const auto& topic : *topicHistory)
{
if (topic.mInfoId == infoId)
return true;
}
return false;
}
void DialogueManager::executeTopic(const ESM::RefId& topic, ResponseCallback* callback)
{
Filter filter(mActor, mChoice, mTalkedTo);
const MWWorld::Store<ESM::Dialogue>& dialogues
= MWBase::Environment::get().getWorld()->getStore().get<ESM::Dialogue>();
const ESM::Dialogue& dialogue = *dialogues.find(topic);
const ESM::DialInfo* info = filter.search(dialogue, true);
if (info)
{
ESM::RefId title;
if (dialogue.mType == ESM::Dialogue::Persuasion)
{
// Determine GMST from dialogue topic. GMSTs are:
// sAdmireSuccess, sAdmireFail, sIntimidateSuccess, sIntimidateFail,
// sTauntSuccess, sTauntFail, sBribeSuccess, sBribeFail
std::string modifiedTopic = "s" + topic.getRefIdString();
modifiedTopic.erase(std::remove(modifiedTopic.begin(), modifiedTopic.end(), ' '), modifiedTopic.end());
const MWWorld::Store<ESM::GameSetting>& gmsts
= MWBase::Environment::get().getWorld()->getStore().get<ESM::GameSetting>();
title = ESM::RefId::stringRefId(gmsts.find(modifiedTopic)->mValue.getString());
}
else
title = topic;
MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
callback->addResponse(
title.getRefIdString(), Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
if (dialogue.mType == ESM::Dialogue::Topic)
{
// Make sure the returned DialInfo is from the Dialogue we supplied. If could also be from the Info
// refusal group, in which case it should not be added to the journal.
for (ESM::Dialogue::InfoContainer::const_iterator iter = dialogue.mInfo.begin();
iter != dialogue.mInfo.end(); ++iter)
{
if (iter->mId == info->mId)
{
MWBase::Environment::get().getJournal()->addTopic(topic, info->mId, mActor);
break;
}
}
}
mLastTopic = topic;
executeScript(info->mResultScript, mActor);
addTopicsFromText(info->mResponse);
}
}
const ESM::Dialogue* DialogueManager::searchDialogue(const ESM::RefId& id)
{
return MWBase::Environment::get().getWorld()->getStore().get<ESM::Dialogue>().search(id);
}
void DialogueManager::updateGlobals()
{
MWBase::Environment::get().getWorld()->updateDialogueGlobals();
}
void DialogueManager::updateActorKnownTopics()
{
updateGlobals();
mActorKnownTopics.clear();
const auto& dialogs = MWBase::Environment::get().getWorld()->getStore().get<ESM::Dialogue>();
Filter filter(mActor, -1, mTalkedTo);
for (const auto& dialog : dialogs)
{
if (dialog.mType == ESM::Dialogue::Topic)
{
const auto* answer = filter.search(dialog, true);
const auto& topicId = dialog.mId;
if (answer != nullptr)
{
int topicFlags = 0;
if (!inJournal(topicId, answer->mId))
{
// Does this dialogue contains some actor-specific answer?
if (answer->mActor == mActor.getCellRef().getRefId())
topicFlags |= MWBase::DialogueManager::TopicType::Specific;
}
else
topicFlags |= MWBase::DialogueManager::TopicType::Exhausted;
mActorKnownTopics.insert(std::make_pair(dialog.mId, ActorKnownTopicInfo{ topicFlags, answer }));
}
}
}
// If response to a topic leads to a new topic, the original topic is not exhausted.
for (auto& [dialogId, topicInfo] : mActorKnownTopics)
{
// If the topic is not marked as exhausted, we don't need to do anything about it.
// If the topic will not be shown to the player, the flag actually does not matter.
if (!(topicInfo.mFlags & MWBase::DialogueManager::TopicType::Exhausted) || !mKnownTopics.count(dialogId))
continue;
for (const auto& topicId : parseTopicIdsFromText(topicInfo.mInfo->mResponse))
{
if (mActorKnownTopics.count(topicId) && !mKnownTopics.count(topicId))
{
topicInfo.mFlags &= ~MWBase::DialogueManager::TopicType::Exhausted;
break;
}
}
}
}
std::list<std::string> DialogueManager::getAvailableTopics()
{
updateActorKnownTopics();
std::list<std::string> keywordList;
for (const auto& [topic, topicInfo] : mActorKnownTopics)
{
// does the player know the topic?
if (mKnownTopics.count(topic))
keywordList.push_back(topic.getRefIdString());
}
// sort again, because the previous sort was case-sensitive
keywordList.sort(Misc::StringUtils::ciLess);
return keywordList;
}
int DialogueManager::getTopicFlag(const ESM::RefId& topicId) const
{
auto known = mActorKnownTopics.find(topicId);
if (known != mActorKnownTopics.end())
return known->second.mFlags;
return 0;
}
void DialogueManager::keywordSelected(const std::string& keyword, ResponseCallback* callback)
{
if (!mIsInChoice)
{
const ESM::Dialogue* dialogue = searchDialogue(ESM::RefId::stringRefId(keyword));
if (dialogue && dialogue->mType == ESM::Dialogue::Topic)
{
executeTopic(ESM::RefId::stringRefId(keyword), callback);
}
}
}
bool DialogueManager::isInChoice() const
{
return mIsInChoice;
}
void DialogueManager::goodbyeSelected()
{
// Apply disposition change to NPC's base disposition if we **think** we need to change something
if ((mPermanentDispositionChange || mOriginalDisposition != mCurrentDisposition) && mActor.getClass().isNpc())
{
updateOriginalDisposition();
MWMechanics::NpcStats& npcStats = mActor.getClass().getNpcStats(mActor);
// Clamp permanent disposition change so that final disposition doesn't go below 0 (could happen with
// intimidate)
npcStats.setBaseDisposition(0);
int zero = MWBase::Environment::get().getMechanicsManager()->getDerivedDisposition(mActor, false);
int disposition = std::clamp(mOriginalDisposition + mPermanentDispositionChange, -zero, 100 - zero);
npcStats.setBaseDisposition(disposition);
}
mPermanentDispositionChange = 0;
mOriginalDisposition = 0;
mCurrentDisposition = 0;
}
void DialogueManager::questionAnswered(int answer, ResponseCallback* callback)
{
mChoice = answer;
const ESM::Dialogue* dialogue = searchDialogue(mLastTopic);
if (dialogue)
{
Filter filter(mActor, mChoice, mTalkedTo);
if (dialogue->mType == ESM::Dialogue::Topic || dialogue->mType == ESM::Dialogue::Greeting)
{
if (const ESM::DialInfo* info = filter.search(*dialogue, true))
{
std::string text = info->mResponse;
addTopicsFromText(text);
mChoice = -1;
mIsInChoice = false;
mChoices.clear();
MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
callback->addResponse("", Interpreter::fixDefinesDialog(text, interpreterContext));
if (dialogue->mType == ESM::Dialogue::Topic)
{
// Make sure the returned DialInfo is from the Dialogue we supplied. If could also be from the
// Info refusal group, in which case it should not be added to the journal
for (ESM::Dialogue::InfoContainer::const_iterator iter = dialogue->mInfo.begin();
iter != dialogue->mInfo.end(); ++iter)
{
if (iter->mId == info->mId)
{
MWBase::Environment::get().getJournal()->addTopic(mLastTopic, info->mId, mActor);
break;
}
}
}
executeScript(info->mResultScript, mActor);
}
else
{
mChoice = -1;
mIsInChoice = false;
mChoices.clear();
}
}
}
updateActorKnownTopics();
}
void DialogueManager::addChoice(std::string_view text, int choice)
{
mIsInChoice = true;
mChoices.emplace_back(text, choice);
}
const std::vector<std::pair<std::string, int>>& DialogueManager::getChoices() const
{
return mChoices;
}
bool DialogueManager::isGoodbye() const
{
return mGoodbye;
}
void DialogueManager::goodbye()
{
mIsInChoice = false;
mGoodbye = true;
}
void DialogueManager::persuade(int type, ResponseCallback* callback)
{
bool success;
int temp, perm;
MWBase::Environment::get().getMechanicsManager()->getPersuasionDispositionChange(
mActor, MWBase::MechanicsManager::PersuasionType(type), success, temp, perm);
updateOriginalDisposition();
if (temp > 0 && perm > 0 && mOriginalDisposition + perm + mPermanentDispositionChange < 0)
perm = -(mOriginalDisposition + mPermanentDispositionChange);
mCurrentDisposition += temp;
mActor.getClass().getNpcStats(mActor).setBaseDisposition(mCurrentDisposition);
mPermanentDispositionChange += perm;
MWWorld::Ptr player = MWMechanics::getPlayer();
player.getClass().skillUsageSucceeded(player, ESM::Skill::Speechcraft, success ? 0 : 1);
if (success)
{
int gold = 0;
if (type == MWBase::MechanicsManager::PT_Bribe10)
gold = 10;
else if (type == MWBase::MechanicsManager::PT_Bribe100)
gold = 100;
else if (type == MWBase::MechanicsManager::PT_Bribe1000)
gold = 1000;
if (gold)
{
player.getClass().getContainerStore(player).remove(MWWorld::ContainerStore::sGoldId, gold);
mActor.getClass().getContainerStore(mActor).add(MWWorld::ContainerStore::sGoldId, gold);
}
}
std::string text;
if (type == MWBase::MechanicsManager::PT_Admire)
text = "Admire";
else if (type == MWBase::MechanicsManager::PT_Taunt)
text = "Taunt";
else if (type == MWBase::MechanicsManager::PT_Intimidate)
text = "Intimidate";
else
{
text = "Bribe";
}
executeTopic(ESM::RefId::stringRefId(text + (success ? " Success" : " Fail")), callback);
}
void DialogueManager::applyBarterDispositionChange(int delta)
{
if (mActor.getClass().isNpc())
{
updateOriginalDisposition();
mCurrentDisposition += delta;
mActor.getClass().getNpcStats(mActor).setBaseDisposition(mCurrentDisposition);
if (Settings::Manager::getBool("barter disposition change is permanent", "Game"))
mPermanentDispositionChange += delta;
}
}
bool DialogueManager::checkServiceRefused(ResponseCallback* callback, ServiceType service)
{
Filter filter(mActor, service, mTalkedTo);
const MWWorld::Store<ESM::Dialogue>& dialogues
= MWBase::Environment::get().getWorld()->getStore().get<ESM::Dialogue>();
const ESM::Dialogue& dialogue = *dialogues.find(ESM::RefId::stringRefId("Service Refusal"));
std::vector<const ESM::DialInfo*> infos = filter.list(dialogue, false, false, true);
if (!infos.empty())
{
const ESM::DialInfo* info = infos[0];
addTopicsFromText(info->mResponse);
const MWWorld::Store<ESM::GameSetting>& gmsts
= MWBase::Environment::get().getWorld()->getStore().get<ESM::GameSetting>();
MWScript::InterpreterContext interpreterContext(&mActor.getRefData().getLocals(), mActor);
callback->addResponse(gmsts.find("sServiceRefusal")->mValue.getString(),
Interpreter::fixDefinesDialog(info->mResponse, interpreterContext));
executeScript(info->mResultScript, mActor);
return true;
}
return false;
}
void DialogueManager::say(const MWWorld::Ptr& actor, const ESM::RefId& topic)
{
MWBase::SoundManager* sndMgr = MWBase::Environment::get().getSoundManager();
if (sndMgr->sayActive(actor))
{
// Actor is already saying something.
return;
}
if (actor.getClass().isNpc() && MWBase::Environment::get().getWorld()->isSwimming(actor))
{
// NPCs don't talk while submerged
return;
}
if (actor.getClass().getCreatureStats(actor).getKnockedDown())
{
// Unconscious actors can not speak
return;
}
const MWWorld::ESMStore& store = MWBase::Environment::get().getWorld()->getStore();
const ESM::Dialogue* dial = store.get<ESM::Dialogue>().find(topic);
const MWMechanics::CreatureStats& creatureStats = actor.getClass().getCreatureStats(actor);
Filter filter(actor, 0, creatureStats.hasTalkedToPlayer());
const ESM::DialInfo* info = filter.search(*dial, false);
if (info != nullptr)
{
MWBase::WindowManager* winMgr = MWBase::Environment::get().getWindowManager();
if (winMgr->getSubtitlesEnabled())
winMgr->messageBox(info->mResponse);
if (!info->mSound.empty())
sndMgr->say(actor, info->mSound);
if (!info->mResultScript.empty())
executeScript(info->mResultScript, actor);
}
}
int DialogueManager::countSavedGameRecords() const
{
return 1; // known topics
}
void DialogueManager::write(ESM::ESMWriter& writer, Loading::Listener& progress) const
{
ESM::DialogueState state;
state.mKnownTopics.reserve(mKnownTopics.size());
std::copy(mKnownTopics.begin(), mKnownTopics.end(), std::back_inserter(state.mKnownTopics));
state.mChangedFactionReaction = mChangedFactionReaction;
writer.startRecord(ESM::REC_DIAS);
state.save(writer);
writer.endRecord(ESM::REC_DIAS);
}
void DialogueManager::readRecord(ESM::ESMReader& reader, uint32_t type)
{
if (type == ESM::REC_DIAS)
{
const MWWorld::ESMStore& store = MWBase::Environment::get().getWorld()->getStore();
ESM::DialogueState state;
state.load(reader);
for (std::vector<ESM::RefId>::const_iterator iter(state.mKnownTopics.begin());
iter != state.mKnownTopics.end(); ++iter)
if (store.get<ESM::Dialogue>().search(*iter))
mKnownTopics.insert(*iter);
mChangedFactionReaction = state.mChangedFactionReaction;
}
}
void DialogueManager::modFactionReaction(const ESM::RefId& faction1, const ESM::RefId& faction2, int diff)
{
// Make sure the factions exist
MWBase::Environment::get().getWorld()->getStore().get<ESM::Faction>().find(faction1);
MWBase::Environment::get().getWorld()->getStore().get<ESM::Faction>().find(faction2);
int newValue = getFactionReaction(faction1, faction2) + diff;
auto& map = mChangedFactionReaction[faction1];
map[faction2] = newValue;
}
void DialogueManager::setFactionReaction(const ESM::RefId& faction1, const ESM::RefId& faction2, int absolute)
{
// Make sure the factions exist
MWBase::Environment::get().getWorld()->getStore().get<ESM::Faction>().find(faction1);
MWBase::Environment::get().getWorld()->getStore().get<ESM::Faction>().find(faction2);
auto& map = mChangedFactionReaction[faction1];
map[faction2] = absolute;
}
int DialogueManager::getFactionReaction(const ESM::RefId& faction1, const ESM::RefId& faction2) const
{
ModFactionReactionMap::const_iterator map = mChangedFactionReaction.find(faction1);
if (map != mChangedFactionReaction.end() && map->second.find(faction2) != map->second.end())
return map->second.at(faction2);
const ESM::Faction* faction
= MWBase::Environment::get().getWorld()->getStore().get<ESM::Faction>().find(faction1);
auto it = faction->mReactions.begin();
for (; it != faction->mReactions.end(); ++it)
{
if (it->first == faction2)
return it->second;
}
return 0;
}
void DialogueManager::clearInfoActor(const MWWorld::Ptr& actor) const
{
if (actor == mActor && !mLastTopic.empty())
{
MWBase::Environment::get().getJournal()->removeLastAddedTopicResponse(
mLastTopic, actor.getClass().getName(actor));
}
}
}