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

Fixed and regenerated docs.

Browse source
This commit is contained in:
hispidence 2023-02-27 14:33:55 +00:00
parent 52df6dbb10
commit 9cd98757b7
41 changed files with 306 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Documentation/config.ld
View file

@ -12,13 +12,13 @@ new_type("luautil", "5 Lua utility modules", true)
not_luadoc = true
local version = "1.0.6"
local version = "1.0.7"
project = "TombEngine"
title = "TombEngine " .. version .. " Lua API"
description = "TombEngine " .. version .. " scripting interface"
full_description = [[Welcome to the TombEngine scripting API. This is a work in progress and some information might be wrong or outdated. Please also note that this is primarily a reference document, not a tutorial, so expect descriptions to be fairly sparse.
At the time of writing, there is a tutorial describing the basics of Lua, as well as a number of example scripts, on the wiki <a href="https://github.com/Stranger1992/Tomb-Engine-Demo-Levels/wiki">here</a>.
At the time of writing, there is a tutorial describing the basics of Lua, as well as a number of example scripts, on <a href="https://www.tombengine.com">the TombEngine website</a>.
####Module Hierarchy (boring but important)
Other than the "special tables" (GameVars, LevelVars and LevelFuncs), every module described herein is held in a master table called TEN.
For convenience, these modules and classes are automatically put in the global table. For example, you can call GetMoveableByName either of these two ways:

4
Documentation/doc/1 modules/Effects.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -520,7 +520,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Flow.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -661,7 +661,7 @@ Specify which translations in the strings table correspond to which languages.
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Inventory.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -243,7 +243,7 @@ Similar to <a href="../1 modules/Inventory.html#GiveItem">GiveItem</a> but repla
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Logic.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -370,7 +370,7 @@ and provides the delta time (a float representing game time since last call) via
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Misc.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -839,7 +839,7 @@ To be used with <a href="../2 classes/Strings.DisplayString.html#DisplayString:G
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Objects.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -463,7 +463,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/1 modules/Strings.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -171,7 +171,7 @@ with a call to <a href="../1 modules/Strings.html#ShowString">ShowString</a>, or
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.Animations.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -104,7 +104,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.Fog.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -231,7 +231,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

7
Documentation/doc/2 classes/Flow.InventoryItem.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -160,10 +160,11 @@ Z
</li>
<li><span class="parameter">action</span>
<span class="types"><span class="type">ItemAction</span></span>
is this usable, equippable, or examinable?<br/>
is this usable, equippable, combineable or examinable?<br/>
Must be one of:</p>
<pre><code>EQUIP
USE
COMBINE
EXAMINE
</code></pre>
<p>e.g. <code>myItem.action = ItemAction.EXAMINE</code>
@ -188,7 +189,7 @@ EXAMINE
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.Level.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -534,7 +534,7 @@ Must be at least 4.</p>
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.Mirror.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -104,7 +104,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.Settings.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -144,7 +144,7 @@ has an unrecoverable error, the game will close.
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Flow.SkyLayer.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -202,7 +202,7 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

22
Documentation/doc/2 classes/Objects.AIObject.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -105,13 +105,11 @@
</tr>
<tr>
<td class="name" ><a href="#AIObject:GetRotationY">AIObject:GetRotationY()</a></td>
<td class="summary">Get the object's Y-axis rotation
To the best of my knowledge, the rotation of an AIObject has no effect.</td>
<td class="summary">Get the object's Y-axis rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#AIObject:SetRotationY">AIObject:SetRotationY(The)</a></td>
<td class="summary">Set the object's Y-axis rotation
To the best of my knowledge, the rotation of an AIObject has no effect.</td>
<td class="name" ><a href="#AIObject:SetRotationY">AIObject:SetRotationY(rotation)</a></td>
<td class="summary">Set the object's Y-axis rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#AIObject:GetName">AIObject:GetName()</a></td>
@ -199,7 +197,7 @@
<strong>AIObject:GetRotationY()</strong>
</dt>
<dd>
Get the object's Y-axis rotation
Get the object's Y-axis rotation.
To the best of my knowledge, the rotation of an AIObject has no effect.
@ -218,19 +216,19 @@
</dd>
<dt>
<a name = "AIObject:SetRotationY"></a>
<strong>AIObject:SetRotationY(The)</strong>
<strong>AIObject:SetRotationY(rotation)</strong>
</dt>
<dd>
Set the object's Y-axis rotation
Set the object's Y-axis rotation.
To the best of my knowledge, the rotation of an AIObject has no effect.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">The</span>
<li><span class="parameter">rotation</span>
<span class="types"><span class="type">number</span></span>
object's new Y-axis rotation
The object's new Y-axis rotation
</li>
</ul>
@ -407,7 +405,7 @@ aiObj:SetObjectID(TEN.Objects.ObjID.AI_PATROL1)</pre>
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

16
Documentation/doc/2 classes/Objects.Camera.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -125,7 +125,7 @@
This is used in conjunction with SetPosition to teleport the camera to a new room.</td>
</tr>
<tr>
<td class="name" ><a href="#Camera:PlayCamera">Camera:PlayCamera()</a></td>
<td class="name" ><a href="#Camera:PlayCamera">Camera:PlayCamera([Target])</a></td>
<td class="summary">Active the camera during that frame.</td>
</tr>
</table>
@ -290,13 +290,21 @@
</dd>
<dt>
<a name = "Camera:PlayCamera"></a>
<strong>Camera:PlayCamera()</strong>
<strong>Camera:PlayCamera([Target])</strong>
</dt>
<dd>
Active the camera during that frame.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Target</span>
<span class="types"><span class="type">Moveable</span></span>
If you put a moveable, the camera will look at it. Otherwise, it will look at Lara.
(<em>optional</em>)
</li>
</ul>
@ -310,7 +318,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

55
Documentation/doc/2 classes/Objects.LaraObject.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -128,6 +128,14 @@
<td class="summary">Get sprint energy value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:GetAirborne">Moveable:GetAirborne()</a></td>
<td class="summary">Get the moveable's airborne status</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:SetAirborne">Moveable:SetAirborne(New)</a></td>
<td class="summary">Set the moveable's airborne status</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>
@ -376,6 +384,49 @@
<pre class="example"><span class="keyword">local</span> sprintEnergy = Lara:GetSprintEnergy()</pre>
</ul>
</dd>
<dt>
<a name = "Moveable:GetAirborne"></a>
<strong>Moveable:GetAirborne()</strong>
</dt>
<dd>
Get the moveable's airborne status
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">(bool)</span></span>
true if Lara state must react to aerial forces.
</ol>
</dd>
<dt>
<a name = "Moveable:SetAirborne"></a>
<strong>Moveable:SetAirborne(New)</strong>
</dt>
<dd>
Set the moveable's airborne status
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">New</span>
<span class="types"><span class="type">(bool)</span></span>
airborn status for Lara.
</li>
</ul>
</dd>
<dt>
<a name = "LaraObject:UndrawWeapon"></a>
@ -618,7 +669,7 @@ ROCKETLAUNCHER
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

83
Documentation/doc/2 classes/Objects.Moveable.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -186,11 +186,11 @@ associated getters and setters.</td>
<td class="summary">Set OCB (object code bit) of the moveable</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:GetItemFlags">Moveable:GetItemFlags(short)</a></td>
<td class="name" ><a href="#Moveable:GetItemFlags">Moveable:GetItemFlags(index)</a></td>
<td class="summary">Get the value stored in ItemFlags[index]</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:SetItemFlags">Moveable:SetItemFlags(short, short)</a></td>
<td class="name" ><a href="#Moveable:SetItemFlags">Moveable:SetItemFlags(value, index)</a></td>
<td class="summary">Stores a value in ItemFlags[index]</td>
</tr>
<tr>
@ -273,6 +273,14 @@ associated getters and setters.</td>
<td class="name" ><a href="#Moveable:SetHP">Moveable:SetHP(HP)</a></td>
<td class="summary">Set current HP (hit points/health points)
Clamped to [0, 32767] for "intelligent" entities (i.e.</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:GetLocationAI">Moveable:GetLocationAI()</a></td>
<td class="summary">Get the location value stored in the Enemy AI</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:SetLocationAI">Moveable:SetLocationAI(short)</a></td>
<td class="summary">Updates the location in the enemy AI with the given value.</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:GetAIBits">Moveable:GetAIBits()</a></td>
@ -924,7 +932,7 @@ shiva:SetObjectID(TEN.Objects.ObjID.BIGMEDI_ITEM)</pre>
</dd>
<dt>
<a name = "Moveable:GetItemFlags"></a>
<strong>Moveable:GetItemFlags(short)</strong>
<strong>Moveable:GetItemFlags(index)</strong>
</dt>
<dd>
Get the value stored in ItemFlags[index]
@ -933,16 +941,16 @@ shiva:SetObjectID(TEN.Objects.ObjID.BIGMEDI_ITEM)</pre>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">short</span>
<span class="types"><span class="type">index:</span></span>
) index the ItemFlags, can be between 0 and 7.
<li><span class="parameter">index</span>
<span class="types"><span class="type">int</span></span>
of the ItemFlags, can be between 0 and 7.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">(short)</span></span>
<span class="types"><span class="type">int</span></span>
the value contained in the ItemFlags[index]
</ol>
@ -952,7 +960,7 @@ shiva:SetObjectID(TEN.Objects.ObjID.BIGMEDI_ITEM)</pre>
</dd>
<dt>
<a name = "Moveable:SetItemFlags"></a>
<strong>Moveable:SetItemFlags(short, short)</strong>
<strong>Moveable:SetItemFlags(value, index)</strong>
</dt>
<dd>
Stores a value in ItemFlags[index]
@ -961,13 +969,13 @@ shiva:SetObjectID(TEN.Objects.ObjID.BIGMEDI_ITEM)</pre>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">short</span>
<span class="types"><span class="type">index:</span></span>
) index of the ItemFlags where store the value.
<li><span class="parameter">value</span>
<span class="types"><span class="type">short</span></span>
to store in the moveable's ItemFlags[index]
</li>
<li><span class="parameter">short</span>
<span class="types"><span class="type">index:</span></span>
) index of the ItemFlags where store the value.
<li><span class="parameter">index</span>
<span class="types"><span class="type">int</span></span>
of the ItemFlags where store the value.
</li>
</ul>
@ -1433,6 +1441,49 @@ baddy:SetOnCollidedWithRoom(LevelFuncs.roomCollided)</pre>
</dd>
<dt>
<a name = "Moveable:GetLocationAI"></a>
<strong>Moveable:GetLocationAI()</strong>
</dt>
<dd>
Get the location value stored in the Enemy AI
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">(short)</span></span>
the value contained in the LocationAI of the creature.
</ol>
</dd>
<dt>
<a name = "Moveable:SetLocationAI"></a>
<strong>Moveable:SetLocationAI(short)</strong>
</dt>
<dd>
Updates the location in the enemy AI with the given value.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">short</span>
<span class="types"><span class="type">value:</span></span>
) value to store.
</li>
</ul>
</dd>
<dt>
<a name = "Moveable:GetAIBits"></a>
@ -1806,7 +1857,7 @@ sas:SetPosition(destinationPosition, <span class="keyword">false</span>)</pre>
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Objects.Room.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -332,7 +332,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Objects.Sink.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -268,7 +268,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Objects.SoundSource.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -266,7 +266,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Objects.Static.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -552,7 +552,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Objects.Volume.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -429,7 +429,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/2 classes/Strings.DisplayString.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -341,7 +341,7 @@ TEN.Strings.DisplayStringOption.SHADOW -- will give the text a small shadow
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/3 primitive classes/Color.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -320,7 +320,7 @@
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/3 primitive classes/Rotation.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -255,7 +255,7 @@ All values will be clamped to [0.0f, 360.0f].</p>
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/3 primitive classes/Vec3.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -283,7 +283,7 @@ However, this function would return it as (0, 1, 1).
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/4 enums/Effects.BlendID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -150,7 +150,7 @@ ALPHABLEND
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

