TombEngine/Documentation/doc/2 classes/Objects.LaraObject.html

517 lines
12 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.3 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>TombEngine</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>2 Classes</h2>
<ul class="nowrap">
<li><a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
<li><a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
<li><a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li><a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
<li><a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
<li><a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
<li><a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li><a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
<li><a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
<li><strong>Objects.LaraObject</strong></li>
<li><a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
<li><a href="../2 classes/Objects.Sink.html">Objects.Sink</a></li>
<li><a href="../2 classes/Objects.SoundSource.html">Objects.SoundSource</a></li>
<li><a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
<li><a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
</ul>
<h2>1 Modules</h2>
<ul class="nowrap">
<li><a href="../1 modules/Effects.html">Effects</a></li>
<li><a href="../1 modules/Flow.html">Flow</a></li>
<li><a href="../1 modules/Inventory.html">Inventory</a></li>
<li><a href="../1 modules/Logic.html">Logic</a></li>
<li><a href="../1 modules/Misc.html">Misc</a></li>
<li><a href="../1 modules/Objects.html">Objects</a></li>
<li><a href="../1 modules/Strings.html">Strings</a></li>
</ul>
<h2>3 Primitive Classes</h2>
<ul class="nowrap">
<li><a href="../3 primitive classes/Color.html">Color</a></li>
<li><a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li><a href="../3 primitive classes/Vec3.html">Vec3</a></li>
</ul>
<h2>4 Enums</h2>
<ul class="nowrap">
<li><a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
<li><a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
</ul>
<h2>5 Lua utility modules</h2>
<ul class="nowrap">
<li><a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li><a href="../5 lua utility modules/Timer.html">Timer</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>Objects.LaraObject</code></h1>
<p>Class for extra Lara-only functions.</p>
<p>Do not try to create an object of this type; use the built-in <em>Lara</em> variable instead.</p>
<p>In addition, LaraObject inherits all the functions of <a href="../2 classes/Objects.Moveable.html#">Moveable</a>.</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#LaraObject:SetOnFire">LaraObject:SetOnFire(fire)</a></td>
<td class="summary">Set Lara on fire</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetOnFire">LaraObject:GetOnFire()</a></td>
<td class="summary">Get whether Lara is on fire or not</td>
</tr>
2022-11-18 15:34:45 +00:00
<tr>
<td class="name" ><a href="#LaraObject:SetPoison">LaraObject:SetPoison([Potency])</a></td>
<td class="summary">Set Lara poison potency</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetPoison">LaraObject:GetPoison()</a></td>
<td class="summary">Get poison potency of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:SetAir">LaraObject:SetAir(Air)</a></td>
<td class="summary">Set air value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetAir">LaraObject:GetAir()</a></td>
<td class="summary">Get air value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:SetSprintEnergy">LaraObject:SetSprintEnergy(sprint)</a></td>
<td class="summary">Set sprint energy value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetSprintEnergy">LaraObject:GetSprintEnergy()</a></td>
<td class="summary">Get sprint energy value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:SetWet">LaraObject:SetWet(Wetness)</a></td>
<td class="summary">Set wetness value of Lara (causes dripping)</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetWet">LaraObject:GetWet()</a></td>
<td class="summary">Get wetness value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetAmmoCount">LaraObject:GetAmmoCount()</a></td>
<td class="summary">Get current weapon's ammo count</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:UndrawWeapon">LaraObject:UndrawWeapon()</a></td>
<td class="summary">Lara will undraw her weapon if it is drawn and throw away a flare if she is currently holding one.</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:ThrowAwayTorch">LaraObject:ThrowAwayTorch()</a></td>
<td class="summary">Lara will throw away the torch if she currently holds one in her hand.</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:SetWeaponType">LaraObject:SetWeaponType(weaponType, activate)</a></td>
<td class="summary">Set Lara weapon type</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "LaraObject:SetOnFire"></a>
<strong>LaraObject:SetOnFire(fire)</strong>
</dt>
<dd>
Set Lara on fire
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">fire</span>
<span class="types"><span class="type">bool</span></span>
true to set lara on fire, false to extinguish her
</li>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetOnFire"></a>
<strong>LaraObject:GetOnFire()</strong>
</dt>
<dd>
Get whether Lara is on fire or not
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
fire true if lara is on fire, false otherwise
</ol>
2022-11-18 15:34:45 +00:00
</dd>
<dt>
<a name = "LaraObject:SetPoison"></a>
<strong>LaraObject:SetPoison([Potency])</strong>
</dt>
<dd>
Set Lara poison potency
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Potency</span>
<span class="types"><span class="type">int</span></span>
; maximum value is 64 (default 0)
(<em>optional</em>)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetPoison(<span class="number">10</span>)</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetPoison"></a>
<strong>LaraObject:GetPoison()</strong>
</dt>
<dd>
Get poison potency of Lara
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current poison potency
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> poisonPotency = Lara:GetPoison()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:SetAir"></a>
<strong>LaraObject:SetAir(Air)</strong>
</dt>
<dd>
Set air value of Lara
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Air</span>
<span class="types"><span class="type">int</span></span>
value to give Lara. Maximum value is 1800.
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetAir(<span class="number">100</span>)</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetAir"></a>
<strong>LaraObject:GetAir()</strong>
</dt>
<dd>
Get air value of Lara
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current air value
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> currentAir = Lara:GetAir()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:SetSprintEnergy"></a>
<strong>LaraObject:SetSprintEnergy(sprint)</strong>
</dt>
<dd>
Set sprint energy value of Lara
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">sprint</span>
<span class="types"><span class="type">int</span></span>
energy to give to Lara; maximum value is 120.
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetSprintEnergy(<span class="number">120</span>)</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetSprintEnergy"></a>
<strong>LaraObject:GetSprintEnergy()</strong>
</dt>
<dd>
Get sprint energy value of Lara
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current sprint value
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> sprintEnergy = Lara:GetSprintEnergy()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:SetWet"></a>
<strong>LaraObject:SetWet(Wetness)</strong>
</dt>
<dd>
Set wetness value of Lara (causes dripping)
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Wetness</span>
<span class="types"><span class="type">int</span></span>
value. Maximum 255
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetWet(<span class="number">100</span>)</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetWet"></a>
<strong>LaraObject:GetWet()</strong>
</dt>
<dd>
Get wetness value of Lara
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current wetness value
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> dripAmount = Lara:GetWet()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetAmmoCount"></a>
<strong>LaraObject:GetAmmoCount()</strong>
</dt>
<dd>
Get current weapon's ammo count
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
current ammo count (-1 if infinite)
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> equippedWeaponAmmoLeft = Lara:GetAmmoCount()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:UndrawWeapon"></a>
<strong>LaraObject:UndrawWeapon()</strong>
</dt>
<dd>
Lara will undraw her weapon if it is drawn and throw away a flare if she is currently holding one.
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:UndrawWeapon()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:ThrowAwayTorch"></a>
<strong>LaraObject:ThrowAwayTorch()</strong>
</dt>
<dd>
Lara will throw away the torch if she currently holds one in her hand.
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:ThrowAwayTorch()</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:SetWeaponType"></a>
<strong>LaraObject:SetWeaponType(weaponType, activate)</strong>
</dt>
<dd>
Set Lara weapon type
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">weaponType</span>
<span class="types"><span class="type">LaraWeaponType</span></span>
<p> Must be one of:</p>
<pre><code>NONE
PISTOLS
REVOLVER
UZI
SHOTGUN
HK
CROSSBOW
FLARE
TORCH
GRENADELAUNCHER
HARPOONGUN
ROCKETLAUNCHER
</code></pre>
</li>
<li><span class="parameter">activate</span>
<span class="types"><span class="type">bool</span></span>
true = let her also draw the weapons, set torch lit. false = let Laras new weapons remain holstered until she draws them, set torch unlit.
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetWeaponType(LaraWeaponType.PISTOLS, <span class="keyword">false</span>)</pre>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
2022-11-18 15:34:45 +00:00
<i style="float:right;">Last updated 2022-11-18 15:30:35 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>