Skip to content

Commit 0ed73c5

Browse files
Jakub768Jakub768
committed
Update to TEN 1.5
1 parent baeda32 commit 0ed73c5

Some content is hidden

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

52 files changed

+1415
-238
lines changed

‎1 modules/Effects.html‎

Lines changed: 3 additions & 1 deletion
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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>

‎1 modules/Flow.html‎

Lines changed: 60 additions & 7 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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
@@ -129,6 +131,10 @@ <h2><a href="#gameflow_lua">gameflow.lua </a></h2>
129131
<td class="summary">Enable or disable level selection in title flyby.</td>
130132
</tr>
131133
<tr>
134+
<td class="name" ><a href="#EnableHomeLevel">EnableHomeLevel(enabled)</a></td>
135+
<td class="summary">Enable or disable Home Level entry in the main menu.</td>
136+
</tr>
137+
<tr>
132138
<td class="name" ><a href="#EnableLoadSave">EnableLoadSave(enabled)</a></td>
133139
<td class="summary">Enable or disable saving and loading of savegames.</td>
134140
</tr>
@@ -137,7 +143,7 @@ <h2><a href="#gameflow_lua_or_level_scripts">gameflow.lua or level scripts </a><
137143
<table class="function_list">
138144
<tr>
139145
<td class="name" ><a href="#EnableFlyCheat">EnableFlyCheat(enabled)</a></td>
140-
<td class="summary">Enable or disable DOZY mode (fly cheat).</td>
146+
<td class="summary">Enable or disable the fly cheat.</td>
141147
</tr>
142148
<tr>
143149
<td class="name" ><a href="#EnablePointFilter">EnablePointFilter(enabled)</a></td>
@@ -230,6 +236,10 @@ <h2><a href="#strings_lua">strings.lua </a></h2>
230236
<td class="summary">Get translated string.</td>
231237
</tr>
232238
<tr>
239+
<td class="name" ><a href="#IsStringPresent">IsStringPresent(string)</a></td>
240+
<td class="summary">Check if translated string is present.</td>
241+
</tr>
242+
<tr>
233243
<td class="name" ><a href="#SetLanguageNames">SetLanguageNames(table)</a></td>
234244
<td class="summary">Set language names for translations.</td>
235245
</tr>
@@ -361,21 +371,43 @@ <h3>Parameters:</h3>
361371

362372

363373

374+
</dd>
375+
<dt>
376+
<a name = "EnableHomeLevel"></a>
377+
<strong>EnableHomeLevel(enabled)</strong>
378+
</dt>
379+
<dd>
380+
Enable or disable Home Level entry in the main menu. ()
381+
382+
383+
384+
<h3>Parameters:</h3>
385+
<ul>
386+
<li><span class="parameter">enabled</span>
387+
<span class="types"><span class="type">bool</span></span>
388+
True or false.
389+
</li>
390+
</ul>
391+
392+
393+
394+
395+
364396
</dd>
365397
<dt>
366398
<a name = "EnableLoadSave"></a>
367399
<strong>EnableLoadSave(enabled)</strong>
368400
</dt>
369401
<dd>
370-
Enable or disable saving and loading of savegames.
402+
Enable or disable saving and loading of savegames. ()
371403

372404

373405

374406
<h3>Parameters:</h3>
375407
<ul>
376408
<li><span class="parameter">enabled</span>
377409
<span class="types"><span class="type">bool</span></span>
378-
true or false.
410+
True or false.
379411
</li>
380412
</ul>
381413

@@ -393,16 +425,15 @@ <h2 class="section-header "><a name="gameflow_lua_or_level_scripts"></a>gameflow
393425
<strong>EnableFlyCheat(enabled)</strong>
394426
</dt>
395427
<dd>
396-
Enable or disable DOZY mode (fly cheat).
397-
Must be true or false
428+
Enable or disable the fly cheat. ()
398429

399430

400431

401432
<h3>Parameters:</h3>
402433
<ul>
403434
<li><span class="parameter">enabled</span>
404435
<span class="types"><span class="type">bool</span></span>
405-
true or false
436+
True or false.
406437
</li>
407438
</ul>
408439

@@ -902,6 +933,28 @@ <h3>Parameters:</h3>
902933

903934

904935

936+
</dd>
937+
<dt>
938+
<a name = "IsStringPresent"></a>
939+
<strong>IsStringPresent(string)</strong>
940+
</dt>
941+
<dd>
942+
Check if translated string is present.
943+
944+
945+
946+
<h3>Parameters:</h3>
947+
<ul>
948+
<li><span class="parameter">string</span>
949+
<span class="types"><span class="type">key</span></span>
950+
key for translated string
951+
</li>
952+
</ul>
953+
954+
955+
956+
957+
905958
</dd>
906959
<dt>
907960
<a name = "SetLanguageNames"></a>

‎1 modules/Input.html‎

