mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-04-28 15:57:59 +03:00
858 lines
25 KiB
HTML
858 lines
25 KiB
HTML
<!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.8.2 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>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/Input.html">Input</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/Objects.html">Objects</a></li>
|
|
<li> <a href="../1 modules/Sound.html">Sound</a></li>
|
|
<li> <a href="../1 modules/Strings.html">Strings</a></li>
|
|
<li> <a href="../1 modules/Util.html">Util</a></li>
|
|
<li> <a href="../1 modules/View.html">View</a></li>
|
|
</ul>
|
|
<h2>2 Classes</h2>
|
|
<ul class="nowrap">
|
|
<li> <a href="../2 classes/Collision.Probe.html">Collision.Probe</a></li>
|
|
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
|
|
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
|
|
<li> <a href="../2 classes/Flow.Statistics.html">Flow.Statistics</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> <here>Objects.LaraObject</here></li>
|
|
<li> <a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
|
|
<li> <a href="../2 classes/Objects.Room.html">Objects.Room</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/Objects.Volume.html">Objects.Volume</a></li>
|
|
<li> <a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
|
|
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
|
|
</ul>
|
|
<h2>3 Primitive Classes</h2>
|
|
<ul class="nowrap">
|
|
<li> <a href="../3 primitive classes/Flow.Fog.html">Flow.Fog</a></li>
|
|
<li> <a href="../3 primitive classes/Flow.Horizon.html">Flow.Horizon</a></li>
|
|
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
|
|
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
|
|
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
|
|
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
|
|
<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/Time.html">Time</a></li>
|
|
<li> <a href="../3 primitive classes/Vec2.html">Vec2</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/Collision.MaterialType.html">Collision.MaterialType</a></li>
|
|
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
|
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
|
<li> <a href="../4 enums/Effects.StreamerFeatherMode.html">Effects.StreamerFeatherMode</a></li>
|
|
<li> <a href="../4 enums/Effects.ParticleAnimationType.html">Effects.ParticleAnimationType</a></li>
|
|
<li> <a href="../4 enums/Flow.ErrorMode.html">Flow.ErrorMode</a></li>
|
|
<li> <a href="../4 enums/Flow.FreezeMode.html">Flow.FreezeMode</a></li>
|
|
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
|
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
|
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
|
<li> <a href="../4 enums/Objects.HandStatus.html">Objects.HandStatus</a></li>
|
|
<li> <a href="../4 enums/Objects.WeaponType.html">Objects.WeaponType</a></li>
|
|
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
|
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
|
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
|
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
|
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
|
|
<li> <a href="../4 enums/Strings.DisplayStringOption.html">Strings.DisplayStringOption</a></li>
|
|
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
|
|
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
|
|
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
|
|
<li> <a href="../4 enums/View.PostProcessMode.html">View.PostProcessMode</a></li>
|
|
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
|
|
</ul>
|
|
<h2>5 Lua utility modules</h2>
|
|
<ul class="nowrap">
|
|
<li> <a href="../5 lua utility modules/CustomBar.html">CustomBar</a></li>
|
|
<li> <a href="../5 lua utility modules/Diary.html">Diary</a></li>
|
|
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
|
|
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
|
|
<li> <a href="../5 lua utility modules/Type.html">Type</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Class <code>Objects.LaraObject</code></h1>
|
|
<p>Class for player-only functions.</p>
|
|
<p> Do not try to create an object of this type. Use the built-in <em>Lara</em> variable instead.
|
|
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:SetPoison">LaraObject:SetPoison([poison])</a></td>
|
|
<td class="summary">Set the player's poison value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetPoison">LaraObject:GetPoison()</a></td>
|
|
<td class="summary">Get the player's poison value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:SetAir">LaraObject:SetAir(air)</a></td>
|
|
<td class="summary">Set the player's air value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetAir">LaraObject:GetAir()</a></td>
|
|
<td class="summary">Get the player's air value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:SetWet">LaraObject:SetWet(wetness)</a></td>
|
|
<td class="summary">Set the player's wetness value, causing drips.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetWet">LaraObject:GetWet()</a></td>
|
|
<td class="summary">Get the player's wetness value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:SetStamina">LaraObject:SetStamina(New)</a></td>
|
|
<td class="summary">Set the player's stamina value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetStamina">LaraObject:GetStamina()</a></td>
|
|
<td class="summary">Get the player's stamina value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Moveable:GetAirborne">Moveable:GetAirborne()</a></td>
|
|
<td class="summary">Get the player's airborne status (set when jumping and falling).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Moveable:SetAirborne">Moveable:SetAirborne(airborne)</a></td>
|
|
<td class="summary">Set the player's airborne status.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:UndrawWeapon">LaraObject:UndrawWeapon()</a></td>
|
|
<td class="summary">Undraw a weapon if it is drawn and throw away a flare if currently holding one.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:DiscardTorch">LaraObject:DiscardTorch()</a></td>
|
|
<td class="summary">Discard a held torch.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetHandStatus">LaraObject:GetHandStatus()</a></td>
|
|
<td class="summary">Get the player's hand status.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetWeaponType">LaraObject:GetWeaponType()</a></td>
|
|
<td class="summary">Get the player's weapon type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:SetWeaponType">LaraObject:SetWeaponType(weaponType, activate)</a></td>
|
|
<td class="summary">Set the player's weapon type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetAmmoType">LaraObject:GetAmmoType()</a></td>
|
|
<td class="summary">Get player weapon ammo type.</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:GetVehicle">LaraObject:GetVehicle()</a></td>
|
|
<td class="summary">Get current vehicle, if it exists.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetTarget">LaraObject:GetTarget()</a></td>
|
|
<td class="summary">Get the player's current targeted moveable (if it exists).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:GetInteractedMoveable">LaraObject:GetInteractedMoveable()</a></td>
|
|
<td class="summary">Get the player's current interacted moveable (if it exists).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:IsTorchLit">LaraObject:IsTorchLit()</a></td>
|
|
<td class="summary">Check if a held torch is lit.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:Interact">LaraObject:Interact(mov, [animNumber], [offset], [minOffsetConstraint], [maxOffsetConstraint], [minRotConstraint], [maxRotConstraint], [actionID])</a></td>
|
|
<td class="summary">Align the player with a moveable object for interaction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#LaraObject:TestInteraction">LaraObject:TestInteraction(mov, [minOffsetConstraint], [maxOffsetConstraint], [minRotConstraint], [maxRotConstraint])</a></td>
|
|
<td class="summary">Test the player against a moveable object for interaction.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "LaraObject:SetPoison"></a>
|
|
<strong>LaraObject:SetPoison([poison])</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the player's poison value.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">poison</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
New poison value. <strong>default: 0, max: 128</strong>
|
|
<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 the player's poison value.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
Poison value.
|
|
</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 the player's air value.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">air</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
New air value. <strong>max: 1800</strong>
|
|
</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 the player's air value.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
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:SetWet"></a>
|
|
<strong>LaraObject:SetWet(wetness)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the player's wetness value, causing drips.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">wetness</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
New wetness value. <strong>max: 255</strong>
|
|
</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 the player's wetness value.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
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:SetStamina"></a>
|
|
<strong>LaraObject:SetStamina(New)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the player's stamina value.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">New</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
stamina value. <strong>max: 120</strong>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">Lara:SetStamina(<span class="number">120</span>)</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetStamina"></a>
|
|
<strong>LaraObject:GetStamina()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's stamina value.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
Stamina value.
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> sprintEnergy = Lara:GetStamina()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Moveable:GetAirborne"></a>
|
|
<strong>Moveable:GetAirborne()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's airborne status (set when jumping and falling).
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
True if airborne, otherwise false.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Moveable:SetAirborne"></a>
|
|
<strong>Moveable:SetAirborne(airborne)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the player's airborne status.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">airborne</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
New airborne status.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:UndrawWeapon"></a>
|
|
<strong>LaraObject:UndrawWeapon()</strong>
|
|
</dt>
|
|
<dd>
|
|
Undraw a weapon if it is drawn and throw away a flare if currently holding one.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">Lara:UndrawWeapon()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:DiscardTorch"></a>
|
|
<strong>LaraObject:DiscardTorch()</strong>
|
|
</dt>
|
|
<dd>
|
|
Discard a held torch.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">Lara:DiscardTorch()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetHandStatus"></a>
|
|
<strong>LaraObject:GetHandStatus()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's hand status.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../4 enums/Objects.HandStatus.html#">HandStatus</a></span>
|
|
Hand status.
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> handStatus = Lara:GetHandStatus()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetWeaponType"></a>
|
|
<strong>LaraObject:GetWeaponType()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's weapon type.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../4 enums/Objects.WeaponType.html#">WeaponType</a></span>
|
|
Current weapon type.
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> weaponType = Lara:GetWeaponType()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:SetWeaponType"></a>
|
|
<strong>LaraObject:SetWeaponType(weaponType, activate)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the player's weapon type.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">weaponType</span>
|
|
<span class="types"><a class="type" href="../4 enums/Objects.WeaponType.html#">WeaponType</a></span>
|
|
New weapon type to set.
|
|
</li>
|
|
<li><span class="parameter">activate</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
If <code>true</code>, also draw the weapons or set torch lit. If <code>false</code>, keep weapons holstered or leave torch unlit.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">Lara:SetWeaponType(WeaponType.PISTOLS, <span class="keyword">false</span>)</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetAmmoType"></a>
|
|
<strong>LaraObject:GetAmmoType()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get player weapon ammo type.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../4 enums/Objects.AmmoType.html#">AmmoType</a></span>
|
|
Player weapon ammo type.
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> CurrentAmmoType = Lara:GetAmmoType()</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:GetVehicle"></a>
|
|
<strong>LaraObject:GetVehicle()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get current vehicle, if it exists.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
|
Current vehicle (nil if no vehicle present).
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> vehicle = Lara:GetVehicle()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetTarget"></a>
|
|
<strong>LaraObject:GetTarget()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's current targeted moveable (if it exists).
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
|
Target moveable (nil if the player is not currently targeting a moveable).
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> target = Lara:GetTarget()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:GetInteractedMoveable"></a>
|
|
<strong>LaraObject:GetInteractedMoveable()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the player's current interacted moveable (if it exists).
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
|
Interacted moveable (nil if the player is not interacting with a moveable).
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> interactedMoveable = Lara:GetInteractedMoveable()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:IsTorchLit"></a>
|
|
<strong>LaraObject:IsTorchLit()</strong>
|
|
</dt>
|
|
<dd>
|
|
Check if a held torch is lit.
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
True if lit, otherwise false (also false if there is no torch in hand).
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> isTorchLit = Lara:IsTorchLit()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:Interact"></a>
|
|
<strong>LaraObject:Interact(mov, [animNumber], [offset], [minOffsetConstraint], [maxOffsetConstraint], [minRotConstraint], [maxRotConstraint], [actionID])</strong>
|
|
</dt>
|
|
<dd>
|
|
Align the player with a moveable object for interaction.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">mov</span>
|
|
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
|
Moveable object to align the player with.
|
|
</li>
|
|
<li><span class="parameter">animNumber</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
The animation to play after alignment is complete.
|
|
<em>Default: 197 (BUTTON_PUSH).</em>
|
|
</li>
|
|
<li><span class="parameter">offset</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
Relative position offset from the moveable.
|
|
<em>Default: Vec3(0, 0, 312).</em>
|
|
</li>
|
|
<li><span class="parameter">minOffsetConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
Minimum relative offset constraint.
|
|
<em>Default: Vec3(-256, -512, 0).</em>
|
|
</li>
|
|
<li><span class="parameter">maxOffsetConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
Maximum relative offset constraint.
|
|
<em>Default: Vec3(256, 0, 512).</em>
|
|
</li>
|
|
<li><span class="parameter">minRotConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
Minimum relative rotation constraint.
|
|
<em>Default: Rotation(-10, -40, -10).</em>
|
|
</li>
|
|
<li><span class="parameter">maxRotConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
Maximum relative rotation constraint.
|
|
<em>Default: Rotation(10, 40, 10).</em>
|
|
</li>
|
|
<li><span class="parameter">actionID</span>
|
|
<span class="types"><a class="type" href="../4 enums/Input.ActionID.html#">ActionID</a></span>
|
|
Input action ID to trigger the alignment.
|
|
<em>Default: Input.ActionID.ACTION.</em>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> Lara:Interact(
|
|
moveable, <span class="number">197</span>,
|
|
Vec3(<span class="number">0</span>, <span class="number">0</span>, <span class="number">312</span>), Vec3(-<span class="number">256</span>, -<span class="number">512</span>, -<span class="number">256</span>), Vec3(<span class="number">256</span>, <span class="number">0</span>, <span class="number">512</span>),
|
|
Rotation(-<span class="number">10</span>, -<span class="number">30</span>, -<span class="number">10</span>), Rotation(<span class="number">10</span>, <span class="number">30</span>, <span class="number">10</span>), TEN.Input.ActionID.ACTION)</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "LaraObject:TestInteraction"></a>
|
|
<strong>LaraObject:TestInteraction(mov, [minOffsetConstraint], [maxOffsetConstraint], [minRotConstraint], [maxRotConstraint])</strong>
|
|
</dt>
|
|
<dd>
|
|
Test the player against a moveable object for interaction.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">mov</span>
|
|
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
|
Moveable object to align the player with.
|
|
</li>
|
|
<li><span class="parameter">minOffsetConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
Minimum relative offset constraint.
|
|
<em>Default: Vec3(-256, -512, 0).</em>
|
|
</li>
|
|
<li><span class="parameter">maxOffsetConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
Maximum relative offset constraint.
|
|
<em>Default: Vec3(256, 0, 512).</em>
|
|
</li>
|
|
<li><span class="parameter">minRotConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
Minimum relative rotation constraint.
|
|
<em>Default: Rotation(-10, -40, -10).</em>
|
|
</li>
|
|
<li><span class="parameter">maxRotConstraint</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
Maximum relative rotation constraint.
|
|
<em>Default: Rotation(10, 40, 10).</em>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|