AllMapScript Class Reference

#include "AllMapScript.h"

Inheritance diagram for AllMapScript:

Public Member Functions
virtual void	OnPlayerEnterAll (Map *, Player *)
	This hook called when a player enters any Map.
virtual void	OnPlayerLeaveAll (Map *, Player *)
	This hook called when a player leave any Map.
virtual void	OnBeforeCreateInstanceScript (InstanceMap *, InstanceScript **, bool, std::string, uint32)
	This hook called before create instance script.
virtual void	OnDestroyInstance (MapInstanced *, Map *)
	This hook called before destroy instance.
virtual void	OnCreateMap (Map *)
	This hook called before creating map.
virtual void	OnDestroyMap (Map *)
	This hook called before destroing map.
virtual void	OnMapUpdate (Map *, uint32)
	This hook called before updating map.
virtual bool	CanSendObjectUpdatesToPlayer (Map *, Player *)
	This hook is called before the map sends its pending object update packets to a player.
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
std::string const &	GetName () const
uint16	GetTotalAvailableHooks ()

Protected Member Functions
	AllMapScript (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

AllMapScript()

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

protected

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

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

Member Function Documentation

CanSendObjectUpdatesToPlayer()

virtual bool AllMapScript::CanSendObjectUpdatesToPlayer ( Map *  , Player *    )

inlinevirtual

This hook is called before the map sends its pending object update packets to a player.

Parameters

map	Contains information about the Map
player	Contains information about the Player

Returns

True to send the updates, false to discard them for this player

{ return true; }

Referenced by ScriptMgr::CanSendObjectUpdatesToPlayer().

OnBeforeCreateInstanceScript()

virtual void AllMapScript::OnBeforeCreateInstanceScript ( InstanceMap *  , InstanceScript **  , bool  , std::string  , uint32    )

inlinevirtual

This hook called before create instance script.

Parameters

instanceMap	Contains information about the WorldSession
instanceData	Contains information about the WorldPacket
load	if true loading instance save data
data	Contains information about the instance save data
completedEncounterMask	Contains information about the completed encouter mask

{ }

Referenced by ScriptMgr::OnBeforeCreateInstanceScript().

OnCreateMap()

virtual void AllMapScript::OnCreateMap ( Map *  )

inlinevirtual

This hook called before creating map.

Parameters

map	Contains information about the Map

{ }

Referenced by ScriptMgr::OnCreateMap().

OnDestroyInstance()

virtual void AllMapScript::OnDestroyInstance ( MapInstanced *  , Map *    )

inlinevirtual

This hook called before destroy instance.

Parameters

mapInstanced	Contains information about the MapInstanced
map	Contains information about the Map

{ }

Referenced by ScriptMgr::OnDestroyInstance().

OnDestroyMap()

virtual void AllMapScript::OnDestroyMap ( Map *  )

inlinevirtual

This hook called before destroing map.

Parameters

map	Contains information about the Map

{ }

Referenced by ScriptMgr::OnDestroyMap().

OnMapUpdate()

virtual void AllMapScript::OnMapUpdate ( Map *  , uint32    )

inlinevirtual

This hook called before updating map.

Parameters

map	Contains information about the Map
diff	Contains information about the diff time

{ }

Referenced by ScriptMgr::OnMapUpdate().

OnPlayerEnterAll()

virtual void AllMapScript::OnPlayerEnterAll ( Map *  , Player *    )

inlinevirtual

This hook called when a player enters any Map.

Parameters

map	Contains information about the Map
player	Contains information about the Player

{ }

Referenced by ScriptMgr::OnPlayerEnterMap().

OnPlayerLeaveAll()

virtual void AllMapScript::OnPlayerLeaveAll ( Map *  , Player *    )

inlinevirtual

This hook called when a player leave any Map.

Parameters

map	Contains information about the Map
player	Contains information about the Player

{ }

Referenced by ScriptMgr::OnPlayerLeaveMap().

---

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

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