ScriptRegistry< TScript > Class Template Reference

#include "ScriptMgr.h"

Public Types
typedef std::map< uint32, TScript * >	ScriptMap
typedef ScriptMap::iterator	ScriptMapIterator
typedef std::vector< std::pair< TScript *, std::vector< uint16 > > >	ScriptVector
typedef ScriptVector::iterator	ScriptVectorIterator
typedef std::vector< std::vector< TScript * > >	EnabledHooksVector
typedef EnabledHooksVector::iterator	EnabledHooksVectorIterator

Static Public Member Functions
static void	InitEnabledHooksIfNeeded (uint16 totalAvailableHooks)
static void	AddScript (TScript *const script, std::vector< uint16 > enabledHooks={})
static void	AddALScripts ()
static void	Unload ()
static TScript *	GetScriptById (uint32 id)

Static Public Attributes
static ScriptMap	ScriptPointerList
static ScriptVector	ALScripts
static EnabledHooksVector	EnabledHooks

Static Private Member Functions
static bool	_checkMemory (TScript *const script)

Static Private Attributes
static uint32	_scriptIdCounter = 0

Detailed Description

template<class TScript>
class ScriptRegistry< TScript >

Member Typedef Documentation

EnabledHooksVector

template<class TScript >

typedef std::vector<std::vector<TScript*> > ScriptRegistry< TScript >::EnabledHooksVector

EnabledHooksVectorIterator

template<class TScript >

typedef EnabledHooksVector::iterator ScriptRegistry< TScript >::EnabledHooksVectorIterator

ScriptMap

template<class TScript >

typedef std::map<uint32, TScript*> ScriptRegistry< TScript >::ScriptMap

ScriptMapIterator

template<class TScript >

typedef ScriptMap::iterator ScriptRegistry< TScript >::ScriptMapIterator

ScriptVector

template<class TScript >

typedef std::vector<std::pair<TScript*,std::vector<uint16> > > ScriptRegistry< TScript >::ScriptVector

ScriptVectorIterator

template<class TScript >

typedef ScriptVector::iterator ScriptRegistry< TScript >::ScriptVectorIterator

Member Function Documentation

_checkMemory()

template<class TScript >

static bool ScriptRegistry< TScript >::_checkMemory ( TScript *const  script )

inlinestaticprivate

    {
        // See if the script is using the same memory as another script. If this happens, it means that
        // someone forgot to allocate new memory for a script.
        for (ScriptMapIterator it = ScriptPointerList.begin(); it != ScriptPointerList.end(); ++it)
        {
            if (it->second == script)
            {
                LOG_ERROR("scripts", "Script '{}' has same memory pointer as '{}'.",
                               script->GetName(), it->second->GetName());
 
                return false;
            }
        }
 
        return true;
    }

References LOG_ERROR, and ScriptRegistry< TScript >::ScriptPointerList.

Referenced by ScriptRegistry< TScript >::AddALScripts().

AddALScripts()

template<class TScript >

static void ScriptRegistry< TScript >::AddALScripts ( )

inlinestatic

    {
        for (ScriptVectorIterator it = ALScripts.begin(); it != ALScripts.end(); ++it)
        {
            TScript* const script = (*it).first;
 
            script->checkValidity();
 
            if (script->IsDatabaseBound())
            {
                if (!_checkMemory(script))
                {
                    return;
                }
 
                // Get an ID for the script. An ID only exists if it's a script that is assigned in the database
                // through a script name (or similar).
                uint32 id = sObjectMgr->GetScriptId(script->GetName().c_str());
                if (id)
                {
                    // Try to find an existing script.
                    TScript const* oldScript = nullptr;
                    for (auto iterator = ScriptPointerList.begin(); iterator != ScriptPointerList.end(); ++iterator)
                    {
                        // If the script names match...
                        if (iterator->second->GetName() == script->GetName())
                        {
                            // ... It exists.
                            oldScript = iterator->second;
                            break;
                        }
                    }
 
                    // If the script is already assigned -> delete it!
                    if (oldScript)
                    {
                        for (auto& vIt : EnabledHooks)
                            for (std::size_t i = 0; i < vIt.size(); ++i)
                                if (vIt[i] == oldScript)
                                {
                                    vIt.erase(vIt.begin() + i);
                                    break;
                                }
 
                        delete oldScript;
                    }
 
                    // Assign new script!
                    ScriptPointerList[id] = script;
 
                    // Increment script count only with new scripts
                    if (!oldScript)
                    {
                        sScriptMgr->IncreaseScriptCount();
                    }
                }
                else
                {
                    // The script uses a script name from database, but isn't assigned to anything.
                    if (script->GetName().find("Smart") == std::string::npos)
                        LOG_ERROR("sql.sql", "Script named '{}' is not assigned in the database.",
                                         script->GetName());
                }
            }
            else
            {
                for (uint16 v : (*it).second)
                    EnabledHooks[v].emplace_back(script);
 
                // We're dealing with a code-only script; just add it.
                ScriptPointerList[_scriptIdCounter++] = script;
                sScriptMgr->IncreaseScriptCount();
            }
        }
    }

