mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-08 03:28:03 +03:00
187 lines
6.1 KiB
HTML
187 lines
6.1 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.0.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>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><strong>Flow.InventoryItem</strong></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><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>Flow.InventoryItem</code></h1>
|
|
<p>Represents the properties of an object as it appears in the inventory.</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" ><a href="#InventoryItem">InventoryItem(nameKey, slot, yOffset, scale, rot, axis, meshBits, action)</a></td>
|
|
<td class="summary">Create an InventoryItem.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "InventoryItem"></a>
|
|
<strong>InventoryItem(nameKey, slot, yOffset, scale, rot, axis, meshBits, action)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create an InventoryItem.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">nameKey</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
key for the item's (localised) name.<br />
|
|
Corresponds to an entry in strings.lua.
|
|
</li>
|
|
<li><span class="parameter">slot</span>
|
|
<span class="types"><span class="type">Flow.InvItem</span></span>
|
|
slot of inventory object to change
|
|
</li>
|
|
<li><span class="parameter">yOffset</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
y-axis offset (positive values move the item down).<br />
|
|
A value of about 100 will cause the item to display directly below its usual position.
|
|
</li>
|
|
<li><span class="parameter">scale</span>
|
|
<span class="types"><span class="type">float</span></span>
|
|
item size (1 being standard size).<br />
|
|
A value of 0.5 will cause the item to render at half the size,
|
|
and a value of 2 will cause the item to render at twice the size.
|
|
</li>
|
|
<li><span class="parameter">rot</span>
|
|
<span class="types"><span class="type">Rotation</span></span>
|
|
rotation about x, y, and z axes
|
|
</li>
|
|
<li><span class="parameter">axis</span>
|
|
<span class="types"><span class="type">RotationAxis</span></span>
|
|
Axis to rotate about when the item is being looked at in the inventory.<br />
|
|
Note that this is entirely separate from the <code>rot</code> field described above.
|
|
Must be RotationAxis.X, RotationAxis.Y or RotationAxis.Z.
|
|
e.g. <code>myItem.rotAxisWhenCurrent = RotationAxis.X</code>
|
|
</li>
|
|
<li><span class="parameter">meshBits</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
<strong>Not currently implemented</strong> (will have no effect regardless of what you set it to)
|
|
</li>
|
|
<li><span class="parameter">action</span>
|
|
<span class="types"><span class="type">ItemAction</span></span>
|
|
is this usable, equippable, or examinable?<br/>
|
|
Must be one of:</p>
|
|
<pre><code>EQUIP
|
|
USE
|
|
EXAMINE
|
|
</code></pre>
|
|
<p>e.g. <code>myItem.action = ItemAction.EXAMINE</code>
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
an InventoryItem
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</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>
|
|
<i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|