Skip to content

Commit acbc02a

Browse files
LwmteLwmte
committed
Fix Lara class documentation
1 parent beedc3e commit acbc02a

File tree

1 file changed

+59
-61
lines changed

1 file changed

+59
-61
lines changed

‎2 classes/Objects.LaraObject.html‎

Lines changed: 59 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -123,44 +123,44 @@ <h1>Class <code>Objects.LaraObject</code></h1>
123123
<h2><a href="#Functions">Functions</a></h2>
124124
<table class="function_list">
125125
<tr>
126-
<td class="name" ><a href="#LaraObject:SetPoison">LaraObject:SetPoison([Poison])</a></td>
126+
<td class="name" ><a href="#LaraObject:SetPoison">LaraObject:SetPoison([poison])</a></td>
127127
<td class="summary">Set player poison.</td>
128128
</tr>
129129
<tr>
130130
<td class="name" ><a href="#LaraObject:GetPoison">LaraObject:GetPoison()</a></td>
131-
<td class="summary">Get poison potency of Lara</td>
131+
<td class="summary">Get poison potency of Lara.</td>
132132
</tr>
133133
<tr>
134-
<td class="name" ><a href="#LaraObject:SetAir">LaraObject:SetAir(Air)</a></td>
135-
<td class="summary">Set air value of Lara</td>
134+
<td class="name" ><a href="#LaraObject:SetAir">LaraObject:SetAir(air)</a></td>
135+
<td class="summary">Set air value of Lara.</td>
136136
</tr>
137137
<tr>
138138
<td class="name" ><a href="#LaraObject:GetAir">LaraObject:GetAir()</a></td>
139-
<td class="summary">Get air value of Lara</td>
139+
<td class="summary">Get air value of Lara.</td>
140140
</tr>
141141
<tr>
142-
<td class="name" ><a href="#LaraObject:SetWet">LaraObject:SetWet(Wetness)</a></td>
143-
<td class="summary">Set wetness value of Lara (causes dripping)</td>
142+
<td class="name" ><a href="#LaraObject:SetWet">LaraObject:SetWet(wetness)</a></td>
143+
<td class="summary">Set wetness value of Lara (causes dripping).</td>
144144
</tr>
145145
<tr>
146146
<td class="name" ><a href="#LaraObject:GetWet">LaraObject:GetWet()</a></td>
147-
<td class="summary">Get wetness value of Lara</td>
147+
<td class="summary">Get wetness value of Lara.</td>
148148
</tr>
149149
<tr>
150150
<td class="name" ><a href="#LaraObject:SetStamina">LaraObject:SetStamina(stamina)</a></td>
151-
<td class="summary">Set sprint energy value of Lara</td>
151+
<td class="summary">Set sprint energy value of Lara.</td>
152152
</tr>
153153
<tr>
154154
<td class="name" ><a href="#LaraObject:GetStamina">LaraObject:GetStamina()</a></td>
155-
<td class="summary">Get stamina value of Lara</td>
155+
<td class="summary">Get stamina value of Lara.</td>
156156
</tr>
157157
<tr>
158158
<td class="name" ><a href="#Moveable:GetAirborne">Moveable:GetAirborne()</a></td>
159-
<td class="summary">Get the moveable's airborne status</td>
159+
<td class="summary">Get the moveable's airborne status.</td>
160160
</tr>
161161
<tr>
162-
<td class="name" ><a href="#Moveable:SetAirborne">Moveable:SetAirborne(New)</a></td>
163-
<td class="summary">Set the moveable's airborne status</td>
162+
<td class="name" ><a href="#Moveable:SetAirborne">Moveable:SetAirborne(airborne)</a></td>
163+
<td class="summary">Set the moveable's airborne status.</td>
164164
</tr>
165165
<tr>
166166
<td class="name" ><a href="#LaraObject:UndrawWeapon">LaraObject:UndrawWeapon()</a></td>
@@ -172,23 +172,23 @@ <h2><a href="#Functions">Functions</a></h2>
172172
</tr>
173173
<tr>
174174
<td class="name" ><a href="#LaraObject:GetHandStatus">LaraObject:GetHandStatus()</a></td>
175-
<td class="summary">Get actual hand status of Lara</td>
175+
<td class="summary">Get actual hand status of Lara.</td>
176176
</tr>
177177
<tr>
178178
<td class="name" ><a href="#LaraObject:GetWeaponType">LaraObject:GetWeaponType()</a></td>
179-
<td class="summary">Get actual weapon type of Lara</td>
179+
<td class="summary">Get actual weapon type of Lara.</td>
180180
</tr>
181181
<tr>
182182
<td class="name" ><a href="#LaraObject:SetWeaponType">LaraObject:SetWeaponType(weaponType, activate)</a></td>
183-
<td class="summary">Set Lara weapon type</td>
183+
<td class="summary">Set Lara weapon type.</td>
184184
</tr>
185185
<tr>
186186
<td class="name" ><a href="#LaraObject:GetAmmoType">LaraObject:GetAmmoType()</a></td>
187187
<td class="summary">Get player weapon ammo type.</td>
188188
</tr>
189189
<tr>
190190
<td class="name" ><a href="#LaraObject:GetAmmoCount">LaraObject:GetAmmoCount()</a></td>
191-
<td class="summary">Get current weapon's ammo count</td>
191+
<td class="summary">Get current weapon's ammo count.</td>
192192
</tr>
193193
<tr>
194194
<td class="name" ><a href="#LaraObject:GetVehicle">LaraObject:GetVehicle()</a></td>
@@ -217,7 +217,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
217217
<dl class="function">
218218
<dt>
219219
<a name = "LaraObject:SetPoison"></a>
220-
<strong>LaraObject:SetPoison([Poison])</strong>
220+
<strong>LaraObject:SetPoison([poison])</strong>
221221
</dt>
222222
<dd>
223223
Set player poison.
@@ -226,9 +226,9 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
226226

