-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathChatQueue.html
131 lines (101 loc) · 4.32 KB
/
ChatQueue.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChatQueue - Processing of incoming chat commands : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>ChatQueue</b></li>
</ul>
</div>
<div id="main">
<h1>ChatQueue - Processing of incoming chat commands</h1>
Kore has a feature called 'chat commands': you command your bot to
do certain things by using PM or public chat. This module processes
chat input and executes chat commands when necessary.
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#ChatQueue::add';">
<td class="return-type">void</td>
<td class="func"><a href="#ChatQueue::add">ChatQueue::add</a></td>
<td class="decl">(<span class="type">String</span> type, Bytes userID, String user, String msg)</td>
</tr><tr onclick="location.href='#ChatQueue::clear';">
<td class="return-type">void</td>
<td class="func"><a href="#ChatQueue::clear">ChatQueue::clear</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#ChatQueue::processFirst';">
<td class="return-type">void</td>
<td class="func"><a href="#ChatQueue::processFirst">ChatQueue::processFirst</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="ChatQueue::add"></a>
<h3>ChatQueue::add</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>ChatQueue::add</strong>(<span class="type">String</span> type, Bytes userID, String user, String msg)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>type</code> : 'c' (public chat), 'pm' (private message), 'p' (party chat) or 'g' (guild chat)</dd>
<dd class="param"><code>userID</code> : the account ID of the user who sent this message.</dd>
<dd class="param"><code>user</code> : the name of the user who sent this message.</dd>
<dd class="param"><code>msg</code> : the message.</dd>
</dl><p>
<div class="desc">Add a chat message to the chat queue. The messages in the queue will be processed later.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="ChatQueue::clear"></a>
<h3>ChatQueue::clear</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>ChatQueue::clear</strong>()
</dt>
<dd>
<div class="desc">Clear the chat queue, if there are any unprocessed messages.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="ChatQueue::processFirst"></a>
<h3>ChatQueue::processFirst</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>ChatQueue::processFirst</strong>()
</dt>
<dd>
<div class="desc">Process the first message in the queue, if any.
That message will be removed from the queue.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>