ReputationMgr.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2016 TrinityCore <http://www.trinitycore.org/>
 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __TRINITY_REPUTATION_MGR_H
#define __TRINITY_REPUTATION_MGR_H

#include "Common.h"
#include "SharedDefines.h"
#include "Language.h"
#include "DBCStructure.h"
#include "QueryResult.h"
#include <map>

static uint32 ReputationRankStrIndex[MAX_REPUTATION_RANK] =
{
 LANG_REP_HATED, LANG_REP_HOSTILE, LANG_REP_UNFRIENDLY, LANG_REP_NEUTRAL,
 LANG_REP_FRIENDLY, LANG_REP_HONORED, LANG_REP_REVERED, LANG_REP_EXALTED
};

enum FactionFlags
{
 FACTION_FLAG_NONE = 0x00, // no faction flag
 FACTION_FLAG_VISIBLE = 0x01, // makes visible in client (set or can be set at interaction with target of this faction)
 FACTION_FLAG_AT_WAR = 0x02, // enable AtWar-button in client. player controlled (except opposition team always war state), Flag only set on initial creation
 FACTION_FLAG_HIDDEN = 0x04, // hidden faction from reputation pane in client (player can gain reputation, but this update not sent to client)
 FACTION_FLAG_INVISIBLE_FORCED = 0x08, // always overwrite FACTION_FLAG_VISIBLE and hide faction in rep.list, used for hide opposite team factions
 FACTION_FLAG_PEACE_FORCED = 0x10, // always overwrite FACTION_FLAG_AT_WAR, used for prevent war with own team factions
 FACTION_FLAG_INACTIVE = 0x20, // player controlled, state stored in characters.data (CMSG_SET_FACTION_INACTIVE)
 FACTION_FLAG_RIVAL = 0x40, // flag for the two competing outland factions
 FACTION_FLAG_SPECIAL = 0x80 // horde and alliance home cities and their northrend allies have this flag
};

typedef uint32 RepListID;
struct FactionState
{
 uint32 ID;
 RepListID ReputationListID;
 int32 Standing;
 uint8 Flags;
 bool needSend;
 bool needSave;
};

typedef std::map<RepListID, FactionState> FactionStateList;
typedef std::map<uint32, ReputationRank> ForcedReactions;

class Player;

class TC_GAME_API ReputationMgr
{
 public: // constructors and global modifiers
 explicit ReputationMgr(Player* owner) : _player(owner),
 _visibleFactionCount(0), _honoredFactionCount(0), _reveredFactionCount(0), _exaltedFactionCount(0), _sendFactionIncreased(false) { }
 ~ReputationMgr() { }

 void SaveToDB(SQLTransaction& trans);
 void LoadFromDB(PreparedQueryResult result);
 public: // statics
 static const int32 PointsInRank[MAX_REPUTATION_RANK];
 static const int32 Reputation_Cap;
 static const int32 Reputation_Bottom;

 static ReputationRank ReputationToRank(int32 standing);
 public: // accessors
 uint8 GetVisibleFactionCount() const { return _visibleFactionCount; }
 uint8 GetHonoredFactionCount() const { return _honoredFactionCount; }
 uint8 GetReveredFactionCount() const { return _reveredFactionCount; }
 uint8 GetExaltedFactionCount() const { return _exaltedFactionCount; }

 FactionStateList const& GetStateList() const { return _factions; }

 FactionState const* GetState(FactionEntry const* factionEntry) const
 {
 return factionEntry->CanHaveReputation() ? GetState(factionEntry->ReputationIndex) : NULL;
 }

 FactionState const* GetState(RepListID id) const
 {
 FactionStateList::const_iterator repItr = _factions.find (id);
 return repItr != _factions.end() ? &repItr->second : NULL;
 }

 bool IsAtWar(uint32 faction_id) const;
 bool IsAtWar(FactionEntry const* factionEntry) const;

 int32 GetReputation(uint32 faction_id) const;
 int32 GetReputation(FactionEntry const* factionEntry) const;
 int32 GetBaseReputation(FactionEntry const* factionEntry) const;

 ReputationRank GetRank(FactionEntry const* factionEntry) const;
 ReputationRank GetBaseRank(FactionEntry const* factionEntry) const;
 uint32 GetReputationRankStrIndex(FactionEntry const* factionEntry) const
 {
 return ReputationRankStrIndex[GetRank(factionEntry)];
 };

 ReputationRank const* GetForcedRankIfAny(FactionTemplateEntry const* factionTemplateEntry) const
 {
 return GetForcedRankIfAny(factionTemplateEntry->Faction);
 }

 ReputationRank const* GetForcedRankIfAny(uint32 factionId) const
 {
 ForcedReactions::const_iterator forceItr = _forcedReactions.find(factionId);
 return forceItr != _forcedReactions.end() ? &forceItr->second : NULL;
 }

 public: // modifiers
 bool SetReputation(FactionEntry const* factionEntry, int32 standing)
 {
 return SetReputation(factionEntry, standing, false);
 }
 bool ModifyReputation(FactionEntry const* factionEntry, int32 standing)
 {
 return SetReputation(factionEntry, standing, true);
 }

 void SetVisible(FactionTemplateEntry const* factionTemplateEntry);
 void SetVisible(FactionEntry const* factionEntry);
 void SetAtWar(RepListID repListID, bool on);
 void SetInactive(RepListID repListID, bool on);

 void ApplyForceReaction(uint32 faction_id, ReputationRank rank, bool apply);

 bool SetOneFactionReputation(FactionEntry const* factionEntry, int32 standing, bool incremental);

 public: // senders
 void SendInitialReputations();
 void SendForceReactions();
 void SendState(FactionState const* faction);
 void SendStates();

 private: // internal helper functions
 void Initialize();
 uint32 GetDefaultStateFlags(FactionEntry const* factionEntry) const;
 bool SetReputation(FactionEntry const* factionEntry, int32 standing, bool incremental);
 void SetVisible(FactionState* faction);
 void SetAtWar(FactionState* faction, bool atWar) const;
 void SetInactive(FactionState* faction, bool inactive) const;
 void SendVisible(FactionState const* faction, bool visible = true) const;
 void UpdateRankCounters(ReputationRank old_rank, ReputationRank new_rank);
 private:
 Player* _player;
 FactionStateList _factions;
 ForcedReactions _forcedReactions;
 uint8 _visibleFactionCount :8;
 uint8 _honoredFactionCount :8;
 uint8 _reveredFactionCount :8;
 uint8 _exaltedFactionCount :8;
 bool _sendFactionIncreased; 
};

#endif