Namespaces

Variants
Actions

COMBAT_LOG_EVENT

From Wowpedia
(Redirected from API COMBAT LOG EVENT)
Jump to: navigation, search
COMBAT_LOG_EVENT_UNFILTERED redirects to this page, but most add-on developers will want to use it in preference to COMBAT_LOG_EVENT, because the events provided by the latter will only reflect the user's actual combat log.
Note: COMBAT_LOG_EVENT and COMBAT_LOG_EVENT_UNFILTERED have identical parameters. All information provided here applies to both events.

Base Parameters

1st Param 2nd Param 3rd Param 4th Param 5th Param 6th Param 7th Param 8th Param 9th Param 10th Param 11th Param
timestamp event hideCaster sourceGUID sourceName sourceFlags sourceRaidFlags destGUID destName destFlags destRaidFlags

The timestamp parameter has almost the same format as the return value of the time() function. You can use it as the second parameter to date(). The only difference is that time() returns an integer (the unit is seconds), while the timestamp parameter has three decimal places (milliseconds). That means (timestamp-floor(timestamp))*1000 is the number of milliseconds of the timestamp.

More information on GUIDs (including format, how to tell a player from an NPC, pets, mob IDs, and more) can be found on the API UnitGUID page.

More information on raid flags can be found on the Raid Flag page.

Cataclysm Patch 4.1.0 (2011-04-26): The 4.1 patch added a new parameter, hideCaster

This flag moved all other parameters beginning with sourceGUID one place to the right. Addons that haven't been updated for 4.1 may not function correctly as a result. Further, 4.1 removed Pet Happiness from the PowerType list.

Cataclysm Patch 4.2.0 (2011-06-28): The 4.2 patch added two new parameters, sourceRaidFlags and destRaidFlags

These two parameters were added at the end of the source and destination "subsections" moving all destination parameters one place to the right, and all other parameters two places to the right. Addons that haven't been updated for 4.2 may not function correctly as a result.

Events

How to get full event strings: Read prefix to suffix in order and use the parameter table as specified. Unused entries are nil. A Blank cell means that there are no additional arguments for this pre- or suffix.

Prefixes

The Parameters listed with prefixes are numbered in the order they come after the base 9 parameters.

Prefix 1st Parameter (12th) 2nd Parameter (13th) 3rd Parameter (14th)
SWING
RANGE spellId spellName spellSchool
SPELL spellId spellName spellSchool
SPELL_PERIODIC spellId spellName spellSchool
SPELL_BUILDING spellId spellName spellSchool
ENVIRONMENTAL environmentalType

Suffixes

The Parameters listed with suffixes are numbered in the order they come after the prefix parameters. Note that for the SWING prefix, _DAMAGE starts at the 12th parameter. For ENVIRONMENTAL, it starts at the 13th.

Suffix 1st Param (15th) 2nd Param (16th) 3rd Param (17th) 4th Param (18th) 5th Param (19th) 6th Param (20th) 7th Param (21st) 8th Param (22nd) 9th Param (23rd)
_DAMAGE amount overkill school resisted blocked absorbed critical (1 or nil) glancing (1 or nil) crushing (1 or nil)
_MISSED missType isOffHand amountMissed
_HEAL amount overhealing absorbed critical
_ENERGIZE amount powerType
_DRAIN amount powerType extraAmount
_LEECH amount powerType extraAmount
_INTERRUPT extraSpellId extraSpellName extraSchool
_DISPEL extraSpellId extraSpellName extraSchool auraType
_DISPEL_FAILED extraSpellId extraSpellName extraSchool
_STOLEN extraSpellId extraSpellName extraSchool auraType
_EXTRA_ATTACKS amount
_AURA_APPLIED auraType amount
_AURA_REMOVED auraType amount
_AURA_APPLIED_DOSE auraType amount
_AURA_REMOVED_DOSE auraType amount
_AURA_REFRESH auraType amount
_AURA_BROKEN auraType
_AURA_BROKEN_SPELL extraSpellId extraSpellName extraSchool auraType
_CAST_START
_CAST_SUCCESS
_CAST_FAILED failedType
_INSTAKILL
_DURABILITY_DAMAGE
_DURABILITY_DAMAGE_ALL
_CREATE
_SUMMON
_RESURRECT

Special Events

Event Prefix to use Suffix to use
DAMAGE_SHIELD SPELL _DAMAGE
DAMAGE_SPLIT SPELL _DAMAGE
DAMAGE_SHIELD_MISSED SPELL _MISSED
Event 1st Param (12th) 2nd Param (13th) 3rd Param (14th)
ENCHANT_APPLIED † spellName itemID itemName
ENCHANT_REMOVED † spellName itemID itemName
PARTY_KILL
UNIT_DIED
UNIT_DESTROYED

