LFG.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef SF_LFG_H
#define SF_LFG_H
 
#include "Common.h"
 
namespace lfg
{
 
    enum LFGEnum
    {
        LFG_TANKS_NEEDED = 1,
        LFG_HEALERS_NEEDED = 1,
        LFG_DPS_NEEDED = 3
    };
 
    enum LfgRoles
    {
        PLAYER_ROLE_NONE = 0x00,
        PLAYER_ROLE_LEADER = 0x01,
        PLAYER_ROLE_TANK = 0x02,
        PLAYER_ROLE_HEALER = 0x04,
        PLAYER_ROLE_DAMAGE = 0x08
    };
 
    enum LfgShortageIndex
    {
        LFG_ROLE_SHORTAGE_RARE = 0,
        LFG_ROLE_SHORTAGE_UNCOMMON = 1,
        LFG_ROLE_SHORTAGE_PLENTIFUL = 2,
        LFG_ROLE_SHORTAGE_MAX
    };
 
    enum LfgUpdateType
    {
        LFG_UPDATETYPE_DEFAULT = 0,      // Internal Use
        LFG_UPDATETYPE_LEADER_UNK1 = 1,      // FIXME: At group leave
        LFG_UPDATETYPE_ROLECHECK_ABORTED = 4,
        LFG_UPDATETYPE_JOIN_QUEUE = 6,
        LFG_UPDATETYPE_ROLECHECK_FAILED = 7,
        LFG_UPDATETYPE_REMOVED_FROM_QUEUE = 8,
        LFG_UPDATETYPE_PROPOSAL_FAILED = 9,
        LFG_UPDATETYPE_PROPOSAL_DECLINED = 10,
        LFG_UPDATETYPE_GROUP_FOUND = 11,
        LFG_UPDATETYPE_ADDED_TO_QUEUE = 13,
        LFG_UPDATETYPE_PROPOSAL_BEGIN = 14,
        LFG_UPDATETYPE_UPDATE_STATUS = 15,
        LFG_UPDATETYPE_GROUP_MEMBER_OFFLINE = 16,
        LFG_UPDATETYPE_GROUP_DISBAND_UNK16 = 17,     // FIXME: Sometimes at group disband
        LFG_UPDATETYPE_JOIN_QUEUE_INITIAL = 24,
        LFG_UPDATETYPE_DUNGEON_FINISHED = 25,
        LFG_UPDATETYPE_PARTY_ROLE_NOT_AVAILABLE = 43,
        LFG_UPDATETYPE_JOIN_LFG_OBJECT_FAILED = 45,
    };
 
    enum LfgState
    {
        LFG_STATE_NONE,                                        // Not using LFG / LFR
        LFG_STATE_ROLECHECK,                                   // Rolecheck active
        LFG_STATE_QUEUED,                                      // Queued
        LFG_STATE_PROPOSAL,                                    // Proposal active
        LFG_STATE_BOOT,                                        // Vote kick active
        LFG_STATE_DUNGEON,                                     // In LFG Group, in a Dungeon
        LFG_STATE_FINISHED_DUNGEON,                            // In LFG Group, in a finished Dungeon
        LFG_STATE_RAIDBROWSER                                  // Using Raid finder
    };

    enum LfgLockStatusType
    {
        LFG_LOCKSTATUS_INSUFFICIENT_EXPANSION = 1,
        LFG_LOCKSTATUS_TOO_LOW_LEVEL = 2,
        LFG_LOCKSTATUS_TOO_HIGH_LEVEL = 3,
        LFG_LOCKSTATUS_TOO_LOW_GEAR_SCORE = 4,
        LFG_LOCKSTATUS_TOO_HIGH_GEAR_SCORE = 5,
        LFG_LOCKSTATUS_RAID_LOCKED = 6,
        LFG_LOCKSTATUS_ATTUNEMENT_TOO_LOW_LEVEL = 1001,
        LFG_LOCKSTATUS_ATTUNEMENT_TOO_HIGH_LEVEL = 1002,
        LFG_LOCKSTATUS_QUEST_NOT_COMPLETED = 1022,
        LFG_LOCKSTATUS_MISSING_ITEM = 1025,
        LFG_LOCKSTATUS_NOT_IN_SEASON = 1031,
        LFG_LOCKSTATUS_MISSING_ACHIEVEMENT = 1034
    };

    enum LfgAnswer
    {
        LFG_ANSWER_PENDING = -1,
        LFG_ANSWER_DENY = 0,
        LFG_ANSWER_AGREE = 1
    };
 
    struct LfgLockData
    {
        LfgLockData(uint32 lock = 0, uint32 currentItemLevel = 0, uint32 requiredItemLevel = 0) :
            lockStatus(lock), currentItemLevel(currentItemLevel), requiredItemLevel(requiredItemLevel) { }
 
        uint32 lockStatus;
        uint32 currentItemLevel;
        uint32 requiredItemLevel;
    };
 
    typedef std::set<uint32> LfgDungeonSet;
    typedef std::map<uint32, LfgLockData> LfgLockMap;
    typedef std::map<uint64, LfgLockMap> LfgLockPartyMap;
    typedef std::set<uint64> LfgGuidSet;
    typedef std::list<uint64> LfgGuidList;
    typedef std::map<uint64, uint8> LfgRolesMap;
    typedef std::map<uint64, uint64> LfgGroupsMap;
 
    std::string ConcatenateGuids(LfgGuidList const& guids);
    std::string ConcatenateDungeons(LfgDungeonSet const& dungeons);
    bool IsValidPlayerRoles(uint8 roles);
    std::string GetRolesString(uint8 roles);
    std::string GetStateString(LfgState state);
 
} // namespace lfg
 
#endif