Skip to content

Commit 48b123a

Browse files
Jakub768Jakub768
committed
update docs
1 parent 05e379e commit 48b123a

40 files changed

+377
-96
lines changed

‎1 modules/Effects.html‎

Lines changed: 4 additions & 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -506,7 +507,7 @@ <h3>Parameters:</h3>
506507
</li>
507508
<li><span class="parameter">speed</span>
508509
<span class="types"><span class="type">float</span></span>
509-
(default 1.0). Speed in "amount" per second. A value of 1 will make the flash take one second. Clamped to [0.005, 1.0]
510+
(default 1.0). Speed in "amount" per second. Value of 1 will make flash take one second. Clamped to [0.005, 1.0].
510511
</li>
511512
</ul>
512513

@@ -522,7 +523,7 @@ <h3>Parameters:</h3>
522523
</div> <!-- id="main" -->
523524
<div id="about">
524525
<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>
525-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
526+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
526527
</div> <!-- id="about" -->
527528
</div> <!-- id="container" -->
528529
</body>

‎1 modules/Flow.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -669,7 +670,7 @@ <h3>Parameters:</h3>
669670
</div> <!-- id="main" -->
670671
<div id="about">
671672
<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>
672-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
673+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
673674
</div> <!-- id="about" -->
674675
</div> <!-- id="container" -->
675676
</body>

‎1 modules/Inventory.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -245,7 +246,7 @@ <h3>Parameters:</h3>
245246
</div> <!-- id="main" -->
246247
<div id="about">
247248
<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>
248-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
249+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
249250
</div> <!-- id="about" -->
250251
</div> <!-- id="container" -->
251252
</body>

‎1 modules/Logic.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -408,7 +409,7 @@ <h3>Fields:</h3>
408409
</div> <!-- id="main" -->
409410
<div id="about">
410411
<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>
411-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
412+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
412413
</div> <!-- id="about" -->
413414
</div> <!-- id="container" -->
414415
</body>

‎1 modules/Misc.html‎

Lines changed: 98 additions & 12 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -126,7 +127,7 @@ <h2><a href="#Functions">Functions</a></h2>
126127
<td class="summary">Shows the mode of the game camera.</td>
127128
</tr>
128129
<tr>
129-
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack(name, loop)</a></td>
130+
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack(name, type)</a></td>
130131
<td class="summary">Play an audio track</td>
131132
</tr>
132133
<tr>
@@ -138,10 +139,18 @@ <h2><a href="#Functions">Functions</a></h2>
138139
<td class="summary">Stop any audio tracks currently playing</td>
139140
</tr>
140141
<tr>
141-
<td class="name" ><a href="#StopAudioTrack">StopAudioTrack(looped)</a></td>
142+
<td class="name" ><a href="#StopAudioTrack">StopAudioTrack(type)</a></td>
142143
<td class="summary">Stop audio track that is currently playing</td>
143144
</tr>
144145
<tr>
146+
<td class="name" ><a href="#GetAudioTrackLoudness">GetAudioTrackLoudness(type)</a></td>
147+
<td class="summary">Get current loudness level for specified track type</td>
148+
</tr>
149+
<tr>
150+
<td class="name" ><a href="#GetCurrentSubtitle">GetCurrentSubtitle()</a></td>
151+
<td class="summary">Get current subtitle string for a voice track currently playing.</td>
152+
</tr>
153+
<tr>
145154
<td class="name" ><a href="#PlaySound">PlaySound(sound[, position])</a></td>
146155
<td class="summary">Play sound effect</td>
147156
</tr>
@@ -150,6 +159,10 @@ <h2><a href="#Functions">Functions</a></h2>
150159
<td class="summary">Check if the sound effect is playing</td>
151160
</tr>
152161
<tr>
162+
<td class="name" ><a href="#IsAudioTrackPlaying">IsAudioTrackPlaying(Track)</a></td>
163+
<td class="summary">Check if the audio track is playing</td>
164+
</tr>
165+
<tr>
153166
<td class="name" ><a href="#FlipMap">FlipMap(flipmap)</a></td>
154167
<td class="summary">Do FlipMap with specific ID</td>
155168
</tr>
@@ -410,7 +423,7 @@ <h3>Usage:</h3>
410423
</dd>
411424
<dt>
412425
<a name = "PlayAudioTrack"></a>
413-
<strong>PlayAudioTrack(name, loop)</strong>
426+
<strong>PlayAudioTrack(name, type)</strong>
414427
</dt>
415428
<dd>
416429
Play an audio track
@@ -423,9 +436,9 @@ <h3>Parameters:</h3>
423436
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
424437
of track (without file extension) to play
425438
</li>
426-
<li><span class="parameter">loop</span>
427-
<span class="types"><span class="type">bool</span></span>
428-
if true, the track will loop; if false, it won't (default: false)
439+
<li><span class="parameter">type</span>
440+
<span class="types"><a class="type" href="../4 enums/Misc.SoundTrackType.html#">SoundTrackType</a></span>
441+
of the audio track to play
429442
</li>
430443
</ul>
431444

