Skip to content

Commit 5b548a0

Browse files
Jakub768Jakub768
committed
update Lua docs to 1.2
1 parent c44eb2d commit 5b548a0

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

+4610
-456
lines changed

‎1 modules/Effects.html‎

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,18 @@ <h2>1 Modules</h2>
3434
<ul class="nowrap">
3535
<li> <here>Effects</here></li>
3636
<li> <a href="../1 modules/Flow.html">Flow</a></li>
37+
<li> <a href="../1 modules/Input.html">Input</a></li>
3738
<li> <a href="../1 modules/Inventory.html">Inventory</a></li>
3839
<li> <a href="../1 modules/Logic.html">Logic</a></li>
39-
<li> <a href="../1 modules/Misc.html">Misc</a></li>
4040
<li> <a href="../1 modules/Objects.html">Objects</a></li>
41+
<li> <a href="../1 modules/Sound.html">Sound</a></li>
4142
<li> <a href="../1 modules/Strings.html">Strings</a></li>
43+
<li> <a href="../1 modules/Util.html">Util</a></li>
44+
<li> <a href="../1 modules/View.html">View</a></li>
4245
</ul>
4346
<h2>2 Classes</h2>
4447
<ul class="nowrap">
48+
<li> <a href="../2 classes/DisplaySprite.html">DisplaySprite</a></li>
4549
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
4650
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
4751
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
@@ -69,15 +73,18 @@ <h2>3 Primitive Classes</h2>
6973
</ul>
7074
<h2>4 Enums</h2>
7175
<ul class="nowrap">
76+
<li> <a href="../4 enums/DisplaySprite.AlignMode.html">DisplaySprite.AlignMode</a></li>
77+
<li> <a href="../4 enums/DisplaySprite.ScaleMode.html">DisplaySprite.ScaleMode</a></li>
7278
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7379
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
74-
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
75-
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
76-
<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>
80+
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
81+
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
7882
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7983
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8084
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
85+
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
86+
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
87+
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
8188
</ul>
8289
<h2>5 Lua utility modules</h2>
8390
<ul class="nowrap">
@@ -130,10 +137,6 @@ <h2><a href="#Functions">Functions</a></h2>
130137
<td class="name" ><a href="#MakeEarthquake">MakeEarthquake(strength)</a></td>
131138
<td class="summary">Make an earthquake</td>
132139
</tr>
133-
<tr>
134-
<td class="name" ><a href="#FlashScreen">FlashScreen(color, speed)</a></td>
135-
<td class="summary">Flash screen.</td>
136-
</tr>
137140
</table>
138141

139142
<br/>
@@ -489,32 +492,6 @@ <h3>Parameters:</h3>
489492

490493

491494

492-
</dd>
493-
<dt>
494-
<a name = "FlashScreen"></a>
495-
<strong>FlashScreen(color, speed)</strong>
496-
</dt>
497-
<dd>
498-
Flash screen.
499-
500-
501-
502-
<h3>Parameters:</h3>
503-
<ul>
504-
<li><span class="parameter">color</span>
505-
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
506-
(default Color(255, 255, 255))
507-
</li>
508-
<li><span class="parameter">speed</span>
509-
<span class="types"><span class="type">float</span></span>
510-
(default 1.0). Speed in "amount" per second. Value of 1 will make flash take one second. Clamped to [0.005, 1.0].
511-
</li>
512-
</ul>
513-
514-
515-
516-
517-
518495
</dd>
519496
</dl>
520497

@@ -523,7 +500,7 @@ <h3>Parameters:</h3>
523500
</div> <!-- id="main" -->
524501
<div id="about">
525502
<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>
526-
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
503+
<i style="float:right;">Last updated 2023-11-09 18:25:22 </i>
527504
</div> <!-- id="about" -->
528505
</div> <!-- id="container" -->
529506
</body>

‎1 modules/Flow.html‎

