DatabaseScript Class Reference

#include "DatabaseScript.h"

Inheritance diagram for DatabaseScript:

Public Member Functions
bool	IsDatabaseBound () const override
virtual void	OnAfterDatabasesLoaded (uint32)
	Called after all databases are loaded.
virtual void	OnAfterDatabaseLoadCreatureTemplates (std::vector< CreatureTemplate * >)
	Called after all creature template data has been loaded from the database. This hook could be called multiple times, not just at server startup.
virtual bool	OnModuleDatabasesLoading ()
	Called once the core databases are up, so a module can open a database of its own. Runs before the rest of the world loads, unlike OnAfterDatabasesLoaded which reports the finished core load.
virtual void	OnModuleDatabasesKeepAlive ()
	Called on the world's keep-alive tick, alongside the core pools being pinged.
virtual void	OnModuleDatabasesClosing ()
	Called after the core databases are closed, so a module can close its own.
virtual void	OnDatabaseWarnAboutSyncQueries (bool)
	Called when the core turns its synchronous-query warning on or off.
virtual void	OnDatabaseGetDBRevision (std::map< std::string, std::string > &)
	Called by .server info to collect the revision of a module-owned database.
Public Member Functions inherited from ScriptObject
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
std::string const &	GetName () const
uint16	GetTotalAvailableHooks ()

Protected Member Functions
	DatabaseScript (char const *name, std::vector< uint16 > enabledHooks=std::vector< uint16 >())
Protected Member Functions inherited from ScriptObject
	ScriptObject (char const *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

DatabaseScript()

DatabaseScript::DatabaseScript ( char const *  name, std::vector< uint16 >  enabledHooks = std::vector<uint16>()  )

protected

    : ScriptObject(name, DATABASEHOOK_END)
{
    // If empty - enable all available hooks.
    if (enabledHooks.empty())
        for (uint16 i = 0; i < DATABASEHOOK_END; ++i)
            enabledHooks.emplace_back(i);
 
    ScriptRegistry<DatabaseScript>::AddScript(this, std::move(enabledHooks));
}

References ScriptRegistry< TScript >::AddScript(), and DATABASEHOOK_END.

Member Function Documentation

IsDatabaseBound()

bool DatabaseScript::IsDatabaseBound ( ) const

inlineoverridevirtual

Reimplemented from ScriptObject.

{ return false; }

OnAfterDatabaseLoadCreatureTemplates()

virtual void DatabaseScript::OnAfterDatabaseLoadCreatureTemplates ( std::vector< CreatureTemplate * >  )

inlinevirtual

Called after all creature template data has been loaded from the database. This hook could be called multiple times, not just at server startup.

Parameters

creatureTemplates

Pointer to a modifiable vector of creature templates. Indexed by Entry ID.

{ }

Referenced by ScriptMgr::OnAfterDatabaseLoadCreatureTemplates().

OnAfterDatabasesLoaded()

virtual void DatabaseScript::OnAfterDatabasesLoaded ( uint32  )

inlinevirtual

Called after all databases are loaded.

Parameters

updateFlags

Update flags from the loader

{ }

Referenced by ScriptMgr::OnAfterDatabasesLoaded().

OnDatabaseGetDBRevision()

virtual void DatabaseScript::OnDatabaseGetDBRevision ( std::map< std::string, std::string > &  )

inlinevirtual

Called by .server info to collect the revision of a module-owned database.

Parameters

revisions

Revision string to report, keyed by module name

{ }

Referenced by ScriptMgr::OnDatabaseGetDBRevision().

OnDatabaseWarnAboutSyncQueries()

virtual void DatabaseScript::OnDatabaseWarnAboutSyncQueries ( bool  )

inlinevirtual

Called when the core turns its synchronous-query warning on or off.

Parameters

apply

True when the warning is being enabled

{ }

Referenced by ScriptMgr::OnDatabaseWarnAboutSyncQueries().

OnModuleDatabasesClosing()

virtual void DatabaseScript::OnModuleDatabasesClosing ( )

inlinevirtual

Called after the core databases are closed, so a module can close its own.

{ }

Referenced by ScriptMgr::OnModuleDatabasesClosing().

OnModuleDatabasesKeepAlive()

virtual void DatabaseScript::OnModuleDatabasesKeepAlive ( )

inlinevirtual

Called on the world's keep-alive tick, alongside the core pools being pinged.

{ }

Referenced by ScriptMgr::OnModuleDatabasesKeepAlive().

OnModuleDatabasesLoading()

virtual bool DatabaseScript::OnModuleDatabasesLoading ( )

inlinevirtual

Called once the core databases are up, so a module can open a database of its own. Runs before the rest of the world loads, unlike OnAfterDatabasesLoaded which reports the finished core load.

Returns

false to abort startup, e.g. when the module's own database failed to open

{ return true; }

Referenced by ScriptMgr::OnModuleDatabasesLoading().

---

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

• azerothcore-wotlk/src/server/game/Scripting/ScriptDefines/DatabaseScript.h
• azerothcore-wotlk/src/server/game/Scripting/ScriptDefines/DatabaseScript.cpp