[8587] MaNGOS 0.14 release.
[getmangos.git] / doc / EventAI.txt
blobcf385643ba0d81d47bf78345f87952ab277c2bd6
1 =============================================
2 EventAI documentation: (updated May 19, 2009)
3 =============================================
5 EventAI allows users to create new creature scripts entierly within the database.
7 For the AI to be used, you must first make sure to set AIname for each creature that should use this AI.
8 UPDATE creature_template SET AIName = 'EventAI' WHERE entry IN (...);
11 =========================================
12 Basic structure of EventAI
13 =========================================
15 EventAI follows a basic if (Event) then do (Action) format.
16 Below is the list of current fields of the creature_ai_scripts table.
18 (Field_Name)                (Description)
19 id                          This value is merely an incrementing counter of the current Event number. Required for sql queries.
20 creature_id                 Creature id which should trigger this event.
22 event_type                  The type of event (see "Event types" below)
23 event_inverse_phase_mask    Mask with phases this event should NOT trigger in*
24 event_chance                Percentage chance of triggering the event (1 - 100)
25 event_flags                 Event flags (repeatable, ... (see below))
26 event_param1                Variables for the event (depends on event_type)
27 event_param2
28 event_param3
29 event_param4
31 action1_type                An action to take when the event occurs (see "Action types" below)
32 action1_param1              Variables used by Action1 (depends on action_type)
33 action1_param2
34 action1_param3
36 action2_type
37 action2_param1
38 action2_param2
39 action2_param3
41 action3_type
42 action3_param1
43 action3_param2
44 action3_param3
46 All params are signed 32-bit values (+/- 2147483647). Time values are always in milliseconds.
47 In case of a percentage value, use value/100 (ie. param = 500 then that means 500%, -50 = -50%)
49 [*] Phase mask is a bitmask of phases which shouldn't trigger this event. (ie. Phase mask of value 12 (binary 1100) results in triggering this event in phases 0, 1 and all others with exception for phases 2 and 3 (counting from 0).
52 =========================================
53 Event types
54 =========================================
56 A list of event types EventAI is able to handle.
57 Each event type has its own specific interpretation of the params that accompany it.
58 Params are always read in the ascending order (from Param1 to Param3).
59 Events will not repeat until the creature exits combat or unless EFLAG_REPEATABLE is set.
60 Some events such as EVENT_T_AGGRO, EVENT_T_DEATH, EVENT_T_SPAWNED, and EVENT_T_EVADE cannot repeat.
62 #   Internal name                Param usage                                             Description
63 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
64 0    EVENT_T_TIMER               InitialMin, InitialMax, RepeatMin, RepeatMax            Expires at first between (Param1) and (Param2) and then between every (Param3) and (Param4),  but only in combat.
65 1    EVENT_T_TIMER_OOC           InitialMin, InitialMax, RepeatMin, RepeatMax            Expires at first between (Param1) and (Param2) and then between every (Param3) and (Param4),  but only out of combat.
66 2    EVENT_T_HP                  HPMax%, HPMin%, RepeatMin, RepeatMax                    Expires when HP is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
67 3    EVENT_T_MANA                ManaMax%,ManaMin% RepeatMin, RepeatMax                  Expires once Mana% is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
68 4    EVENT_T_AGGRO               NONE                                                    Expires upon initial aggro (does not repeat).
69 5    EVENT_T_KILL                RepeatMin, RepeatMax                                    Expires upon killing a player. Will repeat between (Param1) and (Param2).
70 6    EVENT_T_DEATH               NONE                                                    Expires upon creature death.
71 7    EVENT_T_EVADE               NONE                                                    Expires upon creature EnterEvadeMode().
72 8    EVENT_T_SPELLHIT            SpellID, Schoolmask, RepeatMin, RepeatMax               Expires upon a spell hit. When (param1) is set, it will be used as a trigger. With (param2) specified, the expiration is limited to specific spell schools (-1 for all). Will repeat every (Param3) and (Param4).
73 9    EVENT_T_RANGE               MinDist, MaxDist, RepeatMin, RepeatMax                  Expires when the highest threat target distance is greater than (Param1) and less than (Param2). Will repeat every (Param3) and (Param4).
74 10   EVENT_T_OOC_LOS             Hostile-or-Not, MaxAllowedRange, RepeatMin, RepeatMax   Expires when a unit moves within distance (MaxAllowedRange) of a creature. If (Param1) is zero it will expire only when unit is hostile, friendly otherwise (Param1 = 1), depends generally on faction. Will repeat every (Param3) and (Param4). Does not expire when the creature is in combat.
75 11   EVENT_T_SPAWNED             NONE                                                    Expires on initial spawn and on creature respawn (useful for setting ranged movement type).
76 12   EVENT_T_TARGET_HP           HPMax%, HPMin%, RepeatMin, RepeatMax                    Expires when current target's HP is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
77 13   EVENT_T_TARGET_CASTING      RepeatMin, RepeatatMax                                  Expires when the current target is casting a spell. Will repeat every (Param1) and (Param2).
78 14   EVENT_T_FRIENDLY_HP         HPDeficit, Radius, RepeatMin, RepeatMax                 Expires when a friendly unit in radius has at least (Param1) HP missing. Will repeat every (Param3) and (Param4).
79 15   EVENT_T_FRIENDLY_IS_CC      DispelType, Radius, RepeatMin, RepeatMax                Expires when a friendly unit is crowd controlled within the given radius (Param2). Will repeat every (Param3) and (Param4).
80 16   EVENT_T_MISSING_BUFF        SpellId, Radius, RepeatMin, RepeatMax                   Expires when a friendly unit is missing aura(s) given by a spell (Param1) within radius (Param2). Will repeat every (Param3) and (Param4).
81 17   EVENT_T_SUMMONED_UNIT       CreatureId, RepeatMin, RepeatMax                        Expires after creature with entry = (Param1) is spawned (Param1 = 0 means all spawns). Will repeat every (Param2) and (Param3).
82 18   EVENT_T_TARGET_MANA         ManaMax%, ManaMin%, RepeatMin, RepeatMax
83 21   EVENT_T_REACHED_HOME        NONE                                                    Expires when a creature reach it's home(spawn) location after evade.
84 22   EVENT_T_RECEIVE_EMOTE       EmoteId, Condition, CondValue1, CondValue2              Expires when a creature receives an emote with emote text id (enum TextEmotes) in (Param1). Conditions can be defined (Param2) with optional values (Param3,Param4), see enum ConditionType.
85 23   EVENT_T_BUFFED              SpellID, AmmountInStack, RepeatMin, RepeatMax           Expires when a creature has spell (Param1) auras applied in a stack greater or equal to value provided in (Param2). Will repeat every (Param3) and (Param4).
86 24   EVENT_T_TARGET_BUFFED       SpellID, AmmountInStack, RepeatMin, RepeatMax           Expires when a target unit has spell (Param1) auras applied in a stack greater or equal to value provided in (Param2). Will repeat every (Param3) and (Param4).
89 =========================================
90 Action Types
91 =========================================
93 A list of action types that EventAI can handle.
94 Each event type has its own specific interpretation of it's params, like every event type.
96 #    Internal name                     Param usage                     Description
97 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
98 0    ACTION_T_NONE                     No Action                       Does nothing.
99 1    ACTION_T_TEXT                     -TextId1, -TextId2, -TextId3    Simply displays the specified -TextId. When -TextId2 and -TextId3 are specified, the selection will be randomized. Text types are defined, along with other options for the text, in a table below. All values needs to be negative.
100 2    ACTION_T_SET_FACTION              FactionId                       Changes faction for a creature. When param1 is zero, creature will revert to it's default faction.
101 3    ACTION_T_MORPH_TO_ENTRY_OR_MODEL  CreatureEntry, ModelId          Set either model from creature_template.entry (Param1) OR explicit modelId (Param2). If (Param1) AND (Param2) are both 0, demorph and revert to the default model.
102 4    ACTION_T_SOUND                    SoundId                         Plays a sound
103 5    ACTION_T_EMOTE                    EmoteId                         Does an emote
104 6    ACTION_T_RANDOM_SAY                                               UNUSED
105 7    ACTION_T_RANDOM_YELL                                              UNUSED
106 8    ACTION_T_RANDOM_TEXTEMOTE                                         UNUSED
107 9    ACTION_T_RANDOM_SOUND             SoundId1, SoundId2, SoundId3    Plays a random sound *
108 10   ACTION_T_RANDOM_EMOTE             EmoteId1, EmoteId2, EmoteId3    Emotes a random emote
109 11   ACTION_T_CAST                     SpellId, Target, CastFlags      Casts spell (Param1) on a target (Param2) using cast flags (specified below).
110 12   ACTION_T_SUMMON                   CreatureID, Target, Duration    Summons a creature (Param1) for (Param3) duration and orders it to attach (Param2) target. Spawns on top of current creature.
111 13   ACTION_T_THREAT_SINGLE_PCT        Threat%, Target                 Modifies a threat by (Param1) percent on a target (Param2).
112 14   ACTION_T_THREAT_ALL_PCT           Threat%                         Modifies a threat by (Param1) on all targets in the threat list (using -100% here will result in full aggro dump).
113 15   ACTION_T_QUEST_EVENT              QuestID, Target                 Calls AreaExploredOrEventHappens with (Param1) for a target in (Param2).
114 16   ACTION_T_QUEST_CASTCREATUREGO     CreatureID, SpellId, Target     Sends CastCreatureOrGo for a creature specified by CreatureId (Param1) with provided spell id (Param2) for a target in (Param3).
115 17   ACTION_T_SET_UNIT_FIELD           Field_Number, Value, Target     Sets a unit field (Param1) to provided value (Param2) on a target in (Param3).
116 18   ACTION_T_SET_UNIT_FLAG            Flags, Target                   Sets flag (flags can be used together to modify multiple flags at once) on a target (Param2).
117 19   ACTION_T_REMOVE_UNIT_FLAG         Flags, Target                   Removes flag on a target (Param2).
118 20   ACTION_T_AUTO_ATTACK              AllowAutoAttack                 Stop melee attack when (Param1) is zero, otherwise continue attacking / allow melee attack.
119 21   ACTION_T_COMBAT_MOVEMENT          AllowCombatMovement             Stop combat based movement when (Param1) is zero, otherwise continue/allow combat based movement (targeted movement generator).
120 22   ACTION_T_SET_PHASE                Phase                           Sets the current phase to (Param1).
121 23   ACTION_T_INC_PHASE                Value                           Increments the phase by (Param1). May be negative to decrement, but should not be zero.
122 24   ACTION_T_EVADE                    No Params                       Forces the creature to evade, wiping all threat and dropping combat.
123 25   ACTION_T_FLEE_FOR_ASSIST          No Params                       Causes the creature to flee for assistence (often at low health).
124 26   ACTION_T_QUEST_EVENT_ALL          QuestId                         Calls GroupEventHappens with (Param1). Only used if it's _expected_ event should call quest completion for all players in a current party.
125 27   ACTION_T_CASTCREATUREGO_ALL       QuestId, SpellId                Calls CastedCreatureOrGo for all players on the threat list with quest id specified in (Param1) and spell id in (Param2).
126 28   ACTION_T_REMOVEAURASFROMSPELL     Target, Spellid                 Removes all auras on a target (Param1) caused by a spell (Param2).
127 29   ACTION_T_RANGED_MOVEMENT          Distance, Angle                 Changes the movement generator to a ranged type. (note: default melee type can still be set by using 0 as angle and 0 as distance).
128 30   ACTION_T_RANDOM_PHASE             PhaseId1, PhaseId2, PhaseId3    Sets a phase to a specified id(s)*
129 31   ACTION_T_RANDOM_PHASE_RANGE       PhaseMin, PhaseMax              Sets a phase to a random id (Phase = PhaseMin + rnd % PhaseMin-PhaseMax). PhaseMax must be greater than PhaseMin.
130 32   ACTION_T_SUMMON                   CreatureID, Target, SummonID    Summons a creature (Param1) to attack target (Param2) at location specified by EventAI_Summons (Param3).
131 33   ACTION_T_KILLED_MONSTER           CreatureID, Target              Calls KilledMonster (Param1) for a target (Param2).
132 34   ACTION_T_SET_INST_DATA            Field, Data                     Calls ScriptedInstance::SetData with field (Param1) and data (Param2).
133 35   ACTION_T_SET_INST_DATA64          Field, Target                   Calls ScriptedInstance::SetData64 with field (Param1) and target's GUID (Param2).
134 36   ACTION_T_UPDATE_TEMPLATE          TemplateId, Team                Changes a creature's template to (Param1) with team = Alliance or Horde when (Param2) is either false or true respectively.
135 37   ACTION_T_DIE                      No Params                       Kills the creature
136 38   ACTION_T_ZONE_COMBAT_PULSE        No Params                       Puts all players within an instance into combat with the creature. Only works when a creature is already in combat. Doesn't work outside instances.
137 39   ACTION_T_CALL_FOR_HELP            Radius                          Call any friendly out-of-combat creatures in a radius (Param1) to attack current creature's target.
138 40   ACTION_T_SET_SHEATH               Sheath                          Sets sheath state for a creature (0 = no weapon, 1 = melee weapon, 2 = ranged weapon).
139 41   ACTION_T_FORCE_DESPAWN            No Params                       Despawns the creature
140 42   ACTION_T_SET_INVINCIBILITY_HP_LEVEL hp_level, is_percent          Set min. health level for creature that can be set at damage as flat value or percent from max health
142 * = Use -1 where the param is expected to do nothing. Random constant is generated for each event, so if you have a random yell and a random sound, they will be linked up with each other (ie. param2 with param2).
145 =========================================
146 Event Types
147 =========================================
148 Note:
149 COMBAT ONLY - Means that this event will only trigger durring combat.
150 OUT OF COMBAT ONLY - Means that this event will only trigger while out of combat.
151 BOTH - This event can trigger both in and out of combat.
153 Events that do not have lables on them are events that are directly involved with the in and out of combat state.
155 ------------------
156 0 = EVENT_T_TIMER:
157 ------------------
158 Parameter 1: InitialMin - Minumum Time used to calculate Random Initial Expire
159 Parameter 2: InitialMax - Maximum Time used to calculate Random Initial Expire
160 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
161 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
163 COMBAT ONLY! - Expires first between (Param1) and (Param2) and then between every (Param3) and (Param4) from then on.
164 This is commonly used for spells that repeat cast during combat (Simulate Spell Cooldown).
166 ----------------------
167 1 = EVENT_T_TIMER_OOC:
168 ----------------------
169 Parameter 1: InitialMin - Minumum Time used to calculate Random Initial Expire
170 Parameter 2: InitialMax - Maximum Time used to calculate Random Initial Expire
171 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
172 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
174 OUT OF COMBAT ONLY! - Expires first between (Param1) and (Param2) and then between every (Param3) and (Param4) from then on.
175 This is commonly used for events that occur and repeat outside of combat.
177 ---------------
178 2 = EVENT_T_HP:
179 ---------------
180 Parameter 1: HPMax% - Maximum HP% That this Event will Expire
181 Parameter 2: HPMin% - Minimum HP% That this Event will Expire
182 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
183 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
185 BOTH - Expires when HP is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
186 This is commonly used for events that trigger at a specific HP% (Such as Heal/Enrage Spells or NPC's that Flee).
188 -----------------
189 3 = EVENT_T_MANA:
190 -----------------
191 Parameter 1: ManaMax% - Maximum Mana% That this Event will Expire
192 Parameter 2: ManaMin% - Minimum Mana% That this Event will Expire
193 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
194 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
196 BOTH - Expires once Mana% is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
197 This is commonly used for events where an NPC low on Mana will do something (Such as stop casting spells and switch to melee).
199 ------------------
200 4 = EVENT_T_AGGRO:
201 ------------------
202 This Event Expires upon initial aggro (does not repeat).
204 -----------------
205 5 = EVENT_T_KILL:
206 -----------------
207 Parameter 1: RepeatMin - Minimum Time used to calculate Random Repeat Expire
208 Parameter 2: RepeatMax - Maximum Time used to calculate Random Repeat Expire
210 COMBAT ONLY! - Expires upon killing a player. Will repeat every (Param1) and (Param2).
211 This Event Expires upon killing a player. It is commonly used for NPC's who yell or do something after killing a player.
213 ------------------
214 6 = EVENT_T_DEATH:
215 ------------------
216 This Event Expires upon Death of the Scripted NPC.
217 This is commonly used for NPC's who have a yell on death or cast some kind if summon spell when they die.
219 ------------------
220 7 = EVENT_T_EVADE:
221 ------------------
222 This Event Expires upon the creature EnterEvadeMode().
223 This is commonly used for NPC's who use phases, allows you to reset their phase to 0 upon evade to prevent possible strange behavior.
225 ---------------------
226 8 = EVENT_T_SPELLHIT:
227 ---------------------
228 Parameter 1: SpellID - The Spell ID that will trigger the event to occur (NOTE: If you use Spell School as the trigger set this value to 0)
229 Parameter 2: School - Spell School to trigger the event (NOTE: If you use a SpellID then set this value to -1) - *See Below for Spell School Bitmask Values*
230 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
231 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
233 BOTH - Expires upon Spell hit. If (param1) is set will only expire on that spell OR If (param2) is set it will only expire on spells of that school. Will repeat every (Param3) and (Param4).
234 This Event is commonly used for NPC's who can do special things when you cast a spell (Or specific spell) on them.
236 (name, school, schoolmask)
237 SPELL_SCHOOL_NORMAL = 0, ==> 1
238 SPELL_SCHOOL_HOLY   = 1, ==> 2
239 SPELL_SCHOOL_FIRE   = 2, ==> 4
240 SPELL_SCHOOL_NATURE = 3, ==> 8
241 SPELL_SCHOOL_FROST  = 4, ==> 16
242 SPELL_SCHOOL_SHADOW = 5, ==> 32
243 SPELL_SCHOOL_ARCANE = 6, ==> 64
244 Use These Values For Schoolmask (Param2) or Any Combinations Of These Schoolmasks for Multiple Schools.
246 ------------------
247 9 = EVENT_T_RANGE:
248 ------------------
249 Parameter 1: MinDist - This Distance is the Minimum Distance between the NPC and it's target to allow this Event to Expire
250 Parameter 2: MaxDist - This Distance is the Maximum Distance between the NPC and it's target to allow this Event to Expire
251 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
252 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
254 COMBAT ONLY! - Expires when the highest threat target distance is greater than (Param1) and less than (Param2). Will repeat every (Param3) and (Param4).
255 This Event is commonly used for NPC's who have Ranged Combat and will Throw/Shoot between a certian distance.
257 ---------------------
258 10 = EVENT_T_OOC_LOS:
259 ---------------------
260 Parameter 1: Hostile-or-Not   - This will expire if Unit are hostile. If Param1=1 it will only expire if Unit are not Hostile(generally determined by faction)
261 Parameter 2: MaxAllowedRange  - Expires when a Unit moves within this distance to creature
262 Parameter 3: RepeatMin        - Minimum Time used to calculate Random Repeat Expire
263 Parameter 4: RepeatMax        - Maximum Time used to calculate Random Repeat Expire
265 OUT OF COMBAT!
266 This Event is commonly used for NPC's who do something or say something to you when you walk past them Out of Combat.
268 ---------------------
269 11 = EVENT_T_SPAWNED:
270 ---------------------
271 Expires at initial spawn and at creature respawn.
272 This Event is commonly used for setting ranged movement type or Summoning a Pet on Spawn
273 Parameter 1: 0: works always, 1: works on map in Parameter 2, 2: works on zone/subzone in Parameter 2
274 Parameter 2: depends on Parameter 1: for 1 it is map ID, for 2 it is area ID to check
276 -----------------------
277 12 = EVENT_T_TARGET_HP:
278 -----------------------
279 Parameter 1: HPMax% - Maximum HP% That this Event will Expire
280 Parameter 2: HPMin% - Minimum HP% That this Event will Expire
281 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
282 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
284 COMBAT ONLY! - Expires when Current NPC's Target's HP is between (Param1) and (Param2). Will repeat every (Param3) and (Param4).
285 This Event is commonly used for NPC's who have a special ability (Like Execute) that only casts when a Player HP is low.
287 ----------------------------
288 13 = EVENT_T_TARGET_CASTING:
289 ----------------------------
290 Parameter 1: RepeatMin - Minimum Time used to calculate Random Repeat Expire
291 Parameter 2: RepeatMax - Maximum Time used to calculate Random Repeat Expire
293 COMBAT ONLY! - Expires when the current target is casting a spell. Will repeat every (Param1) and (Param2).
294 This event is commonly used for NPC's who will cast a counter spell when their target starts to cast a spell.
296 -------------------------
297 14 = EVENT_T_FRIENDLY_HP:
298 -------------------------
299 Parameter 1: HPDeficit - This is the Amount of HP Missing from Full HP to trigger this event (You would need to calculate the amount of HP the event happens and subtract that from Full HP Value to get this number)
300 Parameter 2: Radius - This is the Range in Yards the NPC will scan for nearby Friendlies (Faction is Friendly To) for the missing amount of HP in Param1.
301 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
302 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
304 COMBAT ONLY! - Expires when a friendly unit in radius(param2) has at least (param1) hp missing. Will repeat every (Param3) and (Param4).
305 This is commonly used when an NPC in Combat will heal a nearby Friendly NPC in Combat with a Heal/Renew Spell.
307 ----------------------------
308 15 = EVENT_T_FRIENDLY_IS_CC:
309 ----------------------------
310 Parameter 1: DispelType - Dispel Type to trigger the event - *See Below for Dispel Bitmask Values*
311 Parameter 2: Radius - This is the Range in Yards the NPC will scan for nearby Friendlies being Crowd Controlled
312 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
313 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
315 COMBAT ONLY! - Expires when a friendly unit is Crowd controlled within the given radius (param2). Will repeat every (Param3) and (Param4).
316 This is commonly used for NPC's who can come to the resule of other Friendly NPC's if being Crowd Controlled
318 --------------------------
319 16 = EVENT_T_MISSING_BUFF:
320 --------------------------
321 Parameter 1: SpellId - This is the SpellID That the Aura Check will look for (If it is missing this Aura)
322 Parameter 2: Radius - This is the Range in Yards the NPC will scan for nearby Friendlies (Faction is Friendly To) for the missing Aura.
323 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
324 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
326 BOTH - Expires when a friendly unit is missing aura's given by spell (param1) within radius (param2). Will repeat every (Param3) and (Param4).
327 This is commonly used for NPC's who watch friendly units for a debuff to end so they can recast it on them again.
329 ---------------------------
330 17 = EVENT_T_SUMMONED_UNIT:
331 ---------------------------
332 Parameter 1: CreatureId - The CreatureID that the NPC is watching to spawn to trigger this event
333 Parameter 2: RepeatMin - Minimum Time used to calculate Random Repeat Expire
334 Parameter 3: RepeatMax - Maximum Time used to calculate Random Repeat Expire
336 BOTH - Expires after creature with entry(Param1) is spawned or for all spawns if param1 = 0. Will repeat every (Param2) and (Param3) .
337 This is commonly used for NPC's who will do something special once another NPC is summoned. Usually used is Complex Scripts or Special Events.
339 ---------------------------
340 21 = EVENT_T_REACHED_HOME:
341 ---------------------------
342 Expires only when creature has returned to it's home location after Evade. Out of combat event.
343 Most commonly used to cast spells that can not be casted in EVENT_T_EVADE and other effects that does not fit in while still running back to spawn/home location.
345 ---------------------------
346 22 = EVENT_T_RECEIVE_EMOTE:
347 ---------------------------
348 Expires only when creature receive emote from player. Valid text emote id's are in Mangos source (enum TextEmotes)
349 Event does not require any conditions to process, however many are ecpected to have condition.
351 ---------------------------
352 23 = EVENT_T_BUFFED       :
353 ---------------------------
354 Parameter 1: SpellId - This is the SpellID That the Aura Check will look for
355 Parameter 2: Amount -  This is the amount of SpellID's auras at creature required for event expire.
356 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
357 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
359 ---------------------------
360 24 = EVENT_T_TARGET_BUFFED:
361 ---------------------------
362 Parameter 1: SpellId - This is the SpellID That the Aura Check will look for
363 Parameter 2: Amount -  This is the amount of SpellID's auras at target unit required for event expire.
364 Parameter 3: RepeatMin - Minimum Time used to calculate Random Repeat Expire
365 Parameter 4: RepeatMax - Maximum Time used to calculate Random Repeat Expire
367 EventAI use conditions from available in Mangos (enum ConditionType)
368 Current implemented conditions:
369 CONDITION_NONE (0)            0            0
370 CONDITION_AURA (1)            spell_id     effindex
371 CONDITION_ITEM (2)            item_id      count
372 CONDITION_ITEM_EQUIPPED (3)   item_id      count
373 CONDITION_ZONEID (4)          zone_id      0
374 CONDITION_REPUTATION_RANK (5) faction_id   min_rank
375 CONDITION_TEAM (6)            player_team  0 (469-Alliance / 67-Horde)
376 CONDITION_SKILL (7)           skill_id     min_skill_value
377 CONDITION_QUESTREWARDED (8)   quest_id     0, if quest are rewarded
378 CONDITION_QUESTTAKEN (9)      quest_id     0, while quest active(incomplete)
379 CONDITION_ACTIVE_EVENT (12)   event_id     0, note this is id from dbc, also defined in Mangos source(enum HolidayIds) NOT id of game_event in database
381 =========================================
382 Action Types
383 =========================================
385 -----------------
386 1 = ACTION_T_TEXT:
387 -----------------
388 Parameter 1: The entry of the text that the NPC should use from eventai_texts table. Optionally a entry from other tables can be used (such as custom_texts).
389              Entry are required to be negative and exist in a *_texts-table. The type text to be displayed are defined in the texts-table itself (Say, Yell, Whisper, Emote Text, Boss Whisper, Boss Emote)
390              Other options are also to be defined in the texts-table, such as a sound to be heard with the text and the language used in output (common, dwarvish, etc).
391              In case this entry has a localized version of the text, the localized text will be displayed in client that support this locale.
393 Parameter 2: Optional. TextId can be defined in addition. The same apply to this as explained above, however eventAI will randomize between the two.
394 Parameter 3: Optional, if Parameter 2 exist. In this case, eventAI will randomize between three.
396 Read at bottom for documentation of creature_ai_texts-table.
398 ------------------
399 2 = ACTION_T_SET_FACTION:
400 ------------------
401 Parameter 1: FactionId from Faction.dbc OR 0. Changes faction for creature. If 0, creature will revert to it's default faction if previously changed.
403 -----------------------
404 3 = ACTION_T_MORPH_TO_ENTRY_OR_MODEL:
405 -----------------------
406 Parameter 1: Creature entry from creature_template. Action will then change to the model this creature are using.
407 Parameter 2: If parameter 1 is 0, then this modelId will be used (in case parameter 1 exist, parameter 2 will not be used)
409 If both parameter 1 and 2 is 0, the creature will DeMorph, and use it's default model.
411 -------------------
412 4 = ACTION_T_SOUND:
413 -------------------
414 Parameter 1: The Sound ID to be played. (Sound IDs are contained in the DBC files.)
416 The creature will play the specified sound.
417 This is commonly used for Bosses who Yell and then also have a Voice for the same thing.
419 -------------------
420 5 = ACTION_T_EMOTE:
421 -------------------
422 Parameter 1: The Emote ID that the creature should perform. (Emote IDs are also contained in the DBC but they can be found in the mangos source as well).
424 The creature will perform a visual emote. Unlike a text emote, a visual emote is one where the creature will actually move or perform a gesture.
425 This is commonly used for NPC's who may perform a special action (Salute, Roar, ect...). Not all player emotes work for creature models.
427 ------------------------
428 6 = ACTION_T_RANDOM_SAY:
429 ------------------------
430 UNUSED       Can be reused to create new action type
432 -------------------------
433 7 = ACTION_T_RANDOM_YELL:
434 -------------------------
435 UNUSED       Can be reused to create new action type
437 ------------------------------
438 8 = ACTION_T_RANDOM_TEXTEMOTE:
439 ------------------------------
440 UNUSED       Can be reused to create new action type
442 --------------------------
443 9 = ACTION_T_RANDOM_SOUND:
444 --------------------------
445 Parameter 1: The Sound ID to be played as Random Choice #1.
446 Parameter 2: The Sound ID to be played as Random Choice #2.
447 Parameter 3: The Sound ID to be played as Random Choice #3.
449 Similar to the ACTION_T_SOUND action, it will choose at random a sound to play.
451 ---------------------------
452 10 = ACTION_T_RANDOM_EMOTE:
453 ---------------------------
454 Parameter 1: The Emote ID to be played as Random Choice #1.
455 Parameter 2: The Emote ID to be played as Random Choice #2.
456 Parameter 3: The Emote ID to be played as Random Choice #3.
458 Similar to the ACTION_T_EMOTE action, it will choose at random an Emote to Visually Perform.
460 -------------------
461 11 = ACTION_T_CAST:
462 -------------------
463 Parameter 1: SpellId - The Spell ID to use for the NPC to cast. The value used in this field needs to be a valid Spell ID.
464 Parameter 2: Target - The Target Type defining who the creature should cast the spell at. The value in this field needs to be a valid Target Type as specified in the reference tables below.
465 Parameter 3: CastFlags - See Table Below for Cast Flag Bitmask Values. If you are unsure what to set this value at leave it at 0.
467 The creature will cast a spell specified by a spell ID on a target specified by the target type.
468 This is commonly used for NPC's who cast spells.
470 ---------------------
471 12 = ACTION_T_SUMMON:
472 ---------------------
473 Parameter 1: CreatureID - The Creature Template ID to be Summoned. The value here needs to be a valid Creature Template ID.
474 Parameter 2: Target - The Target Type defining who the Summoned creature will attack once spawned. The value in this field needs to be a valid Target Type as specified in the reference tables below.
475 Parameter 3: Duration - The duration until the summoned creature should be unsummoned AFTER Combat ends. The value in this field is in milliseconds or 0.
477 The NPC will Summon another creature at the same spot as itself that will attack the specified target.
478 NOTE: Almost all Creature Summons have proper Summon Spells that should be used when possible. This Action is a powerful last resort option only to be used if nothing else works.
479 NOTE: Using Target Type 0 will cause the Summoned creature to not attack anyone.
480 NOTE: If Duration is set at 0, then the summoned creature will not despawn until it has died.
481 This is used as a manual way to force an NPC to Summon.
482 --------------------------------
483 13 = ACTION_T_THREAT_SINGLE_PCT:
484 --------------------------------
485 Parameter 1: Threat% - Threat percent that should be modified. The value in this field can range from -100 to +100. If it is negative, threat will be taken away and if positive, threat will be added.
486 Parameter 2: Target - The Target Type defining on whom the threat change should occur. The value in this field needs to be a valid target type as specified in the reference tables below.
488 This action will modify the threat of a target in the creature's threat list by the specified percent.
489 This is commonly used to allow an NPC to adjust the Threat to a single player.
491 -----------------------------
492 14 = ACTION_T_THREAT_ALL_PCT:
493 -----------------------------
494 Parameter 1: Threat% - The percent that should be used in modifying everyone's threat in the creature's threat list. The value here can range from -100 to +100.
496 This action will modify the threat for everyone in the creature's threat list by the specified percent.
497 NOTE: Using -100 will cause the creature to reset everyone's threat to 0 so that everyone has the same amount of threat. It will NOT remove anyone from the threat list.
498 This is commonly used to allow an NPC to drop threat for all players to zero.
500 --------------------------
501 15 = ACTION_T_QUEST_EVENT:
502 --------------------------
503 Parameter 1: QuestID - The Quest Template ID. The value here must be a valid quest template ID. Furthermore, the quest should have SpecialFlags | 2 as it would need to be completed by an external event which is the activation of this action.
504 Parameter 2: Target - The Target Type defining whom the quest should be completed for. The value in this field needs to be a valid target type as specified in the reference tables below.
506 This action will satisfy the external completion requirement for the quest for the specified target defined by the target type.
507 NOTE: This action can only be used with player targets so it must be ensured that the target type will point to a player.
508 This is commonly used for Quests where only ONE player will gain credit for the quest.
510 -----------------------------
511 16 = ACTION_T_CASTCREATUREGO:
512 -----------------------------
513 Parameter 1: CreatureID - The Creature Template ID to be Summoned. The value here needs to be a valid Creature Template ID.
514 Parameter 2: SpellId - The Spell ID to use to simulate the cast. The value used in this field needs to be a valid Spell ID.
515 Parameter 3: Target - The Target Type defining whom the quest credit should be given to. The value in this field needs to be a valid target type as specified in the reference tables below.
517 This action will call CastedCreatureOrGO() function for the player. It can be used to give quest credit for casting a spell on the creature.
518 This is commonly used for NPC's who have a special requirement to have a Spell cast on them to complete a quest.
520 -----------------------------
521 17 = ACTION_T_SET_UNIT_FIELD:
522 -----------------------------
523 Parameter 1: Field_Number - The index of the Field Number to be changed. Use (http://wiki.udbforums.org/index.php/Character_data) for a list of indeces and what they control. Creatures only contain the OBJECT_FIELD_* and UNIT_FIELD_* fields. They do not contain the PLAYER_FIELD_* fields.
524 Parameter 2: Value - The new value to be put in the field.
525 Parameter 3: Target - The Target Type defining for whom the unit field should be changed. The value in this field needs to be a valid target type as specified in the reference tables below.
527 When activated, this action can change the target's unit field values. More information on the field value indeces can be found at (http://wiki.udbforums.org/index.php/Character_data)
529 ----------------------------
530 18 = ACTION_T_SET_UNIT_FLAG:
531 ----------------------------
532 Parameter 1: Flags - The flag(s) to be set. Multiple flags can be set by using bitwise-OR on them (adding them together).
533 Parameter 2: Target - The Target Type defining for whom the flags should be changed. The value in this field needs to be a valid Target Type as specified in the reference tables below.
535 When activated, this action changes the target's flags by adding (turning on) more flags. For example, this action can make the creature unattackable/unselectable if the right flags are used.
537 -------------------------------
538 19 = ACTION_T_REMOVE_UNIT_FLAG:
539 -------------------------------
540 Parameter 1: Flags - The flag(s) to be removed. Multiple flags can be set by using bitwise-OR on them (adding them together).
541 Parameter 2: Target - The target type defining for whom the flags should be changed. The value in this field needs to be a valid Target Type as specified in the reference tables below.
543 When activated, this action changes the target's flags by removing (turning off) flags. For example, this action can make the creature normal after it was unattackable/unselectable if the right flags are used.
545 --------------------------
546 20 = ACTION_T_AUTO_ATTACK:
547 --------------------------
548 Parameter 1: AllowAutoAttack - If zero, then the creature will stop its melee attacks. If non-zero, then the creature will either continue its melee attacks (the action would then have no effect) or it will start its melee attacks on the target with the top threat if its melee attacks were previously stopped.
550 This action controls whether or not the creature should stop or start the auto melee attack.
551 NOTE: The ACID Dev Team has conformed to using either 0 or 1 for the Param values (0 = Stop Melee, 1 = Start Melee).
552 This is commonly used in combination with EVENT_T_RANGE and ACTION_T_COMBAT_MOVEMENT for Ranged Combat for Mages and Spell Casters.
554 ------------------------------
555 21 = ACTION_T_COMBAT_MOVEMENT:
556 ------------------------------
557 Parameter 1: If zero, then the creature will stop moving towards its victim (if its victim gets out of melee range) and will be stationary. If non-zero, then the creature will either continue to follow its victim (the action would have no effect) or it will start to follow the target with the top threat if its movement was disabled before.
558 Parameter 2: If non-zero, then stop melee combat state (if param1=0) or start melee combat state (if param1!=0) and creature in combat with selected target.
560 This action controls whether or not the creature will always move towards its target.
561 NOTE: The ACID Dev Team has conformed to using either 0 or 1 for the Param values. (0 = Stop Movement, 1 = Start Movement)
562 This is commonly used with EVENT_T_RANGE and ACTION_T_AUTO_ATTACK for NPC's who engage in Ranged Comabt (Either Spells or Ranged Attacks)
563 Parameter 2 specialy used for ranged combat proper client side visual show ranged weapon in proper state.
565 ------------------------
566 22 = ACTION_T_SET_PHASE:
567 ------------------------
568 Parameter 1: The new phase to set the creature in. This number must be an integer between 0 and 31. Numbers outside of that range will result in an error.
570 When activated, this action sets the creature's event to the specified value.
571 NOTE: The creature's current Phase is NOT reset at creature evade. You must manually set the phase back to 0 at EVENT_T_RESET.
572 NOTE: The value used for the Param is the actual Phase Number (Not The Event_Inverse_Phase_Mask)
573 This is commonly used for complex scripts with several phases and you need to switch to a different phase.
575 ------------------------
576 23 = ACTION_T_INC_PHASE:
577 ------------------------
578 Parameter 1: Value - The number of phases to increase or decrease. Use negative values to decrease the current phase.
580 When activated, this action will increase (or decrease) the current creature's phase.
581 NOTE: After increasing or decreasing the phase by this action, the current phase must NOT be lower than 0 or exceed 31.
582 This can be used instead of ACTION_T_SET_PHASE to change phases in scripts. Just a user friendly option for changing phases.
584 --------------------
585 24 = ACTION_T_EVADE:
586 --------------------
587 When activated, the creature will immediately exit out of combat, clear its threat list, and move back to its spawn point. Basically, this action will reset the whole encounter.
588 NOTE: All Param Values Are 0 for this Action.
590 -------------------
591 25 = ACTION_T_FLEE:
592 -------------------
593 When activated, the creature will try to flee from combat. Currently this is done by it casting a fear-like spell on itself called "Run Away".
594 A Better Flee system is in Development.
595 NOTE: All Param Values Are 0 for this Action.
597 ------------------------------
598 26 = ACTION_T_QUEST_EVENT_ALL:
599 ------------------------------
600 Parameter 1: QuestId - The quest ID to finish for everyone.
602 This action does the same thing as the ACTION_T_QUEST_EVENT does but it does it for all players in the creature's threat list.
603 NOTE: If a player is not in the NPC's threat list for whatever reason, he/she won't get the quest completed.
605 ---------------------------------
606 27 = ACTION_T_CASTCREATUREGO_ALL:
607 ---------------------------------
608 Parameter 1: QuestId - The quest template ID.
609 Parameter 2: SpellId - The spell ID used to simulate the cast.
611 This action does the same thing as the ACTION_T_CASTCREATUREGO does but it does it for all players in the creature's threat list.
612 NOTE: If a player is not in its threat list for whatever reason, he/she won't receive the cast emulation.
614 -----------------------------------
615 28 = ACTION_T_REMOVEAURASFROMSPELL:
616 -----------------------------------
617 Parameter 1: Target - The target type defining for whom the unit field should be changed. The value in this field needs to be a valid target type as specified in the reference tables below.
618 Parameter 2: SpellId - The spell ID whose auras will be removed.
620 This action will remove all auras from a specific spell from the target.
621 This is commonly used for NPC's who have an OOC Aura that is removed at combat start or a similar idea (Like Stealth or Shape Shift)
623 ------------------------------
624 29 = ACTION_T_RANGED_MOVEMENT:
625 ------------------------------
626 Parameter 1: Distance - The distance the mob should keep between it and its target.
627 Parameter 2: Angle - The angle the mob should use.
629 This action changes the movement type generator to ranged type using the specified values for angle and distance.
630 NOTE: Specifying zero angle and distance will make it just melee instead.
631 This is commonly used for NPC's who always attack at range and you can specify the distance they will maintain from the target.
633 ---------------------------
634 30 = ACTION_T_RANDOM_PHASE:
635 ---------------------------
636 Parameter 1: PhaseId1 - A possible random phase choice.
637 Parameter 2: PhaseId2 - A possible random phase choice.
638 Parameter 3: PhaseId3 - A possible random phase choice.
640 Randomly sets the phase to one from the three parameter choices.
641 NOTE: Use -1 to specify that if this param is picked to do nothing. Random is constant between actions within an event. So if you have a random Yell and a random Sound they will match up (ex: param2 with param2)
642 NOTE 2: PLEASE NOTE THAT EACH OF THE PARAM VALUES ARE ACTUAL PHASE NUMBERS NOT THE INVERSE PHASE MASK VALUE.
643 This is commonly used for Spellcasting NPC's who on Aggro may select at random a school of spells to use for the fight. Use this if you have up to 3 phases used, otherwise use Action 31 for more then 3 phases.
645 ---------------------------------
646 31 = ACTION_T_RANDOM_PHASE_RANGE:
647 ---------------------------------
648 Parameter 1: PhaseMin - The minimum of the phase range.
649 Parameter 2: PhaseMax - The maximum of the phase range. The number here must be greater than PhaseMin.
651 Randomly sets the phase between a range of phases controlled by the parameters. Sets the phase to a random id (Phase = PhaseMin + rnd % PhaseMin-PhaseMax).
652 NOTE: PhaseMax must be greater than PhaseMin.
653 NOTE 2: PLEASE NOTE THAT EACH OF THE PARAM VALUES ARE ACTUAL PHASE NUMBERS NOT THE INVERSE PHASE MASK VALUE.
654 This is commonly used for Spellcasting NPC's who on Aggro may select at random a school of spells to use for the fight. Use this if you have MORE then 3 phases used, otherwise use Action 30.
656 ---------------------
657 32 = ACTION_T_SUMMON:
658 ---------------------
659 Parameter 1: CreatureID - The creature template ID to be summoned. The value here needs to be a valid creature template ID.
660 Parameter 2: Target - The target type defining who the summoned creature will attack. The value in this field needs to be a valid target type as specified in the reference tables below. NOTE: Using target type 0 will cause the summoned creature to not attack anyone.
661 Parameter 3: SummonID - The summon ID from the creature_ai_summons table controlling the position (and spawntime) where the summoned mob should be spawned at.
663 Summons creature (param1) to attack target (param2) at location specified by creature_ai_summons (param3).
664 NOTE: Param3 Value is the ID Value used for the entry used in creature_ai_summons for this action. You MUST have an creature_ai_summons entry to use this action.
665 This is commonly used for NPC's who need to Summon a creature at a specific location. (Normally used for complex events)
667 -----------------------------
668 33 = ACTION_T_KILLED_MONSTER:
669 -----------------------------
670 Parameter 1: CreatureID - The creature template ID. The value here must be a valid creature template ID.
671 Parameter 2: Target - The target type defining whom the quest kill count should be given to. The value in this field needs to be a valid target type as specified in the reference tables below.
673 When activated, this action will call KilledMonster() function for the player. It can be used to give creature credit for killing a creature. In general if the quest is set to be accompished on different creatures (e.g. "Credit" templates).
674 NOTE: It can be ANY creature including certain quest specific triggers
675 This is commonly used for giving the player Quest Credits for NPC kills (Many NPC's may use the same CreatureID for the Kill Credit)
677 ----------------------------
678 34 = ACTION_T_SET_INST_DATA:
679 ----------------------------
680 Parameter 1: Field - The field to change in the instance script. Again, this field needs to be a valid field that has been already defined in the instance's script.
681 Parameter 2: Data - The value to put at that field index.
683 Sets data for the instance. Note that this will only work when the creature is inside an instantiable zone that has a valid script (ScriptedInstance) assigned.
684 This is commonly used to link an EventAI script with a existing Script Library C++ Script. You make make things happen like opening doors on specific events that happen.
686 ------------------------------
687 35 = ACTION_T_SET_INST_DATA64:
688 ------------------------------
689 Parameter 1: Field - The field to change in the instance script. Again, this field needs to be a valid field that has been already defined in the instance's script.
690 Parameter 2: Target - The target type to use to get the GUID that will be stored at the field index. The value in this field needs to be a valid target type as specified in the reference tables below.
692 Sets GUID (64 bits) data for the instance based on the target. Note that this will only work when the creature is inside an instantiable zone that has a valid script (ScriptedInstance) assigned.
693 Calls ScriptedInstance::SetData64 with field (param1) and data (param2) target's GUID.
695 ------------------------------
696 36 = ACTION_T_UPDATE_TEMPLATE:
697 ------------------------------
698 Parameter 1: TemplateId - The creature template ID. The value here must be a valid creature template ID.
699 Parameter 2: Team - Use model_id from team : Alliance(0) or Horde (1).
701 This function temporarily changes creature entry to new entry, display is changed, loot is changed, but AI is not changed. At respawn creature will be reverted to original entry.
702 Changes the creature to a new creature template of (param1) with team = Alliance if (param2) = false or Horde if (param2) = true
704 ------------------
705 37 = ACTION_T_DIE:
706 ------------------
707 Kills the creature
708 This is commonly used if you need to Instakill the creature for one reason or another.
710 --------------------------------
711 38 = ACTION_T_ZONE_COMBAT_PULSE:
712 --------------------------------
713 Places all players within the instance into combat with the creature. Only works in combat and only works inside of instances.
715 ----------------------------
716 39 = ACTION_T_CALL_FOR_HELP:
717 ----------------------------
718 Parameter 1: Radius - All friendly (not only same faction) creatures will go to help
720 Call any friendly creatures (if its not in combat/etc) in radius attack creature target.
721 Mostly used when call to help more wide that normal aggro radius or auto-used call for assistance, and need apply at some event.
723 -------------------------
724 40   ACTION_T_SET_SHEATH:
725 -------------------------
726 Parameter 1: Sheath state
727 0    SHEATH_STATE_UNARMED               not prepared weapon show (not used mostly by creatures)
728 1    SHEATH_STATE_MELEE                 melee weapon prepared show
729 2    SHEATH_STATE_RANGED                ranged weapon prepared show
731 Let set sheath state for creature.
732 Note: SHEATH_STATE_RANGED case work in combat state only if combat not start as melee commands.
733 This possible setup by set ar event AI start (single used EVENT_T_TIMER_OOC set ACTION_T_COMBAT_MOVEMENT 0 for creature that prefered ranged attack)
735 -------------------------
736 41   ACTION_T_FORCE_DESPAWN
737 -------------------------
738 Despawns the creature (in or out of combat)
739 No parameters
741 -------------------------
742 42   ACTION_T_SET_INVINCIBILITY_HP_LEVEL
743 -------------------------
744 Parameter 1: min. health level for creature that can be set at damage, 0 used as absent min. health value for apply damage.
745 Parameter 2: format of paramater 1 value
746 0    paramater 1 used as flat value
747 1    paramater 1 used as percent (0..100) from creature max health
749 =========================================
750 Target Types
751 =========================================
752 Below is the list of current Target types that EventAI can handle.
753 Target types are used by certain actions and may effect actions differently
755 (#   Internal Name                      Discription)
756 0    TARGET_T_SELF                      Self cast
757 1    TARGET_T_HOSTILE                   Our current target (ie: highest aggro)
758 2    TARGET_T_HOSTILE_SECOND_AGGRO      Second highest aggro (generaly used for cleaves and some special attacks)
759 3    TARGET_T_HOSTILE_LAST_AGGRO        Dead last on aggro (no idea what this could be used for)
760 4    TARGET_T_HOSTILE_RANDOM            Just any random target on our threat list
761 5    TARGET_T_HOSTILE_RANDOM_NOT_TOP    Any random target except top threat
762 6    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)
764 =========================================
765 Cast Flags
766 =========================================
767 Below is the list of current Cast Flags that EventAI's spell casting can handle.
768 Cast flags are handled bitwise. Bit 0 is Interrupt Previous, bit 1 is triggered, etc.
769 So for example the number "3" (11 in Binary, selecting first 2 options) would mean that this cast has both CAST_INTURRUPT_PREVIOUS and CAST_TRIGGERED.
770 Another example: the number "5" (101 in Binary, selecting first and third options) would mean that this cast has CAST_INTURRUPT_PREVIOUS and CAST_FORCE_CAST.
772 (bit#   Decimal     Internal Name                  Discription)
773 0       1           CAST_INTURRUPT_PREVIOUS        Interrupts any previous spell casting (basicaly makes sure that this spell goes off)
774 1       2           CAST_TRIGGERED                 Forces the spell to be instant cast and require no mana/reagents.
775 2       4           CAST_FORCE_CAST                Forces spell to cast even if the target is possibly out of range or the creature is possibly out of mana
776 3       8           CAST_NO_MELEE_IF_OOM           Prevents creature from entering melee if out of mana or out of range
777 4       16          CAST_FORCE_TARGET_SELF         Forces the target to cast this spell on itself
778 5       32          CAST_AURA_NOT_PRESENT          Only casts the spell on the target if the target does not have the aura from that spell on itself already.
780 NOTE: You can add the numbers in the decimal column to combine flags.
781  For example if you wanted to use CAST_NO_MELEE_IF_OOM(8) and CAST_TRIGGERED(2) you would simply use 10 in the cast flags field (8 + 2 = 10).
783 =========================================
784 Event Flags
785 =========================================
786 Below is the list of current Event Flags that EventAI can handle. Event flags are handled bitwise.
788 (bit#   Decimal   Internal Name                  Discription)
789 0       1         EFLAG_REPEATABLE               Event repeats (Does not repeat if this flag is not set)
790 1       2         EFLAG_NORMAL                   Event occurs in Normal instance difficulty (will not occur in Normal if not set)
791 2       4         EFLAG_HEROIC                   Event occurs in Heroic instance difficulty (will not occur in Heroic if not set)
792 3       8
793 4       16
794 5       32
795 6       64
796 7       128        EFLAG_DEBUG_ONLY              Prevents events from occuring on Release builds. Useful for testing new features.
798 NOTE: You can add the numbers in the decimal column to combine flags.
801 =========================================
802 Basic Structure of creature_ai_texts
803 =========================================
804 Below is a the list of current fields within the texts tables.
806 Field_Name            Description
807 -----------------------------------------------------------
808 entry                 This value is mearly an NEGATIVE identifier of the current text number. Required for sql queries. Valid range are -1 to -999999
809 content_default       This is the actual text presented in the default language (English).
811 content_loc1          This is the actual text presented in the Localization #1 Clients (Korean)
812 content_loc2          This is the actual text presented in the Localization #2 Clients (French)
813 content_loc3          This is the actual text presented in the Localization #3 Clients (German)
814 content_loc4          This is the actual text presented in the Localization #4 Clients (Chinese)
815 content_loc5          This is the actual text presented in the Localization #5 Clients (Taiwanese)
816 content_loc6          This is the actual text presented in the Localization #6 Clients (Spanish)
817 content_loc7          This is the actual text presented in the Localization #7 Clients (Spanish Mexico)
818 content_loc8          This is the actual text presented in the Localization #8 Clients (Russian)
820 sound                 This value is the Sound ID that corresponds to the actual text used.
821 type                  Variables used to define type of text (Say/Yell/Textemote/Whisper).
822 language              This value is the Language that the text is native in.
823 emote                 Value from enum Emote. Only source of text will play this emote (not target, if target are defined in DoScriptText)
824 comment               This is a comment regarding the text entry
826 Note: Fields `content_loc1` to `content_loc8` are NULL values by default and are normally handled by seperate localization projects.
828 =========================================
829 Text Types (type)
830 =========================================
831 Below is the list of current Text types that texts tables can handle. These were previously seperate Actions in ACID.
833 #    Internal Name                 Description
834 -----------------------------------------------------------
835 0    CHAT_TYPE_SAY                 This type sets the text to be displayed as a Say (Speech Bubble).
836 1    CHAT_TYPE_YELL                This type sets the text to be displayed as a Yell (Red Speech Bubble) and usually has a matching Sound ID.
837 2    CHAT_TYPE_TEXT_EMOTE          This type sets the text to be displayed as a text emote in orange in the chat log.
838 3    CHAT_TYPE_BOSS_EMOTE          This type sets the text to be displayed as a text emote in orange in the chat log (Used only for specific Bosses).
839 4    CHAT_TYPE_WHISPER             This type sets the text to be displayed as a whisper to the player in the chat log.
840 5    CHAT_TYPE_BOSS_WHISPER        This type sets the text to be displayed as a whisper to the player in the chat log (Used only for specific Bosses).
841 6    CHAT_TYPE_ZONE_YELL           Same as CHAT_TYPE_YELL but will display to all players in current zone.
843 =========================================
844 Language Types (language)
845 =========================================
846 Below is the list of current Language types that are allowed.
847 This is the Race Language that the text is native to (So it will display properly)
849 #    Internal Name                Description
850 -----------------------------------------------------------
851 0    UNIVERSAL                    Text in this language is understood by ALL Races.
852 1    ORCISH                       Text in this language is understood ONLY by Horde Races.
853 2    DARNASSIAN                   Text in this language is understood ONLY by the Night Elf Race.
854 3    TAURAHE                      Text in this language is understood ONLY by the Tauren Race.
855 6    DWARVISH                     Text in this language is understood ONLY by the Dwarf Race.
856 7    COMMON                       Text in this language is understood ONLY by Alliance Races.
857 8    DEMONIC                      Text in this language is understood ONLY by the Demon Race (Not Implimented).
858 9    TITAN                        This language was used by Sargeras to speak with other Titians (Not Implemented).
859 10   THALASSIAN                   Text in this language is understood ONLY by the Blood Elf Race.
860 11   DRACONIC                     Text in this language is understood ONLY by the Dragon Race.
861 12   KALIMAG                      Text will display as Kalimag (not readable by players, language of all elementals)
862 13   GNOMISH                      Text in this language is understood ONLY by the Gnome Race.
863 14   TROLL                        Text in this language is understood ONLY by the Troll Race.
864 33   GUTTERSPEAK                  Text in this language is understood ONLY by the Undead Race.
865 35   DRAENEI                      Text in this language is understood ONLY by the Draenai Race.
866 36   ZOMBIE                       (not currently used?)
867 37   GNOMISH BINARY               Binary language used by Alliance when drinking Binary Brew
868 38   GOBLIN BINARY                Binary language used by Horce when drinking Binary Brew