Lines changed: 178 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,18 @@ <h2>1 Modules</h2>
3434
<ul class="nowrap">
3535
<li> <a href="../1 modules/Effects.html">Effects</a></li>
3636
<li> <here>Flow</here></li>
37+
<li> <a href="../1 modules/Input.html">Input</a></li>
3738
<li> <a href="../1 modules/Inventory.html">Inventory</a></li>
3839
<li> <a href="../1 modules/Logic.html">Logic</a></li>
39-
<li> <a href="../1 modules/Misc.html">Misc</a></li>
4040
<li> <a href="../1 modules/Objects.html">Objects</a></li>
41+
<li> <a href="../1 modules/Sound.html">Sound</a></li>
4142
<li> <a href="../1 modules/Strings.html">Strings</a></li>
43+
<li> <a href="../1 modules/Util.html">Util</a></li>
44+
<li> <a href="../1 modules/View.html">View</a></li>
4245
</ul>
4346
<h2>2 Classes</h2>
4447
<ul class="nowrap">
48+
<li> <a href="../2 classes/DisplaySprite.html">DisplaySprite</a></li>
4549
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
4650
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
4751
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
@@ -69,15 +73,18 @@ <h2>3 Primitive Classes</h2>
6973
</ul>
7074
<h2>4 Enums</h2>
7175
<ul class="nowrap">
76+
<li> <a href="../4 enums/DisplaySprite.AlignMode.html">DisplaySprite.AlignMode</a></li>
77+
<li> <a href="../4 enums/DisplaySprite.ScaleMode.html">DisplaySprite.ScaleMode</a></li>
7278
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7379
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
74-
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
75-
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
76-
<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>
80+
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
81+
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
7882
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
7983
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8084
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
85+
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
86+
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
87+
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
8188
</ul>
8289
<h2>5 Lua utility modules</h2>
8390
<ul class="nowrap">
@@ -118,6 +125,10 @@ <h2><a href="#gameflow_lua">gameflow.lua </a></h2>
118125
<td class="name" ><a href="#EnableLevelSelect">EnableLevelSelect(enabled)</a></td>
119126
<td class="summary">Enable or disable level selection in title flyby.</td>
120127
</tr>
128+
<tr>
129+
<td class="name" ><a href="#EnableLoadSave">EnableLoadSave(enabled)</a></td>
130+
<td class="summary">Enable or disable saving and loading of savegames.</td>
131+
</tr>
121132
</table>
122133
<h2><a href="#gameflow_lua_or_level_scripts">gameflow.lua or level scripts </a></h2>
123134
<table class="function_list">
@@ -126,6 +137,10 @@ <h2><a href="#gameflow_lua_or_level_scripts">gameflow.lua or level scripts </a><
126137
<td class="summary">Enable or disable DOZY mode (fly cheat).</td>
127138
</tr>
128139
<tr>
140+
<td class="name" ><a href="#EnablePointFilter">EnablePointFilter(enabled)</a></td>
141+
<td class="summary">Enable or disable point texture filter.</td>
142+
</tr>
143+
<tr>
129144
<td class="name" ><a href="#EnableMassPickup">EnableMassPickup(enabled)</a></td>
130145
<td class="summary">Enable or disable mass pickup.</td>
131146
</tr>
@@ -142,6 +157,22 @@ <h2><a href="#gameflow_lua_or_level_scripts">gameflow.lua or level scripts </a><
142157
<td class="summary">Finishes the current level, with optional level index provided.</td>
143158
</tr>
144159
<tr>
160+
<td class="name" ><a href="#SaveGame">SaveGame(slotID)</a></td>
161+
<td class="summary">Save the game to a savegame slot.</td>
162+
</tr>
163+
<tr>
164+
<td class="name" ><a href="#LoadGame">LoadGame(slotID)</a></td>
165+
<td class="summary">Load the game from a savegame slot.</td>
166+
</tr>
167+
<tr>
168+
<td class="name" ><a href="#DeleteSaveGame">DeleteSaveGame(slotID)</a></td>
169+
<td class="summary">Delete a savegame.</td>
170+
</tr>
171+
<tr>
172+
<td class="name" ><a href="#DoesSaveGameExist">DoesSaveGameExist(slotID)</a></td>
173+
<td class="summary">Check if a savegame exists.</td>
174+
</tr>
175+
<tr>
145176
<td class="name" ><a href="#GetSecretCount">GetSecretCount()</a></td>
146177
<td class="summary">Returns the player's current per-game secret count.</td>
147178
</tr>
@@ -181,7 +212,7 @@ <h2><a href="#strings_lua">strings.lua </a></h2>
181212
</tr>
182213
<tr>
183214
<td class="name" ><a href="#GetString">GetString(string)</a></td>
184-
<td class="summary">Get translated string</td>
215+
<td class="summary">Get translated string.</td>
185216
</tr>
186217
<tr>
187218
<td class="name" ><a href="#SetLanguageNames">SetLanguageNames(table)</a></td>
@@ -315,6 +346,28 @@ <h3>Parameters:</h3>
315346

316347

317348

