Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-28 15:57:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
TombEngine/Documentation/doc/2 classes/Objects.Volume.html
Lwmte 7c2f6f96e4
Lua API documentation revisions (#1636) 
* First iteration

* Revise Moveable class documentation

* Revise remaining documentation

* Extend laraType description

* Enum documentation revisions

* Edit version

* Corrections and updates

* Corrections
2025-04-20 22:39:30 +03:00

463 lines
12 KiB
HTML
Raw Blame 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.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>&nbsp;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> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></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> <here>Objects.Volume</here></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.Volume</code></h1>
<p>Activator volume.</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Volume:GetName">Volume:GetName()</a></td>
<td class="summary">Get the unique string identifier of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:GetPosition">Volume:GetPosition()</a></td>
<td class="summary">Get the position of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:GetRotation">Volume:GetRotation()</a></td>
<td class="summary">Get the rotation of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:GetScale">Volume:GetScale()</a></td>
<td class="summary">Get this scale of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:SetName">Volume:SetName(name)</a></td>
<td class="summary">Set the unique string identifier of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:SetPosition">Volume:SetPosition(pos)</a></td>
<td class="summary">Set the position of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:SetRotation">Volume:SetRotation(rot)</a></td>
<td class="summary">Set the rotation of this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:SetScale">Volume:SetScale(scale)</a></td>
<td class="summary">Set the scale of the volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:GetActive">Volume:GetActive()</a></td>
<td class="summary">Determine if this volume is active.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:IsMoveableInside">Volume:IsMoveableInside(moveable)</a></td>
<td class="summary">Determine if a moveable is inside this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:Enable">Volume:Enable()</a></td>
<td class="summary">Enable this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:Disable">Volume:Disable()</a></td>
<td class="summary">Disable this volume.</td>
</tr>
<tr>
<td class="name" ><a href="#Volume:ClearActivators">Volume:ClearActivators()</a></td>
<td class="summary">Clear the activators for this volume, allowing it to trigger again.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Volume:GetName"></a>
<strong>Volume:GetName()</strong>
</dt>
<dd>
Get the unique string identifier of this volume.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
Name.
</ol>
</dd>
<dt>
<a name = "Volume:GetPosition"></a>
<strong>Volume:GetPosition()</strong>
</dt>
<dd>
Get the position of this volume.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
Position.
</ol>
</dd>
<dt>
<a name = "Volume:GetRotation"></a>
<strong>Volume:GetRotation()</strong>
</dt>
<dd>
Get the rotation of this volume.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
Rotation.
</ol>
</dd>
<dt>
<a name = "Volume:GetScale"></a>
<strong>Volume:GetScale()</strong>
</dt>
<dd>
Get this scale of this volume.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
Scale.
</ol>
</dd>
<dt>
<a name = "Volume:SetName"></a>
<strong>Volume:SetName(name)</strong>
</dt>
<dd>
Set the unique string identifier of this volume.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
New name.
</li>
</ul>
</dd>
<dt>
<a name = "Volume:SetPosition"></a>
<strong>Volume:SetPosition(pos)</strong>
</dt>
<dd>
Set the position of this volume.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pos</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
New position.
</li>
</ul>
</dd>
<dt>
<a name = "Volume:SetRotation"></a>
<strong>Volume:SetRotation(rot)</strong>
</dt>
<dd>
Set the rotation of this volume.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">rot</span>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
New rotation.
</li>
</ul>
</dd>
<dt>
<a name = "Volume:SetScale"></a>
<strong>Volume:SetScale(scale)</strong>
</dt>
<dd>
Set the scale of the volume.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">scale</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
New scale.
</li>
</ul>
</dd>
<dt>
<a name = "Volume:GetActive"></a>
<strong>Volume:GetActive()</strong>
</dt>
<dd>
Determine if this volume is active.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Boolean representing active status.
</ol>
</dd>
<dt>
<a name = "Volume:IsMoveableInside"></a>
<strong>Volume:IsMoveableInside(moveable)</strong>
</dt>
<dd>
Determine if a moveable is inside this volume.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">moveable</span>
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
Moveable to be checked for containment.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Boolean representing containment status.
</ol>
</dd>
<dt>
<a name = "Volume:Enable"></a>
<strong>Volume:Enable()</strong>
</dt>
<dd>
Enable this volume.
</dd>
<dt>
<a name = "Volume:Disable"></a>
<strong>Volume:Disable()</strong>
</dt>
<dd>
Disable this volume.
</dd>
<dt>
<a name = "Volume:ClearActivators"></a>
<strong>Volume:ClearActivators()</strong>
</dt>
<dd>
Clear the activators for this volume, allowing it to trigger again.
</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>
Reference in a new issue View git blame Copy permalink