Scenario Class Reference

#include <Scenario.h>

Inheritance diagram for Scenario:

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 () const
bool	IsCompletedStep (ScenarioStepEntry const *step)
void	SetStepState (ScenarioStepEntry const *step, ScenarioStepState state)
ScenarioEntry const *	GetEntry () const
ScenarioStepState	GetStepState (ScenarioStepEntry const *step) const
ScenarioStepEntry const *	GetStep () const
ScenarioStepEntry const *	GetFirstStep () const
ScenarioStepEntry const *	GetLastStep () const
void	SendScenarioState (Player const *player) const
void	SendBootPlayer (Player const *player) const
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
void	UpdateCriteria (CriteriaType type, uint64 miscValue1=0, uint64 miscValue2=0, uint64 miscValue3=0, WorldObject const *ref=nullptr, Player *referencePlayer=nullptr)
void	UpdateTimedCriteria (Milliseconds timeDiff)
void	StartCriteria (CriteriaStartEvent startEvent, uint32 entry, Milliseconds timeLost=Milliseconds::zero())
virtual void	FailCriteria (CriteriaFailEvent failEvent, uint32 asset)

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	DoForAllPlayers (std::function< void(Player *)> const &worker) const
void	SendPacket (WorldPacket const *data) const override
void	SendAllData (Player const *) const override
void	BuildScenarioStateFor (Player const *player, WorldPackets::Scenario::ScenarioState *scenarioState) const
std::vector< WorldPackets::Scenario::BonusObjectiveData >	GetBonusObjectivesData () const
std::vector< WorldPackets::Achievement::CriteriaProgress >	GetCriteriasProgressFor (Player const *player) const
CriteriaList const &	GetCriteriaByType (CriteriaType type, uint32 asset) const override
Protected Member Functions inherited from CriteriaHandler
void	UpdateCriteria (Criteria const *criteria, uint64 miscValue1=0, uint64 miscValue2=0, uint64 miscValue3=0, WorldObject const *ref=nullptr, Player *referencePlayer=nullptr)
CriteriaProgress *	GetCriteriaProgress (Criteria const *entry)
void	SetCriteriaProgress (Criteria const *criteria, uint64 changeValue, Player *referencePlayer, ProgressType progressType=PROGRESS_SET)
void	RemoveCriteriaProgress (Criteria const *criteria)
bool	IsCompletedCriteriaTree (CriteriaTree const *tree)
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)
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

Protected Attributes
Map const *	_map
GuidUnorderedSet	_players
ScenarioData const *	_data
Protected Attributes inherited from CriteriaHandler
CriteriaProgressMap	_criteriaProgress
std::unordered_map< uint32, Milliseconds >	_startedCriteria

Private Attributes
ObjectGuid const	_guid
ScenarioStepEntry const *	_currentstep
std::map< ScenarioStepEntry const *, ScenarioStepState >	_stepStates

Detailed Description

Definition at line 52 of file Scenario.h.

Constructor & Destructor Documentation

Scenario()

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

Definition at line 28 of file Scenario.cpp.

References _data, ASSERT, ScenarioData::Entry, GetFirstStep(), ScenarioEntry::ID, SCENARIO_STEP_NOT_STARTED, SetStep(), SetStepState(), ScenarioData::Steps, and TC_LOG_ERROR.

~Scenario()

Scenario::~Scenario

(

)

Definition at line 43 of file Scenario.cpp.

References _map, _players, ObjectAccessor::GetPlayer(), and SendBootPlayer().

Member Function Documentation

AfterCriteriaTreeUpdate()

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

inlineoverrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 90 of file Scenario.h.

BuildScenarioStateFor()

void Scenario::BuildScenarioStateFor ( Player const *  player, WorldPackets::Scenario::ScenarioState *  scenarioState  ) const

protected

Definition at line 252 of file Scenario.cpp.

