npc_midsummer_bonfire Struct Reference

Inheritance diagram for npc_midsummer_bonfire:

Public Member Functions
	npc_midsummer_bonfire (Creature *creature)
void	Ignite ()
void	StampOut ()
void	UpdateBonfireBlessingBuffs ()
bool	InitBonfire ()
void	SpellHit (Unit *caster, SpellInfo const *spellInfo) override
void	UpdateAI (uint32 diff) override
	Use to start attacking a target. Called just before JustEngagedWith()
Public Member Functions inherited from ScriptedAI
	ScriptedAI (Creature *creature)
	~ScriptedAI () override
void	AttackStartNoMove (Unit *target)
void	DamageTaken (Unit *, uint32 &, DamageEffectType, SpellSchoolMask) override
	Called at any Damage from any attacker (before damage apply)
void	UpdateAI (uint32 diff) override
	Use to start attacking a target. Called just before JustEngagedWith()
void	JustDied (Unit *) override
void	KilledUnit (Unit *) override
void	JustSummoned (Creature *) override
void	SummonedCreatureDespawn (Creature *) override
void	SpellHit (Unit *, SpellInfo const *) override
void	SpellHitTarget (Unit *, SpellInfo const *) override
void	MovementInform (uint32, uint32) override
void	OnPossess (bool)
bool	IsInRoom (const Position *pos, Axis axis, bool above)
void	Reset () override
void	JustEngagedWith (Unit *) override
	Called for reaction when initially engaged.
void	AttackStart (Unit *) override
void	DoStartMovement (Unit *target, float distance=0.0f, float angle=0.0f)
void	DoStartNoMovement (Unit *target)
void	DoStopAttack ()
void	DoCastSpell (Unit *target, SpellInfo const *spellInfo, bool triggered=false)
void	DoPlaySoundToSet (WorldObject *source, uint32 soundId)
void	DoPlayMusic (uint32 soundId, bool zone)
void	DoAddThreat (Unit *unit, float amount)
void	DoModifyThreatByPercent (Unit *unit, int32 pct)
void	DoResetThreat (Unit *unit)
void	DoResetThreatList ()
float	DoGetThreat (Unit *unit)
void	DoTeleportPlayer (Unit *unit, float x, float y, float z, float o)
void	DoTeleportPlayer (Unit *unit, Position pos)
void	DoTeleportAll (float x, float y, float z, float o)
Unit *	DoSelectLowestHpFriendly (float range, uint32 minHPDiff=1)
std::list< Creature * >	DoFindFriendlyCC (float range)
std::list< Creature * >	DoFindFriendlyMissingBuff (float range, uint32 spellId)
Player *	GetPlayerAtMinimumRange (float minRange)
Creature *	DoSpawnCreature (uint32 entry, float offsetX, float offsetY, float offsetZ, float angle, uint32 type, uint32 despawntime)
bool	IsUniqueTimedEventDone (uint32 id) const
void	SetUniqueTimedEventDone (uint32 id)
void	ResetUniqueTimedEvent (uint32 id)
void	ClearUniqueTimedEventsDone ()
void	ScheduleTimedEvent (Milliseconds timerMin, Milliseconds timerMax, std::function< void()> exec, Milliseconds repeatMin, Milliseconds repeatMax=0s, uint32 uniqueId=0)
void	ScheduleTimedEvent (Milliseconds timerMax, std::function< void()> exec, Milliseconds repeatMin, Milliseconds repeatMax=0s, uint32 uniqueId=0)
void	ScheduleUniqueTimedEvent (Milliseconds timer, std::function< void()> exec, uint32 uniqueId)
bool	HealthBelowPct (uint32 pct) const
bool	HealthAbovePct (uint32 pct) const
SpellInfo const *	SelectSpell (Unit *target, uint32 school, uint32 mechanic, SelectTargetType targets, uint32 powerCostMin, uint32 powerCostMax, float rangeMin, float rangeMax, SelectEffect effect)
void	SetEquipmentSlots (bool loadDefault, int32 mainHand=EQUIP_NO_CHANGE, int32 offHand=EQUIP_NO_CHANGE, int32 ranged=EQUIP_NO_CHANGE)
virtual bool	CheckEvadeIfOutOfCombatArea () const
bool	IsHeroic () const
Difficulty	GetDifficulty () const
bool	Is25ManRaid () const
template<class T >
const T &	DUNGEON_MODE (const T &normal5, const T &heroic10) const
template<class T >
const T &	RAID_MODE (const T &normal10, const T &normal25) const
template<class T >
const T &	RAID_MODE (const T &normal10, const T &normal25, const T &heroic10, const T &heroic25) const
Player *	SelectTargetFromPlayerList (float maxdist, uint32 excludeAura=0, bool mustBeInLOS=false) const
void	SetInvincibility (bool apply)
bool	IsInvincible () const
void	SetAutoAttackAllowed (bool allow)
bool	IsAutoAttackAllowed () const
Public Member Functions inherited from CreatureAI
void	Talk (uint8 id, WorldObject const *whisperTarget=nullptr, Milliseconds delay=0s)
	Causes the creature to talk/say the text assigned to their entry in the creature_text database table.
