#include <Scenario.h>

Public Member Functions
	Scenario (Map map, ScenarioData const scenarioData)

	~Scenario ()

void	Reset () override

void	SetStep (ScenarioStepEntry const *step)

virtual void	CompleteStep (ScenarioStepEntry const *step)

virtual void	CompleteScenario ()

virtual void	OnPlayerEnter (Player *player)

virtual void	OnPlayerExit (Player *player)

virtual void	Update (uint32)

bool	IsComplete ()

bool	IsCompletedStep (ScenarioStepEntry const *step)

void	SetStepState (ScenarioStepEntry const *step, ScenarioStepState state)

ScenarioEntry const *	GetEntry () const

ScenarioStepState	GetStepState (ScenarioStepEntry const *step)

ScenarioStepEntry const *	GetStep () const

ScenarioStepEntry const *	GetFirstStep () const

ScenarioStepEntry const *	GetLastStep () const

void	SendScenarioState (Player *player)

void	SendBootPlayer (Player *player)

Public Member Functions inherited from CriteriaHandler
	CriteriaHandler ()

virtual	~CriteriaHandler ()

	CriteriaHandler (CriteriaHandler const &right)=delete

	CriteriaHandler (CriteriaHandler &&right)=delete

CriteriaHandler &	operator= (CriteriaHandler const &right)=delete

CriteriaHandler &	operator= (CriteriaHandler &&right)=delete

virtual void	Reset ()

void	UpdateCriteria (CriteriaType type, uint64 miscValue1=0, uint64 miscValue2=0, uint64 miscValue3=0, WorldObject const ref=nullptr, Player referencePlayer=nullptr)

virtual void	SendAllData (Player const *receiver) const =0

void	UpdateTimedCriteria (uint32 timeDiff)

void	StartCriteriaTimer (CriteriaStartEvent startEvent, uint32 entry, uint32 timeLost=0)

void	RemoveCriteriaTimer (CriteriaStartEvent startEvent, uint32 entry)

Protected Member Functions
void	SendCriteriaUpdate (Criteria const criteria, CriteriaProgress const progress, Seconds timeElapsed, bool timedCompleted) const override

void	SendCriteriaProgressRemoved (uint32) override

bool	CanUpdateCriteriaTree (Criteria const criteria, CriteriaTree const tree, Player *referencePlayer) const override

bool	CanCompleteCriteriaTree (CriteriaTree const *tree) override

void	CompletedCriteriaTree (CriteriaTree const tree, Player referencePlayer) override

void	AfterCriteriaTreeUpdate (CriteriaTree const , Player ) override

void	SendPacket (WorldPacket const *data) const override

void	SendAllData (Player const *) const override

void	BuildScenarioState (WorldPackets::Scenario::ScenarioState *scenarioState)

std::vector< WorldPackets::Scenario::BonusObjectiveData >	GetBonusObjectivesData ()

std::vector< WorldPackets::Achievement::CriteriaProgress >	GetCriteriasProgress ()

CriteriaList const &	GetCriteriaByType (CriteriaType type, uint32 asset) const override

Protected Member Functions inherited from CriteriaHandler
virtual void	SendCriteriaUpdate (Criteria const criteria, CriteriaProgress const progress, Seconds timeElapsed, bool timedCompleted) const =0

CriteriaProgress *	GetCriteriaProgress (Criteria const *entry)

void	SetCriteriaProgress (Criteria const criteria, uint64 changeValue, Player referencePlayer, ProgressType progressType=PROGRESS_SET)

void	RemoveCriteriaProgress (Criteria const *criteria)

virtual void	SendCriteriaProgressRemoved (uint32 criteriaId)=0

bool	IsCompletedCriteriaTree (CriteriaTree const *tree)

virtual bool	CanUpdateCriteriaTree (Criteria const criteria, CriteriaTree const tree, Player *referencePlayer) const

virtual bool	CanCompleteCriteriaTree (CriteriaTree const *tree)

virtual void	CompletedCriteriaTree (CriteriaTree const tree, Player referencePlayer)=0

virtual void	AfterCriteriaTreeUpdate (CriteriaTree const , Player )

bool	IsCompletedCriteria (Criteria const *criteria, uint64 requiredAmount)

bool	CanUpdateCriteria (Criteria const criteria, CriteriaTreeList const trees, uint64 miscValue1, uint64 miscValue2, uint64 miscValue3, WorldObject const ref, Player referencePlayer)

virtual void	SendPacket (WorldPacket const *data) const =0

bool	ConditionsSatisfied (Criteria const criteria, Player referencePlayer) const

