-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathActor--You.html
285 lines (237 loc) · 9.12 KB
/
Actor--You.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
<!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>Actor::You - You actor object : 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>Actor::You</b></li>
</ul>
</div>
<div id="main">
<h1>Actor::You - You actor object</h1>
<code>$char</code> is of the Actor::You class. This class represents the your own character.
<p>
<a href="Actor.html"><code>Actor</code></a> is the base class for this class.
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#$char->getSkillLevel';">
<td class="return-type">int</td>
<td class="func"><a href="#$char->getSkillLevel">$char->getSkillLevel</a></td>
<td class="decl">(<span class="type"><a href="Skill.html">Skill</a></span> skill)</td>
</tr><tr onclick="location.href='#$char->hp_percent';">
<td class="return-type">float</td>
<td class="func"><a href="#$char->hp_percent">$char->hp_percent</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$char->inventory';">
<td class="return-type"><a href="InventoryList.html">InventoryList</a></td>
<td class="func"><a href="#$char->inventory">$char->inventory</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$char->master';">
<td class="return-type">float</td>
<td class="func"><a href="#$char->master">$char->master</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$char->sp_percent';">
<td class="return-type">float</td>
<td class="func"><a href="#$char->sp_percent">$char->sp_percent</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$char->weight_percent';">
<td class="return-type">float</td>
<td class="func"><a href="#$char->weight_percent">$char->weight_percent</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$char->{charID}';">
<td class="return-type">Bytes</td>
<td class="func"><a href="#$char->{charID}">$char->{charID}</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#$char->{homunculus}';">
<td class="return-type">Actor::Homunculus</td>
<td class="func"><a href="#$char->{homunculus}">$char->{homunculus}</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#$char->{permitSkill}';">
<td class="return-type"><a href="Skill.html">Skill</a></td>
<td class="func"><a href="#$char->{permitSkill}">$char->{permitSkill}</a></td>
<td class="decl"></td>
</tr><tr onclick="location.href='#Hash<String, Hash> $char->{skills}';">
<td class="return-type"></td>
<td class="func"><a href="#Hash<String, Hash> $char->{skills}">Hash<String, Hash> $char->{skills}</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="$char->getSkillLevel"></a>
<h3>$char->getSkillLevel</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$char->getSkillLevel</strong>(<span class="type"><a href="Skill.html">Skill</a></span> skill)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">result >= 0</dd>
</dl><p>
<div class="desc">Returns the maximum level of the specified skill. If the character doesn't
have that skill, the 0 is returned.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->hp_percent"></a>
<h3>$char->hp_percent</h3>
<dl>
<dt class="decl">
<span class="return-type"> float</span> <strong>$char->hp_percent</strong>()
</dt>
<dd>
<div class="desc">Returns your HP percentage (between 0 and 100).</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->inventory"></a>
<h3>$char->inventory</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="InventoryList.html">InventoryList</a></span> <strong>$char->inventory</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Get the inventory list for this character.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->master"></a>
<h3>$char->master</h3>
<dl>
<dt class="decl">
<span class="return-type"> float</span> <strong>$char->master</strong>()
</dt>
<dd>
<div class="desc">Returns your master (if any).
<p>
FIXME: Should eventually ensure that either an <code>Actor::Party</code> (party member who
is not near you) or <a href="Actor--Player.html"><code>Actor::Player</code></a> (would be ensured if <code>%players</code> hash was
guaranteed to be clean) is returned.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->sp_percent"></a>
<h3>$char->sp_percent</h3>
<dl>
<dt class="decl">
<span class="return-type"> float</span> <strong>$char->sp_percent</strong>()
</dt>
<dd>
<div class="desc">Returns your SP percentage (between 0 and 100).</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->weight_percent"></a>
<h3>$char->weight_percent</h3>
<dl>
<dt class="decl">
<span class="return-type"> float</span> <strong>$char->weight_percent</strong>()
</dt>
<dd>
<div class="desc">Returns your weight percentage (between 0 and 100).</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->{charID}"></a>
<h3>$char->{charID}</h3>
<dl>
<dt class="decl">
<span class="return-type"> Bytes</span> <strong>$char->{charID}</strong>
</dt>
<dd>
<div class="desc">A unique character ID for this character (not the same as the account ID, or <code>$char</code>->{ID}).</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->{homunculus}"></a>
<h3>$char->{homunculus}</h3>
<dl>
<dt class="decl">
<span class="return-type"> Actor::Homunculus</span> <strong>$char->{homunculus}</strong>
</dt>
<dd>
<div class="desc">If the character has a homunculus, and the homunculus is currently online, then this
member points to character's homunculus object.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$char->{permitSkill}"></a>
<h3>$char->{permitSkill}</h3>
<dl>
<dt class="decl">
<span class="return-type"> <a href="Skill.html">Skill</a></span> <strong>$char->{permitSkill}</strong>
</dt>
<dd>
<div class="desc">When you use certain items, the server temporarily permits you to use a skill.
For example, when you use an Yggdrasil Leaf, the server temporarily lets you
to use Resurrection.
<p>
This member specifies which skill is currently temporarily permitted. It is undef
when there is no temporarily permitted skill.
The temporary permission is removed once you have used the skill, or when you have
changed map server. (TODO: are these really all the cases?)</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Hash<String, Hash> $char->{skills}"></a>
<h3>Hash<String, Hash> $char->{skills}</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Hash<String, Hash> $char->{skills}</strong>
</dt>
<dd>
<div class="desc">Contains a set of skills that the character has. The keys of the hash
are the skill handles, and the values are a hash containing the following
items:
<ul>
<li>ID - The skill ID.</li>
<li>lv - The maximum level of this skill.</li>
<li>sp - The amount of SP that this skill needs, when used at the maximum level.</li>
<li>range - The range of this skill, in blocks.</li>
<li>up - Whether this skill can be leveled up further.</li>
<li>targetType - This skill's target type.
</li>
</ul></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>