References _data, _guid, _stepStates, WorldPackets::Scenario::ScenarioState::BonusObjectives, WorldPackets::Scenario::ScenarioState::CriteriaProgress, WorldPackets::Scenario::ScenarioState::CurrentStep, ScenarioData::Entry, GetBonusObjectivesData(), GetCriteriasProgressFor(), GetStep(), ScenarioEntry::ID, IsComplete(), WorldPackets::Scenario::ScenarioState::PickedSteps, SCENARIO_STEP_DONE, SCENARIO_STEP_IN_PROGRESS, SCENARIO_STEP_NOT_STARTED, WorldPackets::Scenario::ScenarioState::ScenarioComplete, WorldPackets::Scenario::ScenarioState::ScenarioGUID, and WorldPackets::Scenario::ScenarioState::ScenarioID.

Referenced by SendScenarioState(), and SetStep().

CanCompleteCriteriaTree()

bool Scenario::CanCompleteCriteriaTree ( CriteriaTree const *  tree )

overrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 197 of file Scenario.cpp.

References CriteriaHandler::CanCompleteCriteriaTree(), GetStep(), GetStepState(), ScenarioStepEntry::IsBonusObjective(), SCENARIO_STEP_DONE, and CriteriaTree::ScenarioStep.

CanUpdateCriteriaTree()

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

overrideprotectedvirtual

Reimplemented from CriteriaHandler.

Definition at line 178 of file Scenario.cpp.

References _data, ScenarioData::Entry, GetStep(), ScenarioEntry::ID, ScenarioStepEntry::IsBonusObjective(), ScenarioStepEntry::ScenarioID, and CriteriaTree::ScenarioStep.

CompletedCriteriaTree()

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

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 218 of file Scenario.cpp.

References ASSERT_NOTNULL, CompleteStep(), IsCompletedStep(), SCENARIO_STEP_DONE, CriteriaTree::ScenarioStep, and SetStepState().

CompleteScenario()

void Scenario::CompleteScenario ( )

virtual

Definition at line 88 of file Scenario.cpp.

References _data, CompleteAnyScenario, CompleteScenario, DoForAllPlayers(), ScenarioData::Entry, ScenarioEntry::ID, SendPacket(), Player::UpdateCriteria(), and WorldPackets::Scenario::ScenarioCompleted::Write().

Referenced by CompleteStep().

CompleteStep()

void Scenario::CompleteStep ( ScenarioStepEntry const *  step )

virtual

Definition at line 58 of file Scenario.cpp.

References _data, _map, _players, CompleteScenario(), ObjectAccessor::GetPlayer(), GetStepState(), ScenarioStepEntry::ID, ScenarioStepEntry::IsBonusObjective(), IsComplete(), Item, ScenarioStepEntry::OrderIndex, ScenarioStepEntry::RewardQuestID, SCENARIO_STEP_DONE, ScenarioStepEntry::ScenarioID, SetStep(), sObjectMgr, ScenarioData::Steps, and TC_LOG_ERROR.

Referenced by CompletedCriteriaTree().

DoForAllPlayers()

void Scenario::DoForAllPlayers ( std::function< void(Player *)> const &  worker ) const

protected

Definition at line 237 of file Scenario.cpp.

References _map, _players, and ObjectAccessor::GetPlayer().

Referenced by CompleteScenario(), SendCriteriaUpdate(), SendPacket(), and SetStep().

GetBonusObjectivesData()

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

protected

Definition at line 320 of file Scenario.cpp.

References _data, WorldPackets::Scenario::BonusObjectiveData::BonusObjectiveID, GetStepState(), WorldPackets::Scenario::BonusObjectiveData::ObjectiveComplete, SCENARIO_STEP_DONE, sCriteriaMgr, and ScenarioData::Steps.

Referenced by BuildScenarioStateFor().

GetCriteriaByType()

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

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 357 of file Scenario.cpp.

References _data, ScenarioData::Entry, ScenarioEntry::ID, and sCriteriaMgr.

GetCriteriasProgressFor()

std::vector< WorldPackets::Achievement::CriteriaProgress > Scenario::GetCriteriasProgressFor ( Player const *  player ) const

protected

Definition at line 340 of file Scenario.cpp.