bool	RequirementsSatisfied (Criteria const criteria, uint64 miscValue1, uint64 miscValue2, uint64 miscValue3, WorldObject const ref, Player *referencePlayer) const

virtual bool	RequiredAchievementSatisfied (uint32) const

bool	ModifierTreeSatisfied (ModifierTreeNode const parent, uint64 miscValue1, uint64 miscValue2, WorldObject const ref, Player *referencePlayer) const

bool	ModifierSatisfied (ModifierTreeEntry const modifier, uint64 miscValue1, uint64 miscValue2, WorldObject const ref, Player *referencePlayer) const

virtual std::string	GetOwnerInfo () const =0

virtual CriteriaList const &	GetCriteriaByType (CriteriaType type, uint32 asset) const =0

Protected Attributes
Map const *	_map

GuidUnorderedSet	_players

ScenarioData const *	_data

Protected Attributes inherited from CriteriaHandler
CriteriaProgressMap	_criteriaProgress

std::map< uint32, uint32 >	_timeCriteriaTrees

Private Attributes
ObjectGuid const	_guid

ScenarioStepEntry const *	_currentstep

std::map< ScenarioStepEntry const *, ScenarioStepState >	_stepStates

Detailed Description

Definition at line 51 of file Scenario.h.

Constructor & Destructor Documentation

◆ Scenario()

Scenario::Scenario	(	Map *	map,
		ScenarioData const *	scenarioData
	)

Definition at line 27 of file Scenario.cpp.

 : _map(map), _data(scenarioData),
 _guid(ObjectGuid::Create<HighGuid::Scenario>(map->GetId(), scenarioData->Entry->ID, map->GenerateLowGuid<HighGuid::Scenario>())),
 _currentstep(nullptr)
{
 ASSERT(_data);
 
 for (std::pair<uint8 const, ScenarioStepEntry const*> const& scenarioStep : _data->Steps)
 SetStepState(scenarioStep.second, SCENARIO_STEP_NOT_STARTED);
 
 if (ScenarioStepEntry const* step = GetFirstStep())
 SetStep(step);
 else
 TC_LOG_ERROR("scenario", "Scenario::Scenario: Could not launch Scenario (id: {}), found no valid scenario step", _data->Entry->ID);
}

Here is the call graph for this function:

◆ ~Scenario()

Scenario::~Scenario ( )

Definition at line 42 of file Scenario.cpp.

{
 for (ObjectGuid guid : _players)
 if (Player* player = ObjectAccessor::GetPlayer(_map, guid))
 SendBootPlayer(player);
 
 _players.clear();
}

Here is the call graph for this function:

Member Function Documentation

◆ AfterCriteriaTreeUpdate()

void Scenario::AfterCriteriaTreeUpdate	(	CriteriaTree const *	,
		Player *
	)

inlineoverrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 89 of file Scenario.h.

89{ }

◆ BuildScenarioState()

void Scenario::BuildScenarioState ( WorldPackets::Scenario::ScenarioState * scenarioState )

protected

Definition at line 225 of file Scenario.cpp.