@@ -473,7 +486,7 @@ <h3>Parameters:</h3>
473486
</dd>
474487
<dt>
475488
<a name = "StopAudioTrack"></a>
476-
<strong>StopAudioTrack(looped)</strong>
489+
<strong>StopAudioTrack(type)</strong>
477490
</dt>
478491
<dd>
479492
Stop audio track that is currently playing
@@ -482,16 +495,67 @@ <h3>Parameters:</h3>
482495

483496
<h3>Parameters:</h3>
484497
<ul>
485-
<li><span class="parameter">looped</span>
486-
<span class="types"><span class="type">bool</span></span>
487-
if set, stop looped audio track, if not, stop one-shot audio track
498+
<li><span class="parameter">type</span>
499+
<span class="types"><a class="type" href="../4 enums/Misc.SoundTrackType.html#">SoundTrackType</a></span>
500+
of the audio track
488501
</li>
489502
</ul>
490503

491504

492505

493506

494507

508+
</dd>
509+
<dt>
510+
<a name = "GetAudioTrackLoudness"></a>
511+
<strong>GetAudioTrackLoudness(type)</strong>
512+
</dt>
513+
<dd>
514+
Get current loudness level for specified track type
515+
516+
517+
518+
<h3>Parameters:</h3>
519+
<ul>
520+
<li><span class="parameter">type</span>
521+
<span class="types"><a class="type" href="../4 enums/Misc.SoundTrackType.html#">SoundTrackType</a></span>
522+
of the audio track
523+
</li>
524+
</ul>
525+
526+
<h3>Returns:</h3>
527+
<ol>
528+
529+
<span class="types"><span class="type">float</span></span>
530+
current loudness of a specified audio track
531+
</ol>
532+
533+
534+
535+
536+
</dd>
537+
<dt>
538+
<a name = "GetCurrentSubtitle"></a>
539+
<strong>GetCurrentSubtitle()</strong>
540+
</dt>
541+
<dd>
542+
Get current subtitle string for a voice track currently playing.
543+
Subtitle file must be in .srt format, have same filename as voice track, and be placed in same directory as voice track.
544+
Returns nil if no voice track is playing or no subtitle present.
545+
546+
547+
548+
549+
<h3>Returns:</h3>
550+
<ol>
551+
552+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
553+
current subtitle string
554+
</ol>
555+
556+
557+
558+
495559
</dd>
496560
<dt>
497561
<a name = "PlaySound"></a>
@@ -541,6 +605,28 @@ <h3>Parameters:</h3>
541605

542606

543607

608+
</dd>
609+
<dt>
610+
<a name = "IsAudioTrackPlaying"></a>
611+
<strong>IsAudioTrackPlaying(Track)</strong>
612+
</dt>
613+
<dd>
614+
Check if the audio track is playing
615+
616+
617+
618+
<h3>Parameters:</h3>
619+
<ul>
620+
<li><span class="parameter">Track</span>
621+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
622+
filename to check. Should be without extension and without full directory path.
623+
</li>
624+
</ul>
625+
626+
627+
628+
629+
544630
</dd>
545631
<dt>
546632
<a name = "FlipMap"></a>
@@ -915,7 +1001,7 @@ <h3>Parameters:</h3>
9151001
</div> <!-- id="main" -->
9161002
<div id="about">
9171003
<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>
918-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
1004+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
9191005
</div> <!-- id="about" -->
9201006
</div> <!-- id="container" -->
9211007
</body>

‎1 modules/Objects.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -465,7 +466,7 @@ <h3>Returns:</h3>
465466
</div> <!-- id="main" -->
466467
<div id="about">
467468
<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>
468-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
469+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
469470
</div> <!-- id="about" -->
470471
</div> <!-- id="container" -->
471472
</body>

‎1 modules/Strings.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -205,7 +206,7 @@ <h3>Returns:</h3>
205206
</div> <!-- id="main" -->
206207
<div id="about">
207208
<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>
208-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
209+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
209210
</div> <!-- id="about" -->
210211
</div> <!-- id="container" -->
211212
</body>

‎2 classes/Flow.Animations.html‎

Lines changed: 3 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.0.9 Lua API</title>
6+
<title>TombEngine 1.1.0 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -74,6 +74,7 @@ <h2>4 Enums</h2>
7474
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
7575
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
7676
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
77+
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</a></li>
7778
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7879
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
7980
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
@@ -106,7 +107,7 @@ <h1>Class <code>Flow.Animations</code></h1>
106107
</div> <!-- id="main" -->
107108
<div id="about">
108109
<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>
109-
<i style="float:right;">Last updated 2023-06-03 11:42:57 </i>
110+
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
110111
</div> <!-- id="about" -->
111112
</div> <!-- id="container" -->
112113
</body>

0 commit comments

Comments
 (0)