2021-08-12 20:16:28 +01:00
|
|
|
<!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>
|
2021-08-23 20:16:01 +01:00
|
|
|
<title>TombEngine Lua API</title>
|
2021-08-12 20:16:28 +01:00
|
|
|
<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="#Members">Members</a></li>
|
|
|
|
|
<li><a href="#Functions">Functions</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Pre-game script classes</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
2021-08-23 19:19:36 +01:00
|
|
|
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
2021-08-12 20:16:28 +01:00
|
|
|
<li><strong>InventoryObject</strong></li>
|
2021-08-23 19:19:36 +01:00
|
|
|
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
|
|
|
|
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
|
|
|
|
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
|
|
|
|
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Script Files</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
2021-08-23 19:19:36 +01:00
|
|
|
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
|
|
|
|
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2>Enums</h2>
|
|
|
|
|
<ul class="nowrap">
|
|
|
|
|
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
|
|
|
|
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2>Entity classes</h2>
|
|
|
|
|
<ul class="nowrap">
|
|
|
|
|
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
|
|
|
|
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
|
|
|
|
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
|
|
|
|
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
|
|
|
|
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
|
|
|
|
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2>Misc classes</h2>
|
|
|
|
|
<ul class="nowrap">
|
|
|
|
|
<li><a href="../misc classes/Color.html">Color</a></li>
|
|
|
|
|
<li><a href="../misc classes/Position.html">Position</a></li>
|
|
|
|
|
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content">
|
|
|
|
|
|
|
|
|
|
<h1>Class <code>InventoryObject</code></h1>
|
|
|
|
|
<p>Represents the properties of an object as it appears in the inventory.</p>
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2><a href="#Members">Members</a></h2>
|
|
|
|
|
<table class="function_list">
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#nameKey">nameKey</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(string) string key for the item's (localised) name.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#slot">slot</a></td>
|
|
|
|
|
<td class="summary">(<a href="../enums/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#yOffset">yOffset</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(float) y-axis offset (positive values will move the item lower).</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#scale">scale</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(float) Item's size when displayed in the inventory as a multiple of its "regular" size.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#rot">rot</a></td>
|
|
|
|
|
<td class="summary">(<a href="../misc classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#rotAxisWhenCurrent">rotAxisWhenCurrent</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(RotationAxis) Axis to rotate about when the item is being looked at in the inventory.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#meshBits">meshBits</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(int) <strong>Not currently implemented</strong> (will have no effect regardless of what you set it to)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#action">action</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(ItemAction) What can the player do with the item?</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
|
|
|
<table class="function_list">
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new()</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">Create an inventoryObject item.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new(nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">For more information on each parameter, see the
|
|
|
|
|
associated getters and setters.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
|
|
|
|
|
|
|
|
|
<dl class="function">
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "nameKey"></a>
|
|
|
|
|
<strong>nameKey</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(string) string key for the item's (localised) name. Corresponds to an entry in strings.lua.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "slot"></a>
|
|
|
|
|
<strong>slot</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
2021-08-23 19:19:36 +01:00
|
|
|
(<a href="../enums/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change
|
2021-08-12 20:16:28 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "yOffset"></a>
|
|
|
|
|
<strong>yOffset</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(float) y-axis offset (positive values will move the item lower).
|
|
|
|
|
A value of about 100 will cause the item to display directly below its usual position.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "scale"></a>
|
|
|
|
|
<strong>scale</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(float) Item's size when displayed in the inventory as a multiple of its "regular" size.
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "rot"></a>
|
|
|
|
|
<strong>rot</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
2021-08-23 19:19:36 +01:00
|
|
|
(<a href="../misc classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.
|
2021-08-12 20:16:28 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "rotAxisWhenCurrent"></a>
|
|
|
|
|
<strong>rotAxisWhenCurrent</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(RotationAxis) Axis to rotate about when the item is being looked at in the inventory.
|
2021-08-23 19:19:36 +01:00
|
|
|
Note that this is entirely separate from the <a href="../pre-game script classes/InventoryObject.html#rot">rot</a> field described above.
|
2021-08-12 20:16:28 +01:00
|
|
|
Must be RotationAxis.X, RotationAxis.Y or RotationAxis.Z.
|
|
|
|
|
e.g. <code>myItem.rotAxisWhenCurrent = RotationAxis.X</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "meshBits"></a>
|
|
|
|
|
<strong>meshBits</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(int) <strong>Not currently implemented</strong> (will have no effect regardless of what you set it to)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "action"></a>
|
|
|
|
|
<strong>action</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(ItemAction) What can the player do with the item?
|
|
|
|
|
Must be one of:</p>
|
|
|
|
|
<pre><code>EQUIP
|
|
|
|
|
USE
|
|
|
|
|
EXAMINE
|
|
|
|
|
</code></pre>
|
|
|
|
|
<p>e.g. <code>myItem.action = ItemAction.EXAMINE</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
2021-08-23 19:19:36 +01:00
|
|
|
|
2021-08-12 20:16:28 +01:00
|
|
|
<dl class="function">
|
|
|
|
|
<dt>
|
|
|
|
|
<a name = "InventoryObject.new"></a>
|
2021-08-23 19:19:36 +01:00
|
|
|
<strong>InventoryObject.new()</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Create an inventoryObject item. Use this if you want to specify property values later later.
|
|
|
|
|
The default property values are not disclosed here, since at the time of writing, they are subject to change.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
an InventoryObject
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
|
|
|
|
<a name = "InventoryObject.new"></a>
|
2021-08-23 19:19:36 +01:00
|
|
|
<strong>InventoryObject.new(nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
For more information on each parameter, see the
|
|
|
|
|
associated getters and setters.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">nameKey</span>
|
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
|
|
|
name key
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">slot</span>
|
2021-08-23 19:19:36 +01:00
|
|
|
<span class="types"><span class="type">InvItem</span></span>
|
2021-08-12 20:16:28 +01:00
|
|
|
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)
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">scale</span>
|
|
|
|
|
<span class="types"><span class="type">float</span></span>
|
|
|
|
|
item size (1 being standard size)
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">rot</span>
|
2021-08-23 19:19:36 +01:00
|
|
|
<span class="types"><span class="type">Rotation</span></span>
|
2021-08-12 20:16:28 +01:00
|
|
|
rotation about x, y, and z axes
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">rotAxisWhenCurrent</span>
|
|
|
|
|
<span class="types"><span class="type">RotationAxis</span></span>
|
|
|
|
|
axis to rotate around in inventory
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">meshBits</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
not currently implemented
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">action</span>
|
|
|
|
|
<span class="types"><span class="type">ItemAction</span></span>
|
|
|
|
|
is this usable, equippable, or examinable?
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
an InventoryObject
|
|
|
|
|
</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>
|
2021-08-23 20:16:01 +01:00
|
|
|
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
|
2021-08-12 20:16:28 +01:00
|
|
|
</div> <!-- id="about" -->
|
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