12
Documentation/doc/4 enums/Effects.EffectID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -113,11 +113,13 @@
<p>The following constants are inside EffectID.</p>
<pre><code>FIRE
<pre><code>NONE
FIRE
SPARKS
SMOKE
ELECTRICDEATH
LASERDEATH
ELECTRICIGNITE
REDIGNITE
CADAVER
CUSTOM
</code></pre>
@ -146,7 +148,7 @@ CUSTOM
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/4 enums/Misc.ActionID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -157,7 +157,7 @@ STEPRIGHT
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/4 enums/Misc.CameraType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -146,7 +146,7 @@ OBJECT
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

11
Documentation/doc/4 enums/Objects.ObjID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -194,7 +194,7 @@ TYRANNOSAUR
COBRA
MONKEY
WHALE
SMALL_DINOSAUR
COMPSOGNATHUS
FISH_EMITTER
RAT
BIG_RAT
@ -288,7 +288,6 @@ DRAGON_BONE_BACK
SPHERE_OF_DOOM
SPHERE_OF_DOOM2
SPHERE_OF_DOOM3
CIVVIE
SPEAR_GUARDIAN
SPEAR_GUARDIAN_STATUE
SWORD_GUARDIAN
@ -322,7 +321,6 @@ WRAITH2
WRAITH3
WRAITH4
LARA_DOUBLE
COMPY
HYDRA
LASERHEAD
SCIENTIST
@ -470,6 +468,7 @@ PUSHABLE_OBJECT_CLIMBABLE10
TRAIN
EXPLOSION
DAMOCLES_SWORD
ELECTRIC_CLEANER
PUZZLE_ITEM1
PUZZLE_ITEM2
PUZZLE_ITEM3
@ -702,6 +701,7 @@ BURNING_TORCH_ITEM
CLOCKWORK_BEETLE
CLOCKWORK_BEETLE_COMBO1
CLOCKWORK_BEETLE_COMBO2
SWITCH_TYPE1
SWITCH_TYPE2
SWITCH_TYPE3
@ -734,6 +734,7 @@ JUMP_SWITCH
CROWBAR_SWITCH
PULLEY
CROWDOVE_SWITCH
MINECART_SWITCH
DOOR_TYPE1
DOOR_TYPE2
DOOR_TYPE3
@ -1312,7 +1313,7 @@ PC_SAVE_INV_ITEM
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/4 enums/Objects.RoomFlagID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -147,7 +147,7 @@ NOLENSFLARE
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/4 enums/Objects.RoomReverb.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -145,7 +145,7 @@ PIPE
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/5 lua utility modules/EventSequence.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -345,7 +345,7 @@ LevelFuncs.SpawnBaddy = <span class="keyword">function</span>(baddy, name, pos)
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
Documentation/doc/5 lua utility modules/Timer.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -518,7 +518,7 @@ LevelFuncs.TriggerTimer = <span class="keyword">function</span>(obj)
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