† These events are pretty much useless. They are triggered when a weapon's enchant changes, but before the API information is updated to reflect the change. It is possible for main-hand and off-hand wielded weapons to have the same itemID. So we might not even know for sure which weapon the enchant changed on. When an enchant is reapplied the original is removed first, triggering an ENCHANT_REMOVED event before a ENCHANT_APPLIED event is triggered.

A much better way of tracking temporary weapon enchants is to use the UNIT_INVENTORY_CHANGED event (a true event, not part of a COMBAT_LOG_EVENT_UNFILTERED) which is triggered every time an enchant changes. What's more, the information on the temporary enchants available through the API has been updated at the point this event is triggered. Sometimes the event is triggered twice however.

Parameter Values

Spell School

spellSchool
(binary / bitmask)
spellSchool
(hex)
spellSchool
(decimal)
Type Color Codes / School Combination
00000001
0x1 1 Physical #FFFF00 - (255, 255, 0) - (1.00, 1.00, 0.00)
00000010
0x2 2 Holy #FFE680 - (255, 230, 128) - (1.00, 0.90, 0.50)
00000100
0x4 4 Fire #FF8000 - (255, 128, 0) - (1.00, 0.50, 0.00)
00001000
0x8 8 Nature #4DFF4D - (77, 255, 77) - (0.30, 1.00, 0.30)
00010000
0x10 16 Frost #80FFFF - (128, 255, 255) - (0.50, 1.00, 1.00)
00100000
0x20 32 Shadow #8080FF - (128, 128, 255) - (0.50, 0.50, 1.00)
01000000
0x40 64 Arcane #FF80FF - (255, 128, 255) - (1.00, 0.50, 1.00)
Double schools
00000011
0x3 3 Holystrike Holy + Physical
00000101
0x5 5 Flamestrike Fire + Physical
00000110
0x6 6 Holyfire Fire + Holy
00001001
0x9 9 Stormstrike Nature + Physical
00001010
0xA 10 Holystorm Nature + Holy
00001100
0xC 12 Firestorm Nature + Fire
00010001
0x11 17 Froststrike Frost + Physical
00010010
0x12 18 Holyfrost Frost + Holy
00010100
0x14 20 Frostfire Frost + Fire
00011000
0x18 24 Froststorm Frost + Nature
00100001
0x21 33 Shadowstrike Shadow + Physical
00100010
0x22 34 Shadowlight (Twilight) Shadow + Holy
00100100
0x24 36 Shadowflame Shadow + Fire
00101000
0x28 40 Shadowstorm (Plague) Shadow + Nature
00110000
0x30 48 Shadowfrost Shadow + Frost
01000001
0x41 65 Spellstrike Arcane + Physical
01000010
0x42 66 Divine Arcane + Holy
01000100
0x44 68 Spellfire Arcane + Fire
01001000
0x48 72 Spellstorm Arcane + Nature
01010000
0x50 80 Spellfrost Arcane + Frost
01100000
0x60 96 Spellshadow Arcane + Shadow
Triple and multi schools
00011100
0x1C 28 Elemental Frost + Nature + Fire
01111100
0x7C 124 Chromatic Arcane + Shadow + Frost + Nature + Fire
01111110
0x7E 126 Magic Arcane + Shadow + Frost + Nature + Fire + Holy
01111111
0x7F 127 Chaos Arcane + Shadow + Frost + Nature + Fire + Holy + Physical

Power Type

powerType Type
-2 health
0 mana
1 rage
2 focus
3 energy
4 pet happiness (removed in 4.1)
5 runes
6 runic power

Miss type

  • "ABSORB"
  • "BLOCK"
  • "DEFLECT"
  • "DODGE"
  • "EVADE"
  • "IMMUNE"
  • "MISS"
  • "PARRY"
  • "REFLECT"
  • "RESIST"

Aura Type

  • "BUFF"
  • "DEBUFF"

Environmental Type

  • "DROWNING"
  • "FALLING"
  • "FATIGUE"
  • "FIRE"
  • "LAVA"
  • "SLIME"
  • More possible but currently unconfirmed

MoP Patch 5.0.4 (2012-08-28): Currently in the Mists of Pandaria Beta, this value is now reporting non-localized proper case strings (e.g. "Falling") instead of non-localized capitalized strings (e.g. "FALLING"). Addons that haven't been updated may not function correctly as a result.

