Scoreboard.h

Go to the documentation of this file.

 
// Scoreboard.h
 
// Implementation of a scoreboard that keeps track of specified objectives
 
 
 
 
 
#pragma once
 
#include "FunctionRef.h"
 
 
 
 
 
class cClientHandle;
class cObjective;
class cTeam;
class cWorld;
 
using cObjectiveCallback = cFunctionRef<bool(cObjective &)>;
using cTeamCallback      = cFunctionRef<bool(cTeam &)>;
 
 
 
 
 
// tolua_begin
class cObjective
{
public:
 
    typedef int Score;
 
    enum eType
    {
        otDummy,
 
        otDeathCount,
        otPlayerKillCount,
        otTotalKillCount,
        otHealth,
 
        otAchievement,
 
        otStat,
        otStatItemCraft,
        otStatItemUse,
        otStatItemBreak,
 
        otStatBlockMine,
        otStatEntityKill,
        otStatEntityKilledBy
    };
 
    // tolua_end
 
    static AString TypeToString(eType a_Type);
 
    static eType StringToType(const AString & a_Name);
 
public:
 
    cObjective(const AString & a_Name, const AString & a_DisplayName, eType a_Type, cWorld * a_World);
 
    // tolua_begin
 
    eType GetType(void) const { return m_Type; }
 
    const AString & GetName(void)        const { return m_Name; }
    const AString & GetDisplayName(void) const { return m_DisplayName; }
 
    void Reset(void);
 
    Score GetScore(const AString & a_Name) const;
 
    void SetScore(const AString & a_Name, Score a_Score);
 
    void ResetScore(const AString & a_Name);
 
    Score AddScore(const AString & a_Name, Score a_Delta);
 
    Score SubScore(const AString & a_Name, Score a_Delta);
 
    void SetDisplayName(const AString & a_Name);
 
    // tolua_end
 
    void SendTo(cClientHandle & a_Client);
 
private:
 
    typedef std::pair<AString, Score> cTrackedPlayer;
 
    typedef std::map<AString, Score> cScoreMap;
 
    cScoreMap m_Scores;
 
    AString m_DisplayName;
    AString m_Name;
 
    eType m_Type;
 
    cWorld * m_World;
 
    friend class cScoreboardSerializer;
 
 
};  // tolua_export
 
 
 
 
 
// tolua_begin
class cTeam
{
public:
 
    // tolua_end
 
    cTeam(
        const AString & a_Name, const AString & a_DisplayName,
        const AString & a_Prefix, const AString & a_Suffix
    );
 
    // tolua_begin
 
    bool AddPlayer(const AString & a_Name);
 
    bool RemovePlayer(const AString & a_Name);
 
    bool HasPlayer(const AString & a_Name) const;
 
    void Reset(void);
 
    // tolua_begin
 
    size_t GetNumPlayers(void) const;
 
    bool AllowsFriendlyFire(void)      const { return m_AllowsFriendlyFire; }
    bool CanSeeFriendlyInvisible(void) const { return m_CanSeeFriendlyInvisible; }
 
    const AString & GetDisplayName(void) const { return m_DisplayName; }
    const AString & GetName(void)        const { return m_Name; }
 
    const AString & GetPrefix(void) const { return m_Prefix; }
    const AString & GetSuffix(void) const { return m_Suffix; }
 
    void SetFriendlyFire(bool a_Flag)            { m_AllowsFriendlyFire      = a_Flag; }
    void SetCanSeeFriendlyInvisible(bool a_Flag) { m_CanSeeFriendlyInvisible = a_Flag; }
 
    void SetDisplayName(const AString & a_Name);
 
    void SetPrefix(const AString & a_Prefix) { m_Prefix = a_Prefix; }
    void SetSuffix(const AString & a_Suffix) { m_Suffix = a_Suffix; }
 
    // tolua_end
 
private:
 
    typedef std::set<AString> cPlayerNameSet;
 
    bool m_AllowsFriendlyFire;
    bool m_CanSeeFriendlyInvisible;
 
    AString m_DisplayName;
    AString m_Name;
 
    AString m_Prefix;
    AString m_Suffix;
 
    cPlayerNameSet m_Players;
 
    friend class cScoreboardSerializer;
 
 
};  // tolua_export
 
 
 
 
 
// tolua_begin
class cScoreboard
{
public:
 
    enum eDisplaySlot
    {
        dsList = 0,
        dsSidebar,
        dsName,
 
        dsCount
    };
 
    // tolua_end
 
 
public:
 
    cScoreboard(cWorld * a_World);
 
    // tolua_begin
 
    cObjective * RegisterObjective(const AString & a_Name, const AString & a_DisplayName, cObjective::eType a_Type);
 
    bool RemoveObjective(const AString & a_Name);
 
    cObjective * GetObjective(const AString & a_Name);
 
    cTeam * RegisterTeam(const AString & a_Name, const AString & a_DisplayName, const AString & a_Prefix, const AString & a_Suffix);
 
    bool RemoveTeam(const AString & a_Name);
 
    cTeam * GetTeam(const AString & a_Name);
 
    void SetDisplay(const AString & a_Objective, eDisplaySlot a_Slot);
 
    cObjective * GetObjectiveIn(eDisplaySlot a_Slot);
 
    size_t GetNumObjectives(void) const;
 
    size_t GetNumTeams(void) const;
 
    void AddPlayerScore(const AString & a_Name, cObjective::eType a_Type, cObjective::Score a_Value = 1);
 
    // tolua_end
 
    AStringVector GetTeamNames();
 
    void SendTo(cClientHandle & a_Client);
 
    cTeam * QueryPlayerTeam(const AString & a_Name);  // WARNING: O(n logn)
 
    bool ForEachObjectiveWith(cObjective::eType a_Type, cObjectiveCallback a_Callback);
 
    bool ForEachObjective(cObjectiveCallback a_Callback);  // Exported in ManualBindings.cpp
 
    bool ForEachTeam(cTeamCallback a_Callback);  // Exported in ManualBindings.cpp
 
    void SetDisplay(cObjective * a_Objective, eDisplaySlot a_Slot);
 
 
private:
 
    typedef std::pair<AString, cObjective> cNamedObjective;
    typedef std::pair<AString, cTeam>      cNamedTeam;
 
    typedef std::map<AString, cObjective> cObjectiveMap;
    typedef std::map<AString, cTeam>      cTeamMap;
 
    // TODO 2014-01-19 xdot: Potential optimization - Sort objectives based on type
    cCriticalSection m_CSObjectives;
    cObjectiveMap m_Objectives;
 
    cCriticalSection m_CSTeams;
    cTeamMap m_Teams;
 
    cWorld * m_World;
 
    cObjective * m_Display[dsCount];
 
    friend class cScoreboardSerializer;
 
 
};  // tolua_export