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

Regenerated docs with version bumped to 1.0.8.

Browse source
This commit is contained in:
hispidence 2023-03-24 18:27:38 +00:00
parent cdf8f0b8ec
commit 71d2d047b1
39 changed files with 143 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Documentation/config.ld
View file

@ -12,7 +12,7 @@ new_type("luautil", "5 Lua utility modules", true)
not_luadoc = true
local version = "1.0.7"
local version = "1.0.8"
project = "TombEngine"
title = "TombEngine " .. version .. " Lua API"
description = "TombEngine " .. version .. " scripting interface"

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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

30
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -144,6 +144,10 @@
<td class="summary">Play sound effect</td>
</tr>
<tr>
<td class="name" ><a href="#IsSoundPlaying">IsSoundPlaying(Sound)</a></td>
<td class="summary">Check if the sound effect is playing</td>
</tr>
<tr>
<td class="name" ><a href="#FlipMap">FlipMap(flipmap)</a></td>
<td class="summary">Do FlipMap with specific ID</td>
</tr>
@ -509,6 +513,28 @@ eyes of the creatures would be.
</dd>
<dt>
<a name = "IsSoundPlaying"></a>
<strong>IsSoundPlaying(Sound)</strong>
</dt>
<dd>
Check if the sound effect is playing
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Sound</span>
<span class="types"><span class="type">int</span></span>
ID to check. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
</li>
</ul>
</dd>
<dt>
<a name = "FlipMap"></a>
@ -839,7 +865,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -189,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -405,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -318,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

40
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -96,8 +96,8 @@
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#LaraObject:SetPoison">LaraObject:SetPoison([Potency])</a></td>
<td class="summary">Set Lara poison potency</td>
<td class="name" ><a href="#LaraObject:SetPoison">LaraObject:SetPoison([Poison])</a></td>
<td class="summary">Set Lara poison</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetPoison">LaraObject:GetPoison()</a></td>
@ -120,12 +120,12 @@
<td class="summary">Get wetness value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:SetSprintEnergy">LaraObject:SetSprintEnergy(sprint)</a></td>
<td class="name" ><a href="#LaraObject:SetStamina">LaraObject:SetStamina(stamina)</a></td>
<td class="summary">Set sprint energy value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#LaraObject:GetSprintEnergy">LaraObject:GetSprintEnergy()</a></td>
<td class="summary">Get sprint energy value of Lara</td>
<td class="name" ><a href="#LaraObject:GetStamina">LaraObject:GetStamina()</a></td>
<td class="summary">Get stamina value of Lara</td>
</tr>
<tr>
<td class="name" ><a href="#Moveable:GetAirborne">Moveable:GetAirborne()</a></td>
@ -182,18 +182,18 @@
<dl class="function">
<dt>
<a name = "LaraObject:SetPoison"></a>
<strong>LaraObject:SetPoison([Potency])</strong>
<strong>LaraObject:SetPoison([Poison])</strong>
</dt>
<dd>
Set Lara poison potency
Set Lara poison
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Potency</span>
<li><span class="parameter">Poison</span>
<span class="types"><span class="type">int</span></span>
; maximum value is 64 (default 0)
; maximum value is 128 (default 0)
(<em>optional</em>)
</li>
</ul>
@ -335,8 +335,8 @@
</dd>
<dt>
<a name = "LaraObject:SetSprintEnergy"></a>
<strong>LaraObject:SetSprintEnergy(sprint)</strong>
<a name = "LaraObject:SetStamina"></a>
<strong>LaraObject:SetStamina(stamina)</strong>
</dt>
<dd>
Set sprint energy value of Lara
@ -345,9 +345,9 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">sprint</span>
<li><span class="parameter">stamina</span>
<span class="types"><span class="type">int</span></span>
energy to give to Lara; maximum value is 120.
to give to Lara; maximum value is 120.
</li>
</ul>
@ -356,16 +356,16 @@
<h3>Usage:</h3>
<ul>
<pre class="example">Lara:SetSprintEnergy(<span class="number">120</span>)</pre>
<pre class="example">Lara:SetStamina(<span class="number">120</span>)</pre>
</ul>
</dd>
<dt>
<a name = "LaraObject:GetSprintEnergy"></a>
<strong>LaraObject:GetSprintEnergy()</strong>
<a name = "LaraObject:GetStamina"></a>
<strong>LaraObject:GetStamina()</strong>
</dt>
<dd>
Get sprint energy value of Lara
Get stamina value of Lara
@ -381,7 +381,7 @@
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> sprintEnergy = Lara:GetSprintEnergy()</pre>
<pre class="example"><span class="keyword">local</span> sprintEnergy = Lara:GetStamina()</pre>
</ul>
</dd>
@ -669,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -1857,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -148,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

