Skip to content

Commit 79d6d2e

Browse files
Jakub768Jakub768
committed
Update docs to TEN 1.3
1 parent 5d7cb13 commit 79d6d2e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1298
-233
lines changed

‎1 modules/Effects.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>TombEngine 1.2 Lua API</title>
6+
<title>TombEngine 1.3 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -75,15 +75,18 @@ <h2>4 Enums</h2>
7575
<ul class="nowrap">
7676
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7777
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
78+
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
7879
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
7980
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
81+
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
8082
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
8183
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8284
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
8385
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
8486
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
8587
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
8688
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
89+
<li> <a href="../4 enums/View.PostProcessMode.html">View.PostProcessMode</a></li>
8790
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
8891
</ul>
8992
<h2>5 Lua utility modules</h2>
@@ -500,7 +503,7 @@ <h3>Parameters:</h3>
500503
</div> <!-- id="main" -->
501504
<div id="about">
502505
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
503-
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
506+
<i style="float:right;">Last updated 2024-01-07 13:18:42 </i>
504507
</div> <!-- id="about" -->
505508
</div> <!-- id="container" -->
506509
</body>

‎1 modules/Flow.html‎

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>TombEngine 1.2 Lua API</title>
6+
<title>TombEngine 1.3 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -75,15 +75,18 @@ <h2>4 Enums</h2>
7575
<ul class="nowrap">
7676
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7777
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
78+
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
7879
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
7980
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
81+
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
8082
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
8183
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8284
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
8385
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
8486
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
8587
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
8688
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
89+
<li> <a href="../4 enums/View.PostProcessMode.html">View.PostProcessMode</a></li>
8790
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
8891
</ul>
8992
<h2>5 Lua utility modules</h2>
@@ -153,8 +156,12 @@ <h2><a href="#gameflow_lua_or_level_scripts">gameflow.lua or level scripts </a><
153156
<td class="summary">Returns the level that the game control is running in that moment.</td>
154157
</tr>
155158
<tr>
156-
<td class="name" ><a href="#EndLevel">EndLevel([index])</a></td>
157-
<td class="summary">Finishes the current level, with optional level index provided.</td>
159+
<td class="name" ><a href="#EndLevel">EndLevel([index][, startPos])</a></td>
160+
<td class="summary">Finishes the current level, with optional level index and start position index provided.</td>
161+
</tr>
162+
<tr>
163+
<td class="name" ><a href="#GetGameStatus">GetGameStatus()</a></td>
164+
<td class="summary">Get current game status, such as normal game loop, exiting to title, etc.</td>
158165
</tr>
159166
<tr>
160167
<td class="name" ><a href="#SaveGame">SaveGame(slotID)</a></td>
@@ -495,12 +502,13 @@ <h3>Returns:</h3>
495502
</dd>
496503
<dt>
497504
<a name = "EndLevel"></a>
498-
<strong>EndLevel([index])</strong>
505+
<strong>EndLevel([index][, startPos])</strong>
499506
</dt>
500507
<dd>
501-
Finishes the current level, with optional level index provided. If level index
502-
is not provided or is zero, jumps to next level. If level index is more than
503-
level count, jumps to title.
508+
Finishes the current level, with optional level index and start position index provided.
509+
If level index is not provided or is zero, jumps to next level. If level index is more than
510+
level count, jumps to title. If LARA_START_POS objects are present in level, player will be
511+
teleported to such object with OCB similar to provided second argument.
504512

505513

506514

@@ -511,12 +519,38 @@ <h3>Parameters:</h3>
511519
level index (default 0)
512520
(<em>optional</em>)
513521
</li>
522+
<li><span class="parameter">startPos</span>
523+
<span class="types"><span class="type">int</span></span>
524+
player start position (default 0)
525+
(<em>optional</em>)
526+
</li>
514527
</ul>
515528

516529

517530

518531

519532