Failed Type

  • "A more powerful spell is already active"
  • "Another action is in progress"
  • "Can only use outside"
  • "Can only use while swimming"
  • "Can't do that while asleep"
  • "Can't do that while charmed"
  • "Can't do that while confused"
  • "Can't do that while fleeing"
  • "Can't do that while horrified"
  • "Can't do that while incapacitated"
  • "Can't do that while moving"
  • "Can't do that while silenced"
  • "Can't do that while stunned"
  • "Interrupted"
  • "Invalid target"
  • "Item is not ready yet"
  • "Must be in Bear Form, Dire Bear Form"
  • "Must have a Ranged Weapon equipped"
  • "No path available"
  • "No target"
  • "Not enough energy"
  • "Not enough mana"
  • "Not enough rage"
  • "Not yet recovered"
  • "Nothing to dispel"
  • "Out of range"
  • "Target is friendly"
  • "Target is hostile"
  • "Target needs to be in front of you."
  • "Target not in line of sight"
  • "Target too close"
  • "You are dead"
  • "You are in combat"
  • "You are in shapeshift form"
  • "You are unable to move"
  • "You can't do that yet"
  • "You must be behind your target."
  • "Your target is dead"
  • More possible but currently unconfirmed

Examples

Introduction

I wanted to post some info about what I have learned about using this event. I think the description of how the work arguments is confusing. Hopefully this provides some clarity.

There are always at least 11 arguments. (arg1 through arg11) Depending on the Prefix there will be 0, 1, or 3 more arguments. These will be numbered starting with 12 and going up to 14 if necessary. Depending on the Suffix there will be 0-8 more arguments. These will be numbered starting from the last Prefix argument (IE 12, 13, or 15).

Sample Arguments Example

Example: The following 2 examples show the parameters used for a SPELL_MISS event and a SWING_DAMAGE events

Event Type Arg1 Arg2 Arg3 Arg4 Arg5 Arg6 Arg7 Arg8 Arg9 Arg10 Arg11 Arg12 Arg13 Arg14 Arg15 Arg16 Arg17 Arg18 Arg19 Arg20
SPELL_MISS timestamp event hideCaster sourceGUID sourceName sourceFlags sourceRaidFlags destGUID destName destFlags destRaidFlags spellId spellName spellSchool missType isOffHand amountMissed
SWING_DAMAGE timestamp event hideCaster sourceGUID sourceName sourceFlags sourceRaidFlags destGUID destName destFlags destRaidFlags amount overkill school resisted blocked absorbed critical glancing crushing

Simple Function Example

Example the following function would display a message whenever a Mind Blast crits.

Foo.lua

local frame = CreateFrame("FRAME");
frame:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED");
frame:SetScript("OnEvent", function(self, event, ...)

  local timestamp, type, hideCaster,
    sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags = ...

  --[[
    * Note, for this example, you could just use 'local type = select(2, ...)'.  The others are included
      so that it's clear what's available.
    * You can also lump all of the arguments into one block (or one really long line):

    local timestamp, type, hideCaster,                                                                      -- arg1  to arg3
      sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags,   -- arg4  to arg11
      spellId, spellName, spellSchool,                                                                      -- arg12 to arg14
      amount, overkill, school, resisted, blocked, absorbed, critical, glancing, crushing = ...             -- arg15 to arg23
  ]]

  if (event == "COMBAT_LOG_EVENT_UNFILTERED") then
    if (type == "SPELL_DAMAGE") then

      local spellId, spellName, spellSchool, amount,
        overkill, school, resisted, blocked, absorbed, critical, glancing, crushing = select(12, ...)

      if (spellName == "Mind Blast" and critical == 1) then -- "== 1" for clarity only.  Not needed.
        print("Mind Blast Just Critted!")
      end
    end
  end
end);

Event Descriptions

Summary Of what I have learned about when events fire and when they don't: (Preliminary)

Prefixes

Event Prefix Description
SPELL_ Spell is the prefix for most effects even if the spell is a DoT or channeled. IE when the spell begins to be cast, SPELL_CAST_START is fired and not SPELL_PERIODIC_CAST_START. This is the same with _MISS, _FAILED, etc.
SPELL_PERIODIC Spell_PERIODIC Only the effects that are periodic start with this PREFIX. IE: Successfully casting a DoT only happens once therefor even though the spell is periodic use the SPELL_ prefix. However, the damage is periodic so it will start with SPELL_PERIODIC_. 90% of the time you will only care about _DAMAGE or _HEAL.
SPELL_BUILDING SPELL_BUILDING New in WotLK, assumed to be damage that can affect destructable buildings.
ENVIRONMENTAL sourceGUID = "0x0000000000000000", sourceName = nil