6
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -340,6 +340,7 @@ LAGOON_WITCH
BOSS_SHIELD
BOSS_EXPLOSION_SHOCKWAVE
BOSS_EXPLOSION_RING
WASP_MUTANT
SPRINGBOARD
ROLLING_SPINDLE
DISK_SHOOTER
@ -469,6 +470,7 @@ TRAIN
EXPLOSION
DAMOCLES_SWORD
ELECTRIC_CLEANER
SLAMMING_DOORS
PUZZLE_ITEM1
PUZZLE_ITEM2
PUZZLE_ITEM3
@ -1313,7 +1315,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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25: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.7 Lua API</title>
<title>TombEngine 1.0.8 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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

6
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.7 Lua API</title>
<title>TombEngine 1.0.8 Lua API</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
@ -87,7 +87,7 @@
<div id="content">
<h2>TombEngine 1.0.7 scripting interface</h2>
<h2>TombEngine 1.0.8 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 <a href="https://www.tombengine.com">the TombEngine website</a>.</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-02-27 14:31:34 </i>
<i style="float:right;">Last updated 2023-03-24 18:25:34 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

29
Documentation/output.xml
View file

@ -1071,6 +1071,19 @@ eyes of the creatures would be.</description>
</parameters>
</function>
<function>
<module>Misc</module>
<name>IsSoundPlaying</name>
<summary>Check if the sound effect is playing</summary>
<parameters>
<parameter>
<name>Sound</name>
<type>int</type>
<description>ID to check. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.</description>
</parameter>
</parameters>
</function>
<function>
<module>Misc</module>
<name>FlipMap</name>
@ -1548,12 +1561,12 @@ eyes of the creatures would be.</description>
<module>Objects.LaraObject</module>
<caller>LaraObject</caller>
<name>SetPoison</name>
<summary>Set Lara poison potency</summary>
<summary>Set Lara poison</summary>
<parameters>
<parameter>
<name>Potency</name>
<name>Poison</name>
<type>int</type>
<description>; maximum value is 64 (default 0)</description>
<description>; maximum value is 128 (default 0)</description>
</parameter>
</parameters>
</function>
@ -1628,13 +1641,13 @@ eyes of the creatures would be.</description>
<function>
<module>Objects.LaraObject</module>
<caller>LaraObject</caller>
<name>SetSprintEnergy</name>
<name>SetStamina</name>
<summary>Set sprint energy value of Lara</summary>
<parameters>
<parameter>
<name>sprint</name>
<name>stamina</name>
<type>int</type>
<description>energy to give to Lara; maximum value is 120.</description>
<description>to give to Lara; maximum value is 120.</description>
</parameter>
</parameters>
</function>
@ -1642,8 +1655,8 @@ eyes of the creatures would be.</description>
<function>
<module>Objects.LaraObject</module>
<caller>LaraObject</caller>
<name>GetSprintEnergy</name>
<summary>Get sprint energy value of Lara</summary>
<name>GetStamina</name>
<summary>Get stamina value of Lara</summary>
<returns>
<return>
<type>int</type>