533+
</dd>
534+
<dt>
535+
<a name = "GetGameStatus"></a>
536+
<strong>GetGameStatus()</strong>
537+
</dt>
538+
<dd>
539+
Get current game status, such as normal game loop, exiting to title, etc.
540+
541+
542+
543+
544+
<h3>Returns:</h3>
545+
<ol>
546+
547+
<span class="types"><a class="type" href="../4 enums/Flow.GameStatus.html#">GameStatus</a></span>
548+
the current game status
549+
</ol>
550+
551+
552+
553+
520554
</dd>
521555
<dt>
522556
<a name = "SaveGame"></a>
@@ -840,7 +874,7 @@ <h3>Parameters:</h3>
840874
</div> <!-- id="main" -->
841875
<div id="about">
842876
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
843-
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
877+
<i style="float:right;">Last updated 2024-01-07 13:18:42 </i>
844878
</div> <!-- id="about" -->
845879
</div> <!-- id="container" -->
846880
</body>

‎1 modules/Input.html‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>TombEngine 1.2 Lua API</title>
6+
<title>TombEngine 1.3 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -75,15 +75,18 @@ <h2>4 Enums</h2>
7575
<ul class="nowrap">
7676
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7777
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
78+
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
7879
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
7980
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
81+
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
8082
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
8183
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8284
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
8385
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
8486
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
8587
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
8688
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
89+
<li> <a href="../4 enums/View.PostProcessMode.html">View.PostProcessMode</a></li>
8790
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
8891
</ul>
8992
<h2>5 Lua utility modules</h2>
@@ -126,7 +129,7 @@ <h2><a href="#Functions">Functions</a></h2>
126129
<td class="summary">Clear an action key.</td>
127130
</tr>
128131
<tr>
129-
<td class="name" ><a href="#GetCursorDisplayPosition">GetCursorDisplayPosition()</a></td>
132+
<td class="name" ><a href="#GetMouseDisplayPosition">GetMouseDisplayPosition()</a></td>
130133
<td class="summary">Get the display position of the cursor in percent.</td>
131134
</tr>
132135
</table>
@@ -253,8 +256,8 @@ <h3>Parameters:</h3>
253256

254257
</dd>
255258
<dt>
256-
<a name = "GetCursorDisplayPosition"></a>
257-
<strong>GetCursorDisplayPosition()</strong>
259+
<a name = "GetMouseDisplayPosition"></a>
260+
<strong>GetMouseDisplayPosition()</strong>
258261
</dt>
259262
<dd>
260263
Get the display position of the cursor in percent. ()
@@ -280,7 +283,7 @@ <h3>Returns:</h3>
280283
</div> <!-- id="main" -->
281284
<div id="about">
282285
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
283-
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
286+
<i style="float:right;">Last updated 2024-01-07 13:18:42 </i>
284287
</div> <!-- id="about" -->
285288
</div> <!-- id="container" -->
286289
</body>

‎1 modules/Inventory.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>TombEngine 1.2 Lua API</title>
6+
<title>TombEngine 1.3 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -75,15 +75,18 @@ <h2>4 Enums</h2>
7575
<ul class="nowrap">
7676
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7777
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
78+
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
7879
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
7980
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
81+
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
8082
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
8183
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8284
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
8385
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
8486
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
8587
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
8688
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
89+
<li> <a href="../4 enums/View.PostProcessMode.html">View.PostProcessMode</a></li>
8790
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
8891
</ul>
8992
<h2>5 Lua utility modules</h2>
@@ -250,7 +253,7 @@ <h3>Parameters:</h3>
250253
</div> <!-- id="main" -->
251254
<div id="about">
252255
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
253-
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
256+
<i style="float:right;">Last updated 2024-01-07 13:18:42 </i>
254257
</div> <!-- id="about" -->
255258
</div> <!-- id="container" -->
256259
</body>

0 commit comments

Comments
 (0)