void	Talk (uint8 id, Milliseconds delay)
WorldObject *	GetSummoner () const
	Returns the summoner creature/object, if the creature is a temporary summon.
	CreatureAI (Creature *creature)
	~CreatureAI () override
void	MoveCircleChecks ()
void	MoveBackwardsChecks ()
void	MoveInLineOfSight_Safe (Unit *who)
	== Reactions At =================================
void	TriggerAlert (Unit const *who) const
virtual bool	CanRespawn ()
virtual void	EnterEvadeMode (EvadeReason why=EVADE_REASON_OTHER)
virtual void	IsSummonedBy (WorldObject *)
virtual void	SummonedCreatureDies (Creature *, Unit *)
virtual void	SummonedCreatureDespawnAll ()
virtual void	SummonedCreatureEvade (Creature *)
virtual void	AttackedBy (Unit *)
virtual bool	IsEscorted ()
virtual void	JustRespawned ()
virtual void	PathEndReached (uint32)
void	OnCharmed (bool apply) override
	Called when unit is charmed.
virtual void	JustReachedHome ()
void	DoZoneInCombat (Creature *creature=nullptr, float maxRangeToNearestTarget=250.0f)
virtual void	ReceiveEmote (Player *, uint32)
virtual void	OwnerAttackedBy (Unit *)
virtual void	OwnerAttacked (Unit *)
virtual void	CorpseRemoved (uint32 &)
	== Triggered Actions Requested ==================
virtual void	PassengerBoarded (Unit *, int8, bool)
	== Fields =======================================
virtual bool	BeforeSpellClick (Unit *)
virtual void	OnSpellClick (Unit *, bool &)
virtual bool	CanSeeAlways (WorldObject const *)
virtual bool	CanBeSeen (Player const *)
virtual bool	CanAlwaysBeDetectable (WorldObject const *)
virtual void	PetStopAttack ()
virtual bool	CheckInRoom ()
CreatureBoundary const *	GetBoundary () const
void	SetBoundary (CreatureBoundary const *boundary, bool negativeBoundaries=false)
bool	IsInBoundary (Position const *who=nullptr) const
virtual void	CalculateThreat (Unit *, float &, SpellInfo const *)
virtual bool	OnTeleportUnreacheablePlayer (Player *)
virtual void	OnAuraRemove (AuraApplication *, AuraRemoveMode)
Public Member Functions inherited from UnitAI
	UnitAI (Unit *unit)
virtual	~UnitAI ()
virtual bool	CanAIAttack (Unit const *) const
virtual void	InitializeAI ()
virtual void	DoAction (int32)
virtual uint32	GetData (uint32) const
virtual void	SetData (uint32, uint32)
virtual void	SetGUID (ObjectGuid, int32=0)
virtual ObjectGuid	GetGUID (int32=0) const
Unit *	SelectTarget (SelectTargetMethod targetType, uint32 position=0, float dist=0.0f, bool playerOnly=false, bool withTank=true, int32 aura=0)
template<class PREDICATE >
Unit *	SelectTarget (SelectTargetMethod targetType, uint32 position, PREDICATE const &predicate)
void	SelectTargetList (std::list< Unit * > &targetList, uint32 num, SelectTargetMethod targetType, uint32 position=0, float dist=0.0f, bool playerOnly=false, bool withTank=true, int32 aura=0)
	Select the best (up to) <num> targets (in <targetType> order) from the threat list that fulfill the following:
template<class PREDICATE >
void	SelectTargetList (std::list< Unit * > &targetList, uint32 num, SelectTargetMethod targetType, uint32 position, PREDICATE const &predicate)
virtual void	JustEnteredCombat (Unit *)
	Called when the unit enters combat.
virtual void	JustExitedCombat ()
	Called when the unit leaves combat.
virtual void	DamageDealt (Unit *, uint32 &, DamageEffectType, SpellSchoolMask)
	Called at any Damage to any victim (before damage apply)
virtual void	HealReceived (Unit *, uint32 &)
	Called when the creature receives heal.
virtual void	OnPowerUpdate (Powers, int32, int32, uint32)
	Called when the creature power updates.
virtual void	HealDone (Unit *, uint32 &)
	Called when the unit heals.
virtual void	OnCalculateMeleeDamageReceived (uint32 &, Unit *)
	Called during damage calculations.
virtual void	OnCalculateSpellDamageReceived (int32 &, Unit *)
virtual void	OnCalculatePeriodicTickReceived (uint32 &, Unit *)
	Called during calculation when receiving periodic healing or damage (DoT or HoT)
void	AttackStartCaster (Unit *victim, float dist)
SpellCastResult	DoAddAuraToAllHostilePlayers (uint32 spellid)
SpellCastResult	DoCast (uint32 spellId)
SpellCastResult	DoCast (Unit *victim, uint32 spellId, bool triggered=false)
SpellCastResult	DoCastSelf (uint32 spellId, bool triggered=false)
SpellCastResult	DoCastToAllHostilePlayers (uint32 spellid, bool triggered=false)
	To specify the caster as target if the spell is self-cast.
SpellCastResult	DoCastVictim (uint32 spellId, bool triggered=false)
SpellCastResult	DoCastAOE (uint32 spellId, bool triggered=false)
SpellCastResult	DoCastRandomTarget (uint32 spellId, uint32 threatTablePosition=0, float dist=0.0f, bool playerOnly=true, bool triggered=false, bool withTank=true)
	Cast the spell on a random unit from the threat list.
SpellCastResult	DoCastMaxThreat (uint32 spellId, uint32 threatTablePosition=0, float dist=0.0f, bool playerOnly=true, bool triggered=false)
	Cast spell on the top threat target, which may not be the current victim.
float	DoGetSpellMaxRange (uint32 spellId, bool positive=false)
void	DoMeleeAttackIfReady ()
bool	DoSpellAttackIfReady (uint32 spell)
void	DoSpellAttackToRandomTargetIfReady (uint32 spell, uint32 threatTablePosition=0, float dist=0.f, bool playerOnly=true)
virtual void	SummonMovementInform (Creature *, uint32, uint32)
	Called when a summon reaches a waypoint or point movement finished.
virtual void	sGossipHello (Player *)
virtual void	sGossipSelect (Player *, uint32, uint32)
virtual void	sGossipSelectCode (Player *, uint32, uint32, char const *)
virtual void	sQuestAccept (Player *, Quest const *)
virtual void	sQuestSelect (Player *, Quest const *)
virtual void	sQuestComplete (Player *, Quest const *)
virtual void	sQuestReward (Player *, Quest const *, uint32)
virtual void	sOnGameEvent (bool, uint16)
virtual std::string	GetDebugInfo () const

Private Attributes
bool *	_isStampedOut
TeamId	_teamId
uint8	_type
GameObject *	_spellFocus
GameObject *	_bonfire