References ScriptRegistry< TScript >::_checkMemory(), ScriptRegistry< TScript >::_scriptIdCounter, ScriptRegistry< TScript >::ALScripts, ScriptRegistry< TScript >::EnabledHooks, LOG_ERROR, ScriptRegistry< TScript >::ScriptPointerList, sObjectMgr, and sScriptMgr.

AddScript()

template<class TScript >

static void ScriptRegistry< TScript >::AddScript ( TScript *const  script, std::vector< uint16 >  enabledHooks = {}  )

inlinestatic

                                                                                  {})
    {
        ASSERT(script);
 
        if (!_checkMemory(script))
            return;
 
        if (EnabledHooks.empty())
            InitEnabledHooksIfNeeded(script->GetTotalAvailableHooks());
 
        if (script->isAfterLoadScript())
        {
            ALScripts.emplace_back(script, std::move(enabledHooks));
        }
        else
        {
            script->checkValidity();
 
            for (uint16 v : enabledHooks)
                EnabledHooks[v].emplace_back(script);
 
            // We're dealing with a code-only script; just add it.
            ScriptPointerList[_scriptIdCounter++] = script;
            sScriptMgr->IncreaseScriptCount();
        }
    }

Referenced by AccountScript::AccountScript(), AchievementCriteriaScript::AchievementCriteriaScript(), AchievementScript::AchievementScript(), ALEScript::ALEScript(), AllBattlegroundScript::AllBattlegroundScript(), AllCommandScript::AllCommandScript(), AllCreatureScript::AllCreatureScript(), AllGameObjectScript::AllGameObjectScript(), AllItemScript::AllItemScript(), AllMapScript::AllMapScript(), AllSpellScript::AllSpellScript(), AreaTriggerScript::AreaTriggerScript(), ArenaScript::ArenaScript(), ArenaTeamScript::ArenaTeamScript(), AuctionHouseScript::AuctionHouseScript(), BattlefieldScript::BattlefieldScript(), BattlegroundMapScript::BattlegroundMapScript(), BattlegroundScript::BattlegroundScript(), CommandScript::CommandScript(), ConditionScript::ConditionScript(), CreatureScript::CreatureScript(), DatabaseScript::DatabaseScript(), DynamicObjectScript::DynamicObjectScript(), FormulaScript::FormulaScript(), GameEventScript::GameEventScript(), GameObjectScript::GameObjectScript(), GlobalScript::GlobalScript(), GroupScript::GroupScript(), GuildScript::GuildScript(), InstanceMapScript::InstanceMapScript(), ItemScript::ItemScript(), LootScript::LootScript(), MailScript::MailScript(), MiscScript::MiscScript(), ModuleScript::ModuleScript(), MovementHandlerScript::MovementHandlerScript(), OutdoorPvPScript::OutdoorPvPScript(), PetScript::PetScript(), PlayerScript::PlayerScript(), ServerScript::ServerScript(), SessionScript::SessionScript(), SpellScriptLoader::SpellScriptLoader(), TicketScript::TicketScript(), TransportScript::TransportScript(), UnitScript::UnitScript(), VehicleScript::VehicleScript(), WeatherScript::WeatherScript(), WorldMapScript::WorldMapScript(), WorldObjectScript::WorldObjectScript(), and WorldScript::WorldScript().

