creature_ai_scripts - cmangos/issues GitHub Wiki

Back to world database list of tables.

creature_ai_scripts for EventAI (ACID) scripted NPCs
creature_ai_summons for Summon IDs used in ACTION_T_SUMMON_ID (32)

The Manual-like and most-recent documentation for EventAI can be found in doc/EventAI.txt

ScriptDev2 was integrated into cmangos on 04 sept 2015 and enables us to handle DB-based scripting that allows the use of a database (MySQL only right now) to specify the actions that a creature script will do.

The script is called EventAI and will be referenced like this for the rest of this guide. A basic EventAI script works with and requires only two pieces of information: When it happens and What happens when.

The first piece of information (the When it happens) will be referred to as the event.

The second piece of information (the What happens when) will be referred to as the action.
Currently, a single EventAI script entry can have up to three actions.

Anyone that wants to create entries for the EventAI script needs to answer the two questions above.

Some events will only occur once while others can be timed so that they occur at a specified interval.

Example:

let’s say that a certain creature using EventAI will have a max of four phases. We are then dealing with a 4 bit number in this field. Let’s further say that that certain creature has an event that will only trigger in its phase 2 (a timed spell cast for instance). Then the field should contain all of the phases the event SHOULDN’T be triggered in…then out of the four bits, we leave the third bit alone (off) and turn on all of the other bits so we get 1011 which is equal to 11, so we put in 11 as the inverse phase mask for the event entry. As another example, let’s say that the same creature previously mentioned has another event that is only triggered in the phase 0 and phase 3. This would mean that we need to ignore phase 1 and 2, so our bitmask would be 0110 which is equal to 6 so we put in 6 for this event’s inverse phase mask field. Please note that both examples were tailored for a creature with four and only four phases. If you decide to add more phases later on, you will have to redefine all of the nonzero bitmasks for all of the mob’s events.

EventAI can also support phases. A phase is just a way to group certain events + actions together so that the creature will perform certain actions based on what event it is currently on. The way the phase system works in EventAI is that for every event added, it needs to be specified under which phases the event SHOULD NOT occur. This is a bit confusing at first, so let’s look at it more closely. A creature can have more than one phase, up to a max of 32 different phases (with the first one being phase 0, and last one being phase 31). How the phase selection field works is that it contains a 32bit number. Each bit in the number represents a possible phase, with the bit in the least significant position signifying phase 0 and the most significant bit signifying phase 31. The default value of zero in this field has no bits set and since the field controls when the event should NOT trigger, it would then mean that the event will always be triggered independent of the current phase the creature is in. Therefore, if you want to specify what phases the event should occur in, you need to add up all of the corresponding bits for all the other phases where the event shouldn’t trigger in (confusing…yes).

All of the events, EventFlags, actions and possible targets are summarized and described below.

• NU = Not Used*
• IC = In Combat Only*
• OOC = Out Of Combat Only*
• US = Unsupported

Now that all of the supported events have been listed and described, we shall now move on to the actions that can be performed.

Each event can take up to three actions. The actions will all be performed when the event is triggered and they will be performed in the order that they have been defined. This means that, for a certain event, action 1 will be performed first, followed by action 2, then lastly by action 3.

Just like event definitions, each action can use up to three different parameters but not all actions will use all three parameters. If a parameter isn’t mentioned for an action, then that action does not need that parameter.

b2_0_sheath

bytes1

Working with phases requires a certain amount of math. You will have to know a few things before we begin.

You should have an idea of how many phases the NPC will have.
You will have to know Binary Addition. Don’t worry, I’ll show you how to do it.

0110 = 06 (base 10)  
0111 = 07 (base 10)  
____ = __
1101 = 13 (base 10)

('327301','3273','11','0','100','0','0','0','0','0','0','0','57','2','35','0','0','0','0','0','0','0','0','0','Kolkar Stormer - Enable Range Mode on Spawn'),

('327305','3273','0','0','100','1281','0','0','3000','4000','0','0','11','9532','1','256','0','0','0','0','0','0','0','0','Kolkar Stormer - Cast Lightning Bolt (Range Mode)'),
('327306','3273','0','0','100','1537','0','0','5000','20000','0','0','11','9532','1','256','0','0','0','0','0','0','0','0','Kolkar Stormer - Cast Lightning Bolt (Melee Mode)'),

The ranged mode was designed to be toggled on spawn, but can effectively by toggled on phase change or on other condition when needed. It automatically reverts itself on evade. It works in connection with its modes, and automatically changes chase distance. A main casting spell, which is supposed to be lowest in priority (highest ID), needs to use 256 cast flag. This notes that when this spell returns OOM error, ranged mode automatically adjusts its behavior to melee mode. Ranged mode also responds to kicks and silence on this spell, forcing the mob into temporary melee mode. Last notable feature with ranged mode is distancing, which occurs if current victim is rooted by an aura and the npc is in melee mode. When creature is in melee mode, and the target is rooted, the creature runs away from main aggro targets melee reach.