Lines changed: 22 additions & 1 deletion
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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
@@ -129,6 +131,10 @@ <h2><a href="#Functions">Functions</a></h2>
129131
<td class="summary">Clear an action key.</td>
130132
</tr>
131133
<tr>
134+
<td class="name" ><a href="#KeyClearAll">KeyClearAll()</a></td>
135+
<td class="summary">Clear all action keys.</td>
136+
</tr>
137+
<tr>
132138
<td class="name" ><a href="#GetMouseDisplayPosition">GetMouseDisplayPosition()</a></td>
133139
<td class="summary">Get the display position of the cursor in percent.</td>
134140
</tr>
@@ -254,6 +260,21 @@ <h3>Parameters:</h3>
254260

255261

256262

263+
</dd>
264+
<dt>
265+
<a name = "KeyClearAll"></a>
266+
<strong>KeyClearAll()</strong>
267+
</dt>
268+
<dd>
269+
Clear all action keys.
270+
271+
272+
273+
274+
275+
276+
277+
257278
</dd>
258279
<dt>
259280
<a name = "GetMouseDisplayPosition"></a>

‎1 modules/Inventory.html‎

Lines changed: 79 additions & 1 deletion
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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
@@ -124,6 +126,18 @@ <h2><a href="#Functions">Functions</a></h2>
124126
<td class="name" ><a href="#SetItemCount">SetItemCount(objectID, count)</a></td>
125127
<td class="summary">Set the amount of an item in the player's inventory.</td>
126128
</tr>
129+
<tr>
130+
<td class="name" ><a href="#GetUsedItem">GetUsedItem()</a></td>
131+
<td class="summary">Get last item used in the player's inventory.</td>
132+
</tr>
133+
<tr>
134+
<td class="name" ><a href="#SetUsedItem">SetUsedItem(objectID)</a></td>
135+
<td class="summary">Set last item used in the player's inventory.</td>
136+
</tr>
137+
<tr>
138+
<td class="name" ><a href="#ClearUsedItem">ClearUsedItem()</a></td>
139+
<td class="summary">Clear last item used in the player's inventory.</td>
140+
</tr>
127141
</table>
128142

129143
<br/>
@@ -245,6 +259,70 @@ <h3>Parameters:</h3>
245259

246260

247261

262+
</dd>
263+
<dt>
264+
<a name = "GetUsedItem"></a>
265+
<strong>GetUsedItem()</strong>
266+
</dt>
267+
<dd>
268+
Get last item used in the player's inventory.
269+
This value will be valid only for a single frame after exiting inventory, after which Lara says "No".
270+
Therefore, this function must be preferably used either in OnLoop or OnUseItem events.
271+
272+
273+
274+
275+
<h3>Returns:</h3>
276+
<ol>
277+
278+
<span class="types"><a class="type" href="../4 enums/Objects.ObjID.html#">ObjID</a></span>
279+
Last item used in the inventory.
280+
</ol>
281+
282+
283+
284+
285+
</dd>
286+
<dt>
287+
<a name = "SetUsedItem"></a>
288+
<strong>SetUsedItem(objectID)</strong>
289+
</dt>
290+
<dd>
291+
Set last item used in the player's inventory.
292+
You will be able to specify only objects which already exist in the inventory.
293+
Will only be valid for the next frame. If not processed by the game, Lara will say "No".
294+
295+
296+
297+
<h3>Parameters:</h3>
298+
<ul>
299+
<li><span class="parameter">objectID</span>
300+
<span class="types"><a class="type" href="../4 enums/Objects.ObjID.html#">ObjID</a></span>
301+
Object ID of the item to select from inventory.
302+
</li>
303+
</ul>
304+
305+
306+
307+
308+
309+
</dd>
310+
<dt>
311+
<a name = "ClearUsedItem"></a>
312+
<strong>ClearUsedItem()</strong>
313+
</dt>
314+
<dd>
315+
Clear last item used in the player's inventory.
316+
When this function is used in OnUseItem level function, it allows to override existing item functionality.
317+
For items without existing functionality, this function is needed to avoid Lara saying "No" after using it.
318+
319+
320+
321+
322+
323+
324+
325+
248326
</dd>
249327
</dl>
250328

‎1 modules/Logic.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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
@@ -263,7 +265,8 @@ <h3>Usage:</h3>
263265
SAVE
264266
START
265267
END
266-
LOOP</pre>
268+
LOOP
269+
USEITEM</pre>
267270

268271

269272
<h3>Parameters:</h3>

‎1 modules/Objects.html‎

Lines changed: 3 additions & 1 deletion
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.4 Lua API</title>
6+
<title>TombEngine 1.5 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -49,10 +49,12 @@ <h2>2 Classes</h2>
4949
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
5050
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
5151
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52+
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5253
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
5354
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5455
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
5556
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57+
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
5658
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5759
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
5860
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>

0 commit comments

Comments
 (0)