227227
<h3>Parameters:</h3>
228228
<ul>
229-
<li><span class="parameter">Poison</span>
229+
<li><span class="parameter">poison</span>
230230
<span class="types"><span class="type">int</span></span>
231-
; maximum value is 128 (default 0)
231+
Poison strength. Maximum value is 128 (default 0)
232232
(<em>optional</em>)
233233
</li>
234234
</ul>
@@ -247,7 +247,7 @@ <h3>Usage:</h3>
247247
<strong>LaraObject:GetPoison()</strong>
248248
</dt>
249249
<dd>
250-
Get poison potency of Lara
250+
Get poison potency of Lara.
251251

252252

253253

@@ -256,7 +256,7 @@ <h3>Returns:</h3>
256256
<ol>
257257

258258
<span class="types"><span class="type">int</span></span>
259-
current poison potency
259+
Current poison potency.
260260
</ol>
261261

262262

@@ -269,18 +269,18 @@ <h3>Usage:</h3>
269269
</dd>
270270
<dt>
271271
<a name = "LaraObject:SetAir"></a>
272-
<strong>LaraObject:SetAir(Air)</strong>
272+
<strong>LaraObject:SetAir(air)</strong>
273273
</dt>
274274
<dd>
275-
Set air value of Lara
275+
Set air value of Lara.
276276

277277

278278

279279
<h3>Parameters:</h3>
280280
<ul>
281-
<li><span class="parameter">Air</span>
281+
<li><span class="parameter">air</span>
282282
<span class="types"><span class="type">int</span></span>
283-
value to give Lara. Maximum value is 1800.
283+
Air value to give Lara. Maximum value is 1800.
284284
</li>
285285
</ul>
286286

@@ -298,7 +298,7 @@ <h3>Usage:</h3>
298298
<strong>LaraObject:GetAir()</strong>
299299
</dt>
300300
<dd>
301-
Get air value of Lara
301+
Get air value of Lara.
302302

303303

304304

@@ -307,7 +307,7 @@ <h3>Returns:</h3>
307307
<ol>
308308

309309
<span class="types"><span class="type">int</span></span>
310-
current air value
310+
Current air value.
311311
</ol>
312312

313313

@@ -320,18 +320,18 @@ <h3>Usage:</h3>
320320
</dd>
321321
<dt>
322322
<a name = "LaraObject:SetWet"></a>
323-
<strong>LaraObject:SetWet(Wetness)</strong>
323+
<strong>LaraObject:SetWet(wetness)</strong>
324324
</dt>
325325
<dd>
326-
Set wetness value of Lara (causes dripping)
326+
Set wetness value of Lara (causes dripping).
327327

328328

329329

330330
<h3>Parameters:</h3>
331331
<ul>
332-
<li><span class="parameter">Wetness</span>
332+
<li><span class="parameter">wetness</span>
333333
<span class="types"><span class="type">int</span></span>
334-
value. Maximum 255
334+
Wetness value. Maximum value is 255.
335335
</li>
336336
</ul>
337337

@@ -349,7 +349,7 @@ <h3>Usage:</h3>
349349
<strong>LaraObject:GetWet()</strong>
350350
</dt>
351351
<dd>
352-
Get wetness value of Lara
352+
Get wetness value of Lara.
353353

354354

355355

@@ -358,7 +358,7 @@ <h3>Returns:</h3>
358358
<ol>
359359

360360
<span class="types"><span class="type">int</span></span>
361-
current wetness value
361+
Current wetness value.
362362
</ol>
363363

364364

@@ -374,15 +374,15 @@ <h3>Usage:</h3>
374374
<strong>LaraObject:SetStamina(stamina)</strong>
375375
</dt>
376376
<dd>
377-
Set sprint energy value of Lara
377+
Set sprint energy value of Lara.
378378

379379

380380

381381
<h3>Parameters:</h3>
382382
<ul>
383383
<li><span class="parameter">stamina</span>
384384
<span class="types"><span class="type">int</span></span>
385-
to give to Lara; maximum value is 120.
385+
Stamina to give to Lara. Maximum value is 120.
386386
</li>
387387
</ul>
388388

@@ -400,7 +400,7 @@ <h3>Usage:</h3>
400400
<strong>LaraObject:GetStamina()</strong>
401401
</dt>
402402
<dd>
403-
Get stamina value of Lara
403+
Get stamina value of Lara.
404404

