vanilla-wow-addons – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 --[[
2 ****************************************************************
3 Scrolling Combat Text 5.0
4 Event Config File
5 ****************************************************************
6  
7 PLEASE NOTE:
8 As of 4.1, There is now a new section at the bottom of this file.
9 It contains a list of various chat events used by WoW. Please see
10 the section before it for more details
11  
12 Description:
13 This file is used to setup custom events for use in SCT. Most
14 of the old limitations have been removed, so you can now check
15 for custom events on most chat log messages. You can now also
16 perform captures on the text and display the data in a
17 customized format. for each event you must setup three required
18 settings. for captured events you must setup one required
19 setting. All events can also have one optional setting:
20  
21 name: This is basically the text you want SCT to display
22 whenever the event occurs. for captured data you
23 use *n where n is the index of the captured data in
24 the order of the search. (see examples)
25  
26 search: This is the EXACT text SCT will search for to know
27 when to display the event. You will most likley
28 need to watch your combat chat log in game and see
29 what text is displayed when the buff/talent/proc
30 goes off. You can now use normal LUA expressions
31 to capture data. The order of these expressions is
32 what should be used in determining how to display
33 them in the name field. (see examples)
34  
35 argcount: this is required when you are wanting to use
36 captured data. This tells SCT how many captured
37 fields you want to replace in the name field. Keeping
38 this accurate helps improve SCT performance. If its
39 lower then you need some captured fields will not be
40 displayed, if its higher it just wastes loops
41 looking for data that is not there.
42  
43  
44 r, g, b: These are the color settings used to select the
45 color you want the event to display in. r = red,
46 g = green, b = blue. Some common colors:
47  
48 Red: r=256/256, g=0/256, b=0/256
49 Green: r=0/256, g=256/256, b=0/256
50 Blue: r=0/256, g=0/256, b=256/256
51 Yellow: r=256/256, g=256/256, b=0/256
52 Magenta: r=256/256, g=0/256, b=256/256
53 Cyan: r=0/256, g=256/256, b=256/256
54  
55 iscrit: this will make the event appear as a crit event,
56 so it will be sticky or large font. You only need
57 to set this if you want it used. iscrit=1
58  
59 ismsg: this will make the event appear as a message.
60 You only need to set this if you want it used. ismsg=1
61  
62 class: This allows you to filter events by class. Put only
63 the classes you want to see the even here. They must
64 be in LUA table format.
65  
66 Examples:
67  
68 Warrior only: class={"Warrior"}
69 Warrior and Shaman: class={"Warrior", "Shaman"}
70  
71 anitype: this allows you to specify the type of animation to
72 use for an event.
73  
74 1 - Vertical
75 2 - Rainbow
76 3 - Horizontal
77 4 - Angled Down
78  
79 sound: (advanced users only)
80 plays a sound built into WoW. Please see here for a
81 list of values: http://www.wowwiki.com/API_PlaySound
82  
83 Examples:
84 sound="TellMessage"
85 sound="GnomeExploration"
86  
87 soundwave: (advanced users only)
88 plays a wave file in the path you choose. You can use
89 in game ones if you know the path, or custom ones you
90 put it in an addon folder.
91  
92 Examples:
93 In game: soundwave="Sound\\Spells\\ShaysBell.wav"
94 Custom: soundwave="Interface\\AddOns\\MyAddOn\\mysound.wav"
95  
96 Note:
97 Make sure you increase the key count ([1], [2], etc...) for
98 each new event you add. Feel free to delete any of the already
99 provided events if you know you will never need them or you
100 dont want them to display. You may also place -- in front
101 of any of them to comment them out.
102  
103 Problems:
104 if the event you are wanting to add is not being displayed by
105 SCT make sure you double check the search text. Any space,
106 comma, or period out of place will cause it to fail.
107 ****************************************************************]]
108  
109 local sct_Event_Config = {
110  
111 -- To remove an event, simply add -- in front of the line.
112 -- Example : to remove "Windfury!" do :
113 -- [1] = {name="Windfury!", search="You gain Windfury", r=256/256, g=256/256, b=0/256},
114  
115 [1] = {name="Clearcast!", search="You gain Clearcast", r=256/256, g=256/256, b=0/256},
116 [2] = {name="Flurry!", search="You gain Flurry", r=128/256, g=0/256, b=0/256},
117 [3] = {name="Lightning Shield!", search="You gain Lightning Shield", r=0/256, g=0/256, b=256/256},
118 [4] = {name="Nightfall!", search="You gain Shadow Trance", r=0/256, g=128/256, b=128/256},
119 [5] = {name="Overpower!", search="You attack. (.+) dodges.", r=256/256, g=256/256, b=0/256, iscrit=1, class={"Warrior"}},
120 [6] = {name="Overpower!", search="Your (.+) was dodged", r=256/256, g=256/256, b=0/256, iscrit=1, class={"Warrior"}},
121 [7] = {name="Enraged!", search="You gain Enrage", r=128/256, g=256/256, b=128/256, iscrit=1, class={"Warrior"}},
122 [8] = {name="Crusader!", search="You gain Holy Strength", r=128/256, g=128/256, b=256/256, iscrit=1},
123  
124 --Captured data examples. Remove, change, or comment out the ones you don't want.
125  
126 --Spam Stoppers
127 --[9] = {name="", search="Your Bloodthirst heals you", r=0/256, g=256/256, b=0/256, class={"Warrior"}},
128 --[10] = {name="", search="Your Vampiric Embrace", r=0/256, g=0/256, b=0/256, class={"Priest"}},
129  
130 };
131  
132  
133 --[[
134 ****************************************************************
135 This list of Wow Events are used for searching custom events.
136 They are only events that are not normally used by SCT.
137 By default they are commented out. To enable an event to be
138 searched by SCT, remove the "--" before the event, save, and
139 then reload/relog. if for some reason you do not see the event
140 you need here, you can find a full list of them here:
141 http://www.wowwiki.com/Events_%28API%29
142  
143 To figure out what event a chat message is, set SCT_Event_Debug
144 to true. You will now get a chat message saying what event is
145 being fired for every event.
146 ****************************************************************]]
147  
148 local sct_Event_Debug = false;
149  
150 local sct_Event_List = {
151  
152 --self events
153 --"CHAT_MSG_COMBAT_SELF_MISSES",
154  
155 --pet events
156 --"CHAT_MSG_COMBAT_PET_HITS",
157 --"CHAT_MSG_COMBAT_PET_MISSES",
158 --"CHAT_MSG_SPELL_PET_DAMAGE",
159 --"CHAT_MSG_SPELL_PET_BUFF",
160  
161 --party events
162 --"CHAT_MSG_COMBAT_PARTY_HITS",
163 --"CHAT_MSG_COMBAT_PARTY_MISSES",
164 --"CHAT_MSG_SPELL_PARTY_DAMAGE",
165 --"CHAT_MSG_SPELL_PARTY_BUFF",
166  
167 --realm events
168 --"CHAT_MSG_COMBAT_FRIENDLYPLAYER_HITS",
169 --"CHAT_MSG_COMBAT_FRIENDLYPLAYER_MISSES",
170 --"CHAT_MSG_SPELL_FRIENDLYPLAYER_DAMAGE",
171 --"CHAT_MSG_SPELL_FRIENDLYPLAYER_BUFF",
172  
173 --mob events
174 --"CHAT_MSG_COMBAT_CREATURE_VS_PARTY_HITS",
175 --"CHAT_MSG_COMBAT_CREATURE_VS_PARTY_MISSES",
176 --"CHAT_MSG_COMBAT_CREATURE_VS_CREATURE_HITS",
177 --"CHAT_MSG_COMBAT_CREATURE_VS_CREATURE_MISSES",
178 --"CHAT_MSG_SPELL_CREATURE_VS_PARTY_DAMAGE",
179 --"CHAT_MSG_SPELL_CREATURE_VS_PARTY_BUFF",
180 --"CHAT_MSG_SPELL_CREATURE_VS_CREATURE_DAMAGE",
181 --"CHAT_MSG_SPELL_CREATURE_VS_CREATURE_BUFF",
182  
183 --damage shields
184 --"CHAT_MSG_SPELL_DAMAGESHIELDS_ON_SELF",
185 --"CHAT_MSG_SPELL_DAMAGESHIELDS_ON_OTHERS",
186  
187 --spell auras
188 --"CHAT_MSG_SPELL_AURA_GONE_PARTY",
189 --"CHAT_MSG_SPELL_AURA_GONE_OTHER",
190 --"CHAT_MSG_SPELL_BREAK_AURA",
191  
192 --item enchants
193 --"CHAT_MSG_SPELL_ITEM_ENCHANTMENTS",
194  
195 --periodic effects
196 --"CHAT_MSG_SPELL_PERIODIC_PARTY_DAMAGE",
197 --"CHAT_MSG_SPELL_PERIODIC_FRIENDLYPLAYER_DAMAGE",
198 --"CHAT_MSG_SPELL_PERIODIC_CREATURE_DAMAGE",
199 --"CHAT_MSG_SPELL_PERIODIC_CREATURE_BUFFS",
200  
201 --deaths
202 --"CHAT_MSG_COMBAT_FRIENDLY_DEATH",
203 --"CHAT_MSG_COMBAT_HOSTILE_DEATH",
204  
205 --experience
206 --"CHAT_MSG_COMBAT_XP_GAIN",
207  
208 --trade skills
209 --"CHAT_MSG_SPELL_TRADESKILLS",
210  
211 --monster emotes
212 --"CHAT_MSG_MONSTER_EMOTE",
213 --"CHAT_MSG_MONSTER_SAY",
214 --"CHAT_MSG_MONSTER_WHISPER",
215 --"CHAT_MSG_MONSTER_YELL",
216  
217 --chat channels
218 --"CHAT_MSG_DND",
219 --"CHAT_MSG_EMOTE",
220 --"CHAT_MSG_GUILD",
221 --"CHAT_MSG_IGNORED",
222 --"CHAT_MSG_LOOT",
223 --"CHAT_MSG_OFFICER",
224 --"CHAT_MSG_PARTY",
225 --"CHAT_MSG_RAID",
226 --"CHAT_MSG_SAY",
227 --"CHAT_MSG_SYSTEM",
228 --"CHAT_MSG_TEXT_EMOTE",
229 --"CHAT_MSG_WHISPER",
230 --"CHAT_MSG_WHISPER_INFORM",
231 --"CHAT_MSG_YELL",
232  
233 --battlegrounds
234 --"CHAT_MSG_BG_SYSTEM_ALLIANCE",
235 --"CHAT_MSG_BG_SYSTEM_HORDE",
236 --"CHAT_MSG_BG_SYSTEM_NEUTRAL",
237  
238 --misc
239 --"CHAT_MSG_COMBAT_ERROR",
240 --"CHAT_MSG_COMBAT_MISC_INFO",
241 --"CHAT_MSG_SPELL_FAILED_LOCALPLAYER",
242 }
243  
244 --Don't mess with these =)
245 SCT.EventConfig = sct_Event_Config;
246 SCT.EventDebug = sct_Event_Debug;
247 SCT.EventList = sct_Event_List;