Additional Inherited Members
Public Types inherited from ScriptedAI
enum class	Axis {   AXIS_X ,   AXIS_Y }
Public Types inherited from CreatureAI
enum	EvadeReason {   EVADE_REASON_NO_HOSTILES ,   EVADE_REASON_BOUNDARY ,   EVADE_REASON_SEQUENCE_BREAK ,   EVADE_REASON_NO_PATH ,   EVADE_REASON_OTHER }
Static Public Member Functions inherited from CreatureAI
static bool	IsInBounds (CreatureBoundary const &boundary, Position const *who)
Static Public Member Functions inherited from UnitAI
static void	FillAISpellInfo ()
Public Attributes inherited from ScriptedAI
Creature *	me
Static Public Attributes inherited from UnitAI
static AISpellInfoType *	AISpellInfo
Protected Member Functions inherited from CreatureAI
bool	UpdateVictim ()
bool	UpdateVictimWithGaze ()
void	SetGazeOn (Unit *target)
Creature *	DoSummon (uint32 entry, Position const &pos, uint32 despawnTime=30000, TempSummonType summonType=TEMPSUMMON_CORPSE_TIMED_DESPAWN)
Creature *	DoSummon (uint32 entry, WorldObject *obj, float radius=5.0f, uint32 despawnTime=30000, TempSummonType summonType=TEMPSUMMON_CORPSE_TIMED_DESPAWN)
Creature *	DoSummonFlyer (uint32 entry, WorldObject *obj, float flightZ, float radius=5.0f, uint32 despawnTime=30000, TempSummonType summonType=TEMPSUMMON_CORPSE_TIMED_DESPAWN)
virtual void	MoveInLineOfSight (Unit *)
bool	_EnterEvadeMode (EvadeReason why=EVADE_REASON_OTHER)
Protected Attributes inherited from CreatureAI
Creature *const	me
EventMap	events
TaskScheduler	scheduler
CreatureBoundary const *	_boundary
bool	_negateBoundary
Protected Attributes inherited from UnitAI
Unit *const	me

Detailed Description

Constructor & Destructor Documentation

npc_midsummer_bonfire()

npc_midsummer_bonfire::npc_midsummer_bonfire ( Creature *  creature )

inline

                                              : ScriptedAI(creature)
    {
        //  Midsummer Bonfire Spawn Trap also spawns this NPC (currently unwanted)
        if (me->ToTempSummon())
            me->DespawnOrUnsummon();
 
        _isStampedOut  = nullptr;
        _teamId     = TEAM_NEUTRAL;
        _type       = BONFIRE_TYPE_NONE;
        _spellFocus = nullptr;
 
        if (!IsHolidayActive(HOLIDAY_FIRE_FESTIVAL))
            return;
 
        scheduler.Schedule(420ms, [this](TaskContext context)
            {
                if (!InitBonfire())
                    context.Repeat();
            });
    }

References _isStampedOut, _spellFocus, _teamId, _type, BONFIRE_TYPE_NONE, Creature::DespawnOrUnsummon(), HOLIDAY_FIRE_FESTIVAL, InitBonfire(), IsHolidayActive(), ScriptedAI::me, TaskContext::Repeat(), TaskScheduler::Schedule(), CreatureAI::scheduler, TEAM_NEUTRAL, and Unit::ToTempSummon().

Member Function Documentation

Ignite()

void npc_midsummer_bonfire::Ignite ( )

inline

    {
        if (_isStampedOut)
            *_isStampedOut = false;
 
        if (!_spellFocus)
        {
            DoCastSelf(SPELL_MIDSUMMER_BONFIRE_BUNNIES_2, true);
 
            if ((_spellFocus = me->FindNearestGameObject(GO_MIDSUMMER_BONFIRE_CAMPFIRE_SPELL_FOCUS, 10.0f)))
                me->AddGameObject(_spellFocus);
        }
 
        switch (_type)
        {
            case BONFIRE_TYPE_ALLIANCE:
            case BONFIRE_TYPE_HORDE:
                DoCastSelf(SPELL_LIGHT_BONFIRE_ART_KIT, true);
                UpdateBonfireBlessingBuffs();
                break;
            case BONFIRE_TYPE_AHUNE:
                if (_bonfire)
                    _bonfire->SetGoState(GO_STATE_ACTIVE);
                break;
            default:
                break;
        }
    }