Suffixes

Event Prefix Description
_DAMAGE Triggered on damage to health. Nothing Special. (overkill returns a number greater than or equal to zero)
_MISSED Triggered When Effect isn't applied but mana/energy is used IE: ABSORB BLOCK DEFLECT DODGE EVADE IMMUNE MISS PARRY REFLECT RESIST
_HEAL Triggered when a unit is healed
_ENERGIZE Any effect that restores energy/mana. Spell/trinket/item set bonuses can trigger this event. IE: Vampiric Touch, or Mark of Defiance (Trinket)
_DRAIN Same as _ENERGIZE but this time you are losing energy/mana. Caused by enemies.
_LEECH Same as _DRAIN, but the source unit will simultaneously receive the same kind of energy (specified in extraAmount)
_INTERRUPT Spellcasting being interrupted by an ability such as Kick or Pummel.
_DISPEL A buff or debuff being actively dispelled by a spell like Remove Curse or Dispel Magic. The source is the caster of the aura that was dispelled, and the destination is the target which was dispelled (needs verifying).
_DISPEL_FAILED A failed attempt to dispel a buff or debuff, most likely due to immunity.
_STOLEN A buff being transferred from the destination unit to the source unit (i.e. mages' Spellsteal).
_EXTRA_ATTACKS Unit gains extra melee attacks due to an ability (like Sword Sepcialization or Windfury). These attacks usually happen in brief succession 100-200ms following this event.
_AURA_APPLIED Triggered When Buffs/Debuffs are Applied. Note: This event doesn't fire if a debuff is applied twice without being removed. IE: casting Vampiric Embrace twice in a row only triggers this event once. This can make it difficult to track whether a debuff was successfully reapplied to the target. However, for instant cast spells, SPELL_CAST_SUCCESS can be used.
_AURA_REMOVED Triggered When Buffs/Debuffs expire. The souce is the caster of the aura which faded, and the destination is the target from which the aura faded (needs verifying).
_AURA_APPLIED_DOSE Triggered by stacking Debuffs if the debuff is already applied to a target. IE: If you cast Mind Flay twice it causes 2 doses of shadow vunerability, the first time it will trigger, SPELL_AURA_APPLIED (arg10 = shadow vulnerability), and SPELL_AURA_APPLIED_DOSE (arg10 = shadow vunerability) the second. The last argument reflects the new number of doses on the unit.
_AURA_REMOVED_DOSE The opposite of _AURA_APPLIED_DOSE, reducing the amount of doses on a buff/debuff on the unit.
_AURA_REFRESH Resets the expiration timer of a buff/debuff on the unit.
_AURA_BROKEN A buff or debuff is being removed by melee damage. The source is the name of the caster of the aura that was broken, and the destination is the target which the aura broke off of (needs verifying).
_AURA_BROKEN_SPELL A buff or debuff is being removed by spell damage (specified in extraSpell...). Source and destination is the same as the above.
_CAST_START Triggered when a spell begins casting. Instant Cast and channeled spells don't invoke this event. They trigger _CAST_SUCCESS, _FAILED instead.
_CAST_SUCCESS Triggered when channeled spells begin or when instant cast spells are cast. This (obviously) isn't triggered when this spell misses. On a miss SPELL_MISS will be triggered instead. Also, spells that invoke _CAST_START don't trigger this event when they are done casting. Use _SPELL_MISS or _SPELL_DAMAGE or _SPELL_AURA_APPLIED to see when they were cast
_CAST_FAILED If the cast fails before it starts (IE invalid target), then _CAST_START never triggers. However it is possible for a cast to fail after beginning. (IE you jump, move, hit escape etc.)
_INSTAKILL Immediately kills the destination unit (usually happens when warlocks sacrifice their minions).
_DURABILITY_DAMAGE
_DURABILITY_DAMAGE_ALL
_CREATE Creates an object (as opposed to an NPC who are 'summoned') like a hunter's trap or a mage's portal.
_SUMMON Summmons an NPC such as a pet or totem.
_DISSIPATES Fires when Gas Clouds are being extracted with Zapthrottle Mote Extractor

Special Events

Event Description
UNIT_DIED destGUID and destName refer to the unit that died.
PARTY_KILL includes both sourceGUID and destGUID, but only reports for you (not in a party) or your other 4 party members (not raid members)