8
Documentation/doc/index.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.0.6 Lua API</title>
<title>TombEngine 1.0.7 Lua API</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
@ -87,10 +87,10 @@
<div id="content">
<h2>TombEngine 1.0.6 scripting interface</h2>
<h2>TombEngine 1.0.7 scripting interface</h2>
<p>Welcome to the TombEngine scripting API. This is a work in progress and some information might be wrong or outdated. Please also note that this is primarily a reference document, not a tutorial, so expect descriptions to be fairly sparse.</p>
<p>At the time of writing, there is a tutorial describing the basics of Lua, as well as a number of example scripts, on the offical Tomb Engine website: <a href="https://www.TombEngine.com">here</a>.</p>
<p>At the time of writing, there is a tutorial describing the basics of Lua, as well as a number of example scripts, on <a href="https://www.tombengine.com">the TombEngine website</a>.</p>
<h4>Module Hierarchy (boring but important)</h4>
<p>Other than the "special tables" (GameVars, LevelVars and LevelFuncs), every module described herein is held in a master table called TEN.
For convenience, these modules and classes are automatically put in the global table. For example, you can call GetMoveableByName either of these two ways:</p>
@ -273,7 +273,7 @@ local door = GetMoveableByName("door_type4_14")
</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 2023-01-29 18:57:43 </i>
<i style="float:right;">Last updated 2023-02-27 14:31:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

