InstanceSave Class Reference

#include <InstanceSaveMgr.h>

Public Types
typedef std::list< Player * >	PlayerListType
typedef std::list< Group * >	GroupListType

Public Member Functions
	InstanceSave (uint16 MapId, uint32 InstanceId, Difficulty difficulty, time_t resetTime, bool canReset)
	~InstanceSave ()
uint32	GetPlayerCount () const
uint32	GetGroupCount () const
uint32	GetInstanceId () const
uint32	GetMapId () const
void	SaveToDB ()
void	DeleteFromDB ()
time_t	GetResetTime () const
void	SetResetTime (time_t resetTime)
time_t	GetResetTimeForDB ()
InstanceTemplate const *	GetTemplate ()
MapEntry const *	GetMapEntry ()
void	AddPlayer (Player *player)
bool	RemovePlayer (Player *player)
void	AddGroup (Group *group)
bool	RemoveGroup (Group *group)
bool	CanReset () const
void	SetCanReset (bool canReset)
Difficulty	GetDifficultyID () const
void	SetToDelete (bool toDelete)

Private Member Functions
bool	UnloadIfEmpty ()

Private Attributes
PlayerListType	m_playerList
GroupListType	m_groupList
time_t	m_resetTime
uint32	m_instanceid
uint32	m_mapid
Difficulty	m_difficulty
bool	m_canReset
bool	m_toDelete
std::mutex	_playerListLock

Friends
class	InstanceSaveManager

Member Typedef Documentation

typedef std::list<Group*> InstanceSave::GroupListType

typedef std::list<Player*> InstanceSave::PlayerListType

Constructor & Destructor Documentation

InstanceSave::InstanceSave	(	uint16	MapId,
		uint32	InstanceId,
		Difficulty	difficulty,
		time_t	resetTime,
		bool	canReset
	)

: m_resetTime(resetTime), m_instanceid(InstanceId), m_mapid(MapId),
 m_difficulty(difficulty), m_canReset(canReset), m_toDelete(false) { }

InstanceSave::~InstanceSave

(

)

{
 // the players and groups must be unbound before deleting the save
 ASSERT(m_playerList.empty() && m_groupList.empty());
}

Member Function Documentation

void InstanceSave::AddGroup ( Group *  group )

inline

{ m_groupList.push_back(group); }

Here is the caller graph for this function:

void InstanceSave::AddPlayer ( Player *  player )

inline

 {
 std::lock_guard<std::mutex> lock(_playerListLock);
 m_playerList.push_back(player);
 }

bool InstanceSave::CanReset ( ) const

inline

{ return m_canReset; }

Here is the caller graph for this function:

void InstanceSave::DeleteFromDB

(

)

{
 InstanceSaveManager::DeleteInstanceFromDB(GetInstanceId());
}

Here is the call graph for this function:

Here is the caller graph for this function:

Difficulty InstanceSave::GetDifficultyID ( ) const

inline

{ return m_difficulty; }

Here is the caller graph for this function:

uint32 InstanceSave::GetGroupCount ( ) const

inline

{ return uint32(m_groupList.size()); }

Here is the caller graph for this function:

uint32 InstanceSave::GetInstanceId ( ) const

inline

{ return m_instanceid; }

Here is the caller graph for this function:

MapEntry const * InstanceSave::GetMapEntry

(

)

{
 return sMapStore.LookupEntry(m_mapid);
}

uint32 InstanceSave::GetMapId ( ) const

inline

{ return m_mapid; }

Here is the caller graph for this function:

uint32 InstanceSave::GetPlayerCount ( ) const

inline

{ return uint32(m_playerList.size()); }

Here is the caller graph for this function:

time_t InstanceSave::GetResetTime ( ) const

inline

{ return m_resetTime; }

Here is the caller graph for this function:

time_t InstanceSave::GetResetTimeForDB

(

)

{
 // only save the reset time for normal instances
 const MapEntry* entry = sMapStore.LookupEntry(GetMapId());
 if (!entry || entry->IsRaid() || GetDifficultyID() == DIFFICULTY_HEROIC)
 return 0;
 else
 return GetResetTime();
}

Here is the call graph for this function:

Here is the caller graph for this function:

InstanceTemplate const * InstanceSave::GetTemplate

(

)

{
 return sObjectMgr->GetInstanceTemplate(m_mapid);
}

bool InstanceSave::RemoveGroup ( Group *  group )

inline

 {
 m_groupList.remove(group);
 bool isStillValid = UnloadIfEmpty();
 if (m_toDelete)
 delete this;
 return isStillValid;
 }

Here is the caller graph for this function:

bool InstanceSave::RemovePlayer ( Player *  player )

inline

 {
 _playerListLock.lock();
 m_playerList.remove(player);
 bool isStillValid = UnloadIfEmpty();
 _playerListLock.unlock();

 //delete here if needed, after releasing the lock
 if (m_toDelete)
 delete this;

 return isStillValid;
 }

void InstanceSave::SaveToDB

(

)

{
 // save instance data too
 std::string data;
 uint32 completedEncounters = 0;

 Map* map = sMapMgr->FindMap(GetMapId(), m_instanceid);
 if (map)
 {
 ASSERT(map->IsDungeon());
 if (InstanceScript* instanceScript = ((InstanceMap*)map)->GetInstanceScript())
 {
 data = instanceScript->GetSaveData();
 completedEncounters = instanceScript->GetCompletedEncounterMask();
 }
 }

 PreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_INS_INSTANCE_SAVE);
 stmt->setUInt32(0, m_instanceid);
 stmt->setUInt16(1, GetMapId());
 stmt->setUInt32(2, uint32(GetResetTimeForDB()));
 stmt->setUInt8(3, uint8(GetDifficultyID()));
 stmt->setUInt32(4, completedEncounters);
 stmt->setString(5, data);
 CharacterDatabase.Execute(stmt);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void InstanceSave::SetCanReset ( bool  canReset )

inline

{ m_canReset = canReset; }

void InstanceSave::SetResetTime ( time_t  resetTime )

inline

{ m_resetTime = resetTime; }

void InstanceSave::SetToDelete ( bool  toDelete )

inline

 {
 m_toDelete = toDelete;
 }

bool InstanceSave::UnloadIfEmpty ( )

private

{
 if (m_playerList.empty() && m_groupList.empty())
 {
 // don't remove the save if there are still players inside the map
 if (Map* map = sMapMgr->FindMap(GetMapId(), GetInstanceId()))
 if (map->HavePlayers())
 return true;

 if (!sInstanceSaveMgr->lock_instLists)
 sInstanceSaveMgr->RemoveInstanceSave(GetInstanceId());

 return false;
 }
 else
 return true;
}

Here is the call graph for this function:

Friends And Related Function Documentation

friend class InstanceSaveManager

friend

Member Data Documentation

std::mutex InstanceSave::_playerListLock

private

bool InstanceSave::m_canReset

private

Difficulty InstanceSave::m_difficulty

private

GroupListType InstanceSave::m_groupList

private

uint32 InstanceSave::m_instanceid

private

uint32 InstanceSave::m_mapid

private

PlayerListType InstanceSave::m_playerList

private

Todo:

: Check if maybe it's enough to just store the number of players/groups

time_t InstanceSave::m_resetTime

private

bool InstanceSave::m_toDelete

private

---

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

• src/server/game/Instances/InstanceSaveMgr.h
• src/server/game/Instances/InstanceSaveMgr.cpp