2 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #ifndef MANGOS_CREATURE_EAI_H
20 #define MANGOS_CREATURE_EAI_H
24 #include "CreatureAI.h"
30 #define EVENT_UPDATE_TIME 500
36 EVENT_T_TIMER
= 0, // InitialMin, InitialMax, RepeatMin, RepeatMax
37 EVENT_T_TIMER_OOC
= 1, // InitialMin, InitialMax, RepeatMin, RepeatMax
38 EVENT_T_HP
= 2, // HPMax%, HPMin%, RepeatMin, RepeatMax
39 EVENT_T_MANA
= 3, // ManaMax%,ManaMin% RepeatMin, RepeatMax
40 EVENT_T_AGGRO
= 4, // NONE
41 EVENT_T_KILL
= 5, // RepeatMin, RepeatMax
42 EVENT_T_DEATH
= 6, // NONE
43 EVENT_T_EVADE
= 7, // NONE
44 EVENT_T_SPELLHIT
= 8, // SpellID, School, RepeatMin, RepeatMax
45 EVENT_T_RANGE
= 9, // MinDist, MaxDist, RepeatMin, RepeatMax
46 EVENT_T_OOC_LOS
= 10, // NoHostile, MaxRnage, RepeatMin, RepeatMax
47 EVENT_T_SPAWNED
= 11, // Condition, CondValue1
48 EVENT_T_TARGET_HP
= 12, // HPMax%, HPMin%, RepeatMin, RepeatMax
49 EVENT_T_TARGET_CASTING
= 13, // RepeatMin, RepeatMax
50 EVENT_T_FRIENDLY_HP
= 14, // HPDeficit, Radius, RepeatMin, RepeatMax
51 EVENT_T_FRIENDLY_IS_CC
= 15, // DispelType, Radius, RepeatMin, RepeatMax
52 EVENT_T_FRIENDLY_MISSING_BUFF
= 16, // SpellId, Radius, RepeatMin, RepeatMax
53 EVENT_T_SUMMONED_UNIT
= 17, // CreatureId, RepeatMin, RepeatMax
54 EVENT_T_TARGET_MANA
= 18, // ManaMax%, ManaMin%, RepeatMin, RepeatMax
55 EVENT_T_QUEST_ACCEPT
= 19, // QuestID
56 EVENT_T_QUEST_COMPLETE
= 20, //
57 EVENT_T_REACHED_HOME
= 21, // NONE
58 EVENT_T_RECEIVE_EMOTE
= 22, // EmoteId, Condition, CondValue1, CondValue2
59 EVENT_T_BUFFED
= 23, // Param1 = SpellID, Param2 = Number of Time STacked, Param3/4 Repeat Min/Max
60 EVENT_T_TARGET_BUFFED
= 24, // Param1 = SpellID, Param2 = Number of Time STacked, Param3/4 Repeat Min/Max
65 enum EventAI_ActionType
67 ACTION_T_NONE
= 0, // No action
68 ACTION_T_TEXT
= 1, // TextId1, optionally -TextId2, optionally -TextId3(if -TextId2 exist). If more than just -TextId1 is defined, randomize. Negative values.
69 ACTION_T_SET_FACTION
= 2, // FactionId (or 0 for default)
70 ACTION_T_MORPH_TO_ENTRY_OR_MODEL
= 3, // Creature_template entry(param1) OR ModelId (param2) (or 0 for both to demorph)
71 ACTION_T_SOUND
= 4, // SoundId
72 ACTION_T_EMOTE
= 5, // EmoteId
73 ACTION_T_RANDOM_SAY
= 6, // UNUSED
74 ACTION_T_RANDOM_YELL
= 7, // UNUSED
75 ACTION_T_RANDOM_TEXTEMOTE
= 8, // UNUSED
76 ACTION_T_RANDOM_SOUND
= 9, // SoundId1, SoundId2, SoundId3 (-1 in any field means no output if randomed that field)
77 ACTION_T_RANDOM_EMOTE
= 10, // EmoteId1, EmoteId2, EmoteId3 (-1 in any field means no output if randomed that field)
78 ACTION_T_CAST
= 11, // SpellId, Target, CastFlags
79 ACTION_T_SUMMON
= 12, // CreatureID, Target, Duration in ms
80 ACTION_T_THREAT_SINGLE_PCT
= 13, // Threat%, Target
81 ACTION_T_THREAT_ALL_PCT
= 14, // Threat%
82 ACTION_T_QUEST_EVENT
= 15, // QuestID, Target
83 ACTION_T_CAST_EVENT
= 16, // QuestID, SpellId, Target - must be removed as hack?
84 ACTION_T_SET_UNIT_FIELD
= 17, // Field_Number, Value, Target
85 ACTION_T_SET_UNIT_FLAG
= 18, // Flags (may be more than one field OR'd together), Target
86 ACTION_T_REMOVE_UNIT_FLAG
= 19, // Flags (may be more than one field OR'd together), Target
87 ACTION_T_AUTO_ATTACK
= 20, // AllowAttackState (0 = stop attack, anything else means continue attacking)
88 ACTION_T_COMBAT_MOVEMENT
= 21, // AllowCombatMovement (0 = stop combat based movement, anything else continue attacking)
89 ACTION_T_SET_PHASE
= 22, // Phase
90 ACTION_T_INC_PHASE
= 23, // Value (may be negative to decrement phase, should not be 0)
91 ACTION_T_EVADE
= 24, // No Params
92 ACTION_T_FLEE_FOR_ASSIST
= 25, // No Params
93 ACTION_T_QUEST_EVENT_ALL
= 26, // QuestID
94 ACTION_T_CAST_EVENT_ALL
= 27, // CreatureId, SpellId
95 ACTION_T_REMOVEAURASFROMSPELL
= 28, // Target, Spellid
96 ACTION_T_RANGED_MOVEMENT
= 29, // Distance, Angle
97 ACTION_T_RANDOM_PHASE
= 30, // PhaseId1, PhaseId2, PhaseId3
98 ACTION_T_RANDOM_PHASE_RANGE
= 31, // PhaseMin, PhaseMax
99 ACTION_T_SUMMON_ID
= 32, // CreatureId, Target, SpawnId
100 ACTION_T_KILLED_MONSTER
= 33, // CreatureId, Target
101 ACTION_T_SET_INST_DATA
= 34, // Field, Data
102 ACTION_T_SET_INST_DATA64
= 35, // Field, Target
103 ACTION_T_UPDATE_TEMPLATE
= 36, // Entry, Team
104 ACTION_T_DIE
= 37, // No Params
105 ACTION_T_ZONE_COMBAT_PULSE
= 38, // No Params
106 ACTION_T_CALL_FOR_HELP
= 39, // Radius
107 ACTION_T_SET_SHEATH
= 40, // Sheath (0-passive,1-melee,2-ranged)
108 ACTION_T_FORCE_DESPAWN
= 41, // No Params
109 ACTION_T_SET_INVINCIBILITY_HP_LEVEL
= 42, // MinHpValue, format(0-flat,1-percent from max health)
116 TARGET_T_SELF
= 0, //Self cast
118 //Hostile targets (if pet then returns pet owner)
119 TARGET_T_HOSTILE
, //Our current target (ie: highest aggro)
120 TARGET_T_HOSTILE_SECOND_AGGRO
, //Second highest aggro (generaly used for cleaves and some special attacks)
121 TARGET_T_HOSTILE_LAST_AGGRO
, //Dead last on aggro (no idea what this could be used for)
122 TARGET_T_HOSTILE_RANDOM
, //Just any random target on our threat list
123 TARGET_T_HOSTILE_RANDOM_NOT_TOP
, //Any random target except top threat
125 //Invoker targets (if pet then returns pet owner)
126 TARGET_T_ACTION_INVOKER
, //Unit who caused this Event to occur (only works for EVENT_T_AGGRO, EVENT_T_KILL, EVENT_T_DEATH, EVENT_T_SPELLHIT, EVENT_T_OOC_LOS, EVENT_T_FRIENDLY_HP, EVENT_T_FRIENDLY_IS_CC, EVENT_T_FRIENDLY_MISSING_BUFF)
128 //Hostile targets (including pets)
129 TARGET_T_HOSTILE_WPET
, //Current target (can be a pet)
130 TARGET_T_HOSTILE_WPET_SECOND_AGGRO
, //Second highest aggro (generaly used for cleaves and some special attacks)
131 TARGET_T_HOSTILE_WPET_LAST_AGGRO
, //Dead last on aggro (no idea what this could be used for)
132 TARGET_T_HOSTILE_WPET_RANDOM
, //Just any random target on our threat list
133 TARGET_T_HOSTILE_WPET_RANDOM_NOT_TOP
, //Any random target except top threat
135 TARGET_T_ACTION_INVOKER_WPET
,
142 CAST_INTURRUPT_PREVIOUS
= 0x01, //Interrupt any spell casting
143 CAST_TRIGGERED
= 0x02, //Triggered (this makes spell cost zero mana and have no cast time)
144 CAST_FORCE_CAST
= 0x04, //Forces cast even if creature is out of mana or out of range
145 CAST_NO_MELEE_IF_OOM
= 0x08, //Prevents creature from entering melee if out of mana or out of range
146 CAST_FORCE_TARGET_SELF
= 0x10, //Forces the target to cast this spell on itself
147 CAST_AURA_NOT_PRESENT
= 0x20, //Only casts the spell if the target does not have an aura from the spell
152 EFLAG_REPEATABLE
= 0x01, //Event repeats
153 EFLAG_DIFFICULTY_0
= 0x02, //Event only occurs in instance difficulty 0
154 EFLAG_DIFFICULTY_1
= 0x04, //Event only occurs in instance difficulty 1
155 EFLAG_DIFFICULTY_2
= 0x08, //Event only occurs in instance difficulty 2
156 EFLAG_DIFFICULTY_3
= 0x10, //Event only occurs in instance difficulty 3
157 EFLAG_RESERVED_5
= 0x20,
158 EFLAG_RESERVED_6
= 0x40,
159 EFLAG_DEBUG_ONLY
= 0x80, //Event only occurs in debug build
161 EFLAG_DIFFICULTY_ALL
= (EFLAG_DIFFICULTY_0
|EFLAG_DIFFICULTY_1
|EFLAG_DIFFICULTY_2
|EFLAG_DIFFICULTY_3
)
164 enum SpawnedEventMode
166 SPAWNED_EVENT_ALWAY
= 0,
167 SPAWNED_EVENT_MAP
= 1,
168 SPAWNED_EVENT_ZONE
= 2
171 // String text additional data, used in (CreatureEventAI)
172 struct StringTextData
180 typedef UNORDERED_MAP
<int32
, StringTextData
> CreatureEventAI_TextMap
;
182 struct CreatureEventAI_Action
184 EventAI_ActionType type
: 16;
192 // ACTION_T_SET_FACTION = 2
195 uint32 factionId
; // faction or 0 for default)
197 // ACTION_T_MORPH_TO_ENTRY_OR_MODEL = 3
200 uint32 creatureId
; // set one from fields (or 0 for both to demorph)
203 // ACTION_T_SOUND = 4
208 // ACTION_T_EMOTE = 5
213 // ACTION_T_RANDOM_SOUND = 9
216 int32 soundId1
; // (-1 in any field means no output if randomed that field)
220 // ACTION_T_RANDOM_EMOTE = 10
223 int32 emoteId1
; // (-1 in any field means no output if randomed that field)
227 // ACTION_T_CAST = 11
234 // ACTION_T_SUMMON = 12
241 // ACTION_T_THREAT_SINGLE_PCT = 13
247 // ACTION_T_THREAT_ALL_PCT = 14
252 // ACTION_T_QUEST_EVENT = 15
258 // ACTION_T_CAST_EVENT = 16
265 // ACTION_T_SET_UNIT_FIELD = 17
272 // ACTION_T_SET_UNIT_FLAG = 18, // value provided mask bits that will be set
273 // ACTION_T_REMOVE_UNIT_FLAG = 19, // value provided mask bits that will be clear
279 // ACTION_T_AUTO_ATTACK = 20
282 uint32 state
; // 0 = stop attack, anything else means continue attacking
284 // ACTION_T_COMBAT_MOVEMENT = 21
287 uint32 state
; // 0 = stop combat based movement, anything else continue attacking
288 uint32 melee
; // if set: at stop send melee combat stop if in combat, use for terminate melee fighting state for switch to ranged
290 // ACTION_T_SET_PHASE = 22
295 // ACTION_T_INC_PHASE = 23
300 // ACTION_T_QUEST_EVENT_ALL = 26
305 // ACTION_T_CAST_EVENT_ALL = 27
311 // ACTION_T_REMOVEAURASFROMSPELL = 28
317 // ACTION_T_RANGED_MOVEMENT = 29
323 // ACTION_T_RANDOM_PHASE = 30
330 // ACTION_T_RANDOM_PHASE_RANGE = 31
335 } random_phase_range
;
336 // ACTION_T_SUMMON_ID = 32
343 // ACTION_T_KILLED_MONSTER = 33
349 // ACTION_T_SET_INST_DATA = 34
355 // ACTION_T_SET_INST_DATA64 = 35
361 // ACTION_T_UPDATE_TEMPLATE = 36
367 // ACTION_T_CALL_FOR_HELP = 39
372 // ACTION_T_SET_SHEATH = 40
377 // ACTION_T_SET_INVINCIBILITY_HP_LEVEL = 42
382 } invincibility_hp_level
;
393 struct CreatureEventAI_Event
399 uint32 event_inverse_phase_mask
;
401 EventAI_Type event_type
: 16;
402 uint8 event_chance
: 8;
403 uint8 event_flags
: 8;
408 // EVENT_T_TIMER_OOC = 1
418 // EVENT_T_TARGET_HP = 12
419 // EVENT_T_TARGET_MANA = 18
433 // EVENT_T_SPELLHIT = 8
437 uint32 schoolMask
; // -1 (==0xffffffff) is ok value for full mask, or must be more limited mask like (0 < 1) = 1 for normal/physical school
449 // EVENT_T_OOC_LOS = 10
457 // EVENT_T_SPAWNED = 11
461 uint32 conditionValue1
;
463 // EVENT_T_TARGET_CASTING = 13
469 // EVENT_T_FRIENDLY_HP = 14
477 // EVENT_T_FRIENDLY_IS_CC = 15
480 uint32 dispelType
; // unused ?
485 // EVENT_T_FRIENDLY_MISSING_BUFF = 16
493 // EVENT_T_SUMMONED_UNIT = 17
500 // EVENT_T_QUEST_ACCEPT = 19
501 // EVENT_T_QUEST_COMPLETE = 20
506 // EVENT_T_RECEIVE_EMOTE = 22
511 uint32 conditionValue1
;
512 uint32 conditionValue2
;
514 // EVENT_T_BUFFED = 23
515 // EVENT_T_TARGET_BUFFED = 24
534 CreatureEventAI_Action action
[MAX_ACTIONS
];
537 typedef std::vector
<CreatureEventAI_Event
> CreatureEventAI_Event_Vec
;
538 typedef UNORDERED_MAP
<uint32
, CreatureEventAI_Event_Vec
> CreatureEventAI_Event_Map
;
540 struct CreatureEventAI_Summon
548 uint32 SpawnTimeSecs
;
552 typedef UNORDERED_MAP
<uint32
, CreatureEventAI_Summon
> CreatureEventAI_Summon_Map
;
554 struct CreatureEventAIHolder
556 CreatureEventAIHolder(CreatureEventAI_Event p
) : Event(p
), Time(0), Enabled(true){}
558 CreatureEventAI_Event Event
;
563 bool UpdateRepeatTimer(Creature
* creature
, uint32 repeatMin
, uint32 repeatMax
);
566 class MANGOS_DLL_SPEC CreatureEventAI
: public CreatureAI
570 explicit CreatureEventAI(Creature
*c
);
573 CreatureEventAIList
.clear();
575 void JustRespawned();
577 void JustReachedHome();
578 void EnterCombat(Unit
*enemy
);
579 void EnterEvadeMode();
580 void JustDied(Unit
* killer
);
581 void KilledUnit(Unit
* victim
);
582 void JustSummoned(Creature
* pUnit
);
583 void AttackStart(Unit
*who
);
584 void MoveInLineOfSight(Unit
*who
);
585 void SpellHit(Unit
* pUnit
, const SpellEntry
* pSpell
);
586 void DamageTaken(Unit
* done_by
, uint32
& damage
);
587 void UpdateAI(const uint32 diff
);
588 bool IsVisible(Unit
*) const;
589 void ReceiveEmote(Player
* pPlayer
, uint32 text_emote
);
590 static int Permissible(const Creature
*);
592 bool ProcessEvent(CreatureEventAIHolder
& pHolder
, Unit
* pActionInvoker
= NULL
);
593 void ProcessAction(CreatureEventAI_Action
const& action
, uint32 rnd
, uint32 EventId
, Unit
* pActionInvoker
);
594 inline uint32
GetRandActionParam(uint32 rnd
, uint32 param1
, uint32 param2
, uint32 param3
);
595 inline int32
GetRandActionParam(uint32 rnd
, int32 param1
, int32 param2
, int32 param3
);
596 inline Unit
* GetTargetByType(uint32 Target
, Unit
* pActionInvoker
);
597 inline Unit
* SelectUnit(AttackingTarget target
, uint32 position
) const;
599 void DoScriptText(int32 textEntry
, WorldObject
* pSource
, Unit
* target
);
600 void DoMeleeAttackIfReady();
601 bool CanCast(Unit
* Target
, SpellEntry
const *Spell
, bool Triggered
);
603 bool SpawnedEventConditionsCheck(CreatureEventAI_Event
const& event
);
605 Unit
* DoSelectLowestHpFriendly(float range
, uint32 MinHPDiff
);
606 void DoFindFriendlyMissingBuff(std::list
<Creature
*>& _list
, float range
, uint32 spellid
);
607 void DoFindFriendlyCC(std::list
<Creature
*>& _list
, float range
);
609 //Holder for events (stores enabled, time, and eventid)
610 std::list
<CreatureEventAIHolder
> CreatureEventAIList
;
611 uint32 EventUpdateTime
; //Time between event updates
612 uint32 EventDiff
; //Time between the last event call
615 //Variables used by Events themselves
616 uint8 Phase
; // Current phase, max 32 phases
617 bool CombatMovementEnabled
; // If we allow targeted movment gen (movement twoards top threat)
618 bool MeleeEnabled
; // If we allow melee auto attack
619 float AttackDistance
; // Distance to attack from
620 float AttackAngle
; // Angle of attack
621 uint32 InvinceabilityHpLevel
; // Minimal health level allowed at damage apply