96
Documentation/output.xml
View file

@ -707,10 +707,11 @@ e.g. `myItem.rotAxisWhenCurrent = RotationAxis.X`</description>
<parameter>
<name>action</name>
<type>ItemAction</type>
<description>is this usable, equippable, or examinable?<br/>
<description>is this usable, equippable, combineable or examinable?<br/>
Must be one of:
EQUIP
USE
COMBINE
EXAMINE
e.g. `myItem.action = ItemAction.EXAMINE`</description>
</parameter>
@ -1308,8 +1309,8 @@ eyes of the creatures would be.</description>
<module>Objects.AIObject</module>
<caller>AIObject</caller>
<name>GetRotationY</name>
<summary>Get the object's Y-axis rotation
To the best of my knowledge, the rotation of an AIObject has no effect.</summary>
<summary>Get the object's Y-axis rotation.</summary>
<description>To the best of my knowledge, the rotation of an AIObject has no effect.</description>
<returns>
<return>
<type>number</type>
@ -1322,13 +1323,13 @@ eyes of the creatures would be.</description>
<module>Objects.AIObject</module>
<caller>AIObject</caller>
<name>SetRotationY</name>
<summary>Set the object's Y-axis rotation
To the best of my knowledge, the rotation of an AIObject has no effect.</summary>
<summary>Set the object's Y-axis rotation.</summary>
<description>To the best of my knowledge, the rotation of an AIObject has no effect.</description>
<parameters>
<parameter>
<name>The</name>
<name>rotation</name>
<type>number</type>
<description>object's new Y-axis rotation</description>
<description>The object's new Y-axis rotation</description>
</parameter>
</parameters>
</function>
@ -1534,6 +1535,13 @@ eyes of the creatures would be.</description>
<caller>Camera</caller>
<name>PlayCamera</name>
<summary>Active the camera during that frame.</summary>
<parameters>
<parameter>
<name>Target</name>
<type>Moveable</type>
<description>If you put a moveable, the camera will look at it. Otherwise, it will look at Lara.</description>
</parameter>
</parameters>
</function>
<function>
@ -1644,6 +1652,33 @@ eyes of the creatures would be.</description>
</returns>
</function>
<function>
<module>Objects.LaraObject</module>
<caller>Moveable</caller>
<name>GetAirborne</name>
<summary>Get the moveable's airborne status</summary>
<returns>
<return>
<type>(bool)</type>
<description>true if Lara state must react to aerial forces.</description>
</return>
</returns>
</function>
<function>
<module>Objects.LaraObject</module>
<caller>Moveable</caller>
<name>SetAirborne</name>
<summary>Set the moveable's airborne status</summary>
<parameters>
<parameter>
<name>New</name>
<type>(bool)</type>
<description>airborn status for Lara.</description>
</parameter>
</parameters>
</function>
<function>
<module>Objects.LaraObject</module>
<caller>LaraObject</caller>
@ -2154,14 +2189,14 @@ most can just be ignored (see usage).</description>
<summary>Get the value stored in ItemFlags[index]</summary>
<parameters>
<parameter>
<name>short</name>
<type>index:</type>
<description>) index the ItemFlags, can be between 0 and 7.</description>
<name>index</name>
<type>int</type>
<description>of the ItemFlags, can be between 0 and 7.</description>
</parameter>
</parameters>
<returns>
<return>
<type>(short)</type>
<type>int</type>
<description>the value contained in the ItemFlags[index]</description>
</return>
</returns>
@ -2174,14 +2209,14 @@ most can just be ignored (see usage).</description>
<summary>Stores a value in ItemFlags[index]</summary>
<parameters>
<parameter>
<name>short</name>
<type>value:</type>
<description>) index of the ItemFlags where store the value.</description>
<name>value</name>
<type>short</type>
<description>to store in the moveable's ItemFlags[index]</description>
</parameter>
<parameter>
<name>short</name>
<type>index:</type>
<description>) index of the ItemFlags where store the value.</description>
<name>index</name>
<type>int</type>
<description>of the ItemFlags where store the value.</description>
</parameter>
</parameters>
</function>
@ -2489,6 +2524,33 @@ most can just be ignored (see usage).</description>
</parameters>
</function>
<function>
<module>Objects.Moveable</module>
<caller>Moveable</caller>
<name>GetLocationAI</name>
<summary>Get the location value stored in the Enemy AI</summary>
<returns>
<return>
<type>(short)</type>
<description>the value contained in the LocationAI of the creature.</description>
</return>
</returns>
</function>
<function>
<module>Objects.Moveable</module>
<caller>Moveable</caller>
<name>SetLocationAI</name>
<summary>Updates the location in the enemy AI with the given value.</summary>
<parameters>
<parameter>
<name>short</name>
<type>value:</type>
<description>) value to store.</description>
</parameter>
</parameters>
</function>
<function>
<module>Objects.Moveable</module>
<caller>Moveable</caller>