349+
</dd>
350+
<dt>
351+
<a name = "EnableLoadSave"></a>
352+
<strong>EnableLoadSave(enabled)</strong>
353+
</dt>
354+
<dd>
355+
Enable or disable saving and loading of savegames.
356+
357+
358+
359+
<h3>Parameters:</h3>
360+
<ul>
361+
<li><span class="parameter">enabled</span>
362+
<span class="types"><span class="type">bool</span></span>
363+
true or false.
364+
</li>
365+
</ul>
366+
367+
368+
369+
370+
318371
</dd>
319372
</dl>
320373
<h2 class="section-header "><a name="gameflow_lua_or_level_scripts"></a>gameflow.lua or level scripts </h2>
@@ -342,6 +395,29 @@ <h3>Parameters:</h3>
342395

343396

344397

398+
</dd>
399+
<dt>
400+
<a name = "EnablePointFilter"></a>
401+
<strong>EnablePointFilter(enabled)</strong>
402+
</dt>
403+
<dd>
404+
Enable or disable point texture filter.
405+
Must be true or false
406+
407+
408+
409+
<h3>Parameters:</h3>
410+
<ul>
411+
<li><span class="parameter">enabled</span>
412+
<span class="types"><span class="type">bool</span></span>
413+
true or false
414+
</li>
415+
</ul>
416+
417+
418+
419+
420+
345421
</dd>
346422
<dt>
347423
<a name = "EnableMassPickup"></a>
@@ -441,6 +517,100 @@ <h3>Parameters:</h3>
441517

442518

443519

520+
</dd>
521+
<dt>
522+
<a name = "SaveGame"></a>
523+
<strong>SaveGame(slotID)</strong>
524+
</dt>
525+
<dd>
526+
Save the game to a savegame slot.
527+
528+
529+
530+
<h3>Parameters:</h3>
531+
<ul>
532+
<li><span class="parameter">slotID</span>
533+
<span class="types"><span class="type">int</span></span>
534+
ID of the savegame slot to save to.
535+
</li>
536+
</ul>
537+
538+
539+
540+
541+
542+
</dd>
543+
<dt>
544+
<a name = "LoadGame"></a>
545+
<strong>LoadGame(slotID)</strong>
546+
</dt>
547+
<dd>
548+
Load the game from a savegame slot.
549+
550+
551+
552+
<h3>Parameters:</h3>
553+
<ul>
554+
<li><span class="parameter">slotID</span>
555+
<span class="types"><span class="type">int</span></span>
556+
ID of the savegame slot to load from.
557+
</li>
558+
</ul>
559+
560+
561+
562+
563+
564+
</dd>
565+
<dt>
566+
<a name = "DeleteSaveGame"></a>
567+
<strong>DeleteSaveGame(slotID)</strong>
568+
</dt>
569+
<dd>
570+
Delete a savegame.
571+
572+
573+
574+
<h3>Parameters:</h3>
575+
<ul>
576+
<li><span class="parameter">slotID</span>
577+
<span class="types"><span class="type">int</span></span>
578+
ID of the savegame slot to clear.
579+
</li>
580+
</ul>
581+
582+
583+
584+
585+
586+
</dd>
587+
<dt>
588+
<a name = "DoesSaveGameExist"></a>
589+
<strong>DoesSaveGameExist(slotID)</strong>
590+
</dt>
591+
<dd>
592+
Check if a savegame exists.
593+
594+
595+
596+
<h3>Parameters:</h3>
597+
<ul>
598+
<li><span class="parameter">slotID</span>
599+
<span class="types"><span class="type">int</span></span>
600+
ID of the savegame slot to check.
601+
</li>
602+
</ul>
603+
604+
<h3>Returns:</h3>
605+
<ol>
606+
607+
<span class="types"><span class="type">bool</span></span>
608+
true if the savegame exists, false if not.
609+
</ol>
610+
611+
612+
613+
444614
</dd>
445615
<dt>
446616
<a name = "GetSecretCount"></a>
@@ -623,7 +793,7 @@ <h3>Parameters:</h3>
623793
<strong>GetString(string)</strong>
624794
</dt>
625795
<dd>
626-
Get translated string
796+
Get translated string.
627797

628798

629799

@@ -670,7 +840,7 @@ <h3>Parameters:</h3>
670840
</div> <!-- id="main" -->
671841
<div id="about">
672842
<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>
673-
<i style="float:right;">Last updated 2023-07-20 12:10:11 </i>
843+
<i style="float:right;">Last updated 2023-11-09 18:25:22 </i>
674844
</div> <!-- id="about" -->
675845
</div> <!-- id="container" -->
676846
</body>

0 commit comments

Comments
 (0)