instance_commandscript Class Reference

Inheritance diagram for instance_commandscript:

Public Member Functions
	instance_commandscript ()
ChatCommandTable	GetCommands () const override
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
std::string const &	GetName () const
uint16	GetTotalAvailableHooks ()

Static Public Member Functions
static bool	HandleInstanceListBindsCommand (ChatHandler *handler)
static bool	HandleInstanceUnbindCommand (ChatHandler *handler, Variant< uint16, EXACT_SEQUENCE("all")> mapArg, Optional< uint32 > difficultyArg, Optional< PlayerIdentifier > target)
static bool	HandleInstanceStatsCommand (ChatHandler *handler)
static bool	HandleInstanceSaveDataCommand (ChatHandler *handler)
static bool	HandleInstanceSetBossStateCommand (ChatHandler *handler, uint32 encounterId, uint32 state, Optional< PlayerIdentifier > player)
static bool	HandleInstanceGetBossStateCommand (ChatHandler *handler, Optional< PlayerIdentifier > player)

Static Private Member Functions
static std::unordered_map< uint32, char const * >	GetEncounterNames (InstanceMap const *map)
static std::string	GetBossName (std::unordered_map< uint32, char const * > const &encounterNames, uint32 encounterId)

Additional Inherited Members
Protected Member Functions inherited from CommandScript
	CommandScript (char const *name)
