vanilla-wow-addons – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 1. What does this plugin do?
2 This plugin is build to give the player control over timers and warnings,
3 triggerd by selfdefined events. This plugin will simply check every incoming event,
4 with a table of triggers. If the event matches a trigger, a timer will be started,
5 or a warning be send. You can also manually invoke timers, a.E. for your pizza ;)
6  
7 2. The Timers
8  
9 2.1 The Mainframe
10 The Mainframe is accsessible by the "normal" tab. It will show you all timers
11 and there current time. You can sort this table by name or time with clicking
12 onto the column headers. Shift-Click onto the the column headers, will spam
13 the first x timers, or all timers expiring withing x minutes, to the current
14 active chatsend. You can define this x in the config frame.
15 When siwtching to the "light" tab, the background will become transparent, so it
16 does hide less.
17 You can edit the name and the current time, by simply clicking onto the according
18 text. This will start the edit mode. Enter will save the change, ESC will discard it.
19 The "T" Button at the right upper edge will show/hide the NameBox (when activated
20 at the config).
21 The "D" Button of every timer will delete it.
22  
23 2.2 The Mainmenu
24 The Mainmenu is accsessible by the "!" Button at the right-top edge. You will have
25 a dropdown menu with the following options:
26  
27 2.2.1 Dis-/Enable all
28 This will dis-/enable all triggers. When disabled, timers will still run, and you can
29 still invoke them manual, but they will not be invoked by events.
30 This will not affect, the dis-/enabled status of the triggers in in the triggers frame.
31  
32 2.2.2 Delete Expired
33 This will delete all timers, that are expired.
34  
35 2.2.3 Delete by Group
36 This will allow you to delete all timers, that are invoked by triggers of the
37 same group.
38  
39 2.2.4 Delete All Times
40 Simply deletes all timers.
41  
42 2.2.5 Reset Expired
43 This will reset the time of all timers, that are expired.
44  
45 2.2.6 Reset by Group
46 This will allow you to reset the time of all timers, that are
47 invoked by triggers of the same group.
48  
49 2.2.7 Reset All Times
50 Simply reset the time of all timers.
51  
52 2.3 The Timermenu
53 The Timermenu is accsessible by the "!" Button, left of every timer row. This will open
54 a dropdownmenu with options, that will change this timer only:
55  
56 2.3.1 invoked by
57 Shows, with trigger started this timer. When starting a timer manual without a trigger,
58 it will be invoked by the "Default" Trigger.
59  
60 2.3.2 Delete Timer
61 This will delete the timer.
62  
63 2.3.3 Reset Timer
64 This will reset the time of the timer.
65  
66 2.3.4 Pause/Resume Timer
67 This is only availible, when the timer is not stopped. It will pause/resume the timer.
68  
69 2.3.5 Stop Timer
70 This is only availible for incermental timers. It will stop the timer.
71  
72 2.3.6 Spam To
73 This will spam the timer and it's time to the selected channel. Reply will send the data
74 as an answer to the last whisper.
75  
76 3. The Triggers
77  
78 3.1 The Triggerframe
79 The Triggerframe is accsessible by the "trigger" tab. It will show you all triggers, groups
80 and the settings of the triggers/groups. You can sort the triggers, by clicking onto the
81 column headers. This will not affect the groups, the will stay in the same order.
82 You can edit nearly all values and text by clicking onto the text. Some fields will have a
83 Button for a dropdown box.
84 The checkbox at the beginning of every row, will de-/activate the according trigger/group.
85 When checked, it's active.
86  
87 3.2 The Mainmenu
88 The Mainmenu is accsessible by the "!" Button at the right-top edge. You will have
89 a dropdown menu with the following options:
90  
91 3.2.1 Show/Hide inactive
92 When "Hide inactive" is selected, all inactive groups and triggers will be hidden.
93  
94 3.2.2 Unfold/Fold all groups
95 When fold, only the groups are visible, when unfold also all there trigger are visible.
96  
97 3.2.3 De-/Activate all
98 Will De-/Active all groups and triggers.
99  
100 3.2.4 Reset all counter
101 This will reset all trigger counters to 0.
102  
103 3.2.5 Add a new group
104 Will add a new group with a selfdefined name.
105  
106 3.2.6 Delete a group
107 Will delete a non predefined group.
108  
109 3.2.7 Add a trigger
110 This will add a trigger named "New trigger" to the "no group" group.
111  
112 3.2.8 Reload default triggers
113 This will reload the default values of all predefined triggers.
114  
115 3.3 The groups
116 A group is written as --- <name> --- in blue text. It has the follwing options:
117  
118 3.3.1 by playtime
119 When checked, the timer will pause, when leaving the game. It will resume when reentering.
120  
121 3.3.1 When starting, Reset counter
122 When checked, all counters from triggers of this group will be resetted to 0 when starting
123 the game.
124  
125 3.3.2 When starting, Delete timers.
126 When checked, all timers, inherited by triggers of this group, will be delete when starting.
127  
128 3.3.3. The fold/unfold Button
129 The fold("+")/unfold("-") Button can be found, left of the name. It will show(unfold) or
130 hide(fold) all triggers of this group. The triggers will remaine active.
131  
132 3.4 The triggers
133 A trigger has a name in white text. It has the following options:
134  
135 3.4.1 Name
136 The name of the trigger.
137  
138 3.4.2 Time
139 The time, the trigger will start with.
140  
141 3.4.3 Warn
142 When this value is not 0, a warning will be send x-minutes bevor the timer expires.
143  
144 3.4.4 Text
145 When this text is part of the text, of an event, a timer will be started.
146  
147 3.4.5 Message
148 This message will be send as a warning, when the timer expires or the warntime is reached.
149  
150 3.4.6 Channel
151 The channel, the message will be send to.
152  
153 3.4.7 Cnt. (Count)
154 The count, how often this trigger has been invoked.
155  
156 3.4.8 Thr. (Threshold)
157 The minimum time in seconds bevor this trigger can be reinvoked.
158  
159 3.4.9 Type
160 Defines, what will happen, when this trigger is invoked:
161  
162 3.4.9.1 Default
163 Will be of the same type, as the "Default" trigger in the group "no group".
164  
165 3.4.9.2 Multiple
166 Everytime this trigger is invoked, a timer will be started.
167  
168 3.4.9.3 Once
169 When a timer of this trigger is running, no new timer will be started.
170  
171 3.4.9.4 Once/Group
172 When a timer of a trigger of this group is runnung, no new timer will be started.
173  
174 3.4.9.5 Pause
175 When a timer of a trigger of this group is running, it's pause state will be toggled.
176  
177 3.4.9.6 Stop
178 When a timer of a trigger of this group is runnung, it will be stopped.
179 Mode Incremental only.
180  
181 3.4.9.7 Warn only
182 No timer will be started. Only the warning will be send instantly.
183  
184 3.4.10 Mode
185 Defines, what will happen when a timer of this trigger is expired.
186  
187 3.4.10.1 Default
188 Will be of the same type, as the "Default" trigger in the group "no group".
189  
190 3.4.10.2 Contine
191 The timer will continue to count down.
192  
193 3.4.10.3 Delete
194 The timer will be deleted.
195  
196 3.4.10.4 Reset
197 The time of the timer will be reseted.
198  
199 3.4.10.5 Incremental
200 The time will count up from the beginning. So it will never expire.
201  
202 3.4.11 The Triggermenu
203 The Triggermenu is accsessible by the "!" Button, left of the name.
204  
205 3.4.11.1 Show advanced config
206 This will open the advanced configuration menu for the selected timer.
207  
208 3.4.11.2 Reset counter
209 This will reset the counter of this trigger to 0.
210  
211 3.4.11.3 Delete trigger
212 This will delete the trigger. Only availible for non predefined triggers.
213  
214 3.4.11.4 Move to group
215 This will move the trigger to an other group.
216  
217 3.4.11.5 Reset to default
218 This will reset a predefined trigger to it's default values.
219  
220 3.5 The advance configuration
221  
222 3.5.1 Name
223 The name of the trigger.
224  
225 3.5.2 Time
226 The time, the trigger will start with.
227  
228 3.5.3 Text
229 When this text is part of the text, of an event, a timer will be started.
230  
231 3.5.4 Warntime
232 When this value is not 0, a warning will be send x-minutes bevor the timer expires.
233  
234 3.5.5 Warn-Message
235 This message will be send as a warning, when the warntime is reached.
236  
237 3.5.6 Warn-Channel
238 The channel, the message will be send to.
239  
240 3.5.7 Expire-Message
241 This message will be send as a warning, when a timer expires.
242  
243 3.5.8 Expire-Channel
244 The channel, the message will be send to.
245  
246 3.5.9 Cnt. (Count)
247 The count, how often this trigger has been invoked.
248  
249 3.5.10 Thr. (Threshold)
250 The minimum time in seconds bevor this trigger can be reinvoked.
251  
252 3.5.11 Type
253 Defines, what will happen, when this trigger is invoked:
254  
255 3.5.11.1 Default
256 Will be of the same type, as the "Default" trigger in the group "no group".
257  
258 3.5.11.2 Multiple
259 Everytime this trigger is invoked, a timer will be started.
260  
261 3.5.11.3 Once
262 When a timer of this trigger is running, no new timer will be started.
263  
264 3.5.11.4 Once/Group
265 When a timer of a trigger of this group is runnung, no new timer will be started.
266  
267 3.5.11.5 Pause
268 When a timer of a trigger of this group is running, it's pause state will be toggled.
269  
270 3.5.11.6 Stop
271 When a timer of a trigger of this group is runnung, it will be stopped.
272 Mode Incremental only.
273  
274 3.5.11.7 Warn only
275 No timer will be started. Only the warning will be send instantly.
276  
277 3.5.12 Mode
278 Defines, what will happen when a timer of this trigger is expired.
279  
280 3.5.12.1 Default
281 Will be of the same type, as the "Default" trigger in the group "no group".
282  
283 3.5.12.2 Contine
284 The timer will continue to count down.
285  
286 3.5.12.3 Delete
287 The timer will be deleted.
288  
289 3.5.12.4 Reset
290 The time of the timer will be reseted.
291  
292 3.5.12.5 Incremental
293 The time will count up from the beginning. So it will never expire.
294  
295  
296 4 The Configuration
297 The Configframe is accsessible from the "config" tab. It has the following settings:
298  
299 4.1 use Namebar
300 When checked, a floating input box will appear. The text in this box will be used
301 as the name for new timers. You can use the variables as described in the "Variables
302 and Slashcommands" section.
303 When not checked, an input box will popup, everytime a new timer is starting.
304  
305 4.2 Title text
306 This defines the title of the Timersframe. You can use variables as described in the
307 "Variables and Slashcommands" section. If this text is empty, the minmized frame, will
308 be half sized.
309  
310 4.3 Spam first X minutes/timers
311 This defines how many timer will be spammed, when shift-clicking onto the column headers
312 in the timersframe.
313  
314 4.4 Timers Name Size
315 This will define how big the namebox at the timersframe is.
316  
317 4.5. Timers Frame Scale
318 This will define how big all frames are. This feature is not yet 100% stable.
319  
320 4.6 Reset
321 This button will reset, all configuration values to default. This includes the namebar text
322 and the window positions.
323  
324 5 Variables and Slashcommands
325  
326 5.1 Variables
327 This plugin has a variousity of variables, that can be use as placeholders for different texts.
328 Here is a list of what the variables will do and where to use them:
329  
330 5.1.1 Namevariables
331 These variables can be used as part of the namebox text or at the inputbox for a timers name.
332  
333 - "!count" will be replaced with the current value of the counter of the trigger, that has been
334 invoked to start the timer.
335 - "!trigger" will be replaced with the name of the trigger, that has been invoked to start the
336 timer
337 - "!coord" will be replaced with you current coordinates on the map.
338  
339 5.1.2 Messagevariables
340 These variables can be used as part of the message of a trigger. When a timer invoked by
341 this trigger, sends a warning, the variables will be replaced.
342  
343 - "!count" will be replaced with the current value of the counter of this trigger.
344 - "!trigger" will be replaced with the name of the trigger.
345 - "!name" will be replaced with the name of the timer.
346 - "!group" will be replaced with the name of the group of this trigger.
347 - "!time" will be replaced with the current time of the timer.
348 - "!msg" will be replaced with the message, that invoked the trigger.
349 - "!msgsub" will bre replaced with message, that invoked the trigger, but without the
350 part that stands in the triggertext.
351 A.E.: triggertext="Mob looks at", invoked by message="Mob looks at Player", then !msgsub
352 will be replaced with "Player"
353  
354 5.1.3 Titlevariables
355 These variables are used for the timers title text. (See the configuration)
356  
357 - "!tNext" will be replaced with the time of the next expiring timer.
358 - "!nNext" will be replaced with the name of the next expiring timer.
359 - "!iAll" will be replaced with the number of timers.
360 - "!iExpired" will be replaced with the number of expired timers.
361  
362 5.2 Slashcommands
363 The following slashcommands are availible. They are invoked with /ati command. A.E.: "/ati show".
364 Parameters in [] are optional.
365  
366 - "add name time [trigger]" This will add a new timer
367 - "show" This will show the Userinterface, when hidden.
368 - "reset" This will reset all configuration and positions.
369 - "invoke name" This will invoke the trigger "name".
370 - "debug" This will show the internal name of a skill or spell, when an
371 action button is pressed.
372  
373 5.3 Whispercommands
374 Anyone how whispers you "showtime x" (x is optinal) will get a list of all timers expiring in x minutes.
375 If no x is defined, the Spam first value from the configframe will be used.
376  
377 6 Frequently Asked Questions
378  
379 6.1 I don't want this popupbox, everytime a trigger is invoked?
380 - Go to the configuation and check the "use Namebar" checkbox. You can no set the name of
381 the timers with the floating inputbox.
382  
383 6.2 I can't see the namebar, for changing the timer names?
384 - If it's activated in the configuration, press the "T" Button at the top right of the frame.
385  
386 6.3 How can i edit values and text ? There is no edit button.
387 - Simply click the text - you can change it direct.
388  
389 6.4 Is it possible to use the Message that invoked the trigger, as part of the warning message?
390 As Example when names are part of the Message.
391 - Yes, it is. Check the variables section for the variables "!msg" and "!msgsub"
392  
393 6.5 I don't want to have a timer, just a warning?
394 - Switch the type of the trigger to "Warn only". When the warning should go of with delay, use
395 as type "Multiple" and "Delete" as Mode. The delay is the time of the trigger.
396  
397 6.6 I don't see any parts of the plugin ingame, but it's listed at the addons list?
398 - Try "/ati reset".
399  
400 6.7 I want to make a new Spellcast trigger, but i don't know the spellmessage, i've to use?
401 - Use "/ati debug" and press the button for the spell.
402  
403 7 Credits
404 This plugin is written by Tyrion WarMage.
405 It's inspired by the plugin "Timers by Darco modified by Pinus".
406 You can contact me on EU-Server Antonidas, Horde, Player: Tyrion, or
407 by E-Mail: Tyrion@geek-squad.de, or by making a comment to this plugin
408 on www.curse-gaming.com or ui.worldofwar.net
409