SummonList Class Reference

#include <ScriptedCreature.h>

Public Types
typedef GuidList	StorageType
typedef StorageType::iterator	iterator
typedef StorageType::const_iterator	const_iterator
typedef StorageType::size_type	size_type
typedef StorageType::value_type	value_type

Public Member Functions
	SummonList (Creature *creature)
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
iterator	erase (iterator i)
bool	empty () const
size_type	size () const
void	clear ()
void	Summon (Creature const *summon)
void	Despawn (Creature const *summon)
void	DespawnEntry (uint32 entry)
void	DespawnAll ()
template<typename T >
void	DespawnIf (T const &predicate)
template<class Predicate >
void	DoAction (int32 info, Predicate &&predicate, uint16 max=0)
void	DoZoneInCombat (uint32 entry=0)
void	RemoveNotExisting ()
bool	HasEntry (uint32 entry) const

Private Member Functions
void	DoActionImpl (int32 action, StorageType const &summons)

Private Attributes
Creature *	_me
StorageType	_storage

Member Typedef Documentation

const_iterator

typedef StorageType::const_iterator SummonList::const_iterator

iterator

typedef StorageType::iterator SummonList::iterator

size_type

typedef StorageType::size_type SummonList::size_type

StorageType

typedef GuidList SummonList::StorageType

value_type

typedef StorageType::value_type SummonList::value_type

Constructor & Destructor Documentation

SummonList()

SummonList::SummonList ( Creature *  creature )

inlineexplicit

: _me(creature) { }

Member Function Documentation

begin() [1/2]

iterator SummonList::begin ( )

inline

 {
 return _storage.begin();
 }

Here is the caller graph for this function:

begin() [2/2]

const_iterator SummonList::begin ( ) const

inline

 {
 return _storage.begin();
 }

clear()

void SummonList::clear ( )

inline

 {
 _storage.clear();
 }

Here is the caller graph for this function:

Despawn()

void SummonList::Despawn

(

Creature const *

summon

)

{
 _storage.remove(summon->GetGUID());
}

Here is the call graph for this function:

Here is the caller graph for this function:

DespawnAll()

void SummonList::DespawnAll

(

)

{
 while (!_storage.empty())
 {
 Creature* summon = ObjectAccessor::GetCreature(*_me, _storage.front());
 _storage.pop_front();
 if (summon)
 summon->DespawnOrUnsummon();
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

DespawnEntry()

void SummonList::DespawnEntry

(

uint32

entry

)

{
 for (StorageType::iterator i = _storage.begin(); i != _storage.end();)
 {
 Creature* summon = ObjectAccessor::GetCreature(*_me, *i);
 if (!summon)
 i = _storage.erase(i);
 else if (summon->GetEntry() == entry)
 {
 i = _storage.erase(i);
 summon->DespawnOrUnsummon();
 }
 else
 ++i;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

DespawnIf()

template<typename T >

void SummonList::DespawnIf ( T const &  predicate )

inline

 {
 _storage.remove_if(predicate);
 }

DoAction()

template<class Predicate >

void SummonList::DoAction ( int32  info, Predicate &&  predicate, uint16  max = 0  )

inline

 {
 // We need to use a copy of SummonList here, otherwise original SummonList would be modified
 StorageType listCopy = _storage;
 Trinity::Containers::RandomResize<StorageType, Predicate>(listCopy, std::forward<Predicate>(predicate), max);
 DoActionImpl(info, listCopy);
 }

Here is the caller graph for this function:

DoActionImpl()

void SummonList::DoActionImpl ( int32  action, StorageType const &  summons  )

private

{
 for (ObjectGuid const& guid : summons)
 {
 Creature* summon = ObjectAccessor::GetCreature(*_me, guid);
 if (summon && summon->IsAIEnabled())
 summon->AI()->DoAction(action);
 }
}

Here is the call graph for this function:

DoZoneInCombat()

void SummonList::DoZoneInCombat

(

uint32

entry = 0

)

{
 for (StorageType::iterator i = _storage.begin(); i != _storage.end();)
 {
 Creature* summon = ObjectAccessor::GetCreature(*_me, *i);
 ++i;
 if (summon && summon->IsAIEnabled()
 && (!entry || summon->GetEntry() == entry))
 {
 summon->AI()->DoZoneInCombat(nullptr);
 }
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

bool SummonList::empty ( ) const

inline

 {
 return _storage.empty();
 }

Here is the caller graph for this function:

end() [1/2]

iterator SummonList::end ( )

inline

 {
 return _storage.end();
 }

Here is the caller graph for this function:

end() [2/2]

const_iterator SummonList::end ( ) const

inline

 {
 return _storage.end();
 }

erase()

iterator SummonList::erase ( iterator  i )

inline

 {
 return _storage.erase(i);
 }

HasEntry()

bool SummonList::HasEntry

(

uint32

entry

)

const

{
 for (ObjectGuid const& guid : _storage)
 {
 Creature* summon = ObjectAccessor::GetCreature(*_me, guid);
 if (summon && summon->GetEntry() == entry)
 return true;
 }

 return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveNotExisting()

void SummonList::RemoveNotExisting

(

)

{
 for (StorageType::iterator i = _storage.begin(); i != _storage.end();)
 {
 if (ObjectAccessor::GetCreature(*_me, *i))
 ++i;
 else
 i = _storage.erase(i);
 }
}

Here is the call graph for this function:

size()

size_type SummonList::size ( ) const

inline

 {
 return _storage.size();
 }

Here is the caller graph for this function:

Summon()

void SummonList::Summon

(

Creature const *

summon

)

{
 _storage.push_back(summon->GetGUID());
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_me

Creature* SummonList::_me

private

_storage

StorageType SummonList::_storage

private

---

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

• src/server/game/AI/ScriptedAI/ScriptedCreature.h
• src/server/game/AI/ScriptedAI/ScriptedCreature.cpp