Protected Member Functions inherited from ScriptObject
	ScriptObject (char const *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

instance_commandscript()

instance_commandscript::instance_commandscript ( )

inline

: CommandScript("instance_commandscript") { }

Member Function Documentation

GetBossName()

static std::string instance_commandscript::GetBossName ( std::unordered_map< uint32, char const * > const &  encounterNames, uint32  encounterId  )

inlinestaticprivate

    {
        auto it = encounterNames.find(encounterId);
        return (it != encounterNames.end() && it->second) ? it->second : "Unknown";
    }

Referenced by HandleInstanceGetBossStateCommand(), and HandleInstanceSetBossStateCommand().

GetCommands()

ChatCommandTable instance_commandscript::GetCommands ( ) const

inlineoverridevirtual

Implements CommandScript.

    {
        static ChatCommandTable instanceCommandTable =
        {
            { "listbinds",    HandleInstanceListBindsCommand,    rbac::RBAC_PERM_COMMAND_INSTANCE_LISTBINDS,     Console::No },
            { "unbind",       HandleInstanceUnbindCommand,       rbac::RBAC_PERM_COMMAND_INSTANCE_UNBIND,        Console::Yes },
            { "stats",        HandleInstanceStatsCommand,        rbac::RBAC_PERM_COMMAND_INSTANCE_STATS,         Console::Yes },
            { "savedata",     HandleInstanceSaveDataCommand,     rbac::RBAC_PERM_COMMAND_INSTANCE_SAVEDATA,      Console::No },
            { "setbossstate", HandleInstanceSetBossStateCommand, rbac::RBAC_PERM_COMMAND_INSTANCE_SET_BOSS_STATE, Console::Yes },
            { "getbossstate", HandleInstanceGetBossStateCommand, rbac::RBAC_PERM_COMMAND_INSTANCE_GET_BOSS_STATE, Console::Yes },
        };
 
        static ChatCommandTable commandTable =
        {
            { "instance", instanceCommandTable },
        };
 
        return commandTable;
    }

References HandleInstanceGetBossStateCommand(), HandleInstanceListBindsCommand(), HandleInstanceSaveDataCommand(), HandleInstanceSetBossStateCommand(), HandleInstanceStatsCommand(), HandleInstanceUnbindCommand(), rbac::RBAC_PERM_COMMAND_INSTANCE_GET_BOSS_STATE, rbac::RBAC_PERM_COMMAND_INSTANCE_LISTBINDS, rbac::RBAC_PERM_COMMAND_INSTANCE_SAVEDATA, rbac::RBAC_PERM_COMMAND_INSTANCE_SET_BOSS_STATE, rbac::RBAC_PERM_COMMAND_INSTANCE_STATS, and rbac::RBAC_PERM_COMMAND_INSTANCE_UNBIND.

GetEncounterNames()

static std::unordered_map< uint32, char const * > instance_commandscript::GetEncounterNames ( InstanceMap const *  map )

inlinestaticprivate

    {
        std::unordered_map<uint32, char const*> encounterNames;
        Difficulty difficulty = map->GetDifficulty();
 
        // For heroic ICC/Ruby Sanctum, encounters are only defined
        // for normal difficulty in the DBC, use the same fallback
        // pattern as Map::UpdateEncounterState
        DungeonEncounterList const* encounters = nullptr;
        if ((map->GetId() == 631 || map->GetId() == 724)
            && map->IsHeroic())
        {
            encounters = sObjectMgr->GetDungeonEncounterList(
                map->GetId(),
                !map->Is25ManRaid()
                    ? RAID_DIFFICULTY_10MAN_NORMAL
                    : RAID_DIFFICULTY_25MAN_NORMAL);
        }
        else
        {
            Difficulty diffFixed = IsSharedDifficultyMap(map->GetId())
                ? Difficulty(difficulty % 2)
                : difficulty;
            encounters = sObjectMgr->GetDungeonEncounterList(
                map->GetId(), diffFixed);
        }
 
        if (encounters)
        {
            for (auto const* encounter : *encounters)
                encounterNames[encounter->dbcEntry->encounterIndex]
                    = encounter->dbcEntry->encounterName[0];
        }
 
        return encounterNames;
    }

References Map::GetDifficulty(), Map::GetId(), Map::Is25ManRaid(), Map::IsHeroic(), IsSharedDifficultyMap(), RAID_DIFFICULTY_10MAN_NORMAL, RAID_DIFFICULTY_25MAN_NORMAL, and sObjectMgr.

Referenced by HandleInstanceGetBossStateCommand(), and HandleInstanceSetBossStateCommand().

HandleInstanceGetBossStateCommand()

static bool instance_commandscript::HandleInstanceGetBossStateCommand ( ChatHandler *  handler, Optional< PlayerIdentifier >  player  )

inlinestatic

    {
        // Character name must be provided when using this from console.
        if (!player && !handler->GetSession())
        {
            handler->SendErrorMessage(LANG_CMD_SYNTAX);
            return false;
        }
 
        if (!player)
            player = PlayerIdentifier::FromSelf(handler);
 
        if (!player->IsConnected())
        {
            handler->SendErrorMessage(LANG_PLAYER_NOT_FOUND);
            return false;
        }
 
        InstanceMap* map = player->GetConnectedPlayer()->GetMap()->ToInstanceMap();
        if (!map)
        {
            handler->SendErrorMessage(LANG_NOT_DUNGEON);
            return false;
        }
 
        if (!map->GetInstanceScript())
        {
            handler->SendErrorMessage(LANG_NO_INSTANCE_DATA);
            return false;
        }
 
        std::unordered_map<uint32, char const*> encounterNames = GetEncounterNames(map);
 
        for (uint8 i = 0; i < map->GetInstanceScript()->GetEncounterCount(); ++i)
        {
            uint32 state = map->GetInstanceScript()->GetBossState(i);
            std::string stateName = InstanceScript::GetBossStateName(state);
            std::string bossName = GetBossName(encounterNames, i);
 
            handler->PSendSysMessage(
                LANG_COMMAND_INST_GET_BOSS_STATE,
                i, bossName, state, stateName);
        }
 
        return true;
    }

References Acore::ChatCommands::PlayerIdentifier::FromSelf(), GetBossName(), InstanceScript::GetBossState(), InstanceScript::GetBossStateName(), GetEncounterNames(), InstanceMap::GetInstanceScript(), ChatHandler::GetSession(), LANG_CMD_SYNTAX, LANG_COMMAND_INST_GET_BOSS_STATE, LANG_NO_INSTANCE_DATA, LANG_NOT_DUNGEON, LANG_PLAYER_NOT_FOUND, ChatHandler::PSendSysMessage(), ChatHandler::SendErrorMessage(), and Map::ToInstanceMap().

Referenced by GetCommands().

HandleInstanceListBindsCommand()

static bool instance_commandscript::HandleInstanceListBindsCommand ( ChatHandler *  handler )

inlinestatic

    {
        Player* player = handler->getSelectedPlayer();
        if (!player)
            player = handler->GetSession()->GetPlayer();
 
        uint32 counter = 0;
 
        for (uint8 i = 0; i < MAX_DIFFICULTY; ++i)
        {
            for (auto const& [mapId, bind] : sInstanceSaveMgr->PlayerGetBoundInstances(player->GetGUID(), Difficulty(i)))
            {
                InstanceSave const* save = bind.save;
                uint32 resetTime = bind.extended ? save->GetExtendedResetTime() : save->GetResetTime();
                uint32 ttr = (resetTime >= GameTime::GetGameTime().count() ? resetTime - GameTime::GetGameTime().count() : 0);
                std::string timeleft = secsToTimeString(ttr);
                handler->PSendSysMessage("map: {}, inst: {}, perm: {}, diff: {}, canReset: {}, TTR: {}{}",
                    mapId, save->GetInstanceId(), bind.perm ? "yes" : "no", save->GetDifficulty(), save->CanReset() ? "yes" : "no", timeleft, (bind.extended ? " (extended)" : ""));
                counter++;
            }
        }
 
        handler->PSendSysMessage("player binds: {}", counter);
 
        return true;
    }

References InstanceSave::CanReset(), InstanceSave::GetDifficulty(), InstanceSave::GetExtendedResetTime(), GameTime::GetGameTime(), Object::GetGUID(), InstanceSave::GetInstanceId(), WorldSession::GetPlayer(), InstanceSave::GetResetTime(), ChatHandler::getSelectedPlayer(), ChatHandler::GetSession(), MAX_DIFFICULTY, ChatHandler::PSendSysMessage(), secsToTimeString(), and sInstanceSaveMgr.

Referenced by GetCommands().

HandleInstanceSaveDataCommand()

static bool instance_commandscript::HandleInstanceSaveDataCommand ( ChatHandler *  handler )

inlinestatic

    {
        Player* player = handler->GetSession()->GetPlayer();
        Map* map = player->GetMap();
        if (!map->IsDungeon())
        {
            handler->SendErrorMessage("Map is not a dungeon.");
            return false;
        }
 
        if (!map->ToInstanceMap()->GetInstanceScript())
        {
            handler->SendErrorMessage("Map has no instance data.");
            return false;
        }
 
        map->ToInstanceMap()->GetInstanceScript()->SaveToDB();
 
        return true;
    }

References InstanceMap::GetInstanceScript(), WorldObject::GetMap(), WorldSession::GetPlayer(), ChatHandler::GetSession(), Map::IsDungeon(), InstanceScript::SaveToDB(), ChatHandler::SendErrorMessage(), and Map::ToInstanceMap().

Referenced by GetCommands().

HandleInstanceSetBossStateCommand()

static bool instance_commandscript::HandleInstanceSetBossStateCommand ( ChatHandler *  handler, uint32  encounterId, uint32  state, Optional< PlayerIdentifier >  player  )

inlinestatic

    {
        // Character name must be provided when using this from console.
        if (!player && !handler->GetSession())
        {
            handler->SendErrorMessage(LANG_CMD_SYNTAX);
            return false;
        }
 
        if (!player)
            player = PlayerIdentifier::FromSelf(handler);
 
        if (!player->IsConnected())
        {
            handler->SendErrorMessage(LANG_PLAYER_NOT_FOUND);
            return false;
        }
 
        InstanceMap* map = player->GetConnectedPlayer()->GetMap()->ToInstanceMap();
        if (!map)
        {
            handler->SendErrorMessage(LANG_NOT_DUNGEON);
            return false;
        }
 
        if (!map->GetInstanceScript())
        {
            handler->SendErrorMessage(LANG_NO_INSTANCE_DATA);
            return false;
        }
 
        // Reject improper values.
        if (encounterId > map->GetInstanceScript()->GetEncounterCount())
        {
            handler->SendErrorMessage(LANG_BAD_VALUE);
            return false;
        }
 
        map->GetInstanceScript()->SetBossState(encounterId, EncounterState(state));
        std::string stateName = InstanceScript::GetBossStateName(state);
        std::string bossName = GetBossName(GetEncounterNames(map), encounterId);
        handler->PSendSysMessage(LANG_COMMAND_INST_SET_BOSS_STATE, encounterId, bossName, state, stateName);
        return true;
    }

References Acore::ChatCommands::PlayerIdentifier::FromSelf(), GetBossName(), InstanceScript::GetBossStateName(), InstanceScript::GetEncounterCount(), GetEncounterNames(), InstanceMap::GetInstanceScript(), ChatHandler::GetSession(), LANG_BAD_VALUE, LANG_CMD_SYNTAX, LANG_COMMAND_INST_SET_BOSS_STATE, LANG_NO_INSTANCE_DATA, LANG_NOT_DUNGEON, LANG_PLAYER_NOT_FOUND, ChatHandler::PSendSysMessage(), ChatHandler::SendErrorMessage(), InstanceScript::SetBossState(), and Map::ToInstanceMap().

Referenced by GetCommands().

HandleInstanceStatsCommand()

static bool instance_commandscript::HandleInstanceStatsCommand ( ChatHandler *  handler )

inlinestatic

    {
        uint32 dungeon = 0, battleground = 0, arena = 0, spectators = 0;
        sMapMgr->GetNumInstances(dungeon, battleground, arena);
        handler->PSendSysMessage("instances loaded: dungeons ({}), battlegrounds ({}), arenas ({})", dungeon, battleground, arena);
        dungeon = 0;
        battleground = 0;
        arena = 0;
        spectators = 0;
        sMapMgr->GetNumPlayersInInstances(dungeon, battleground, arena, spectators);
        handler->SendErrorMessage("players in instances: dungeons ({}), battlegrounds ({}), arenas ({} + {} spect)", dungeon, battleground, arena, spectators);
        return false;
    }

References ChatHandler::PSendSysMessage(), ChatHandler::SendErrorMessage(), and sMapMgr.

Referenced by GetCommands().

HandleInstanceUnbindCommand()

static bool instance_commandscript::HandleInstanceUnbindCommand ( ChatHandler *  handler, Variant< uint16, EXACT_SEQUENCE("all")>  mapArg, Optional< uint32 >  difficultyArg, Optional< PlayerIdentifier >  target  )

inlinestatic

    {
        if (!target)
            target = PlayerIdentifier::FromTargetOrSelf(handler);
 
        if (!target)
        {
            handler->SendErrorMessage(LANG_PLAYER_NOT_FOUND);
            return false;
        }
 
        Player* player = target->GetConnectedPlayer();
        ObjectGuid const guid = target->GetGUID();
 
        // Keep the bind of the map the character is on, or logged out on
        uint32 currentMapId = 0;
        if (player)
            currentMapId = player->GetMapId();
        else
        {
            CharacterDatabasePreparedStatement* stmt =
                CharacterDatabase.GetPreparedStatement(CHAR_SEL_CHAR_POSITION_XYZ);
            stmt->SetData(0, guid.GetCounter());
            if (PreparedQueryResult result = CharacterDatabase.Query(stmt))
                currentMapId = (*result)[0].Get<uint16>();
        }
 
        uint16 counter = 0;
        uint16 mapId = 0;
 
        if (mapArg.holds_alternative<uint16>())
        {
            mapId = mapArg.get<uint16>();
            if (!mapId)
                return false;
        }
 
        for (uint8 i = 0; i < MAX_DIFFICULTY; ++i)
        {
            BoundInstancesMap const& m_boundInstances = sInstanceSaveMgr->PlayerGetBoundInstances(guid, Difficulty(i));
            for (BoundInstancesMap::const_iterator itr = m_boundInstances.begin(); itr != m_boundInstances.end();)
            {
                InstanceSave const* save = itr->second.save;
                if (itr->first != currentMapId && (!mapId || mapId == itr->first)
                    && (!difficultyArg || *difficultyArg == uint32(save->GetDifficulty())))
                {
                    uint32 resetTime = itr->second.extended ? save->GetExtendedResetTime() : save->GetResetTime();
                    uint32 ttr = (resetTime >= GameTime::GetGameTime().count() ? resetTime - GameTime::GetGameTime().count() : 0);
                    std::string timeleft = secsToTimeString(ttr);
                    handler->PSendSysMessage("unbinding map: {}, inst: {}, perm: {}, diff: {}, canReset: {}, TTR: {}{}", itr->first, save->GetInstanceId(), itr->second.perm ? "yes" : "no", save->GetDifficulty(), save->CanReset() ? "yes" : "no", timeleft, (itr->second.extended ? " (extended)" : ""));
                    sInstanceSaveMgr->PlayerUnbindInstance(guid, itr->first, Difficulty(i), true, player);
                    itr = m_boundInstances.begin();
                    counter++;
                }
                else
                    ++itr;
            }
        }
 
        handler->PSendSysMessage("instances unbound: {}", counter);
 
        return true;
    }

References InstanceSave::CanReset(), CHAR_SEL_CHAR_POSITION_XYZ, CharacterDatabase, Acore::ChatCommands::PlayerIdentifier::FromTargetOrSelf(), ObjectGuid::GetCounter(), InstanceSave::GetDifficulty(), InstanceSave::GetExtendedResetTime(), GameTime::GetGameTime(), InstanceSave::GetInstanceId(), WorldLocation::GetMapId(), InstanceSave::GetResetTime(), LANG_PLAYER_NOT_FOUND, MAX_DIFFICULTY, ChatHandler::PSendSysMessage(), secsToTimeString(), ChatHandler::SendErrorMessage(), PreparedStatementBase::SetData(), and sInstanceSaveMgr.

Referenced by GetCommands().

---

The documentation for this class was generated from the following file:

• azerothcore-wotlk/src/server/scripts/Commands/cs_instance.cpp