WorldScript Class Reference

#include "WorldScript.h"

Inheritance diagram for WorldScript:

Public Member Functions
virtual void	OnOpenStateChange (bool)
virtual void	OnAfterConfigLoad (bool)
virtual void	OnLoadCustomDatabaseTable ()
virtual void	OnBeforeConfigLoad (bool)
virtual void	OnMotdChange (std::string &, LocaleConstant &)
virtual void	OnShutdownInitiate (ShutdownExitCode, ShutdownMask)
virtual void	OnShutdownCancel ()
virtual void	OnUpdate (uint32)
virtual void	OnStartup ()
virtual void	OnShutdown ()
virtual void	OnAfterUnloadAllMaps ()
	Called after all maps are unloaded from core. More...
virtual void	OnBeforeFinalizePlayerWorldSession (uint32 &)
	This hook runs before finalizing the player world session. Can be also used to mutate the cache version of the Client. More...
virtual void	OnBeforeWorldInitialized ()
	This hook runs after all scripts loading and before itialized. More...
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
const std::string &	GetName () const
uint16	GetTotalAvailableHooks ()

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

Detailed Description

Constructor & Destructor Documentation

WorldScript()

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

protected

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

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

Member Function Documentation

OnAfterConfigLoad()

virtual void WorldScript::OnAfterConfigLoad ( bool  )

inlinevirtual

{ }

OnAfterUnloadAllMaps()

virtual void WorldScript::OnAfterUnloadAllMaps ( )

inlinevirtual

Called after all maps are unloaded from core.

{ }

OnBeforeConfigLoad()

virtual void WorldScript::OnBeforeConfigLoad ( bool  )

inlinevirtual

{ }

OnBeforeFinalizePlayerWorldSession()

virtual void WorldScript::OnBeforeFinalizePlayerWorldSession ( uint32 &  )

inlinevirtual

This hook runs before finalizing the player world session. Can be also used to mutate the cache version of the Client.

Parameters

version

The cache version that we will be sending to the Client.

{ }

OnBeforeWorldInitialized()

virtual void WorldScript::OnBeforeWorldInitialized ( )

inlinevirtual

This hook runs after all scripts loading and before itialized.

{ }

OnLoadCustomDatabaseTable()

virtual void WorldScript::OnLoadCustomDatabaseTable ( )

inlinevirtual

{ }

OnMotdChange()

virtual void WorldScript::OnMotdChange ( std::string &  , LocaleConstant &    )

inlinevirtual

{ }

OnOpenStateChange()

virtual void WorldScript::OnOpenStateChange ( bool  )

inlinevirtual

{ }

OnShutdown()

virtual void WorldScript::OnShutdown ( )

inlinevirtual

{ }

OnShutdownCancel()

virtual void WorldScript::OnShutdownCancel ( )

inlinevirtual

{ }

OnShutdownInitiate()

virtual void WorldScript::OnShutdownInitiate ( ShutdownExitCode  , ShutdownMask    )

inlinevirtual

{ }

OnStartup()

virtual void WorldScript::OnStartup ( )

inlinevirtual

{ }

OnUpdate()

virtual void WorldScript::OnUpdate ( uint32  )

inlinevirtual

{ }