{
 scenarioState->ScenarioGUID = _guid;
 scenarioState->ScenarioID = _data->Entry->ID;
 if (ScenarioStepEntry const* step = GetStep())
 scenarioState->CurrentStep = step->ID;
 scenarioState->CriteriaProgress = GetCriteriasProgress();
 scenarioState->BonusObjectives = GetBonusObjectivesData();
 // Don't know exactly what this is for, but seems to contain list of scenario steps that we're either on or that are completed
 for (std::pair<ScenarioStepEntry const* const, ScenarioStepState> const& state : _stepStates)
 {
 if (state.first->IsBonusObjective())
 continue;
 
 switch (state.second)
 {
 case SCENARIO_STEP_IN_PROGRESS:
 case SCENARIO_STEP_DONE:
 break;
 case SCENARIO_STEP_NOT_STARTED:
 default:
 continue;
 }
 
 scenarioState->PickedSteps.push_back(state.first->ID);
 }
 scenarioState->ScenarioComplete = IsComplete();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CanCompleteCriteriaTree()

bool Scenario::CanCompleteCriteriaTree ( CriteriaTree const * tree )

overrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 178 of file Scenario.cpp.

{
 ScenarioStepEntry const* step = tree->ScenarioStep;
 if (!step)
 return false;
 
 ScenarioStepState const state = GetStepState(step);
 if (state == SCENARIO_STEP_DONE)
 return false;
 
 ScenarioStepEntry const* currentStep = GetStep();
 if (!currentStep)
 return false;
 
 if (!step->IsBonusObjective())
 if (step != currentStep)
 return false;
 
 return CriteriaHandler::CanCompleteCriteriaTree(tree);
}

Here is the call graph for this function:

◆ CanUpdateCriteriaTree()

bool Scenario::CanUpdateCriteriaTree	(	Criteria const *	criteria,
		CriteriaTree const *	tree,
		Player *	referencePlayer
	)		const

overrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 159 of file Scenario.cpp.

{
 ScenarioStepEntry const* step = tree->ScenarioStep;
 if (!step)
 return false;
 
 if (step->ScenarioID != _data->Entry->ID)
 return false;
 
 ScenarioStepEntry const* currentStep = GetStep();
 if (!currentStep)
 return false;
 
 if (step->IsBonusObjective())
 return true;
 
 return currentStep == step;
}

Here is the call graph for this function:

◆ CompletedCriteriaTree()

void Scenario::CompletedCriteriaTree	(	CriteriaTree const *	tree,
		Player *	referencePlayer
	)

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 199 of file Scenario.cpp.

{
 ScenarioStepEntry const* step = ASSERT_NOTNULL(tree->ScenarioStep);
 if (!IsCompletedStep(step))
 return;
 
 SetStepState(step, SCENARIO_STEP_DONE);
 CompleteStep(step);
}

Here is the call graph for this function:

◆ CompleteScenario()

void Scenario::CompleteScenario ( )

virtual

Definition at line 87 of file Scenario.cpp.

{
 return SendPacket(WorldPackets::Scenario::ScenarioCompleted(_data->Entry->ID).Write());
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CompleteStep()

void Scenario::CompleteStep ( ScenarioStepEntry const * step )

virtual

Definition at line 57 of file Scenario.cpp.

{
 if (Quest const* quest = sObjectMgr->GetQuestTemplate(step->RewardQuestID))
 for (ObjectGuid guid : _players)
 if (Player* player = ObjectAccessor::GetPlayer(_map, guid))
 player->RewardQuest(quest, LootItemType::Item, 0, nullptr, false);
 
 if (step->IsBonusObjective())
 return;
 
 ScenarioStepEntry const* newStep = nullptr;
 for (auto const& _step : _data->Steps)
 {
 if (_step.second->IsBonusObjective())
 continue;
 
 if (GetStepState(_step.second) == SCENARIO_STEP_DONE)
 continue;
 
 if (!newStep || _step.second->OrderIndex < newStep->OrderIndex)
 newStep = _step.second;
 }
 
 SetStep(newStep);
 if (IsComplete())
 CompleteScenario();
 else
 TC_LOG_ERROR("scenario", "Scenario::CompleteStep: Scenario (id: {}, step: {}) was completed, but could not determine new step, or validate scenario completion.", step->ScenarioID, step->ID);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBonusObjectivesData()

std::vector< WorldPackets::Scenario::BonusObjectiveData > Scenario::GetBonusObjectivesData ( )

protected

Definition at line 293 of file Scenario.cpp.

{
 std::vector<WorldPackets::Scenario::BonusObjectiveData> bonusObjectivesData;
 for (std::pair<uint8 const, ScenarioStepEntry const*> const& scenarioStep : _data->Steps)
 {
 if (!scenarioStep.second->IsBonusObjective())
 continue;
 
 if (sCriteriaMgr->GetCriteriaTree(scenarioStep.second->Criteriatreeid))
 {
 WorldPackets::Scenario::BonusObjectiveData bonusObjectiveData;
 bonusObjectiveData.BonusObjectiveID = scenarioStep.second->ID;
 bonusObjectiveData.ObjectiveComplete = GetStepState(scenarioStep.second) == SCENARIO_STEP_DONE;
 bonusObjectivesData.push_back(bonusObjectiveData);
 }
 }
 
 return bonusObjectivesData;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCriteriaByType()

CriteriaList const & Scenario::GetCriteriaByType	(	CriteriaType	type,
		uint32	asset
	)		const

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 333 of file Scenario.cpp.

{
 return sCriteriaMgr->GetScenarioCriteriaByTypeAndScenario(type, _data->Entry->ID);
}

◆ GetCriteriasProgress()

std::vector< WorldPackets::Achievement::CriteriaProgress > Scenario::GetCriteriasProgress ( )

protected

Definition at line 313 of file Scenario.cpp.

{
 std::vector<WorldPackets::Achievement::CriteriaProgress> criteriasProgress;
 
 if (!_criteriaProgress.empty())
 {
 for (std::pair<uint32 const, CriteriaProgress> const& progressPair : _criteriaProgress)
 {
 WorldPackets::Achievement::CriteriaProgress criteriaProgress;
 criteriaProgress.Id = progressPair.first;
 criteriaProgress.Quantity = progressPair.second.Counter;
 criteriaProgress.Date = progressPair.second.Date;
 criteriaProgress.Player = progressPair.second.PlayerGUID;
 criteriasProgress.push_back(criteriaProgress);
 }
 }
 
 return criteriasProgress;
}

Here is the caller graph for this function:

◆ GetEntry()

ScenarioEntry const * Scenario::GetEntry ( ) const

Definition at line 129 of file Scenario.cpp.

{
 return _data->Entry;
}

Here is the caller graph for this function:

◆ GetFirstStep()

ScenarioStepEntry const * Scenario::GetFirstStep ( ) const

Definition at line 254 of file Scenario.cpp.

{
 // Do it like this because we don't know what order they're in inside the container.
 ScenarioStepEntry const* firstStep = nullptr;
 for (std::pair<uint8 const, ScenarioStepEntry const*> const& scenarioStep : _data->Steps)
 {
 if (scenarioStep.second->IsBonusObjective())
 continue;
 
 if (!firstStep || scenarioStep.second->OrderIndex < firstStep->OrderIndex)
 firstStep = scenarioStep.second;
 }
 
 return firstStep;
}

Here is the caller graph for this function:

◆ GetLastStep()

ScenarioStepEntry const * Scenario::GetLastStep ( ) const

Definition at line 270 of file Scenario.cpp.

{
 // Do it like this because we don't know what order they're in inside the container.
 ScenarioStepEntry const* lastStep = nullptr;
 for (std::pair<uint8 const, ScenarioStepEntry const*> const& scenarioStep : _data->Steps)
 {
 if (scenarioStep.second->IsBonusObjective())
 continue;
 
 if (!lastStep || scenarioStep.second->OrderIndex > lastStep->OrderIndex)
 lastStep = scenarioStep.second;
 }
 
 return lastStep;
}

Here is the caller graph for this function:

◆ GetStep()

ScenarioStepEntry const * Scenario::GetStep ( ) const

inline

Definition at line 72 of file Scenario.h.

72{ return _currentstep; }

Here is the caller graph for this function:

◆ GetStepState()

ScenarioStepState Scenario::GetStepState ( ScenarioStepEntry const * step )

Definition at line 134 of file Scenario.cpp.

{
 std::map<ScenarioStepEntry const*, ScenarioStepState>::const_iterator itr = _stepStates.find(step);
 if (itr == _stepStates.end())
 return SCENARIO_STEP_INVALID;
 
 return itr->second;
}

Here is the caller graph for this function:

◆ IsComplete()

bool Scenario::IsComplete ( )

Definition at line 115 of file Scenario.cpp.

{
 for (std::pair<uint8 const, ScenarioStepEntry const*> const& scenarioStep : _data->Steps)
 {
 if (scenarioStep.second->IsBonusObjective())
 continue;
 
 if (GetStepState(scenarioStep.second) != SCENARIO_STEP_DONE)
 return false;
 }
 
 return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsCompletedStep()

bool Scenario::IsCompletedStep ( ScenarioStepEntry const * step )

Definition at line 209 of file Scenario.cpp.

{
 CriteriaTree const* tree = sCriteriaMgr->GetCriteriaTree(step->Criteriatreeid);
 if (!tree)
 return false;
 
 return IsCompletedCriteriaTree(tree);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnPlayerEnter()

void Scenario::OnPlayerEnter ( Player * player )

virtual

Definition at line 103 of file Scenario.cpp.

{
 _players.insert(player->GetGUID());
 SendScenarioState(player);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnPlayerExit()

void Scenario::OnPlayerExit ( Player * player )

virtual

Definition at line 109 of file Scenario.cpp.

{
 _players.erase(player->GetGUID());
 SendBootPlayer(player);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void Scenario::Reset ( )

overridevirtual

Reimplemented from CriteriaHandler.

Definition at line 51 of file Scenario.cpp.

{
 CriteriaHandler::Reset();
 SetStep(GetFirstStep());
}

Here is the call graph for this function:

◆ SendAllData()

void Scenario::SendAllData ( Player const * ) const

inlineoverrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 93 of file Scenario.h.

93{ }

◆ SendBootPlayer()

void Scenario::SendBootPlayer ( Player * player )

Definition at line 338 of file Scenario.cpp.

{
 WorldPackets::Scenario::ScenarioVacate scenarioBoot;
 scenarioBoot.ScenarioGUID = _guid;
 scenarioBoot.ScenarioID = _data->Entry->ID;
 player->SendDirectMessage(scenarioBoot.Write());
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendCriteriaProgressRemoved()

void Scenario::SendCriteriaProgressRemoved ( uint32 )

inlineoverrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 84 of file Scenario.h.

84{ }

◆ SendCriteriaUpdate()

void Scenario::SendCriteriaUpdate	(	Criteria const *	criteria,
		CriteriaProgress const *	progress,
		Seconds	timeElapsed,
		bool	timedCompleted
	)		const

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 143 of file Scenario.cpp.

{
 WorldPackets::Scenario::ScenarioProgressUpdate progressUpdate;
 progressUpdate.CriteriaProgress.Id = criteria->ID;
 progressUpdate.CriteriaProgress.Quantity = progress->Counter;
 progressUpdate.CriteriaProgress.Player = progress->PlayerGUID;
 progressUpdate.CriteriaProgress.Date = progress->Date;
 if (criteria->Entry->StartTimer)
 progressUpdate.CriteriaProgress.Flags = timedCompleted ? 1 : 0;
 
 progressUpdate.CriteriaProgress.TimeFromStart = timeElapsed;
 progressUpdate.CriteriaProgress.TimeFromCreate = Seconds::zero();
 
 SendPacket(progressUpdate.Write());
}

Here is the call graph for this function:

◆ SendPacket()

void Scenario::SendPacket ( WorldPacket const * data ) const

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 218 of file Scenario.cpp.

{
 for (ObjectGuid guid : _players)
 if (Player* player = ObjectAccessor::GetPlayer(_map, guid))
 player->SendDirectMessage(data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendScenarioState()

void Scenario::SendScenarioState ( Player * player )

Definition at line 286 of file Scenario.cpp.

{
 WorldPackets::Scenario::ScenarioState scenarioState;
 BuildScenarioState(&scenarioState);
 player->SendDirectMessage(scenarioState.Write());
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStep()

void Scenario::SetStep ( ScenarioStepEntry const * step )

Definition at line 92 of file Scenario.cpp.

{
 _currentstep = step;
 if (step)
 SetStepState(step, SCENARIO_STEP_IN_PROGRESS);
 
 WorldPackets::Scenario::ScenarioState scenarioState;
 BuildScenarioState(&scenarioState);
 SendPacket(scenarioState.Write());
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStepState()

void Scenario::SetStepState	(	ScenarioStepEntry const *	step,
		ScenarioStepState	state
	)

inline

Definition at line 69 of file Scenario.h.

69{ _stepStates[step] = state; }

Here is the caller graph for this function:

◆ Update()

virtual void Scenario::Update ( uint32 )

inlinevirtual

Definition at line 65 of file Scenario.h.

65{ }

Here is the caller graph for this function:

Member Data Documentation

◆ _currentstep

ScenarioStepEntry const* Scenario::_currentstep

private

Definition at line 105 of file Scenario.h.

◆ _data

ScenarioData const* Scenario::_data

protected

Definition at line 101 of file Scenario.h.

◆ _guid

ObjectGuid const Scenario::_guid

private

Definition at line 104 of file Scenario.h.

◆ _map

Map const* Scenario::_map

protected

Definition at line 80 of file Scenario.h.

◆ _players

GuidUnorderedSet Scenario::_players

protected

Definition at line 81 of file Scenario.h.

◆ _stepStates

std::map<ScenarioStepEntry const*, ScenarioStepState> Scenario::_stepStates

private

Definition at line 106 of file Scenario.h.

The documentation for this class was generated from the following files:

src/server/game/Scenarios/Scenario.h
src/server/game/Scenarios/Scenario.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Scenario()

◆ ~Scenario()

Member Function Documentation

◆ AfterCriteriaTreeUpdate()

◆ BuildScenarioState()

◆ CanCompleteCriteriaTree()

◆ CanUpdateCriteriaTree()

◆ CompletedCriteriaTree()

◆ CompleteScenario()

◆ CompleteStep()

◆ GetBonusObjectivesData()

◆ GetCriteriaByType()

◆ GetCriteriasProgress()

◆ GetEntry()

◆ GetFirstStep()

◆ GetLastStep()

◆ GetStep()

◆ GetStepState()

◆ IsComplete()

◆ IsCompletedStep()

◆ OnPlayerEnter()

◆ OnPlayerExit()

◆ Reset()

◆ SendAllData()

◆ SendBootPlayer()

◆ SendCriteriaProgressRemoved()

◆ SendCriteriaUpdate()

◆ SendPacket()

◆ SendScenarioState()

◆ SetStep()

◆ SetStepState()

◆ Update()

Member Data Documentation

◆ _currentstep

◆ _data

◆ _guid

◆ _map

◆ _players

◆ _stepStates