References CriteriaHandler::_criteriaProgress, _guid, WorldPackets::Achievement::CriteriaProgress::Date, Player::GetSession(), WorldSession::GetTimezoneOffset(), WorldPackets::Achievement::CriteriaProgress::Id, WorldPackets::Achievement::CriteriaProgress::Player, WorldPackets::Achievement::CriteriaProgress::Quantity, and WowTime::SetUtcTimeFromUnixTime().

Referenced by BuildScenarioStateFor().

GetEntry()

ScenarioEntry const * Scenario::GetEntry

(

)

const

Definition at line 144 of file Scenario.cpp.

References _data, and ScenarioData::Entry.

Referenced by CriteriaHandler::ModifierSatisfied().

GetFirstStep()

ScenarioStepEntry const * Scenario::GetFirstStep

(

)

const

Definition at line 281 of file Scenario.cpp.

References _data, ScenarioStepEntry::OrderIndex, and ScenarioData::Steps.

Referenced by Reset(), and Scenario().

GetLastStep()

ScenarioStepEntry const * Scenario::GetLastStep

(

)

const

Definition at line 297 of file Scenario.cpp.

References _data, ScenarioStepEntry::OrderIndex, and ScenarioData::Steps.

Referenced by CriteriaHandler::ModifierSatisfied().

GetStep()

ScenarioStepEntry const * Scenario::GetStep ( ) const

inline

Definition at line 73 of file Scenario.h.

Referenced by BuildScenarioStateFor(), CanCompleteCriteriaTree(), CanUpdateCriteriaTree(), and CriteriaHandler::ModifierSatisfied().

GetStepState()

ScenarioStepState Scenario::GetStepState

(

ScenarioStepEntry const *

step

)

const

Definition at line 149 of file Scenario.cpp.

References _stepStates, and SCENARIO_STEP_INVALID.

Referenced by CanCompleteCriteriaTree(), CompleteStep(), GetBonusObjectivesData(), and IsComplete().

IsComplete()

bool Scenario::IsComplete

(

)

const

Definition at line 130 of file Scenario.cpp.

References _data, GetStepState(), SCENARIO_STEP_DONE, and ScenarioData::Steps.

Referenced by BuildScenarioStateFor(), and CompleteStep().

IsCompletedStep()

bool Scenario::IsCompletedStep

(

ScenarioStepEntry const *

step

)

Definition at line 228 of file Scenario.cpp.

References ScenarioStepEntry::Criteriatreeid, CriteriaHandler::IsCompletedCriteriaTree(), and sCriteriaMgr.

Referenced by CompletedCriteriaTree().

OnPlayerEnter()

void Scenario::OnPlayerEnter ( Player *  player )

virtual

Definition at line 118 of file Scenario.cpp.

References _players, BaseEntity::GetGUID(), and SendScenarioState().

Referenced by InstanceMap::SetInstanceScenario().

OnPlayerExit()

void Scenario::OnPlayerExit ( Player *  player )

virtual

Definition at line 124 of file Scenario.cpp.

References _players, BaseEntity::GetGUID(), and SendBootPlayer().

Reset()

void Scenario::Reset ( )

overridevirtual

Reimplemented from CriteriaHandler.

Definition at line 52 of file Scenario.cpp.

References GetFirstStep(), CriteriaHandler::Reset(), and SetStep().

SendAllData()

void Scenario::SendAllData ( Player const *  ) const

inlineoverrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 95 of file Scenario.h.

SendBootPlayer()

void Scenario::SendBootPlayer

(

Player const *

player

)

const

Definition at line 362 of file Scenario.cpp.

References _data, _guid, ScenarioData::Entry, ScenarioEntry::ID, WorldPackets::Scenario::ScenarioVacate::ScenarioGUID, WorldPackets::Scenario::ScenarioVacate::ScenarioID, Player::SendDirectMessage(), and WorldPackets::Scenario::ScenarioVacate::Write().

Referenced by OnPlayerExit(), and ~Scenario().

SendCriteriaProgressRemoved()

void Scenario::SendCriteriaProgressRemoved ( uint32  )

inlineoverrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 85 of file Scenario.h.

