vanilla-wow-addons – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1  
2 == ChatThrottleLib Intro ==
3  
4 ChatThrottleLib is a small, embeddable library by Mikk of Bloodhoof-EU that
5 keeps outbound chat and addon communication from exceeding the output rate
6 limit in WoW that otherwise causes players to disconnect from the server.
7  
8 It also has a number of features that will help you make your addon
9 communication run smoother!
10  
11  
12 Benefits of using ChatThrottleLib:
13  
14 * Players do not get disconnected when your addon sends too much data
15  
16 * You can easily prioritize your traffic in three priorities
17  
18 * Communication to different peers is handled as individual flows. A long data
19 stream to "Alice" doesn't interrupt short bursts of traffic to "Bob".
20  
21 * All AddOns using ChatThrottleLib use the same queues, so multiple addons
22 can't cause an overload. Priorities ensure that real-time traffic is still
23 real-time.
24  
25  
26 ChatThrottleLib does:
27  
28 * Round-robin traffic shaping of different communication paths
29 * Prioritization of messages according to three predefined priorities:
30 "BULK", "NORMAL" and "ALERT"
31 * NO queueing of traffic needlessly. No lag introduced until it needs to be.
32 * Adaptive throttling according to traffic bypassing the library
33 * Adaptive throttling according to frame rate
34  
35  
36 == APIs ==
37  
38 * ChatThrottleLib:SendChatMessage("prio", "prefix", "text", "chattype", "language", "destination");
39  
40 * ChatThrottleLib:SendAddonMessage("prio", "prefix", "text", "chattype");
41  
42 "prio" is one of "BULK", "NORMAL" and "ALERT".
43 "prefix" in :SendChatMessage() is only used for traffic shaping purposes
44  
45  
46  
47 == How to embed ChatThrottleLib ==
48  
49 Method 1:
50 * Copy ChatThrottleLib.lua into your addon directory
51 * Add "ChatThrottleLib.lua" to your .toc file
52  
53 Method 2:
54 * Copy the entire ChatThrottleLib folder to your addon
55 * Add "ChatThrottleLib/ChatThrottleLib.xml" to your .toc file
56  
57 You're done, and can now use ChatThrottleLib:SendChatMessage and ChatThrottleLib:SendAddonMessage to send your messages!
58  
59 The library has built-in checks for if it has already been loaded, and avoids loading again if so.
60 If your addon has a newer version of the library than one that has already been loaded, it will replace the old version.
61  
62  
63 == More Information ==
64  
65 * Download: http://www.wowinterface.com/downloads/info5207-ChatThrottleLib.html
66  
67 * Docs: http://www.wowwiki.com/ChatThrottleLib
68  
69 * SVN: http://svn.wowace.com/root/trunk/ChatThrottleLib
70  
71  
72 [Documentation for ChatThrottleLib v11, 2006-08-25]