-
Notifications
You must be signed in to change notification settings - Fork 7
/
InventoryList.html
311 lines (257 loc) · 11.8 KB
/
InventoryList.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<!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>InventoryList - Inventory model : 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>InventoryList</b></li>
</ul>
</div>
<div id="main">
<h1>InventoryList - Inventory model</h1>
<b>Derived from: <a href="Utils--ObjectList.html">ObjectList</a></b>
<p>
The InventoryList class models a character's inventory or a Kapra storage.
<p>
<h3>Differences compared to ObjectList</h3>
All items in Inventory are of the same class, and are all a
subclass of <a href="Actor--Item.html">Actor::Item</a>.
<p><table class="functionIndex">
<tr><th colspan="3">Class InventoryList</th></tr><tr onclick="location.href='#InventoryList->new';">
<td class="return-type"><a href="InventoryList.html">InventoryList</a></td>
<td class="func"><a href="#InventoryList->new">InventoryList->new</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$InventoryList->add';">
<td class="return-type">int</td>
<td class="func"><a href="#$InventoryList->add">$InventoryList->add</a></td>
<td class="decl">(<span class="type"><a href="Actor--Item.html">Actor::Item</a></span> item)</td>
</tr><tr onclick="location.href='#$InventoryList->getByCondition';">
<td class="return-type"><a href="Actor--Item.html">Actor::Item</a></td>
<td class="func"><a href="#$InventoryList->getByCondition">$InventoryList->getByCondition</a></td>
<td class="decl">(<span class="type">Function</span> condition)</td>
</tr><tr onclick="location.href='#$InventoryList->getByName';">
<td class="return-type"><a href="Actor--Item.html">Actor::Item</a></td>
<td class="func"><a href="#$InventoryList->getByName">$InventoryList->getByName</a></td>
<td class="decl">(<span class="type">String</span> name)</td>
</tr><tr onclick="location.href='#$InventoryList->getByNameID';">
<td class="return-type"><a href="Actor--Item.html">Actor::Item</a></td>
<td class="func"><a href="#$InventoryList->getByNameID">$InventoryList->getByNameID</a></td>
<td class="decl">(<span class="type">Bytes</span> nameID)</td>
</tr><tr onclick="location.href='#$InventoryList->getByNameList';">
<td class="return-type"><a href="Actor--Item.html">Actor::Item</a></td>
<td class="func"><a href="#$InventoryList->getByNameList">$InventoryList->getByNameList</a></td>
<td class="decl">(<span class="type">String</span> nameList)</td>
</tr><tr onclick="location.href='#$InventoryList->getByServerIndex';">
<td class="return-type"><a href="Actor--Item.html">Actor::Item</a></td>
<td class="func"><a href="#$InventoryList->getByServerIndex">$InventoryList->getByServerIndex</a></td>
<td class="decl">(<span class="type">int</span> serverIndex)</td>
</tr><tr onclick="location.href='#$InventoryList->remove';">
<td class="return-type">boolean</td>
<td class="func"><a href="#$InventoryList->remove">$InventoryList->remove</a></td>
<td class="decl">(<span class="type"><a href="Actor--Item.html">Actor::Item</a></span> item)</td>
</tr><tr onclick="location.href='#$InventoryList->removeByName';">
<td class="return-type">boolean</td>
<td class="func"><a href="#$InventoryList->removeByName">$InventoryList->removeByName</a></td>
<td class="decl">(<span class="type">String</span> name)</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="$InventoryList->add"></a>
<h3>$InventoryList->add</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$InventoryList->add</strong>(<span class="type"><a href="Actor--Item.html">Actor::Item</a></span> item)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires"> defined($item) defined($item->{name}) $self->find($item) == -1</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$item</code>->{invIndex} == result</dd>
</dl><p>
<div class="desc">Adds an item to this InventoryList. <code>$item</code>->{invIndex} will automatically be set
index in which that item is stored in this list.
<p>
This method overloads <a href="Utils--ObjectList.html#$ObjectList->add"><code>$ObjectList->add()</code></a>, and has a stronger precondition.
See the documentation for that method for more information about this
method.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->getByCondition"></a>
<h3>$InventoryList->getByCondition</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Actor--Item.html">Actor::Item</a></span> <strong>$InventoryList->getByCondition</strong>(<span class="type">Function</span> condition)
</dt>
<dd>
<div class="desc">Return the first Actor::Item object for which the function <code>$condition</code> returns true.
If nothing is found, undef is returned.
<p>
<code>$condition</code> is called with exactly one parameter, namely the item that is currently
being checked.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->getByName"></a>
<h3>$InventoryList->getByName</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Actor--Item.html">Actor::Item</a></span> <strong>$InventoryList->getByName</strong>(<span class="type">String</span> name)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($name)</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">if defined(result): result->{ID} eq <code>$ID</code></dd>
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">An Actor::Item, or undef if there is no item with that name in this list.</dd>
</dl><p>
<div class="desc">Looks up an Actor::Item object based on the item name. The name lookup is
case-insensitive. If there is more than one item with this name, then it
is unspecified which exact item will be returned.
<p>
See also: <code>$Actor</code>->{ID}</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->getByNameID"></a>
<h3>$InventoryList->getByNameID</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Actor--Item.html">Actor::Item</a></span> <strong>$InventoryList->getByNameID</strong>(<span class="type">Bytes</span> nameID)
</dt>
<dd>
<div class="desc">Return the first Actor::Item object, whose 'nameID' field is equal to <code>$nameID</code>.
If nothing is found, undef is returned.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->getByNameList"></a>
<h3>$InventoryList->getByNameList</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Actor--Item.html">Actor::Item</a></span> <strong>$InventoryList->getByNameList</strong>(<span class="type">String</span> nameList)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>nameList</code> : a string containing a comma-separated list of item names.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($nameList)</dd>
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">The found item, or undef if not found.</dd>
</dl><p>
<div class="desc">Lookup an item by using the specified name list. For example, if <code>$nameList</code>
is "Red Potion,White Potion,Jellopy", then this method will look up
either Red Potion, White Potion or Jellopy, whichever is found
first.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->getByServerIndex"></a>
<h3>$InventoryList->getByServerIndex</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Actor--Item.html">Actor::Item</a></span> <strong>$InventoryList->getByServerIndex</strong>(<span class="type">int</span> serverIndex)
</dt>
<dd>
<div class="desc">Return the first Actor::Item object, whose 'index' field is equal to <code>$serverIndex</code>.
If nothing is found, undef is returned.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->remove"></a>
<h3>$InventoryList->remove</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>$InventoryList->remove</strong>(<span class="type"><a href="Actor--Item.html">Actor::Item</a></span> item)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($item) && defined($item->{name})</dd>
</dl><p>
<div class="desc">Removes an item from this InventoryList.
<p>
This method overloads <a href="Utils--ObjectList.html#$ObjectList->remove"><code>$ObjectList->remove()</code></a>, and has a stronger precondition.
See the documentation for that method for more information about this
method.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$InventoryList->removeByName"></a>
<h3>$InventoryList->removeByName</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>$InventoryList->removeByName</strong>(<span class="type">String</span> name)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>name</code> : The name of the item to remove.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($name)</dd>
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">Whether the item with the specified name was in the list.</dd>
</dl><p>
<div class="desc">Removes an item based on the item name. The name lookup is case-insensitive.
If there is more than one item with this name, then it is unspecified which
exact item (with that name) is removed.
<p>
This will trigger an onRemove event before the item is removed.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="InventoryList->new"></a>
<h3>InventoryList->new</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="InventoryList.html">InventoryList</a></span> <strong>InventoryList->new</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"><code>$self->size()</code> == 0</dd>
</dl><p>
<div class="desc">Creates a new InventoryList object.</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>