SendCriteriaUpdate()

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

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 158 of file Scenario.cpp.

References _guid, CriteriaProgress::Counter, WorldPackets::Scenario::ScenarioProgressUpdate::CriteriaProgress, CriteriaProgress::Date, WorldPackets::Achievement::CriteriaProgress::Date, DoForAllPlayers(), Criteria::Entry, WorldPackets::Achievement::CriteriaProgress::Flags, Player::GetSession(), WorldSession::GetTimezoneOffset(), Criteria::ID, WorldPackets::Achievement::CriteriaProgress::Id, WorldPackets::Achievement::CriteriaProgress::Player, WorldPackets::Achievement::CriteriaProgress::Quantity, Player::SendDirectMessage(), WowTime::SetUtcTimeFromUnixTime(), CriteriaEntry::StartTimer, WorldPackets::Achievement::CriteriaProgress::TimeFromCreate, WorldPackets::Achievement::CriteriaProgress::TimeFromStart, and WorldPackets::Scenario::ScenarioProgressUpdate::Write().

SendPacket()

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

overrideprotectedvirtual

Implements CriteriaHandler.

Definition at line 244 of file Scenario.cpp.

References DoForAllPlayers(), and Player::SendDirectMessage().

Referenced by CompleteScenario().

SendScenarioState()

void Scenario::SendScenarioState

(

Player const *

player

)

const

Definition at line 313 of file Scenario.cpp.

References BuildScenarioStateFor(), Player::SendDirectMessage(), and WorldPackets::Scenario::ScenarioState::Write().

Referenced by OnPlayerEnter().

SetStep()

void Scenario::SetStep

(

ScenarioStepEntry const *

step

)

Definition at line 99 of file Scenario.cpp.

References _currentstep, _map, _players, BeginScenarioStep, BuildScenarioStateFor(), DoForAllPlayers(), ObjectAccessor::GetPlayer(), ScenarioStepEntry::ID, SCENARIO_STEP_IN_PROGRESS, Player::SendDirectMessage(), SetStepState(), and WorldPackets::Scenario::ScenarioState::Write().

Referenced by CompleteStep(), Reset(), and Scenario().

SetStepState()

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

inline

Definition at line 70 of file Scenario.h.

Referenced by CompletedCriteriaTree(), InstanceScenario::LoadInstanceData(), Scenario(), and SetStep().

Update()

virtual void Scenario::Update ( uint32  )

inlinevirtual

Definition at line 66 of file Scenario.h.

Member Data Documentation

_currentstep

ScenarioStepEntry const* Scenario::_currentstep

private

Definition at line 107 of file Scenario.h.

Referenced by SetStep().

_data

ScenarioData const* Scenario::_data

protected

Definition at line 103 of file Scenario.h.

Referenced by BuildScenarioStateFor(), CanUpdateCriteriaTree(), CompleteScenario(), CompleteStep(), GetBonusObjectivesData(), GetCriteriaByType(), GetEntry(), GetFirstStep(), GetLastStep(), IsComplete(), InstanceScenario::LoadInstanceData(), Scenario(), and SendBootPlayer().

_guid

ObjectGuid const Scenario::_guid

private

Definition at line 106 of file Scenario.h.

Referenced by BuildScenarioStateFor(), GetCriteriasProgressFor(), SendBootPlayer(), and SendCriteriaUpdate().

_map

Map const* Scenario::_map

protected

Definition at line 81 of file Scenario.h.

Referenced by CompleteStep(), DoForAllPlayers(), InstanceScenario::GetOwnerInfo(), InstanceScenario::LoadInstanceData(), InstanceScenario::SendPacket(), SetStep(), and ~Scenario().

_players

GuidUnorderedSet Scenario::_players

protected

Definition at line 82 of file Scenario.h.

Referenced by CompleteStep(), DoForAllPlayers(), OnPlayerEnter(), OnPlayerExit(), SetStep(), and ~Scenario().

_stepStates

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

private

Definition at line 108 of file Scenario.h.

Referenced by BuildScenarioStateFor(), and GetStepState().

---

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

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