405405

406406

@@ -425,16 +425,16 @@ <h3>Usage:</h3>
425425
<strong>Moveable:GetAirborne()</strong>
426426
</dt>
427427
<dd>
428-
Get the moveable's airborne status
428+
Get the moveable's airborne status.
429429

430430

431431

432432

433433
<h3>Returns:</h3>
434434
<ol>
435435

436-
<span class="types"><span class="type">(bool)</span></span>
437-
true if Lara state must react to aerial forces.
436+
<span class="types"><span class="type">bool</span></span>
437+
True if Lara state must react to aerial forces.
438438
</ol>
439439

440440

@@ -443,18 +443,18 @@ <h3>Returns:</h3>
443443
</dd>
444444
<dt>
445445
<a name = "Moveable:SetAirborne"></a>
446-
<strong>Moveable:SetAirborne(New)</strong>
446+
<strong>Moveable:SetAirborne(airborne)</strong>
447447
</dt>
448448
<dd>
449-
Set the moveable's airborne status
449+
Set the moveable's airborne status.
450450

451451

452452

453453
<h3>Parameters:</h3>
454454
<ul>
455-
<li><span class="parameter">New</span>
456-
<span class="types"><span class="type">(bool)</span></span>
457-
airborn status for Lara.
455+
<li><span class="parameter">airborne</span>
456+
<span class="types"><span class="type">bool</span></span>
457+
New airborne status for Lara.
458458
</li>
459459
</ul>
460460

@@ -506,16 +506,16 @@ <h3>Usage:</h3>
506506
<strong>LaraObject:GetHandStatus()</strong>
507507
</dt>
508508
<dd>
509-
Get actual hand status of Lara
509+
Get actual hand status of Lara.
510510

511511

512512

513513

514514
<h3>Returns:</h3>
515515
<ol>
516516

517-
<span class="types"><span class="type">int</span></span>
518-
hand status 0=HandsFree, 1=Busy(climbing,etc), 2=WeaponDraw, 3=WeaponUndraw, 4=WeaponInHand.
517+
<span class="types"><a class="type" href="../4 enums/Objects.HandStatus.html#">HandStatus</a></span>
518+
Current hand status.
519519
</ol>
520520

521521

@@ -531,16 +531,16 @@ <h3>Usage:</h3>
531531
<strong>LaraObject:GetWeaponType()</strong>
532532
</dt>
533533
<dd>
534-
Get actual weapon type of Lara
534+
Get actual weapon type of Lara.
535535

536536

537537

538538

539539
<h3>Returns:</h3>
540540
<ol>
541541

542-
<span class="types"><span class="type">Flow.WeaponType</span></span>
543-
current weapon type.
542+
<span class="types"><a class="type" href="../4 enums/Objects.WeaponType.html#">WeaponType</a></span>
543+
Current weapon type.
544544
</ol>
545545

546546

@@ -556,21 +556,19 @@ <h3>Usage:</h3>
556556
<strong>LaraObject:SetWeaponType(weaponType, activate)</strong>
557557
</dt>
558558
<dd>
559-
Set Lara weapon type
559+
Set Lara weapon type.
560560

561561

562562

563563
<h3>Parameters:</h3>
564564
<ul>
565565
<li><span class="parameter">weaponType</span>
566-
<span class="types"><span class="type">Flow.WeaponType</span></span>
567-
568-
569-
566+
<span class="types"><a class="type" href="../4 enums/Objects.WeaponType.html#">WeaponType</a></span>
567+
New weapon type to set.
570568
</li>
571569
<li><span class="parameter">activate</span>
572570
<span class="types"><span class="type">bool</span></span>
573-
if <code>true</code>, also draw the weapons or set torch lit. If <code>false</code>, keep weapons holstered or leave torch unlit.
571+
If <code>true</code>, also draw the weapons or set torch lit. If <code>false</code>, keep weapons holstered or leave torch unlit.
574572
</li>
575573
</ul>
576574

@@ -596,8 +594,8 @@ <h3>Usage:</h3>
596594
<h3>Returns:</h3>
597595
<ol>
598596

599-
<span class="types"><span class="type">Flow.AmmoType</span></span>
600-
player weapon ammo type
597+
<span class="types"><a class="type" href="../4 enums/Objects.AmmoType.html#">AmmoType</a></span>
598+
Player weapon ammo type.
601599
</ol>
602600

603601

@@ -613,7 +611,7 @@ <h3>Usage:</h3>
613611
<strong>LaraObject:GetAmmoCount()</strong>
614612
</dt>
615613
<dd>
616-
Get current weapon's ammo count
614+
Get current weapon's ammo count.
617615

618616

619617

@@ -622,7 +620,7 @@ <h3>Returns:</h3>
622620
<ol>
623621

624622
<span class="types"><span class="type">int</span></span>
625-
current ammo count (-1 if infinite)
623+
Current ammo count (-1 if infinite).
626624
</ol>
627625

628626

0 commit comments

Comments
 (0)