References _bonfire, _isStampedOut, _spellFocus, _type, Unit::AddGameObject(), BONFIRE_TYPE_AHUNE, BONFIRE_TYPE_ALLIANCE, BONFIRE_TYPE_HORDE, UnitAI::DoCastSelf(), WorldObject::FindNearestGameObject(), GO_MIDSUMMER_BONFIRE_CAMPFIRE_SPELL_FOCUS, GO_STATE_ACTIVE, ScriptedAI::me, GameObject::SetGoState(), SPELL_LIGHT_BONFIRE_ART_KIT, SPELL_MIDSUMMER_BONFIRE_BUNNIES_2, and UpdateBonfireBlessingBuffs().

InitBonfire()

bool npc_midsummer_bonfire::InitBonfire ( )

inline

    {
        _type = BONFIRE_TYPE_NONE;
        _teamId = TEAM_NEUTRAL;
 
        for (uint32 i = 0; (i < COUNT_GO_BONFIRE_ALLIANCE) && (_type == BONFIRE_TYPE_NONE); i++)
        {
            if ((_bonfire = me->FindNearestGameObject(GoBonfireAlliance[i], 10.0f)))
            {
                _type = BONFIRE_TYPE_ALLIANCE;
                _teamId = TEAM_ALLIANCE;
            }
        }
 
        for (uint32 i = 0; (i < COUNT_GO_BONFIRE_HORDE) && (_type == BONFIRE_TYPE_NONE); i++)
        {
            if ((_bonfire = me->FindNearestGameObject(GoBonfireHorde[i], 10.0f)))
            {
                _type = BONFIRE_TYPE_HORDE;
                _teamId = TEAM_HORDE;
            }
        }
 
        for (uint32 i = 0; (i < COUNT_GO_BONFIRE_CITY) && (_type == BONFIRE_TYPE_NONE); i++)
        {
            if ((_bonfire = me->FindNearestGameObject(GoBonfireCity[i], 10.0f)))
            {
                _type = BONFIRE_TYPE_CITY;
                Ignite();
                return true;
            }
        }
 
        if ((_type == BONFIRE_TYPE_NONE) && (_bonfire = me->FindNearestGameObject(GO_AHUNE_BONFIRE, 10.0f)))
        {
            _type = BONFIRE_TYPE_AHUNE;
            return true;
        }
 
        if (_type == BONFIRE_TYPE_NONE)
            return false;
 
        auto itr = BonfireStateStore.find(std::make_tuple(me->GetMapId(), me->GetZoneId(), _teamId));
        if ((itr != BonfireStateStore.end()) && (itr->second))
            _isStampedOut = itr->second;
        else
            LOG_ERROR("scripts.midsummer", "NPC {} (GUID{}) in map {}, zone {} with teamId {} can't locate its entry within BonfireStateStore", me->GetGUID().GetEntry(), me->GetSpawnId(), me->GetMapId(), me->GetZoneId(), _teamId);
 
        Ignite();
 
        return true;
    }

References BONFIRE_TYPE_AHUNE, BONFIRE_TYPE_ALLIANCE, BONFIRE_TYPE_CITY, BONFIRE_TYPE_HORDE, BONFIRE_TYPE_NONE, BonfireStateStore, COUNT_GO_BONFIRE_ALLIANCE, COUNT_GO_BONFIRE_CITY, COUNT_GO_BONFIRE_HORDE, GO_AHUNE_BONFIRE, GoBonfireAlliance, GoBonfireCity, GoBonfireHorde, LOG_ERROR, TEAM_ALLIANCE, TEAM_HORDE, and TEAM_NEUTRAL.

Referenced by npc_midsummer_bonfire().

SpellHit()

void npc_midsummer_bonfire::SpellHit ( Unit *  caster, SpellInfo const *  spellInfo  )

inlineoverridevirtual

