-
Notifications
You must be signed in to change notification settings - Fork 7
/
Commands.html
182 lines (144 loc) · 6.44 KB
/
Commands.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!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>Commands - Commandline input processing : 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>Commands</b></li>
</ul>
</div>
<div id="main">
<h1>Commands - Commandline input processing</h1>
This module processes commandline input.
<p><table class="functionIndex">
<tr><th colspan="3">Functions</th></tr><tr onclick="location.href='#Commands::register';">
<td class="return-type"></td>
<td class="func"><a href="#Commands::register">Commands::register</a></td>
<td class="decl">(<span class="type">[name,</span> description, callback]...)</td>
</tr><tr onclick="location.href='#Commands::run';">
<td class="return-type"></td>
<td class="func"><a href="#Commands::run">Commands::run</a></td>
<td class="decl">(input)</td>
</tr><tr onclick="location.href='#Commands::unregister';">
<td class="return-type"></td>
<td class="func"><a href="#Commands::unregister">Commands::unregister</a></td>
<td class="decl">(ID)</td>
</tr>
</table>
<p><table class="functionIndex">
<tr><th colspan="3">Private functions</th></tr><tr onclick="location.href='#cmdStorage_list';">
<td class="return-type">void</td>
<td class="func"><a href="#cmdStorage_list">cmdStorage_list</a></td>
<td class="decl">(<span class="type">String</span> list_type)</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="Commands::register"></a>
<h3>Commands::register</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Commands::register</strong>(<span class="type">[name,</span> description, callback]...)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">an ID for use with Commands::unregister()</dd>
</dl><p>
<div class="desc">Register new commands.</div>
<dl class="example">
<dt><strong>Example:</strong></dt>
<dd><pre><span class="hl kwc">my</span> <span class="hl kwb">$ID</span> <span class="hl sym">=</span> Commands<span class="hl sym">::</span><span class="hl kwd">register</span><span class="hl sym">(</span>
<span class="hl sym">[</span><span class="hl str">"my_command"</span><span class="hl sym">,</span> <span class="hl str">"My custom command's description"</span><span class="hl sym">,</span> \<span class="hl sym">&</span>my_callback<span class="hl sym">],</span>
<span class="hl sym">[</span><span class="hl str">"another_command"</span><span class="hl sym">,</span> <span class="hl str">"Yet another command description"</span><span class="hl sym">,</span> \<span class="hl sym">&</span>another_callback<span class="hl sym">]</span>
<span class="hl sym">);</span>
Commands<span class="hl sym">::</span><span class="hl kwd">unregister</span><span class="hl sym">(</span><span class="hl kwb">$ID</span><span class="hl sym">);</span>
</pre></dd>
</dl>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Commands::run"></a>
<h3>Commands::run</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Commands::run</strong>(input)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>input</code> : a command.</dd>
</dl><p>
<div class="desc">Processes <code>$input</code>. See also <a href="http://openkore.sourceforge.net/docs.php">the user documentation</a>
for a list of commands.</div>
<dl class="example">
<dt><strong>Example:</strong></dt>
<dd><pre><span class="hl slc"># Same effect as typing 's' in the console. Displays character status</span>
Commands<span class="hl sym">::</span><span class="hl kwd">run</span><span class="hl sym">(</span><span class="hl str">"s"</span><span class="hl sym">);</span>
</pre></dd>
</dl>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Commands::unregister"></a>
<h3>Commands::unregister</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Commands::unregister</strong>(ID)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>ID</code> : an ID returned by <a href="Commands.html#Commands::register"><code>Commands::register()</code></a></dd>
</dl><p>
<div class="desc">Unregisters a registered command.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="cmdStorage_list"></a>
<h3>cmdStorage_list</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>cmdStorage_list</strong>(<span class="type">String</span> list_type)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>list_type</code> : ''|eq|nu|u</dd>
</dl><p>
<div class="desc">Displays the contents of storage, or a subset indicated by switches.
<p>
Called by: cmdStorage (not called directly).</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>