AllBattlegroundScript Class Reference

#include "AllBattlegroundScript.h"

Inheritance diagram for AllBattlegroundScript:

Public Member Functions
bool	IsDatabaseBound () const override
virtual void	OnBattlegroundStart (Battleground *)
	This hook runs before start Battleground.
virtual void	OnBattlegroundEndReward (Battleground *, Player *, TeamId)
virtual void	OnBattlegroundUpdate (Battleground *, uint32)
virtual void	OnBattlegroundAddPlayer (Battleground *, Player *)
virtual void	OnBattlegroundBeforeAddPlayer (Battleground *, Player *)
virtual void	OnBattlegroundRemovePlayerAtLeave (Battleground *, Player *)
virtual void	OnQueueUpdate (BattlegroundQueue *, uint32, BattlegroundTypeId, BattlegroundBracketId, uint8, bool, uint32)
virtual bool	OnQueueUpdateValidity (BattlegroundQueue *, uint32, BattlegroundTypeId, BattlegroundBracketId, uint8, bool, uint32)
virtual void	OnAddGroup (BattlegroundQueue *, GroupQueueInfo *, uint32 &, Player *, Group *, BattlegroundTypeId, PvPDifficultyEntry const *, uint8, bool, bool, uint32, uint32, uint32, uint32)
virtual bool	CanFillPlayersToBG (BattlegroundQueue *, Battleground *, BattlegroundBracketId)
virtual bool	IsCheckNormalMatch (BattlegroundQueue *, Battleground *, BattlegroundBracketId, uint32, uint32)
virtual bool	CanSendMessageBGQueue (BattlegroundQueue *, Player *, Battleground *, PvPDifficultyEntry const *)
virtual bool	OnBeforeSendJoinMessageArenaQueue (BattlegroundQueue *, Player *, GroupQueueInfo *, PvPDifficultyEntry const *, bool)
	This hook runs before sending the join message during the arena queue, allowing you to run extra operations or disabling the join message.
virtual bool	OnBeforeSendExitMessageArenaQueue (BattlegroundQueue *, GroupQueueInfo *)
	This hook runs before sending the exit message during the arena queue, allowing you to run extra operations or disabling the exit message.
virtual void	OnBattlegroundEnd (Battleground *, TeamId)
	This hook runs after end Battleground.
virtual void	OnBattlegroundDestroy (Battleground *)
	This hook runs before Battleground destroy.
virtual void	OnBattlegroundCreate (Battleground *)
	This hook runs after Battleground create.
virtual void	OnBattlegroundSetup (Battleground *)
	This hook runs after the Battleground setup is completed (map is created and initial objects are spawned)
virtual bool	CanAddGroupToMatchingPool (BattlegroundQueue *, GroupQueueInfo *, uint32, Battleground *, BattlegroundBracketId)
	This hook runs before adding a group to the battleground matching pool.
virtual bool	GetPlayerMatchmakingRating (ObjectGuid, BattlegroundTypeId, float &)
	This hook allows modules to provide matchmaking rating for a player.
Public Member Functions inherited from ScriptObject
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
std::string const &	GetName () const
uint16	GetTotalAvailableHooks ()

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

AllBattlegroundScript()

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

protected

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

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

Member Function Documentation

CanAddGroupToMatchingPool()

virtual bool AllBattlegroundScript::CanAddGroupToMatchingPool ( BattlegroundQueue *  , GroupQueueInfo *  , uint32  , Battleground *  , BattlegroundBracketId    )

inlinevirtual

This hook runs before adding a group to the battleground matching pool.

Allows modules to filter groups based on custom criteria (e.g., MMR matching). Called during FillPlayersToBG before each group is added to the SelectionPool.

Parameters

queue	The battleground queue
group	The group being considered for addition
poolPlayerCount	Current number of players already in the selection pool
bg	The battleground instance
bracketId	The bracket ID

Returns

True to allow adding this group, false to skip it

{ return true; }

Referenced by ScriptMgr::CanAddGroupToMatchingPool().

CanFillPlayersToBG()

virtual bool AllBattlegroundScript::CanFillPlayersToBG ( BattlegroundQueue *  , Battleground *  , BattlegroundBracketId    )

inlinevirtual

{ return true; }

Referenced by ScriptMgr::CanFillPlayersToBG().

CanSendMessageBGQueue()

virtual bool AllBattlegroundScript::CanSendMessageBGQueue ( BattlegroundQueue *  , Player *  , Battleground *  , PvPDifficultyEntry const *    )

inlinevirtual

{ return true; }

Referenced by ScriptMgr::CanSendMessageBGQueue().

GetPlayerMatchmakingRating()

virtual bool AllBattlegroundScript::GetPlayerMatchmakingRating ( ObjectGuid  , BattlegroundTypeId  , float &    )

inlinevirtual

This hook allows modules to provide matchmaking rating for a player.

Modules implementing MMR systems can use this hook to provide player ratings for use in matchmaking algorithms.

Parameters

playerGuid	The player's GUID
bgTypeId	The battleground type
outRating	Reference to store the rating value

Returns

True if rating was provided, false otherwise

{ return false; }

Referenced by ScriptMgr::GetPlayerMatchmakingRating().

IsCheckNormalMatch()

virtual bool AllBattlegroundScript::IsCheckNormalMatch ( BattlegroundQueue *  , Battleground *  , BattlegroundBracketId  , uint32  , uint32    )