GetScriptById()

template<class TScript >

static TScript * ScriptRegistry< TScript >::GetScriptById ( uint32  id )

inlinestatic

    {
        ScriptMapIterator it = ScriptPointerList.find(id);
        if (it != ScriptPointerList.end())
            return it->second;
 
        return nullptr;
    }

References ScriptRegistry< TScript >::ScriptPointerList.

Referenced by ScriptMgr::CreateAuraScripts(), ScriptMgr::CreateInstanceScript(), ScriptMgr::CreateOutdoorPvP(), ScriptMgr::CreateSpellScriptLoaders(), ScriptMgr::CreateSpellScripts(), ScriptMgr::GetCreatureAI(), ScriptMgr::GetDialogStatus(), ScriptMgr::GetDialogStatus(), ScriptMgr::GetGameObjectAI(), ScriptMgr::OnCastItemCombatSpell(), ScriptMgr::OnConditionCheck(), ScriptMgr::OnCriteriaCheck(), ScriptMgr::OnGossipHello(), ScriptMgr::OnGossipHello(), ScriptMgr::OnGossipSelect(), ScriptMgr::OnGossipSelect(), ScriptMgr::OnGossipSelectCode(), ScriptMgr::OnGossipSelectCode(), ScriptMgr::OnItemExpire(), ScriptMgr::OnItemRemove(), ScriptMgr::OnItemUse(), ScriptMgr::OnQuestAccept(), ScriptMgr::OnQuestAccept(), ScriptMgr::OnQuestAccept(), ScriptMgr::OnQuestComplete(), ScriptMgr::OnQuestReward(), ScriptMgr::OnQuestReward(), and ScriptMgr::OnQuestSelect().

InitEnabledHooksIfNeeded()

template<class TScript >

static void ScriptRegistry< TScript >::InitEnabledHooksIfNeeded ( uint16  totalAvailableHooks )

inlinestatic

    {
        EnabledHooks.resize(totalAvailableHooks);
    }

References ScriptRegistry< TScript >::EnabledHooks.

Referenced by TestMap::EnsureDBC(), ArenaHookDefaultsTest::EnsureScriptRegistriesInitialized(), and LowLevelsMinPlayersOverrideTest::SetUp().

Unload()

template<class TScript >

static void ScriptRegistry< TScript >::Unload ( )

inlinestatic

    {
        for (auto const& [scriptID, script] : ScriptPointerList)
            delete script;
 
        ScriptPointerList.clear();
 
        for (auto& hookScripts : EnabledHooks)
            hookScripts.clear();
    }

References ScriptRegistry< TScript >::EnabledHooks, and ScriptRegistry< TScript >::ScriptPointerList.

Referenced by TEST(), and ScriptMgr::Unload().

Member Data Documentation

_scriptIdCounter

template<class TScript >

uint32 ScriptRegistry< TScript >::_scriptIdCounter = 0

staticprivate

Referenced by ScriptRegistry< TScript >::AddALScripts().

ALScripts

template<class TScript >

std::vector< std::pair< TScript *, std::vector< uint16 > > > ScriptRegistry< TScript >::ALScripts

static

Referenced by ScriptRegistry< TScript >::AddALScripts().

EnabledHooks

template<class TScript >

std::vector< std::vector< TScript * > > ScriptRegistry< TScript >::EnabledHooks

static

Referenced by ScriptRegistry< TScript >::AddALScripts(), ScriptRegistry< TScript >::InitEnabledHooksIfNeeded(), and ScriptRegistry< TScript >::Unload().

ScriptPointerList

template<class TScript >

std::map< uint32, TScript * > ScriptRegistry< TScript >::ScriptPointerList

static

Referenced by ScriptRegistry< TScript >::_checkMemory(), ScriptRegistry< TScript >::AddALScripts(), ScriptRegistry< TScript >::GetScriptById(), and ScriptRegistry< TScript >::Unload().

---

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

• azerothcore-wotlk/src/server/game/Scripting/ScriptMgr.h