playerrelations.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2008-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * 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
 * 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 BEING_PLAYERRELATIONS_H
#define BEING_PLAYERRELATIONS_H
 
#include "utils/stringvector.h"
 
#include "enums/being/relation.h"
 
#include <list>
#include <map>
 
#include "localconsts.h"
 
class Being;
class PlayerIgnoreStrategy;
class PlayerRelationsListener;
 
struct PlayerRelation;
 
class PlayerRelationsManager final
{
 public:
 PlayerRelationsManager();
 
 A_DELETE_COPY(PlayerRelationsManager)
 
 ~PlayerRelationsManager();
 
 void init();
 
 void load();
 
 void store() const;
 
 unsigned int checkPermissionSilently(const std::string &player_name,
 const unsigned int flags)
 const A_WARN_UNUSED;
 
 bool hasPermission(const Being *const being,
 const unsigned int flags) const A_WARN_UNUSED;
 
 bool hasPermission(const std::string &being,
 const unsigned int flags) const A_WARN_UNUSED;
 
 void setRelation(const std::string &name,
 const RelationT relation);
 
 RelationT getRelation(const std::string &name) const A_WARN_UNUSED;
 
 void removePlayer(const std::string &name);
 
 unsigned int getDefault() const A_WARN_UNUSED;
 
 void setDefault(const unsigned int permissions);
 
 STD_VECTOR<PlayerIgnoreStrategy *> *getPlayerIgnoreStrategies()
 A_WARN_UNUSED;
 
 const PlayerIgnoreStrategy *getPlayerIgnoreStrategy() const
 noexcept2
 A_WARN_UNUSED
 { return mIgnoreStrategy; }
 
 void setPlayerIgnoreStrategy(PlayerIgnoreStrategy *const strategy)
 noexcept2
 { mIgnoreStrategy = strategy; }
 
 int getPlayerIgnoreStrategyIndex(const std::string &shortname)
 A_WARN_UNUSED;
 
 StringVect *getPlayers() const RETURNS_NONNULL A_WARN_UNUSED;
 
 StringVect *getPlayersByRelation(const RelationT rel)
 const A_WARN_UNUSED;
 
 void clear();
 
 bool getPersistIgnores() const noexcept2 A_WARN_UNUSED
 { return mPersistIgnores; }
 
 void ignoreTrade(const std::string &name) const;
 
 bool isGoodName(Being *const being) const A_WARN_UNUSED;
 
 bool isGoodName(const std::string &name) const A_WARN_UNUSED;
 
 void setPersistIgnores(const bool value) noexcept2
 { mPersistIgnores = value; }
 
 void addListener(PlayerRelationsListener *const listener)
 { mListeners.push_back(listener); }
 
 void removeListener(PlayerRelationsListener *const listener)
 { mListeners.remove(listener); }
 
 bool checkBadRelation(const std::string &name) const A_WARN_UNUSED;
 
 private:
 void signalUpdate(const std::string &name);
 
 bool mPersistIgnores; // If NOT set, we delete the
 // ignored data upon reloading
 unsigned int mDefaultPermissions;
 
 static bool checkName(const std::string &name) A_WARN_UNUSED;
 
 PlayerIgnoreStrategy *mIgnoreStrategy;
 std::map<std::string, PlayerRelation *> mRelations;
 std::list<PlayerRelationsListener *> mListeners;
 STD_VECTOR<PlayerIgnoreStrategy *> mIgnoreStrategies;
};
 
 
extern PlayerRelationsManager playerRelations; // singleton representation
 // of player relations
 
 
#endif // BEING_PLAYERRELATIONS_H