playerrelations.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2008-2009  The Mana World Development Team
 *  Copyright (C) 2009-2024  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */
 
#pragma once
 
#include <list>
#include <map>
#include <string>
#include <vector>
 
class Being;
 
enum class PlayerRelation
{
    Neutral     = 0,
    Friend      = 1,
    Disregarded = 2,
    Ignored     = 3
};
constexpr unsigned int RELATIONS_NR = 4;
 
struct PlayerPermissions
{
    // Used as flags
    enum {
        EMOTE           = 1 << 0,
        SPEECH_FLOAT    = 1 << 1,
        SPEECH_LOG      = 1 << 2,
        WHISPER         = 1 << 3,
        TRADE           = 1 << 4,
 
        DEFAULT         = EMOTE | SPEECH_FLOAT | SPEECH_LOG | WHISPER | TRADE
    };
};
 
static constexpr const char *DEFAULT_IGNORE_STRATEGY = "nop";
 
class PlayerIgnoreStrategy
{
public:
    std::string mDescription;
    std::string mShortName;
 
    virtual ~PlayerIgnoreStrategy() = default;
 
    virtual void ignore(Being *being, unsigned int flags) = 0;
};
 
class PlayerRelationsListener
{
public:
    PlayerRelationsListener() = default;
    virtual ~PlayerRelationsListener() = default;
 
    virtual void playerRelationsUpdated() = 0;
};
 
class PlayerRelationsManager
{
public:
    PlayerRelationsManager() = default;
    ~PlayerRelationsManager();
 
    void init();
 
    void store();
 
    unsigned int checkPermissionSilently(const std::string &player_name,
                                         unsigned int flags);
 
    bool hasPermission(Being *being, unsigned int flags);
 
    bool hasPermission(const std::string &being, unsigned int flags);
 
    void setRelation(const std::string &name, PlayerRelation relation);
 
    PlayerRelation getRelation(const std::string &name) const;
 
    void removePlayer(const std::string &name);
 
    unsigned int getDefault() const;
 
    void setDefault(unsigned int permissions);
 
    std::vector<PlayerIgnoreStrategy *> &getPlayerIgnoreStrategies();
 
    PlayerIgnoreStrategy *getPlayerIgnoreStrategy() const
    {
        return mIgnoreStrategy;
    }
 
    void setPlayerIgnoreStrategy(PlayerIgnoreStrategy *strategy)
    {
        mIgnoreStrategy = strategy;
    }
 
    int getPlayerIgnoreStrategyIndex(const std::string &shortName);
 
    std::vector<std::string> getPlayers() const;
 
    void addListener(PlayerRelationsListener *listener)
    {
        mListeners.push_back(listener);
    }
 
    void removeListener(PlayerRelationsListener *listener)
    {
        mListeners.remove(listener);
    }
 
private:
    void signalUpdate();
 
    PlayerIgnoreStrategy *mIgnoreStrategy = nullptr;
    std::map<std::string, PlayerRelation> mRelations;
    std::list<PlayerRelationsListener *> mListeners;
    std::vector<PlayerIgnoreStrategy *> mIgnoreStrategies;
};
 
 
extern PlayerRelationsManager player_relations; // singleton representation of player relations