inlinevirtual

{ return false; };

Referenced by ScriptMgr::IsCheckNormalMatch().

IsDatabaseBound()

bool AllBattlegroundScript::IsDatabaseBound ( ) const

inlineoverridevirtual

Reimplemented from ScriptObject.

{ return false; }

OnAddGroup()

virtual void AllBattlegroundScript::OnAddGroup ( BattlegroundQueue *  , GroupQueueInfo *  , uint32 &  , Player *  , Group *  , BattlegroundTypeId  , PvPDifficultyEntry const *  , uint8  , bool  , bool  , uint32  , uint32  , uint32  , uint32    )

inlinevirtual

                                                                             { }

Referenced by ScriptMgr::OnAddGroup().

OnBattlegroundAddPlayer()

virtual void AllBattlegroundScript::OnBattlegroundAddPlayer ( Battleground *  , Player *    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnBattlegroundAddPlayer().

OnBattlegroundBeforeAddPlayer()

virtual void AllBattlegroundScript::OnBattlegroundBeforeAddPlayer ( Battleground *  , Player *    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnBattlegroundBeforeAddPlayer().

OnBattlegroundCreate()

virtual void AllBattlegroundScript::OnBattlegroundCreate ( Battleground *  )

inlinevirtual

This hook runs after Battleground create.

Parameters

bg	Contains information about the Battleground

{ }

Referenced by ScriptMgr::OnBattlegroundCreate().

OnBattlegroundDestroy()

virtual void AllBattlegroundScript::OnBattlegroundDestroy ( Battleground *  )

inlinevirtual

This hook runs before Battleground destroy.

Parameters

bg	Contains information about the Battleground

{ }

Referenced by ScriptMgr::OnBattlegroundDestroy().

OnBattlegroundEnd()

virtual void AllBattlegroundScript::OnBattlegroundEnd ( Battleground *  , TeamId    )

inlinevirtual

This hook runs after end Battleground.

Parameters

bg	Contains information about the Battleground
TeamId	Contains information about the winneer team

{ }

Referenced by ScriptMgr::OnBattlegroundEnd().

OnBattlegroundEndReward()

virtual void AllBattlegroundScript::OnBattlegroundEndReward ( Battleground *  , Player *  , TeamId    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnBattlegroundEndReward().

OnBattlegroundRemovePlayerAtLeave()

virtual void AllBattlegroundScript::OnBattlegroundRemovePlayerAtLeave ( Battleground *  , Player *    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnBattlegroundRemovePlayerAtLeave().

OnBattlegroundSetup()

virtual void AllBattlegroundScript::OnBattlegroundSetup ( Battleground *  )

inlinevirtual

This hook runs after the Battleground setup is completed (map is created and initial objects are spawned)

Parameters

bg	Contains information about the Battleground

{ }

Referenced by ScriptMgr::OnBattlegroundSetup().

OnBattlegroundStart()

virtual void AllBattlegroundScript::OnBattlegroundStart ( Battleground *  )

inlinevirtual

This hook runs before start Battleground.

Parameters

bg	Contains information about the Battleground

{ }

Referenced by ScriptMgr::OnBattlegroundStart().

OnBattlegroundUpdate()

virtual void AllBattlegroundScript::OnBattlegroundUpdate ( Battleground *  , uint32    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnBattlegroundUpdate().

OnBeforeSendExitMessageArenaQueue()

virtual bool AllBattlegroundScript::OnBeforeSendExitMessageArenaQueue ( BattlegroundQueue *  , GroupQueueInfo *    )

inlinevirtual

This hook runs before sending the exit message during the arena queue, allowing you to run extra operations or disabling the exit message.

Parameters

queue	Contains information about the Arena queue
ginfo	Contains information about the group of the queue

Returns

True if you want to continue sending the message, false if you want to disable the message

{ return true; }

Referenced by ScriptMgr::OnBeforeSendExitMessageArenaQueue().

OnBeforeSendJoinMessageArenaQueue()

virtual bool AllBattlegroundScript::OnBeforeSendJoinMessageArenaQueue ( BattlegroundQueue *  , Player *  , GroupQueueInfo *  , PvPDifficultyEntry const *  , bool    )

inlinevirtual

This hook runs before sending the join message during the arena queue, allowing you to run extra operations or disabling the join message.

Parameters

queue	Contains information about the Arena queue
leader	Contains information about the player leader
ginfo	Contains information about the group of the queue
bracketEntry	Contains information about the bracket
isRated	Contains information about rated arena or skirmish

Returns

True if you want to continue sending the message, false if you want to disable the message

{ return true; }

Referenced by ScriptMgr::OnBeforeSendJoinMessageArenaQueue().

OnQueueUpdate()

virtual void AllBattlegroundScript::OnQueueUpdate ( BattlegroundQueue *  , uint32  , BattlegroundTypeId  , BattlegroundBracketId  , uint8  , bool  , uint32    )

inlinevirtual

{ }

Referenced by ScriptMgr::OnQueueUpdate().

OnQueueUpdateValidity()

virtual bool AllBattlegroundScript::OnQueueUpdateValidity ( BattlegroundQueue *  , uint32  , BattlegroundTypeId  , BattlegroundBracketId  , uint8  , bool  , uint32    )

inlinevirtual

{ return true; }

Referenced by ScriptMgr::OnQueueUpdateValidity().

---

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

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