Reimplemented from CreatureAI.

    {
        if (!caster->IsPlayer())
            return;
 
        switch (spellInfo->Id)
        {
            case SPELL_TOSS_FUEL_ON_BONFIRE:
            {
                Ignite();
                break;
            }
            case SPELL_STAMP_OUT_BONFIRE:
            {
                StampOut();
 
                // desecrating other faction's bonfire flags player for PVP
                caster->SetPvP(true);
                break;
            }
            default:
                break;
        }
    }

References SpellInfo::Id, Object::IsPlayer(), Unit::SetPvP(), SPELL_STAMP_OUT_BONFIRE, and SPELL_TOSS_FUEL_ON_BONFIRE.

StampOut()

void npc_midsummer_bonfire::StampOut ( )

inline

    {
        switch (_type)
        {
            case BONFIRE_TYPE_ALLIANCE:
            case BONFIRE_TYPE_HORDE:
                if (_isStampedOut)
                    *_isStampedOut = true;
 
                if (_spellFocus)
                {
                    _spellFocus->DespawnOrUnsummon();
                    _spellFocus->AddObjectToRemoveList();
                    _spellFocus = nullptr;
                }
 
                DoCastSelf(SPELL_STAMP_OUT_BONFIRE_ART_KIT, true);
                UpdateBonfireBlessingBuffs();
                break;
            default:
                break;
        }
    }

References _isStampedOut, _spellFocus, _type, WorldObject::AddObjectToRemoveList(), BONFIRE_TYPE_ALLIANCE, BONFIRE_TYPE_HORDE, GameObject::DespawnOrUnsummon(), UnitAI::DoCastSelf(), SPELL_STAMP_OUT_BONFIRE_ART_KIT, and UpdateBonfireBlessingBuffs().

UpdateAI()

void npc_midsummer_bonfire::UpdateAI ( uint32  )

inlineoverridevirtual

Use to start attacking a target. Called just before JustEngagedWith()

Implements UnitAI.

    {
        scheduler.Update(diff);
    }

UpdateBonfireBlessingBuffs()

void npc_midsummer_bonfire::UpdateBonfireBlessingBuffs ( )

inline

    {
        if ((_type != BONFIRE_TYPE_ALLIANCE) && (_type != BONFIRE_TYPE_HORDE))
            return;
 
        me->GetMap()->DoForAllPlayers([&](Player* p)
            {
                if ((p->GetZoneId() == me->GetZoneId()) && (p->GetTeamId() == _teamId))
                {
                    if (_isStampedOut)
                    {
                        if (*_isStampedOut)
                            p->RemoveAurasDueToSpell(SPELL_BONFIRES_BLESSING);
                        else
                        {
                            if (!p->HasAura(SPELL_BONFIRES_BLESSING))
                                p->CastSpell(p, SPELL_BONFIRES_BLESSING, true);
                        }
                    }
                }
            });
    }

References _teamId, _type, BONFIRE_TYPE_ALLIANCE, BONFIRE_TYPE_HORDE, Map::DoForAllPlayers(), WorldObject::GetMap(), Player::GetTeamId(), WorldObject::GetZoneId(), and ScriptedAI::me.

Referenced by Ignite(), and StampOut().

Member Data Documentation

_bonfire

GameObject* npc_midsummer_bonfire::_bonfire

private

Referenced by Ignite().

_isStampedOut

bool* npc_midsummer_bonfire::_isStampedOut

private

Referenced by Ignite(), npc_midsummer_bonfire(), and StampOut().

_spellFocus

GameObject* npc_midsummer_bonfire::_spellFocus

private

Referenced by Ignite(), npc_midsummer_bonfire(), and StampOut().

_teamId

TeamId npc_midsummer_bonfire::_teamId

private

Referenced by npc_midsummer_bonfire(), and UpdateBonfireBlessingBuffs().

_type

uint8 npc_midsummer_bonfire::_type

private

Referenced by Ignite(), npc_midsummer_bonfire(), StampOut(), and UpdateBonfireBlessingBuffs().

---

The documentation for this struct was generated from the following file:

• azerothcore-wotlk/src/server/scripts/Events/midsummer.cpp