6
TombEngine/Scripting/Internal/TEN/Objects/AIObject/AIObject.cpp
View file

@ -36,16 +36,16 @@ void AIObject::Register(sol::table & parent)
// @tparam Vec3 position the new position of the object
ScriptReserved_SetPosition, &AIObject::SetPos,
/// Get the object's Y-axis rotation
/// Get the object's Y-axis rotation.
// To the best of my knowledge, the rotation of an AIObject has no effect.
// @function AIObject:GetRotationY
// @treturn number the object's Y-axis rotation
ScriptReserved_GetRotationY, &AIObject::GetYRot,
/// Set the object's Y-axis rotation
/// Set the object's Y-axis rotation.
// To the best of my knowledge, the rotation of an AIObject has no effect.
// @function AIObject:SetRotationY
// @tparam number The object's new Y-axis rotation
// @tparam number rotation The object's new Y-axis rotation
ScriptReserved_SetRotationY, &AIObject::SetYRot,
/// Get the object's unique string identifier

2
TombEngine/Scripting/Internal/TEN/Objects/Camera/CameraObject.cpp
View file

@ -67,7 +67,7 @@ void CameraObject::Register(sol::table & parent)
/// Active the camera during that frame.
// @function Camera:PlayCamera
// @tparam sol::optional<Moveable&> (optional) If you put a moveable, the camera will look at it. Otherwise, it will look at Lara.
// @tparam[opt] Moveable Target If you put a moveable, the camera will look at it. Otherwise, it will look at Lara.
ScriptReserved_PlayCamera, &CameraObject::PlayCamera
);
}