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

Refactor scripting documentation and flow data types to use fields instead of getters and setters (#1609)

Browse source 
* Initial commit

* Minor changes

* Rename Flow.Starfield to Flow.StarField

* Added cross-referencing, fixed some descriptions

* Start page LDoc cleanup

* Proofread sound module documentation

* Fixed Vec2 docs

* Update FlowLevel.cpp

* Fixed incorrect tag

* Update CHANGELOG.md

* Allow to refresh starfield in runtime

* Update weather.cpp

* Dynamically change amount of stars

* Update CHANGELOG.md

* Update CHANGELOG.md

* Remove brackets in room class documentation

* Added operators for Rotation class

* Rephrase a little

* Minor nitpicks

---------

Co-authored-by: Sezz <sezzary@outlook.com>
This commit is contained in:
Lwmte 2025-03-12 01:34:48 +03:00 • committed by GitHub
parent f01ad441d3
commit 3046f5f4a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
87 changed files with 840 additions and 1326 deletions
Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -34,7 +34,6 @@ TombEngine releases are located in this repository (alongside with Tomb Editor):
* Added TR4 Statue Plinth.
### Lua API changes
* Added Collision.Probe class for basic room collision detection.
* Added advanced particle emitter allowing animations and other effects.
* Added diary module.
@ -46,11 +45,13 @@ TombEngine releases are located in this repository (alongside with Tomb Editor):
* Added Effects.EmitStreamer() function to emit streamers.
* Added Moveable:GetScale() and Movebale:SetScale() methods to set visible scale of moveables.
* Added Rotation:Lerp() function to allow linear interpolation between rotations.
* Added ability to perform additive and subtractive operations on Rotation class and compare one Rotation to another.
* Added various Translate() methods to Vec2 and Vec3 script objects.
* Added alpha transparency functionality for statics and moveables to be used with SetColor() method.
* Added extra arguments for sprite object slots and starting rotation value for EmitParticle function.
* Added ability to save Flow.Level fields such as fog or horizon to a savegame.
* Added ability to dynamically change Flow.Level fields such as fog, starfield or horizon, and save them to a savegame.
* Added pickup count to Flow.Statistics class.
* Changed Flow.StarField and Flow.LensFlare primitive types to use parameters instead of getters and setters.
* Fixed medipack level count in Flow.Statistics class.
## [Version 1.7.1](https://github.com/TombEngine/TombEditorReleases/releases/tag/v1.7.4) - 2025-04-01

18
Documentation/config.ld
View file

@ -12,27 +12,27 @@ new_type("luautil", "5 Lua utility modules", true)
not_luadoc = true
local version = "1.7.2 (Developer)"
local version = "1.8"
project = "&nbsp;TombEngine"
title = "TombEngine " .. version .. " Lua API"
description = "TombEngine " .. version .. " scripting interface"
full_description = [[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.
full_description = [[Welcome to the TombEngine scripting API.
Note that this is primarily a reference document, not a tutorial, so expect descriptions to be fairly sparse.
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>.
####Module Hierarchy (boring but important)
Other than the "special tables" (GameVars, LevelVars and LevelFuncs), every module described herein is held in a master table called TEN.
####Module Hierarchy
Other than the "special tables" (`GameVars`, `LevelVars` and `LevelFuncs`), every module described herein is held in a master table called TEN.
For convenience, these modules and classes are automatically put in the global table. For example, you can call GetMoveableByName either of these two ways:
local door = TEN.Objects.GetMoveableByName("door_type4_14")
local door = GetMoveableByName("door_type4_14")
####Always check logs/TENLog.txt
If you are scripting levels, TombEngine will often kick you back to the title screen, even if `errorMode` (see Flow.Settings) is set to `ErrorMode.WARN` or `ErrorMode.SILENT`.
If you are scripting levels, TombEngine will often kick you back to the title screen, even if `errorMode` (see @{Flow.Settings}) is set to `ErrorMode.WARN` or `ErrorMode.SILENT`.
This might get annoying, but it's on purpose. If your Lua script contains a syntax error (e.g. you're missing `end` at the end of a function), the Lua interpreter will not be able to continue running the script. If it tried to keep running, you'd probably see some pretty strange behaviour, and would possibly get a crash regardless.
This might get annoying, but it's on purpose. If your Lua script contains a syntax error (e.g. you're missing `end` at the end of a function), the Lua interpreter will not be able to continue running the script. If it tried to keep running, you'd probably see some pretty strange behaviour, and would possibly get a crash regardless. If this happens, check __logs/TENLog.txt__ and look for an error message with the word "unrecoverable".
If this happens, check __logs/TENLog.txt__ and look for an error message with the word "unrecoverable".
Enjoy.
Happy building!
\- _squidshire and the TombEngine development team._
]]

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/1 modules/Input.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

92
Documentation/doc/1 modules/Sound.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -124,40 +124,40 @@
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack(name, type)</a></td>
<td class="summary">Play an audio track</td>
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack(filename, type)</a></td>
<td class="summary">Play an audio track.</td>
</tr>
<tr>
<td class="name" ><a href="#SetAmbientTrack">SetAmbientTrack(name, fromStart)</a></td>
<td class="summary">Set and play an ambient track</td>
<td class="summary">Set and play an ambient track.</td>
</tr>
<tr>
<td class="name" ><a href="#StopAudioTracks">StopAudioTracks()</a></td>
<td class="summary">Stop any audio tracks currently playing</td>
<td class="summary">Stop any audio tracks currently playing.</td>
</tr>
<tr>
<td class="name" ><a href="#StopAudioTrack">StopAudioTrack(type)</a></td>
<td class="summary">Stop audio track that is currently playing</td>
<td class="summary">Stop audio track that is currently playing.</td>
</tr>
<tr>
<td class="name" ><a href="#GetAudioTrackLoudness">GetAudioTrackLoudness(type)</a></td>
<td class="summary">Get current loudness level for specified track type</td>
<td class="summary">Get current loudness level for specified track type.</td>
</tr>
<tr>
<td class="name" ><a href="#PlaySound">PlaySound(sound[, position])</a></td>
<td class="summary">Play sound effect</td>
<td class="name" ><a href="#PlaySound">PlaySound(soundID[, position])</a></td>
<td class="summary">Play sound effect.</td>
</tr>
<tr>
<td class="name" ><a href="#StopSound">StopSound(sound)</a></td>
<td class="summary">Stop sound effect</td>
<td class="name" ><a href="#StopSound">StopSound(soundID)</a></td>
<td class="summary">Stop 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>
<td class="name" ><a href="#IsSoundPlaying">IsSoundPlaying(soundID)</a></td>
<td class="summary">Check if the sound effect is playing.</td>
</tr>
<tr>
<td class="name" ><a href="#IsAudioTrackPlaying">IsAudioTrackPlaying(Track)</a></td>
<td class="summary">Check if the audio track is playing</td>
<td class="summary">Check if the audio track is playing.</td>
</tr>
<tr>
<td class="name" ><a href="#GetCurrentSubtitle">GetCurrentSubtitle()</a></td>
@ -174,22 +174,22 @@
<dl class="function">
<dt>
<a name = "PlayAudioTrack"></a>
<strong>PlayAudioTrack(name, type)</strong>
<strong>PlayAudioTrack(filename, type)</strong>
</dt>
<dd>
Play an audio track
Play an audio track. Supported formats are wav, mp3 and ogg.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<li><span class="parameter">filename</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
of track (without file extension) to play
Filename of a track (without file extension) to play.
</li>
<li><span class="parameter">type</span>
<span class="types"><a class="type" href="../4 enums/Sound.SoundTrackType.html#">SoundTrackType</a></span>
of the audio track to play
Type of the audio track to play.
</li>
</ul>
@ -203,7 +203,7 @@
<strong>SetAmbientTrack(name, fromStart)</strong>
</dt>
<dd>
Set and play an ambient track
Set and play an ambient track.
@ -211,11 +211,11 @@
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
of track (without file extension) to play
Name of track (without file extension) to play.
</li>
<li><span class="parameter">fromStart</span>
<span class="types"><span class="type">bool</span></span>
specifies whether ambient track should play from the start, or crossfade at a random position
Specifies whether ambient track should play from the start, or crossfade at a random position.
</li>
</ul>
@ -229,7 +229,7 @@
<strong>StopAudioTracks()</strong>
</dt>
<dd>
Stop any audio tracks currently playing
Stop any audio tracks currently playing.
@ -244,7 +244,7 @@
<strong>StopAudioTrack(type)</strong>
</dt>
<dd>
Stop audio track that is currently playing
Stop audio track that is currently playing.
@ -252,7 +252,7 @@
<ul>
<li><span class="parameter">type</span>
<span class="types"><a class="type" href="../4 enums/Sound.SoundTrackType.html#">SoundTrackType</a></span>
of the audio track
Type of the audio track.
</li>
</ul>
@ -266,7 +266,7 @@
<strong>GetAudioTrackLoudness(type)</strong>
</dt>
<dd>
Get current loudness level for specified track type
Get current loudness level for specified track type.
@ -274,7 +274,7 @@
<ul>
<li><span class="parameter">type</span>
<span class="types"><a class="type" href="../4 enums/Sound.SoundTrackType.html#">SoundTrackType</a></span>
of the audio track
Type of the audio track.
</li>
</ul>
@ -282,7 +282,7 @@
<ol>
<span class="types"><span class="type">float</span></span>
current loudness of a specified audio track
Current loudness of a specified audio track.
</ol>
@ -291,18 +291,18 @@
</dd>
<dt>
<a name = "PlaySound"></a>
<strong>PlaySound(sound[, position])</strong>
<strong>PlaySound(soundID[, position])</strong>
</dt>
<dd>
Play sound effect
Play sound effect.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">sound</span>
<li><span class="parameter">soundID</span>
<span class="types"><span class="type">int</span></span>
ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
Sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
</li>
<li><span class="parameter">position</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
@ -318,18 +318,18 @@
</dd>
<dt>
<a name = "StopSound"></a>
<strong>StopSound(sound)</strong>
<strong>StopSound(soundID)</strong>
</dt>
<dd>
Stop sound effect
Stop sound effect.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">sound</span>
<li><span class="parameter">soundID</span>
<span class="types"><span class="type">int</span></span>
ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
Sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
</li>
</ul>
@ -340,18 +340,18 @@
</dd>
<dt>
<a name = "IsSoundPlaying"></a>
<strong>IsSoundPlaying(Sound)</strong>
<strong>IsSoundPlaying(soundID)</strong>
</dt>
<dd>
Check if the sound effect is playing
Check if the sound effect is playing.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Sound</span>
<li><span class="parameter">soundID</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.
Sound ID to check. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
</li>
</ul>
@ -365,7 +365,7 @@
<strong>IsAudioTrackPlaying(Track)</strong>
</dt>
<dd>
Check if the audio track is playing
Check if the audio track is playing.
@ -373,7 +373,7 @@
<ul>
<li><span class="parameter">Track</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
filename to check. Should be without extension and without full directory path.
Filename to check. Should be without extension and without full directory path.
</li>
</ul>
@ -388,8 +388,8 @@
</dt>
<dd>
Get current subtitle string for a voice track currently playing.
Subtitle file must be in .srt format, have same filename as voice track, and be placed in same directory as voice track.
Returns nil if no voice track is playing or no subtitle present.
Subtitle file must be in .srt format, have same filename as voice track, and be placed in same directory as voice track.
Returns nil if no voice track is playing or no subtitle present.
@ -398,7 +398,7 @@ Returns nil if no voice track is playing or no subtitle present.
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
current subtitle string
Current subtitle string.
</ol>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/1 modules/Util.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/1 modules/View.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/2 classes/Collision.Probe.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

49
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -143,31 +143,31 @@
</tr>
<tr>
<td class="name" ><a href="#layer1">layer1</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Primary sky layer</td>
<td class="summary">(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Primary sky cloud layer.</td>
</tr>
<tr>
<td class="name" ><a href="#layer2">layer2</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Secondary sky layer</td>
<td class="summary">(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Secondary sky cloud layer.</td>
</tr>
<tr>
<td class="name" ><a href="#horizon1">horizon1</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.Horizon.html#">Flow.Horizon</a>) First horizon layer.</td>
</tr>
<tr>
<td class="name" ><a href="#horizon1">horizon1</a></td>
<td class="name" ><a href="#horizon2">horizon2</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.Horizon.html#">Flow.Horizon</a>) Second horizon layer.</td>
</tr>
<tr>
<td class="name" ><a href="#starfield">starfield</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.Starfield.html#">Flow.Starfield</a>) Starfield.</td>
<td class="name" ><a href="#starField">starField</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.StarField.html#">Flow.StarField</a>) Starfield in the sky.</td>
</tr>
<tr>
<td class="name" ><a href="#lensFlare">lensFlare</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.LensFlare.html#">Flow.LensFlare</a>) Global lens flare .</td>
<td class="summary">(<a href="../3 primitive classes/Flow.LensFlare.html#">Flow.LensFlare</a>) Global lens flare.</td>
</tr>
<tr>
<td class="name" ><a href="#fog">fog</a></td>
<td class="summary">(<a href="../3 primitive classes/Flow.Fog.html#">Flow.Fog</a>) omni fog RGB color and distance.</td>
<td class="summary">(<a href="../3 primitive classes/Flow.Fog.html#">Flow.Fog</a>) Global distance fog, with specified RGB color and distance.</td>
</tr>
<tr>
<td class="name" ><a href="#storm">storm</a></td>
@ -199,11 +199,11 @@
</tr>
<tr>
<td class="name" ><a href="#objects">objects</a></td>
<td class="summary">(table of <a href="../3 primitive classes/Flow.InventoryItem.html#">Flow.InventoryItem</a>s) table of inventory object overrides</td>
<td class="summary">(table of <a href="../3 primitive classes/Flow.InventoryItem.html#">Flow.InventoryItem</a>s) A table of inventory object layout overrides.</td>
</tr>
<tr>
<td class="name" ><a href="#secrets">secrets</a></td>
<td class="summary">(short) Set Secrets for Level</td>
<td class="summary">(short) Set total secret count for current level.</td>
</tr>
</table>
<h2><a href="#Functions">Functions</a></h2>
@ -306,7 +306,7 @@
<strong>layer1</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Primary sky layer
(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Primary sky cloud layer.
@ -321,7 +321,7 @@
<strong>layer2</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Secondary sky layer
(<a href="../3 primitive classes/Flow.SkyLayer.html#">Flow.SkyLayer</a>) Secondary sky cloud layer.
@ -347,8 +347,8 @@
</dd>
<dt>
<a name = "horizon1"></a>
<strong>horizon1</strong>
<a name = "horizon2"></a>
<strong>horizon2</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.Horizon.html#">Flow.Horizon</a>) Second horizon layer.
@ -362,11 +362,11 @@
</dd>
<dt>
<a name = "starfield"></a>
<strong>starfield</strong>
<a name = "starField"></a>
<strong>starField</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.Starfield.html#">Flow.Starfield</a>) Starfield.
(<a href="../3 primitive classes/Flow.StarField.html#">Flow.StarField</a>) Starfield in the sky.
@ -381,7 +381,7 @@
<strong>lensFlare</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.LensFlare.html#">Flow.LensFlare</a>) Global lens flare .
(<a href="../3 primitive classes/Flow.LensFlare.html#">Flow.LensFlare</a>) Global lens flare.
@ -396,9 +396,8 @@
<strong>fog</strong>
</dt>
<dd>
(<a href="../3 primitive classes/Flow.Fog.html#">Flow.Fog</a>) omni fog RGB color and distance.
As seen in TR4's Desert Railroad.
If not provided, distance fog will be black.
(<a href="../3 primitive classes/Flow.Fog.html#">Flow.Fog</a>) Global distance fog, with specified RGB color and distance.
If not provided, distance fog will not be visible.
@ -537,7 +536,7 @@ Invisible
<strong>objects</strong>
</dt>
<dd>
(table of <a href="../3 primitive classes/Flow.InventoryItem.html#">Flow.InventoryItem</a>s) table of inventory object overrides
(table of <a href="../3 primitive classes/Flow.InventoryItem.html#">Flow.InventoryItem</a>s) A table of inventory object layout overrides.
@ -552,7 +551,7 @@ Invisible
<strong>secrets</strong>
</dt>
<dd>
(short) Set Secrets for Level
(short) Set total secret count for current level.
@ -580,7 +579,7 @@ Invisible
<ol>
<span class="types"><a class="type" href="../2 classes/Flow.Level.html#Level">Level</a></span>
a Level object
a Level object.
</ol>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/2 classes/Flow.Statistics.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

6
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -118,8 +118,6 @@
<p>Represents a moveable object in the game world.</p>
<p> Examples include the player, traps, enemies, doors, and pickups. See also <a href="../2 classes/Objects.LaraObject.html#">Objects.LaraObject</a> for player-specific features.</p>
<p> pragma nostrip</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">

24
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -177,7 +177,7 @@
<strong>Room:GetRoomNumber()</strong>
</dt>
<dd>
Get the room's number. ()
Get the room's number.
@ -198,7 +198,7 @@
<strong>Room:GetName()</strong>
</dt>
<dd>
Get the room's unique string identifier. ()
Get the room's unique string identifier.
@ -219,7 +219,7 @@
<strong>Room:GetColor()</strong>
</dt>
<dd>
Get the room's ambient light color. ()
Get the room's ambient light color.
@ -240,7 +240,7 @@
<strong>Room:GetReverbType()</strong>
</dt>
<dd>
Get the room's reverb type. ()
Get the room's reverb type.
@ -261,7 +261,7 @@
<strong>Room:SetName(name)</strong>
</dt>
<dd>
Set the room's unique string identifier. ()
Set the room's unique string identifier.
@ -283,7 +283,7 @@
<strong>Room:SetReverbType(Reverb)</strong>
</dt>
<dd>
Set the room's reverb type. ()
Set the room's reverb type.
@ -305,7 +305,7 @@
<strong>Room:SetFlag(flagID, Boolean)</strong>
</dt>
<dd>
Set the room's specified flag. ()
Set the room's specified flag.
@ -331,7 +331,7 @@
<strong>Room:GetFlag(flagID)</strong>
</dt>
<dd>
Get the room's specified flag value (true or false). ()
Get the room's specified flag value (true or false).
@ -353,7 +353,7 @@
<strong>Room:IsTagPresent(tag)</strong>
</dt>
<dd>
Check if the specified tag is set for the room. ()
Check if the specified tag is set for the room.
@ -381,7 +381,7 @@
<strong>Room:GetActive()</strong>
</dt>
<dd>
Check if the room is active. ()
Check if the room is active.

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/2 classes/View.DisplaySprite.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <here>Color</here></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

10
Documentation/doc/3 primitive 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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -115,10 +115,8 @@
<div id="content">
<h1>Primitive Class <code>Flow.Fog</code></h1>
<p>Distance fog.</p>
<p>
</p>
<p>Represesnts distance fog.</p>
<p> To be used with <a href="../2 classes/Flow.Level.html#fog">Flow.Level.fog</a> property.</p>
<h2><a href="#Members">Members</a></h2>

379
Documentation/doc/3 primitive classes/Flow.Horizon.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -116,63 +116,127 @@
<h1>Primitive Class <code>Flow.Horizon</code></h1>
<p>Represents a horizon.</p>
<p>
</p>
<p> To be used with <a href="../2 classes/Flow.Level.html#horizon1">Flow.Level.horizon1</a> and <a href="../2 classes/Flow.Level.html#horizon2">Flow.Level.horizon2</a> properties.</p>
<h2><a href="#Members">Members</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#enabled">enabled</a></td>
<td class="summary">(bool) Horizon enabled state.</td>
</tr>
<tr>
<td class="name" ><a href="#objectID">objectID</a></td>
<td class="summary">(Objects.ObjID) Horizon object ID.</td>
</tr>
<tr>
<td class="name" ><a href="#position">position</a></td>
<td class="summary">(Vec3) Horizon position.</td>
</tr>
<tr>
<td class="name" ><a href="#rotation">rotation</a></td>
<td class="summary">(Rotation) Horizon rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#transparency">transparency</a></td>
<td class="summary">(float) Horizon transparency.</td>
</tr>
</table>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Horizon">Horizon(objectID)</a></td>
<td class="summary">Create a horizon object.</td>
</tr>
<tr>
<td class="name" ><a href="#GetEnabled">GetEnabled()</a></td>
<td class="summary">Get the horizon's enabled state.</td>
</tr>
<tr>
<td class="name" ><a href="#GetObjectID">GetObjectID()</a></td>
<td class="summary">Get the horizon's slot object ID.</td>
</tr>
<tr>
<td class="name" ><a href="#GetPosition">GetPosition()</a></td>
<td class="summary">Get the horizon's world position.</td>
</tr>
<tr>
<td class="name" ><a href="#GetRotation">GetRotation()</a></td>
<td class="summary">Get the horizon's rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#GetTransparency">GetTransparency()</a></td>
<td class="summary">Get the horizon's transparency.</td>
</tr>
<tr>
<td class="name" ><a href="#SetEnabled">SetEnabled(enabled)</a></td>
<td class="summary">Set the horizon's enabled state.</td>
</tr>
<tr>
<td class="name" ><a href="#SetObjectID">SetObjectID(objectID)</a></td>
<td class="summary">Set the horizon's object ID.</td>
</tr>
<tr>
<td class="name" ><a href="#SetPosition">SetPosition(pos[, noInterpolation])</a></td>
<td class="summary">Set the horizon's world position.</td>
</tr>
<tr>
<td class="name" ><a href="#SetRotation">SetRotation(rot[, noInterpolation])</a></td>
<td class="summary">Set the horizon's rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#SetTransparency">SetTransparency(transparency)</a></td>
<td class="summary">Set the horizon's transparency.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Members"></a>Members</h2>
<dl class="function">
<dt>
<a name = "enabled"></a>
<strong>enabled</strong>
</dt>
<dd>
(bool) Horizon enabled state.
If set to true, horizon will be visible.
</dd>
<dt>
<a name = "objectID"></a>
<strong>objectID</strong>
</dt>
<dd>
(Objects.ObjID) Horizon object ID.
</dd>
<dt>
<a name = "position"></a>
<strong>position</strong>
</dt>
<dd>
(Vec3) Horizon position.
Specifies an offset from the camera origin.
</dd>
<dt>
<a name = "rotation"></a>
<strong>rotation</strong>
</dt>
<dd>
(Rotation) Horizon rotation.
Specifies horizon rotation.
</dd>
<dt>
<a name = "transparency"></a>
<strong>transparency</strong>
</dt>
<dd>
(float) Horizon transparency.
Specifies horizon transparency on a range from 0 to 1.
</dd>
</dl>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
@ -203,231 +267,6 @@
</dd>
<dt>
<a name = "GetEnabled"></a>
<strong>GetEnabled()</strong>
</dt>
<dd>
Get the horizon's enabled state.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Enabled state.
</ol>
</dd>
<dt>
<a name = "GetObjectID"></a>
<strong>GetObjectID()</strong>
</dt>
<dd>
Get the horizon's slot object ID.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../4 enums/Objects.ObjID.html#">ObjID</a></span>
Object ID.
</ol>
</dd>
<dt>
<a name = "GetPosition"></a>
<strong>GetPosition()</strong>
</dt>
<dd>
Get the horizon's world position.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
Position.
</ol>
</dd>
<dt>
<a name = "GetRotation"></a>
<strong>GetRotation()</strong>
</dt>
<dd>
Get the horizon's rotation.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
Rotation.
</ol>
</dd>
<dt>
<a name = "GetTransparency"></a>
<strong>GetTransparency()</strong>
</dt>
<dd>
Get the horizon's transparency.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">float</span></span>
Transparency.
</ol>
</dd>
<dt>
<a name = "SetEnabled"></a>
<strong>SetEnabled(enabled)</strong>
</dt>
<dd>
Set the horizon's enabled state.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">enabled</span>
<span class="types"><span class="type">bool</span></span>
New enabled state.
</li>
</ul>
</dd>
<dt>
<a name = "SetObjectID"></a>
<strong>SetObjectID(objectID)</strong>
</dt>
<dd>
Set the horizon's object ID.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">objectID</span>
<span class="types"><a class="type" href="../4 enums/Objects.ObjID.html#">ObjID</a></span>
Object ID.
</li>
</ul>
</dd>
<dt>
<a name = "SetPosition"></a>
<strong>SetPosition(pos[, noInterpolation])</strong>
</dt>
<dd>
Set the horizon's world position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pos</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
New world position.
</li>
<li><span class="parameter">noInterpolation</span>
<span class="types"><span class="type">bool</span></span>
Disable interpolation with the previous frame's position. <strong>default: false</strong>
(<em>optional</em>)
</li>
</ul>
</dd>
<dt>
<a name = "SetRotation"></a>
<strong>SetRotation(rot[, noInterpolation])</strong>
</dt>
<dd>
Set the horizon's rotation.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">rot</span>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
New rotation.
</li>
<li><span class="parameter">noInterpolation</span>
<span class="types"><span class="type">bool</span></span>
Disable interpolation with the previous frame's rotation. <strong>default: false</strong>
(<em>optional</em>)
</li>
</ul>
</dd>
<dt>
<a name = "SetTransparency"></a>
<strong>SetTransparency(transparency)</strong>
</dt>
<dd>
Set the horizon's transparency.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">transparency</span>
<span class="types"><span class="type">float</span></span>
New transparency alpha.
</li>
</ul>
</dd>
</dl>

8
Documentation/doc/3 primitive 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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <here>Flow.InventoryItem</here></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -116,9 +116,7 @@
<h1>Primitive Class <code>Flow.InventoryItem</code></h1>
<p>Represents the properties of an object as it appears in the inventory.</p>
<p>
</p>
<p> To be used in <a href="../2 classes/Flow.Level.html#objects">Flow.Level.objects</a> list.</p>
<h2><a href="#Functions">Functions</a></h2>

334
Documentation/doc/3 primitive classes/Flow.LensFlare.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <here>Flow.LensFlare</here></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -116,59 +116,124 @@
<h1>Primitive Class <code>Flow.LensFlare</code></h1>
<p>Represents a global lens flare (not to be confused with the lens flare object).</p>
<p>
</p>
<p> To be used with <a href="../2 classes/Flow.Level.html#lensFlare">Flow.Level.lensFlare</a> property.</p>
<h2><a href="#Members">Members</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#enabled">enabled</a></td>
<td class="summary">(bool) Lens flare enabled state.</td>
</tr>
<tr>
<td class="name" ><a href="#spriteID">spriteID</a></td>
<td class="summary">(int) Lens flare's sun sprite object ID.</td>
</tr>
<tr>
<td class="name" ><a href="#pitch">pitch</a></td>
<td class="summary">(float) Lens flare's pitch (vertical) angle in degrees.</td>
</tr>
<tr>
<td class="name" ><a href="#yaw">yaw</a></td>
<td class="summary">(float) Lens flare's yaw (horizontal) angle in degrees.</td>
</tr>
<tr>
<td class="name" ><a href="#color">color</a></td>
<td class="summary">(Color) Lens flare's color.</td>
</tr>
</table>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#LensFlare">LensFlare(pitch, yaw, color)</a></td>
<td class="summary">Create a LensFlare object.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:GetSunSpriteID">LensFlare:GetSunSpriteID()</a></td>
<td class="summary">Get this lens flare's sun sprite ID.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:GetPitch">LensFlare:GetPitch()</a></td>
<td class="summary">Get this lens flare's pitch angle in degrees.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:GetYaw">LensFlare:GetYaw()</a></td>
<td class="summary">Get this lens flare's yaw angle in degrees.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:GetColor">LensFlare:GetColor()</a></td>
<td class="summary">Get the lens flare's color.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:GetEnabled">LensFlare:GetEnabled()</a></td>
<td class="summary">Get this lens flare's enabled status.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:SetSunSpriteID">LensFlare:SetSunSpriteID(spriteID)</a></td>
<td class="summary">Set this lens flare's sun sprite ID.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:SetPitch">LensFlare:SetPitch(pitch)</a></td>
<td class="summary">Set this lens flare's pitch angle.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:SetYaw">LensFlare:SetYaw(yaw)</a></td>
<td class="summary">Set this lens flare's yaw angle.</td>
</tr>
<tr>
<td class="name" ><a href="#LensFlare:SetColor">LensFlare:SetColor(color)</a></td>
<td class="summary">Set this lens flare's color.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Members"></a>Members</h2>
<dl class="function">
<dt>
<a name = "enabled"></a>
<strong>enabled</strong>
</dt>
<dd>
(bool) Lens flare enabled state.
If set to true, lens flare will be visible.
</dd>
<dt>
<a name = "spriteID"></a>
<strong>spriteID</strong>
</dt>
<dd>
(int) Lens flare's sun sprite object ID.
</dd>
<dt>
<a name = "pitch"></a>
<strong>pitch</strong>
</dt>
<dd>
(float) Lens flare's pitch (vertical) angle in degrees.
</dd>
<dt>
<a name = "yaw"></a>
<strong>yaw</strong>
</dt>
<dd>
(float) Lens flare's yaw (horizontal) angle in degrees.
</dd>
<dt>
<a name = "color"></a>
<strong>color</strong>
</dt>
<dd>
(Color) Lens flare's color.
</dd>
</dl>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
@ -207,193 +272,6 @@
</dd>
<dt>
<a name = "LensFlare:GetSunSpriteID"></a>
<strong>LensFlare:GetSunSpriteID()</strong>
</dt>
<dd>
Get this lens flare's sun sprite ID.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Sprite ID.
</ol>
</dd>
<dt>
<a name = "LensFlare:GetPitch"></a>
<strong>LensFlare:GetPitch()</strong>
</dt>
<dd>
Get this lens flare's pitch angle in degrees.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">float</span></span>
Pitch angle in degrees.
</ol>
</dd>
<dt>
<a name = "LensFlare:GetYaw"></a>
<strong>LensFlare:GetYaw()</strong>
</dt>
<dd>
Get this lens flare's yaw angle in degrees.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">float</span></span>
Yaw angle in degrees.
</ol>
</dd>
<dt>
<a name = "LensFlare:GetColor"></a>
<strong>LensFlare:GetColor()</strong>
</dt>
<dd>
Get the lens flare's color.
</dd>
<dt>
<a name = "LensFlare:GetEnabled"></a>
<strong>LensFlare:GetEnabled()</strong>
</dt>
<dd>
Get this lens flare's enabled status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Enabled status. <strong>true: enabled</strong>, <strong>false: disabled</strong>
</ol>
</dd>
<dt>
<a name = "LensFlare:SetSunSpriteID"></a>
<strong>LensFlare:SetSunSpriteID(spriteID)</strong>
</dt>
<dd>
Set this lens flare's sun sprite ID.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">spriteID</span>
<span class="types"><span class="type">int</span></span>
New sun sprite ID.
</li>
</ul>
</dd>
<dt>
<a name = "LensFlare:SetPitch"></a>
<strong>LensFlare:SetPitch(pitch)</strong>
</dt>
<dd>
Set this lens flare's pitch angle.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pitch</span>
<span class="types"><span class="type">float</span></span>
New pitch angle in degrees.
</li>
</ul>
</dd>
<dt>
<a name = "LensFlare:SetYaw"></a>
<strong>LensFlare:SetYaw(yaw)</strong>
</dt>
<dd>
Set this lens flare's yaw angle.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">yaw</span>
<span class="types"><span class="type">float</span></span>
New yaw angle in degrees.
</li>
</ul>
</dd>
<dt>
<a name = "LensFlare:SetColor"></a>
<strong>LensFlare:SetColor(color)</strong>
</dt>
<dd>
Set this lens flare's color.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
New color.
</li>
</ul>
</dd>
</dl>

6
Documentation/doc/3 primitive 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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <here>Flow.SkyLayer</here></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -116,7 +116,7 @@
<h1>Primitive Class <code>Flow.SkyLayer</code></h1>
<p>Describes a layer of moving clouds.</p>
<p>As seen in TR4's City of the Dead.</p>
<p> To be used with <a href="../2 classes/Flow.Level.html#layer1">Flow.Level.layer1</a> and <a href="../2 classes/Flow.Level.html#layer2">Flow.Level.layer2</a> properties.</p>
<h2><a href="#Members">Members</a></h2>

369
Documentation/doc/3 primitive classes/Flow.Starfield.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <here>Flow.Starfield</here></li>
<li> <here>Flow.StarField</here></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -114,75 +114,116 @@
<div id="content">
<h1>Primitive Class <code>Flow.Starfield</code></h1>
<p>Represents a starfield in the sky.</p>
<p>
</p>
<h1>Primitive Class <code>Flow.StarField</code></h1>
<p>Represents a star field in the sky.</p>
<p> To be used with <a href="../2 classes/Flow.Level.html#starField">Flow.Level.starField</a> property.</p>
<h2><a href="#Members">Members</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#starCount">starCount</a></td>
<td class="summary">(int) Amount of visible stars.</td>
</tr>
<tr>
<td class="name" ><a href="#meteorCount">meteorCount</a></td>
<td class="summary">(int) Amount of visible meteors.</td>
</tr>
<tr>
<td class="name" ><a href="#meteorSpawnDensity">meteorSpawnDensity</a></td>
<td class="summary">(int) Meteor spawn density.</td>
</tr>
<tr>
<td class="name" ><a href="#meteorVelocity">meteorVelocity</a></td>
<td class="summary">(int) Meteor velocity.</td>
</tr>
</table>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Starfield">Starfield(starCount)</a></td>
<td class="name" ><a href="#StarField">StarField(starCount)</a></td>
<td class="summary">Create a starfield object with only stars.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield">Starfield(starCount, meteorCount, meteorSpawnDensity, meteorVel)</a></td>
<td class="name" ><a href="#StarField">StarField(starCount, meteorCount, meteorSpawnDensity, meteorVel)</a></td>
<td class="summary">Create a starfield object with stars and meteors.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetStarCount">Starfield:GetStarCount()</a></td>
<td class="summary">Get this starfield's number of stars.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetMeteorCount">Starfield:GetMeteorCount()</a></td>
<td class="summary">Get this starfield's number of meteors.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetMeteorSpawnDensity">Starfield:GetMeteorSpawnDensity()</a></td>
<td class="summary">Get this starfield's meteor spawn density.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetMeteorVelocity">Starfield:GetMeteorVelocity()</a></td>
<td class="summary">Get this starfield's meteor velocity.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetStarsEnabled">Starfield:GetStarsEnabled()</a></td>
<td class="summary">Get this starfield's stars enabled status.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:GetMeteorsEnabled">Starfield:GetMeteorsEnabled()</a></td>
<td class="summary">Get this starfield's meteors enabled status.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:SetStarCount">Starfield:SetStarCount(count)</a></td>
<td class="summary">Set this starfield's number of stars.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:SetMeteorCount">Starfield:SetMeteorCount(count)</a></td>
<td class="summary">Set this starfield's number of meteors.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:SetMeteorSpawnDensity">Starfield:SetMeteorSpawnDensity(density)</a></td>
<td class="summary">Set this starfield's meteor spawn density.</td>
</tr>
<tr>
<td class="name" ><a href="#Starfield:SetMeteorVelocity">Starfield:SetMeteorVelocity(velocity)</a></td>
<td class="summary">Set this starfield's meteor velocity.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Members"></a>Members</h2>
<dl class="function">
<dt>
<a name = "starCount"></a>
<strong>starCount</strong>
</dt>
<dd>
(int) Amount of visible stars.
</dd>
<dt>
<a name = "meteorCount"></a>
<strong>meteorCount</strong>
</dt>
<dd>
(int) Amount of visible meteors.
</dd>
<dt>
<a name = "meteorSpawnDensity"></a>
<strong>meteorSpawnDensity</strong>
</dt>
<dd>
(int) Meteor spawn density.
</dd>
<dt>
<a name = "meteorVelocity"></a>
<strong>meteorVelocity</strong>
</dt>
<dd>
(int) Meteor velocity.
</dd>
</dl>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Starfield"></a>
<strong>Starfield(starCount)</strong>
<a name = "StarField"></a>
<strong>StarField(starCount)</strong>
</dt>
<dd>
Create a starfield object with only stars.
@ -200,8 +241,8 @@
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Flow.Starfield.html#Starfield">Starfield</a></span>
A new Starfield object.
<span class="types"><span class="type">Starfield</span></span>
A new StarField object.
</ol>
@ -209,8 +250,8 @@
</dd>
<dt>
<a name = "Starfield"></a>
<strong>Starfield(starCount, meteorCount, meteorSpawnDensity, meteorVel)</strong>
<a name = "StarField"></a>
<strong>StarField(starCount, meteorCount, meteorSpawnDensity, meteorVel)</strong>
</dt>
<dd>
Create a starfield object with stars and meteors.
@ -240,227 +281,13 @@
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Flow.Starfield.html#Starfield">Starfield</a></span>
A new Starfield object.
<span class="types"><a class="type" href="../3 primitive classes/Flow.StarField.html#StarField">StarField</a></span>
A new StarField object.
</ol>
</dd>
<dt>
<a name = "Starfield:GetStarCount"></a>
<strong>Starfield:GetStarCount()</strong>
</dt>
<dd>
Get this starfield's number of stars.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Count.
</ol>
</dd>
<dt>
<a name = "Starfield:GetMeteorCount"></a>
<strong>Starfield:GetMeteorCount()</strong>
</dt>
<dd>
Get this starfield's number of meteors.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Count.
</ol>
</dd>
<dt>
<a name = "Starfield:GetMeteorSpawnDensity"></a>
<strong>Starfield:GetMeteorSpawnDensity()</strong>
</dt>
<dd>
Get this starfield's meteor spawn density.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Spawn density.
</ol>
</dd>
<dt>
<a name = "Starfield:GetMeteorVelocity"></a>
<strong>Starfield:GetMeteorVelocity()</strong>
</dt>
<dd>
Get this starfield's meteor velocity.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">float</span></span>
Velocity.
</ol>
</dd>
<dt>
<a name = "Starfield:GetStarsEnabled"></a>
<strong>Starfield:GetStarsEnabled()</strong>
</dt>
<dd>
Get this starfield's stars enabled status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Stars enabled status. <strong>true: enabled</strong>, <strong>false: disabled</strong>
</ol>
</dd>
<dt>
<a name = "Starfield:GetMeteorsEnabled"></a>
<strong>Starfield:GetMeteorsEnabled()</strong>
</dt>
<dd>
Get this starfield's meteors enabled status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Meteors enabled status. <strong>true: enabled</strong>, <strong>false: disabled</strong>
</ol>
</dd>
<dt>
<a name = "Starfield:SetStarCount"></a>
<strong>Starfield:SetStarCount(count)</strong>
</dt>
<dd>
Set this starfield's number of stars.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">count</span>
<span class="types"><span class="type">int</span></span>
New star count.
</li>
</ul>
</dd>
<dt>
<a name = "Starfield:SetMeteorCount"></a>
<strong>Starfield:SetMeteorCount(count)</strong>
</dt>
<dd>
Set this starfield's number of meteors.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">count</span>
<span class="types"><span class="type">int</span></span>
New meteor count.
</li>
</ul>
</dd>
<dt>
<a name = "Starfield:SetMeteorSpawnDensity"></a>
<strong>Starfield:SetMeteorSpawnDensity(density)</strong>
</dt>
<dd>
Set this starfield's meteor spawn density.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">density</span>
<span class="types"><span class="type">int</span></span>
New meteor spawn density.
</li>
</ul>
</dd>
<dt>
<a name = "Starfield:SetMeteorVelocity"></a>
<strong>Starfield:SetMeteorVelocity(velocity)</strong>
</dt>
<dd>
Set this starfield's meteor velocity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">velocity</span>
<span class="types"><span class="type">float</span></span>
New meteor velocity.
</li>
</ul>
</dd>
</dl>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <here>Rotation</here></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/3 primitive classes/Time.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <here>Time</here></li>

86
Documentation/doc/3 primitive classes/Vec2.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -143,23 +143,19 @@
<td class="summary">Create a Vec2 object.</td>
</tr>
<tr>
<td class="name" ><a href="#__tostring">__tostring(This)</a></td>
<td class="summary">Metafunction.</td>
</tr>
<tr>
<td class="name" ><a href="#Vec2:Normalize">Vec2:Normalize()</a></td>
<td class="summary">Get a copy of this Vec2 normalized to length 1.</td>
</tr>
<tr>
<td class="name" ><a href="#Translate">Translate(dir, dist)</a></td>
<td class="name" ><a href="#Vec2:Translate">Vec2:Translate(dir, dist)</a></td>
<td class="summary">Get a copy of this Vec2 translated in the input Vec2 direction by the input distance.</td>
</tr>
<tr>
<td class="name" ><a href="#Translate">Translate(rot, dist)</a></td>
<td class="name" ><a href="#Vec2:Translate">Vec2:Translate(rot, dist)</a></td>
<td class="summary">Get a copy of this Vec2 translated in the direction of the input rotation in degrees by the input distance.</td>
</tr>
<tr>
<td class="name" ><a href="#Translate">Translate(rot, relOffset)</a></td>
<td class="name" ><a href="#Vec2:Translate">Vec2:Translate(rot, relOffset)</a></td>
<td class="summary">Get a copy of this Vec2 translated by an offset, where the input relative offset Vec2 is rotated according to the input rotation in degrees.</td>
</tr>
<tr>
@ -186,6 +182,10 @@
<td class="name" ><a href="#Vec2:Length">Vec2:Length()</a></td>
<td class="summary">Get the length of this Vec2.</td>
</tr>
<tr>
<td class="name" ><a href="#__tostring">__tostring(This)</a></td>
<td class="summary">Metafunction.</td>
</tr>
</table>
<br/>
@ -288,34 +288,6 @@
</dd>
<dt>
<a name = "__tostring"></a>
<strong>__tostring(This)</strong>
</dt>
<dd>
Metafunction. Use tostring(vector).
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">This</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
Vec2.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
A string showing the X and Y components of the Vec2.
</ol>
</dd>
<dt>
<a name = "Vec2:Normalize"></a>
@ -339,8 +311,8 @@
</dd>
<dt>
<a name = "Translate"></a>
<strong>Translate(dir, dist)</strong>
<a name = "Vec2:Translate"></a>
<strong>Vec2:Translate(dir, dist)</strong>
</dt>
<dd>
Get a copy of this Vec2 translated in the input Vec2 direction by the input distance.
@ -371,8 +343,8 @@
</dd>
<dt>
<a name = "Translate"></a>
<strong>Translate(rot, dist)</strong>
<a name = "Vec2:Translate"></a>
<strong>Vec2:Translate(rot, dist)</strong>
</dt>
<dd>
Get a copy of this Vec2 translated in the direction of the input rotation in degrees by the input distance.
@ -403,8 +375,8 @@
</dd>
<dt>
<a name = "Translate"></a>
<strong>Translate(rot, relOffset)</strong>
<a name = "Vec2:Translate"></a>
<strong>Vec2:Translate(rot, relOffset)</strong>
</dt>
<dd>
Get a copy of this Vec2 translated by an offset, where the input relative offset Vec2 is rotated according to the input rotation in degrees.
@ -598,6 +570,34 @@
</dd>
<dt>
<a name = "__tostring"></a>
<strong>__tostring(This)</strong>
</dt>
<dd>
Metafunction. Use tostring(vector).
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">This</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
Vec2.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
A string showing the X and Y components of the Vec2.
</ol>
</dd>
</dl>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Collision.MaterialType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Effects.FeatherMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

8
Documentation/doc/4 enums/Effects.ParticleAnimationType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
@ -116,9 +116,7 @@
<h1>Enum <code>Effects.ParticleAnimationType</code></h1>
<p>Constants for particle animation type constants.</p>
<p>
</p>
<p> To be used with <a href="../1 modules/Effects.html#EmitAdvancedParticle">Effects.EmitAdvancedParticle</a> function.</p>
<h2><a href="#Tables">Tables</a></h2>

4
Documentation/doc/4 enums/Flow.ErrorMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Flow.FreezeMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Flow.GameStatus.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Input.ActionID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Objects.AmmoType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Objects.HandStatus.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Objects.MoveableStatus.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Objects.WeaponType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Sound.SoundTrackType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Strings.DisplayStringOption.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/Util.LogLevel.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/View.AlignMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/View.CameraType.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/View.PostProcessMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/4 enums/View.ScaleMode.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/5 lua utility modules/CustomBar.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/5 lua utility modules/Diary.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

4
Documentation/doc/5 lua utility modules/Type.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>TombEngine 1.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="../3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="../3 primitive classes/Time.html">Time</a></li>

30
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.7.2 (Developer) Lua API</title>
<title>TombEngine 1.8 Lua API</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
@ -68,7 +68,7 @@
<li> <a href="3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<li> <a href="3 primitive classes/Flow.StarField.html">Flow.StarField</a></li>
<li> <a href="3 primitive classes/Color.html">Color</a></li>
<li> <a href="3 primitive classes/Rotation.html">Rotation</a></li>
<li> <a href="3 primitive classes/Time.html">Time</a></li>
@ -115,25 +115,25 @@
<div id="content">
<h2>TombEngine 1.7.2 (Developer) 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>
<h2>TombEngine 1.8 scripting interface</h2>
<p>Welcome to the TombEngine scripting API.</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>
<h4>Module Hierarchy (boring but important)</h4>
<p>Other than the "special tables" (GameVars, LevelVars and LevelFuncs), every module described herein is held in a master table called TEN.
<p>Note that this is primarily a reference document, not a tutorial, so expect descriptions to be fairly sparse.
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>
<h4>Module Hierarchy</h4>
<p>Other than the "special tables" (<code>GameVars</code>, <code>LevelVars</code> and <code>LevelFuncs</code>), every module described herein is held in a master table called TEN.
For convenience, these modules and classes are automatically put in the global table. For example, you can call GetMoveableByName either of these two ways:</p>
<pre><code>local door = TEN.Objects.GetMoveableByName("door_type4_14")
local door = GetMoveableByName("door_type4_14")
</code></pre>
<h4>Always check logs/TENLog.txt</h4>
<p>If you are scripting levels, TombEngine will often kick you back to the title screen, even if <code>errorMode</code> (see Flow.Settings) is set to <code>ErrorMode.WARN</code> or <code>ErrorMode.SILENT</code>.</p>
<p>If you are scripting levels, TombEngine will often kick you back to the title screen, even if <code>errorMode</code> (see <a href="2 classes/Flow.Settings.html#">Flow.Settings</a>) is set to <code>ErrorMode.WARN</code> or <code>ErrorMode.SILENT</code>.</p>
<p>This might get annoying, but it's on purpose. If your Lua script contains a syntax error (e.g. you're missing <code>end</code> at the end of a function), the Lua interpreter will not be able to continue running the script. If it tried to keep running, you'd probably see some pretty strange behaviour, and would possibly get a crash regardless.</p>
<p>This might get annoying, but it's on purpose. If your Lua script contains a syntax error (e.g. you're missing <code>end</code> at the end of a function), the Lua interpreter will not be able to continue running the script. If it tried to keep running, you'd probably see some pretty strange behaviour, and would possibly get a crash regardless. If this happens, check <strong>logs/TENLog.txt</strong> and look for an error message with the word "unrecoverable".</p>
<p>If this happens, check <strong>logs/TENLog.txt</strong> and look for an error message with the word "unrecoverable".</p>
<p>Enjoy.</p>
<p>Happy building!</p>
<p>- <em>squidshire and the TombEngine development team.</em></p>
@ -247,7 +247,7 @@ local door = GetMoveableByName("door_type4_14")
<table class="module_list">
<tr>
<td class="name" ><a href="3 primitive classes/Flow.Fog.html">Flow.Fog</a></td>
<td class="summary">Distance fog.</td>
<td class="summary">Represesnts distance fog.</td>
</tr>
<tr>
<td class="name" ><a href="3 primitive classes/Flow.Horizon.html">Flow.Horizon</a></td>
@ -266,8 +266,8 @@ local door = GetMoveableByName("door_type4_14")
<td class="summary">Describes a layer of moving clouds.</td>
</tr>
<tr>
<td class="name" ><a href="3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></td>
<td class="summary">Represents a starfield in the sky.</td>
<td class="name" ><a href="3 primitive classes/Flow.StarField.html">Flow.StarField</a></td>
<td class="summary">Represents a star field in the sky.</td>
</tr>
<tr>
<td class="name" ><a href="3 primitive classes/Color.html">Color</a></td>

73
TombEngine/Game/effects/weather.cpp
View file

@ -232,52 +232,65 @@ namespace TEN::Effects::Environment
void EnvironmentController::UpdateStarfield(const ScriptInterfaceLevel& level)
{
if (!level.GetStarfieldStarsEnabled())
int starCount = level.GetStarfieldStarCount();
if (starCount == 0)
return;
if (ResetStarField)
{
int starCount = level.GetStarfieldStarCount();
Stars.clear();
Stars.reserve(starCount);
ResetStarField = false;
}
for (int i = 0; i < starCount; i++)
if (starCount != Stars.size())
{
// If starCount increased, add new stars to existing list.
if (starCount > Stars.size())
{
auto starDir = Random::GenerateDirectionInCone(-Vector3::UnitY, 70.0f);
starDir.Normalize();
// Reserve space for new stars if necessary.
Stars.reserve(starCount);
auto star = StarParticle{};
star.Direction = starDir;
star.Color = Vector3(
Random::GenerateFloat(0.6f, 1.0f),
Random::GenerateFloat(0.6f, 1.0f),
Random::GenerateFloat(0.6f, 1.0f));
star.Scale = Random::GenerateFloat(0.5f, 1.5f);
float cosine = Vector3::UnitY.Dot(starDir);
float maxCosine = cos(DEG_TO_RAD(50.0f));
float minCosine = cos(DEG_TO_RAD(70.0f));
if (cosine >= minCosine && cosine <= maxCosine)
for (int i = (int)Stars.size(); i < starCount; i++)
{
star.Extinction = (cosine - minCosine) / (maxCosine - minCosine);
}
else
{
star.Extinction = 1.0f;
}
auto starDir = Random::GenerateDirectionInCone(-Vector3::UnitY, 70.0f);
starDir.Normalize();
Stars.push_back(star);
auto star = StarParticle{};
star.Direction = starDir;
star.Color = Vector3(
Random::GenerateFloat(0.6f, 1.0f),
Random::GenerateFloat(0.6f, 1.0f),
Random::GenerateFloat(0.6f, 1.0f));
star.Scale = Random::GenerateFloat(0.5f, 1.5f);
float cosine = Vector3::UnitY.Dot(starDir);
float maxCosine = cos(DEG_TO_RAD(50.0f));
float minCosine = cos(DEG_TO_RAD(70.0f));
if (cosine >= minCosine && cosine <= maxCosine)
{
star.Extinction = (cosine - minCosine) / (maxCosine - minCosine);
}
else
{
star.Extinction = 1.0f;
}
Stars.push_back(star);
}
}
// If starCount decreased, resize vector without reinitializing.
else
{
Stars.resize(starCount);
}
ResetStarField = false;
}
for (auto& star : Stars)
star.Blinking = Random::GenerateFloat(0.5f, 1.0f);
if (level.GetStarfieldMeteorsEnabled())
if (level.GetStarfieldMeteorCount() > 0)
{
for (auto& meteor : Meteors)
{
@ -639,7 +652,7 @@ namespace TEN::Effects::Environment
Meteors.end());
}
if (!level.GetStarfieldMeteorsEnabled())
if (level.GetStarfieldMeteorCount() == 0)
return;
int density = level.GetStarfieldMeteorSpawnDensity();

2
TombEngine/Scripting/Include/ScriptInterfaceLevel.h
View file

@ -62,8 +62,6 @@ public:
virtual Color GetLensFlareColor() const = 0;
// Starfield getters
virtual bool GetStarfieldStarsEnabled() const = 0;
virtual bool GetStarfieldMeteorsEnabled() const = 0;
virtual int GetStarfieldStarCount() const = 0;
virtual int GetStarfieldMeteorCount() const = 0;
virtual int GetStarfieldMeteorSpawnDensity() const = 0;

19
TombEngine/Scripting/Internal/ReservedScriptNames.h
View file

@ -433,25 +433,6 @@ constexpr char ScriptReserved_ProbePreview[] = "Preview";
constexpr char ScriptReserved_MaterialType[] = "MaterialType";
// ====
// FLOW
// ====
// Horizon
constexpr char ScriptReserved_Horizon[] = "Horizon";
constexpr char ScriptReserved_HorizonGetEnabled[] = "GetEnabled";
constexpr char ScriptReserved_HorizonGetObjectID[] = "GetObjectID";
constexpr char ScriptReserved_HorizonGetPosition[] = "GetPosition";
constexpr char ScriptReserved_HorizonGetRotation[] = "GetRotation";
constexpr char ScriptReserved_HorizonGetTransparency[] = "GetTransparency";
constexpr char ScriptReserved_HorizonSetEnabled[] = "SetEnabled";
constexpr char ScriptReserved_HorizonSetObjectID[] = "SetObjectID";
constexpr char ScriptReserved_HorizonSetPosition[] = "SetPosition";
constexpr char ScriptReserved_HorizonSetRotation[] = "SetRotation";
constexpr char ScriptReserved_HorizonSetTransparency[] = "SetTransparency";
// =======
// OBJECTS
// =======

2
TombEngine/Scripting/Internal/TEN/Effects/ParticleAnimTypes.h
View file

@ -4,7 +4,7 @@
namespace TEN::Scripting::Effects
{
/// Constants for particle animation type constants.
/// Constants for particle animation type constants. To be used with @{Effects.EmitAdvancedParticle} function.
// @enum Effects.ParticleAnimationType
// @pragma nostrip

2
TombEngine/Scripting/Internal/TEN/Flow/Fog/Fog.cpp
View file

@ -6,7 +6,7 @@
using namespace TEN::Scripting::Types;
/***
Distance fog.
Represesnts distance fog. To be used with @{Flow.Level.fog} property.
@tenprimitive Flow.Fog
@pragma nostrip

78
TombEngine/Scripting/Internal/TEN/Flow/Horizon/Horizon.cpp
View file

@ -9,7 +9,7 @@
namespace TEN::Scripting
{
/// Represents a horizon.
/// Represents a horizon. To be used with @{Flow.Level.horizon1} and @{Flow.Level.horizon2} properties.
//
// @tenprimitive Flow.Horizon
// @pragma nostrip
@ -22,22 +22,32 @@ namespace TEN::Scripting
// Register type.
parent.new_usertype<Horizon>(
ScriptReserved_Horizon,
"Horizon",
ctors(), sol::call_constructor, ctors(),
// Getters
ScriptReserved_HorizonGetEnabled, &Horizon::GetEnabled,
ScriptReserved_HorizonGetObjectID, &Horizon::GetObjectID,
ScriptReserved_HorizonGetPosition, &Horizon::GetPosition,
ScriptReserved_HorizonGetRotation, &Horizon::GetRotation,
ScriptReserved_HorizonGetTransparency, &Horizon::GetTransparency,
/// (bool) Horizon enabled state.
// If set to true, horizon will be visible.
// @mem enabled
"enabled", sol::property(&Horizon::GetEnabled, &Horizon::SetEnabled),
// Setters
ScriptReserved_HorizonSetEnabled, &Horizon::SetEnabled,
ScriptReserved_HorizonSetObjectID, &Horizon::SetObjectID,
ScriptReserved_HorizonSetPosition, &Horizon::SetPosition,
ScriptReserved_HorizonSetRotation, &Horizon::SetRotation,
ScriptReserved_HorizonSetTransparency, &Horizon::SetTransparency);
/// (Objects.ObjID) Horizon object ID.
// @mem objectID
"objectID", sol::property(&Horizon::GetObjectID, &Horizon::SetObjectID),
/// (Vec3) Horizon position.
// Specifies an offset from the camera origin.
// @mem position
"position", sol::property(&Horizon::GetPosition, &Horizon::SetPosition),
/// (Rotation) Horizon rotation.
// Specifies horizon rotation.
// @mem rotation
"rotation", sol::property(&Horizon::GetRotation, &Horizon::SetRotation),
/// (float) Horizon transparency.
// Specifies horizon transparency on a range from 0 to 1.
// @mem transparency
"transparency", sol::property(&Horizon::GetTransparency, &Horizon::SetTransparency));
}
/// Create a horizon object.
@ -56,89 +66,53 @@ namespace TEN::Scripting
_enabled = enabled;
}
/// Get the horizon's enabled state.
// @function GetEnabled
// @treturn bool Enabled state.
bool Horizon::GetEnabled() const
{
return _enabled;
}
/// Get the horizon's slot object ID.
// @function GetObjectID
// @treturn Objects.ObjID Object ID.
GAME_OBJECT_ID Horizon::GetObjectID() const
{
return _objectID;
}
/// Get the horizon's world position.
// @function GetPosition
// @treturn Vec3 Position.
const Vec3 Horizon::GetPosition() const
{
return _position;
}
/// Get the horizon's rotation.
// @function GetRotation
// @treturn Rotation Rotation.
const Rotation Horizon::GetRotation() const
{
return _rotation;
}
/// Get the horizon's transparency.
// @function GetTransparency
// @treturn float Transparency.
const float Horizon::GetTransparency() const
{
return _transparency;
}
/// Set the horizon's enabled state.
// @function SetEnabled
// @tparam bool enabled New enabled state.
void Horizon::SetEnabled(bool value)
{
_enabled = value;
}
/// Set the horizon's object ID.
// @function SetObjectID
// @tparam Objects.ObjID objectID Object ID.
void Horizon::SetObjectID(GAME_OBJECT_ID objectID)
{
_objectID = objectID;
}
/// Set the horizon's world position.
// @function SetPosition
// @tparam Vec3 pos New world position.
// @tparam[opt] bool noInterpolation Disable interpolation with the previous frame's position. __default: false__
void Horizon::SetPosition(const Vec3& pos, TypeOrNil<bool> noInterpolation)
{
bool convertedDisableInterp = ValueOr<bool>(noInterpolation, false);
_prevPosition = convertedDisableInterp ? pos : _position;
_prevPosition = ValueOr<bool>(noInterpolation, false) ? pos : _position;
_position = pos;
}
/// Set the horizon's rotation.
// @function SetRotation
// @tparam Rotation rot New rotation.
// @tparam[opt] bool noInterpolation Disable interpolation with the previous frame's rotation. __default: false__
void Horizon::SetRotation(const Rotation& rot, TypeOrNil<bool> noInterpolation)
{
bool convertedDisableInterp = ValueOr<bool>(noInterpolation, false);
_prevRotation = convertedDisableInterp ? rot : _rotation;
_prevRotation = ValueOr<bool>(noInterpolation, false) ? rot : _rotation;
_rotation = rot;
}
/// Set the horizon's transparency.
// @function SetTransparency
// @tparam float transparency New transparency alpha.
void Horizon::SetTransparency(float value)
{
_transparency = value;

4
TombEngine/Scripting/Internal/TEN/Flow/InventoryItem/InventoryItem.cpp
View file

@ -4,9 +4,7 @@
#include "Scripting/Internal/ReservedScriptNames.h"
#include "Scripting/Internal/ScriptAssert.h"
/***
Represents the properties of an object as it appears in the inventory.
/*** Represents the properties of an object as it appears in the inventory. To be used in @{Flow.Level.objects} list.
@tenprimitive Flow.InventoryItem
@pragma nostrip
*/

64
TombEngine/Scripting/Internal/TEN/Flow/LensFlare/LensFlare.cpp
View file

@ -8,7 +8,7 @@
using namespace TEN::Scripting::Types;
/// Represents a global lens flare (not to be confused with the lens flare object).
/// Represents a global lens flare (not to be confused with the lens flare object). To be used with @{Flow.Level.lensFlare} property.
//
// @tenprimitive Flow.LensFlare
// @pragma nostrip
@ -25,16 +25,39 @@ namespace TEN::Scripting
"LensFlare",
ctors(), sol::call_constructor, ctors(),
/// (bool) Lens flare enabled state.
// If set to true, lens flare will be visible.
// @mem enabled
"enabled", sol::property(&LensFlare::GetEnabled, &LensFlare::SetEnabled),
/// (int) Lens flare's sun sprite object ID.
// @mem spriteID
"spriteID", sol::property(&LensFlare::GetSunSpriteID, &LensFlare::SetSunSpriteID),
/// (float) Lens flare's pitch (vertical) angle in degrees.
// @mem pitch
"pitch", sol::property(&LensFlare::GetPitch, &LensFlare::SetPitch),
/// (float) Lens flare's yaw (horizontal) angle in degrees.
// @mem yaw
"yaw", sol::property(&LensFlare::GetYaw, &LensFlare::SetYaw),
/// (Color) Lens flare's color.
// @mem color
"color", sol::property(&LensFlare::GetColor, &LensFlare::SetColor),
// Compatibility.
"GetSunSpriteID", &LensFlare::GetSunSpriteID,
"GetPitch", &LensFlare::GetPitch,
"GetYaw", &LensFlare::GetYaw,
"GetColor", &LensFlare::GetColor,
"GetEnabled", &LensFlare::GetEnabledStatus,
"GetEnabled", &LensFlare::GetEnabled,
"SetSunSpriteID", &LensFlare::SetSunSpriteID,
"SetPitch", &LensFlare::SetPitch,
"SetYaw", &LensFlare::SetYaw,
"SetColor", &LensFlare::SetColor);
"SetColor", &LensFlare::SetColor,
"SetEnabled", &LensFlare::SetEnabled);
}
/// Create a LensFlare object.
@ -50,48 +73,31 @@ namespace TEN::Scripting
_rotation = Rotation(pitch, yaw, 0.0f);
}
/// Get this lens flare's sun sprite ID.
// @function LensFlare:GetSunSpriteID
// @treturn int Sprite ID.
int LensFlare::GetSunSpriteID() const
{
return _sunSpriteID;
}
/// Get this lens flare's pitch angle in degrees.
// @function LensFlare:GetPitch
// @treturn float Pitch angle in degrees.
float LensFlare::GetPitch() const
{
return _rotation.x;
}
/// Get this lens flare's yaw angle in degrees.
// @function LensFlare:GetYaw
// @treturn float Yaw angle in degrees.
float LensFlare::GetYaw() const
{
return _rotation.y;
}
/// Get the lens flare's color.
// @function LensFlare:GetColor
ScriptColor LensFlare::GetColor() const
{
return _color;
}
/// Get this lens flare's enabled status.
// @function LensFlare:GetEnabled
// @treturn bool Enabled status. __true: enabled__, __false: disabled__
bool LensFlare::GetEnabledStatus() const
bool LensFlare::GetEnabled() const
{
return _isEnabled;
}
/// Set this lens flare's sun sprite ID.
// @function LensFlare:SetSunSpriteID
// @tparam int spriteID New sun sprite ID.
void LensFlare::SetSunSpriteID(int spriteID)
{
// Sprite ID out of range; return early.
@ -104,27 +110,23 @@ namespace TEN::Scripting
_sunSpriteID = spriteID;
}
/// Set this lens flare's pitch angle.
// @function LensFlare:SetPitch
// @tparam float pitch New pitch angle in degrees.
void LensFlare::SetPitch(float pitch)
{
_rotation.x = pitch;
}
/// Set this lens flare's yaw angle.
// @function LensFlare:SetYaw
// @tparam float yaw New yaw angle in degrees.
void LensFlare::SetYaw(float yaw)
{
_rotation.y = yaw;
}
/// Set this lens flare's color.
// @function LensFlare:SetColor
// @tparam Color color New color.
void LensFlare::SetColor(const ScriptColor& color)
{
_color = color;
}
void LensFlare::SetEnabled(bool value)
{
_isEnabled = value;
}
}

3
TombEngine/Scripting/Internal/TEN/Flow/LensFlare/LensFlare.h
View file

@ -39,7 +39,7 @@ namespace TEN::Scripting
float GetPitch() const;
float GetYaw() const;
ScriptColor GetColor() const;
bool GetEnabledStatus() const;
bool GetEnabled() const;
// Setters
@ -47,5 +47,6 @@ namespace TEN::Scripting
void SetPitch(float pitch);
void SetYaw(float yaw);
void SetColor(const ScriptColor& color);
void SetEnabled(bool value);
};
}

38
TombEngine/Scripting/Internal/TEN/Flow/Level/FlowLevel.cpp
View file

@ -15,7 +15,7 @@ These are things things which aren't present in the compiled level file itself.
/// Make a new Level object.
//@function Level
//@treturn Level a Level object
//@treturn Level a Level object.
void Level::Register(sol::table& parent)
{
// Register type.
@ -49,11 +49,11 @@ void Level::Register(sol::table& parent)
//@mem ambientTrack
"ambientTrack", &Level::AmbientTrack,
/// (@{Flow.SkyLayer}) Primary sky layer
/// (@{Flow.SkyLayer}) Primary sky cloud layer.
//@mem layer1
"layer1", &Level::Layer1,
/// (@{Flow.SkyLayer}) Secondary sky layer
/// (@{Flow.SkyLayer}) Secondary sky cloud layer.
//@mem layer2
"layer2", &Level::Layer2,
@ -63,20 +63,20 @@ void Level::Register(sol::table& parent)
"horizon", sol::property(&Level::GetHorizon1Enabled, &Level::SetHorizon1Enabled), // Compatibility.
/// (@{Flow.Horizon}) Second horizon layer.
//@mem horizon1
//@mem horizon2
"horizon2", &Level::Horizon2,
/// (@{Flow.Starfield}) Starfield.
// @mem starfield
"starfield", &Level::Starfield,
/// (@{Flow.StarField}) Starfield in the sky.
// @mem starField
"starField", &Level::Starfield,
"starfield", &Level::Starfield, // Compatibility.
/// (@{Flow.LensFlare}) Global lens flare .
/// (@{Flow.LensFlare}) Global lens flare.
// @mem lensFlare
"lensFlare", &Level::LensFlare,
/// (@{Flow.Fog}) omni fog RGB color and distance.
// As seen in TR4's Desert Railroad.
// If not provided, distance fog will be black.
/// (@{Flow.Fog}) Global distance fog, with specified RGB color and distance.
// If not provided, distance fog will not be visible.
//@mem fog
"fog", &Level::Fog,
@ -126,11 +126,11 @@ e.g. `myLevel.laraType = LaraType.Divesuit`
//@mem resetHub
"resetHub", &Level::ResetHub,
/// (table of @{Flow.InventoryItem}s) table of inventory object overrides
/// (table of @{Flow.InventoryItem}s) A table of inventory object layout overrides.
//@mem objects
"objects", &Level::InventoryObjects,
/// (short) Set Secrets for Level
/// (short) Set total secret count for current level.
//@mem secrets
"secrets", sol::property(&Level::GetSecrets, &Level::SetSecrets)
);
@ -308,7 +308,7 @@ EulerAngles Level::GetHorizonPrevOrientation(int index) const
bool Level::GetLensFlareEnabled() const
{
return LensFlare.GetEnabledStatus();
return LensFlare.GetEnabled();
}
int Level::GetLensFlareSunSpriteID() const
@ -331,16 +331,6 @@ Color Level::GetLensFlareColor() const
return LensFlare.GetColor();
}
bool Level::GetStarfieldStarsEnabled() const
{
return Starfield.GetStarsEnabledStatus();
}
bool Level::GetStarfieldMeteorsEnabled() const
{
return Starfield.GetMeteorsEnabledStatus();
}
int Level::GetStarfieldStarCount() const
{
return Starfield.GetStarCount();

2
TombEngine/Scripting/Internal/TEN/Flow/Level/FlowLevel.h
View file

@ -93,8 +93,6 @@ struct Level : public ScriptInterfaceLevel
Color GetLensFlareColor() const override;
// Starfield getters
bool GetStarfieldStarsEnabled() const override;
bool GetStarfieldMeteorsEnabled() const override;
int GetStarfieldStarCount() const override;
int GetStarfieldMeteorCount() const override;
int GetStarfieldMeteorSpawnDensity() const override;

4
TombEngine/Scripting/Internal/TEN/Flow/SkyLayer/SkyLayer.cpp
View file

@ -7,9 +7,7 @@ namespace TEN::Scripting::Types { class ScriptColor; }
using namespace TEN::Scripting::Types;
/*** Describes a layer of moving clouds.
As seen in TR4's City of the Dead.
/*** Describes a layer of moving clouds. To be used with @{Flow.Level.layer1} and @{Flow.Level.layer2} properties.
@tenprimitive Flow.SkyLayer
@pragma nostrip
*/

76
TombEngine/Scripting/Internal/TEN/Flow/Starfield/Starfield.cpp
View file

@ -6,9 +6,8 @@
using namespace TEN::Effects::Environment;
/// Represents a starfield in the sky.
//
// @tenprimitive Flow.Starfield
/// Represents a star field in the sky. To be used with @{Flow.Level.starField} property.
// @tenprimitive Flow.StarField
// @pragma nostrip
namespace TEN::Scripting
@ -21,38 +20,55 @@ namespace TEN::Scripting
// Register type.
parent.new_usertype<Starfield>(
"Starfield",
"StarField",
ctors(), sol::call_constructor, ctors(),
/// (int) Amount of visible stars.
// @mem starCount
"starCount", sol::property(&Starfield::GetStarCount, &Starfield::SetStarCount),
/// (int) Amount of visible meteors.
// @mem meteorCount
"meteorCount", sol::property(&Starfield::GetMeteorCount, &Starfield::SetMeteorCount),
/// (int) Meteor spawn density.
// @mem meteorSpawnDensity
"meteorSpawnDensity", sol::property(&Starfield::GetMeteorSpawnDensity, &Starfield::SetMeteorSpawnDensity),
/// (int) Meteor velocity.
// @mem meteorVelocity
"meteorVelocity", sol::property(&Starfield::GetMeteorVelocity, &Starfield::SetMeteorVelocity),
// Compatibility.
"GetStarCount", &Starfield::GetStarCount,
"GetMeteorCount", &Starfield::GetMeteorCount,
"GetMeteorSpawnDensity", &Starfield::GetMeteorSpawnDensity,
"GetMeteorVelocity", &Starfield::GetMeteorVelocity,
"GetStarsEnabled", &Starfield::GetStarsEnabledStatus,
"GetMeteorsEnabled", &Starfield::GetMeteorsEnabledStatus,
"SetStarCount", &Starfield::SetStarCount,
"SetMeteorCount", &Starfield::SetMeteorCount,
"SetMeteorSpawnDensity", &Starfield::SetMeteorSpawnDensity,
"SetMeteorVelocity", &Starfield::SetMeteorVelocity);
parent["StarField"] = parent["Starfield"];
}
/// Create a starfield object with only stars.
// @function Starfield
// @function StarField
// @tparam int starCount Star count.
// @treturn Starfield A new Starfield object.
// @treturn Starfield A new StarField object.
Starfield::Starfield(int starCount)
{
_starCount = starCount;
}
/// Create a starfield object with stars and meteors.
// @function Starfield
// @function StarField
// @tparam int starCount Star count. __Max: 6000__
// @tparam int meteorCount Meteor count. __Max: 100__
// @tparam int meteorSpawnDensity Meteor spawn density.
// @tparam int meteorVel Meteor velocity.
// @treturn Starfield A new Starfield object.
// @treturn StarField A new StarField object.
Starfield::Starfield(int starCount, int meteorCount, int meteorSpawnDensity, float meteorVel)
{
if (starCount < 0 || starCount > STAR_COUNT_MAX)
@ -67,57 +83,26 @@ namespace TEN::Scripting
_meteorVelocity = meteorVel;
}
/// Get this starfield's number of stars.
// @function Starfield:GetStarCount
// @treturn int Count.
int Starfield::GetStarCount() const
{
return _starCount;
}
/// Get this starfield's number of meteors.
// @function Starfield:GetMeteorCount
// @treturn int Count.
int Starfield::GetMeteorCount() const
{
return _meteorCount;
}
/// Get this starfield's meteor spawn density.
// @function Starfield:GetMeteorSpawnDensity
// @treturn int Spawn density.
int Starfield::GetMeteorSpawnDensity() const
{
return _meteorSpawnDensity;
}
/// Get this starfield's meteor velocity.
// @function Starfield:GetMeteorVelocity
// @treturn float Velocity.
float Starfield::GetMeteorVelocity() const
{
return _meteorVelocity;
}
/// Get this starfield's stars enabled status.
// @function Starfield:GetStarsEnabled
// @treturn bool Stars enabled status. __true: enabled__, __false: disabled__
bool Starfield::GetStarsEnabledStatus() const
{
return (_starCount > 0);
}
/// Get this starfield's meteors enabled status.
// @function Starfield:GetMeteorsEnabled
// @treturn bool Meteors enabled status. __true: enabled__, __false: disabled__
bool Starfield::GetMeteorsEnabledStatus() const
{
return (_meteorCount > 0);
}
/// Set this starfield's number of stars.
// @function Starfield:SetStarCount
// @tparam int count New star count.
void Starfield::SetStarCount(int count)
{
if (count < 0 || count > STAR_COUNT_MAX)
@ -126,9 +111,6 @@ namespace TEN::Scripting
_starCount = std::clamp(count, 0, STAR_COUNT_MAX);
}
/// Set this starfield's number of meteors.
// @function Starfield:SetMeteorCount
// @tparam int count New meteor count.
void Starfield::SetMeteorCount(int count)
{
if (count < 0 || count > METEOR_COUNT_MAX)
@ -137,17 +119,11 @@ namespace TEN::Scripting
_meteorCount = std::clamp(count, 0, METEOR_COUNT_MAX);
}
/// Set this starfield's meteor spawn density.
// @function Starfield:SetMeteorSpawnDensity
// @tparam int density New meteor spawn density.
void Starfield::SetMeteorSpawnDensity(int spawnDensity)
{
_meteorSpawnDensity = spawnDensity;
}
/// Set this starfield's meteor velocity.
// @function Starfield:SetMeteorVelocity
// @tparam float velocity New meteor velocity.
void Starfield::SetMeteorVelocity(float vel)
{
_meteorVelocity = vel;

2
TombEngine/Scripting/Internal/TEN/Flow/Starfield/Starfield.h
View file

@ -35,8 +35,6 @@ namespace TEN::Scripting
int GetMeteorCount() const;
int GetMeteorSpawnDensity() const;
float GetMeteorVelocity() const;
bool GetStarsEnabledStatus() const;
bool GetMeteorsEnabledStatus() const;
// Setters

2
TombEngine/Scripting/Internal/TEN/Objects/Moveable/MoveableObject.cpp
View file

@ -30,7 +30,7 @@ using namespace TEN::Scripting::Types;
// Examples include the player, traps, enemies, doors, and pickups. See also @{Objects.LaraObject} for player-specific features.
//
// @tenclass Objects.Moveable
// pragma nostrip
// @pragma nostrip
static auto IndexError = IndexErrorMaker(Moveable, ScriptReserved_Moveable);
static auto NewIndexError = NewIndexErrorMaker(Moveable, ScriptReserved_Moveable);

20
TombEngine/Scripting/Internal/TEN/Objects/Room/RoomObject.cpp
View file

@ -51,7 +51,7 @@ using namespace TEN::Scripting::Types;
}
/// Get the room's number.
// @function Room:GetRoomNumber()
// @function Room:GetRoomNumber
// @treturn int Room number.
int Room::GetRoomNumber() const
{
@ -59,7 +59,7 @@ using namespace TEN::Scripting::Types;
}
/// Get the room's unique string identifier.
// @function Room:GetName()
// @function Room:GetName
// @treturn string Room name.
std::string Room::GetName() const
{
@ -67,7 +67,7 @@ using namespace TEN::Scripting::Types;
}
/// Get the room's ambient light color.
// @function Room:GetColor()
// @function Room:GetColor
// @treturn Color Ambient light color.
ScriptColor Room::GetColor() const
{
@ -75,7 +75,7 @@ using namespace TEN::Scripting::Types;
}
/// Get the room's reverb type.
// @function Room:GetReverbType()
// @function Room:GetReverbType
// @treturn Objects.RoomReverb Reverb type.
ReverbType Room::GetReverbType() const
{
@ -83,7 +83,7 @@ using namespace TEN::Scripting::Types;
}
/// Set the room's unique string identifier.
// @function Room:SetName()
// @function Room:SetName
// @tparam string name New name.
void Room::SetName(const std::string& name)
{
@ -104,7 +104,7 @@ using namespace TEN::Scripting::Types;
}
/// Set the room's reverb type.
// @function Room:SetReverbType()
// @function Room:SetReverbType
// @tparam Objects.RoomReverb Reverb type.
void Room::SetReverbType(ReverbType reverb)
{
@ -112,7 +112,7 @@ using namespace TEN::Scripting::Types;
}
/// Set the room's specified flag.
// @function Room:SetFlag()
// @function Room:SetFlag
// @tparam Objects.RoomFlagID flagID Room flag ID.
// @tparam bool Boolean to set the flag to.
void Room::SetFlag(RoomEnvFlags flag, bool value)
@ -128,7 +128,7 @@ using namespace TEN::Scripting::Types;
}
/// Get the room's specified flag value (true or false).
// @function Room:GetFlag()
// @function Room:GetFlag
// @tparam Objects.RoomFlagID flagID Room flag ID.
bool Room::IsTagPresent(const std::string& tag) const
{
@ -144,7 +144,7 @@ using namespace TEN::Scripting::Types;
}
/// Check if the specified tag is set for the room.
// @function Room:IsTagPresent()
// @function Room:IsTagPresent
// @tparam string tag Text tag to check (case sensitive).
// @treturn bool Boolean of the tag's presence.
bool Room::GetActive() const
@ -153,7 +153,7 @@ using namespace TEN::Scripting::Types;
}
/// Check if the room is active.
// @function Room:GetActive()
// @function Room:GetActive
// @treturn bool Boolean of the room's active status.
bool Room::GetFlag(RoomEnvFlags flag) const
{

68
TombEngine/Scripting/Internal/TEN/Sound/SoundHandler.cpp
View file

@ -14,90 +14,90 @@
namespace TEN::Scripting::Sound
{
/// Play an audio track
//@function PlayAudioTrack
//@tparam string name of track (without file extension) to play
//@tparam Sound.SoundTrackType type of the audio track to play
/// Play an audio track. Supported formats are wav, mp3 and ogg.
// @function PlayAudioTrack
// @tparam string filename Filename of a track (without file extension) to play.
// @tparam Sound.SoundTrackType type Type of the audio track to play.
static void PlayAudioTrack(const std::string& trackName, TypeOrNil<SoundTrackType> mode)
{
auto playMode = ValueOr<SoundTrackType>(mode, SoundTrackType::OneShot);
PlaySoundTrack(trackName, playMode);
}
/// Set and play an ambient track
/// Set and play an ambient track.
// @function SetAmbientTrack
// @tparam string name of track (without file extension) to play
// @tparam bool fromStart specifies whether ambient track should play from the start, or crossfade at a random position
// @tparam string name Name of track (without file extension) to play.
// @tparam bool fromStart Specifies whether ambient track should play from the start, or crossfade at a random position.
static void SetAmbientTrack(const std::string& trackName, TypeOrNil<bool> fromTheBeginning)
{
auto pos = ValueOr<bool>(fromTheBeginning, false) ? std::optional<QWORD>(0) : std::optional<QWORD>();
PlaySoundTrack(trackName, SoundTrackType::BGM, pos, pos.has_value() ? SOUND_XFADETIME_ONESHOT : SOUND_XFADETIME_BGM);
}
///Stop any audio tracks currently playing
//@function StopAudioTracks
/// Stop any audio tracks currently playing.
// @function StopAudioTracks
static void StopAudioTracks()
{
StopSoundTracks();
}
///Stop audio track that is currently playing
//@function StopAudioTrack
//@tparam Sound.SoundTrackType type of the audio track
/// Stop audio track that is currently playing.
// @function StopAudioTrack
// @tparam Sound.SoundTrackType type Type of the audio track.
static void StopAudioTrack(TypeOrNil<SoundTrackType> mode)
{
auto playMode = ValueOr<SoundTrackType>(mode, SoundTrackType::OneShot);
StopSoundTrack(playMode, SOUND_XFADETIME_ONESHOT);
}
///Get current loudness level for specified track type
//@function GetAudioTrackLoudness
//@tparam Sound.SoundTrackType type of the audio track
//@treturn float current loudness of a specified audio track
/// Get current loudness level for specified track type.
// @function GetAudioTrackLoudness
// @tparam Sound.SoundTrackType type Type of the audio track.
// @treturn float Current loudness of a specified audio track.
static float GetAudioTrackLoudness(TypeOrNil<SoundTrackType> mode)
{
auto playMode = ValueOr<SoundTrackType>(mode, SoundTrackType::OneShot);
return GetSoundTrackLoudness(playMode);
}
/// Play sound effect
//@function PlaySound
//@tparam int sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
////@tparam[opt] Vec3 position The 3D position of the sound, i.e. where the sound "comes from". If not given, the sound will not be positional.
/// Play sound effect.
// @function PlaySound
// @tparam int soundID Sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
// @tparam[opt] Vec3 position The 3D position of the sound, i.e. where the sound "comes from". If not given, the sound will not be positional.
static void PlaySoundEffect(int soundID, sol::optional<Vec3> pos)
{
SoundEffect(soundID, pos.has_value() ? &Pose(pos->ToVector3i()) : nullptr, SoundEnvironment::Always);
}
/// Stop sound effect
//@function StopSound
//@tparam int sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
/// Stop sound effect.
// @function StopSound
// @tparam int soundID Sound ID to play. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
static void StopSound(int id)
{
StopSoundEffect(id);
}
/// Check if the sound effect is playing
//@function IsSoundPlaying
//@tparam int Sound ID to check. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
/// Check if the sound effect is playing.
// @function IsSoundPlaying
// @tparam int soundID Sound ID to check. Corresponds to the value in the sound XML file or Tomb Editor's "Sound Infos" window.
static bool IsSoundPlaying(int effectID)
{
return (Sound_EffectIsPlaying(effectID, nullptr) != SOUND_NO_CHANNEL);
}
/// Check if the audio track is playing
//@function IsAudioTrackPlaying
//@tparam string Track filename to check. Should be without extension and without full directory path.
/// Check if the audio track is playing.
// @function IsAudioTrackPlaying
// @tparam string Track Filename to check. Should be without extension and without full directory path.
static bool IsAudioTrackPlaying(const std::string& trackName)
{
return Sound_TrackIsPlaying(trackName);
}
///Get current subtitle string for a voice track currently playing.
//Subtitle file must be in .srt format, have same filename as voice track, and be placed in same directory as voice track.
//Returns nil if no voice track is playing or no subtitle present.
//@function GetCurrentSubtitle
//@treturn string current subtitle string
/// Get current subtitle string for a voice track currently playing.
// Subtitle file must be in .srt format, have same filename as voice track, and be placed in same directory as voice track.
// Returns nil if no voice track is playing or no subtitle present.
// @function GetCurrentSubtitle
// @treturn string Current subtitle string.
static TypeOrNil<std::string> GetCurrentVoiceTrackSubtitle()
{
auto& result = GetCurrentSubtitle();

40
TombEngine/Scripting/Internal/TEN/Types/Rotation/Rotation.cpp
View file

@ -25,6 +25,9 @@ namespace TEN::Scripting
// Meta functions
sol::meta_function::to_string, &Rotation::ToString,
sol::meta_function::equal_to, &Rotation::operator ==,
sol::meta_function::addition, &Rotation::operator +,
sol::meta_function::subtraction, &Rotation::operator -,
// Utilities
ScriptReserved_RotationLerp, &Rotation::Lerp,
@ -108,4 +111,41 @@ namespace TEN::Scripting
{
return Vector3(x, y, z);
};
bool Rotation::operator ==(const Rotation& rot) const
{
return (rot.x == x && rot.y == y && rot.z == z);
}
Rotation Rotation::operator +(const Rotation& rot) const
{
return Rotation(WrapAngle(x + rot.x), WrapAngle(y + rot.y), WrapAngle(z + rot.z));
}
Rotation Rotation::operator -(const Rotation& rot) const
{
return Rotation(WrapAngle(x - rot.x), WrapAngle(y - rot.y), WrapAngle(z - rot.z));
}
Rotation& Rotation::operator +=(const Rotation& rot)
{
x = WrapAngle(x + rot.x);
y = WrapAngle(y + rot.y);
z = WrapAngle(z + rot.z);
return *this;
}
Rotation& Rotation::operator -=(const Rotation& rot)
{
x = WrapAngle(x - rot.x);
y = WrapAngle(y - rot.y);
z = WrapAngle(z - rot.z);
return *this;
}
float Rotation::WrapAngle(float angle) const
{
angle -= std::floor(angle / 360.0f) * 360.0f;
return ((angle < 0.0f) ? (angle + 360.0f) : angle);
}
}

11
TombEngine/Scripting/Internal/TEN/Types/Rotation/Rotation.h
View file

@ -40,5 +40,16 @@ namespace TEN::Scripting
// Operators
operator Vector3() const;
bool operator ==(const Rotation& rot) const;
Rotation operator +(const Rotation& rot) const;
Rotation operator -(const Rotation& rot) const;
Rotation& operator +=(const Rotation& rot);
Rotation& operator -=(const Rotation& rot);
private:
// Helpers
float WrapAngle(float angle) const;
};
}

24
TombEngine/Scripting/Internal/TEN/Types/Vec2/Vec2.cpp
View file

@ -84,15 +84,6 @@ Vec2::Vec2(const Vector2& vector)
y = vector.y;
}*/
/// Metafunction. Use tostring(vector).
// @tparam Vec2 This Vec2.
// @treturn string A string showing the X and Y components of the Vec2.
// @function __tostring
std::string Vec2::ToString() const
{
return "{" + std::to_string(x) + ", " + std::to_string(y) + "}";
}
/// Get a copy of this Vec2 normalized to length 1.
// @function Vec2:Normalize
// @treturn Vec2 Normalized vector.
@ -105,7 +96,7 @@ Vec2 Vec2::Normalize() const
}
/// Get a copy of this Vec2 translated in the input Vec2 direction by the input distance.
// @function Translate
// @function Vec2:Translate
// @tparam Vec2 dir Direction vector. Normalized automatically to length 1.
// @tparam float dist Distance.
// @treturn Vec2 Translated vector.
@ -115,7 +106,7 @@ Vec2 Vec2::Translate(const Vec2& dir, float dist)
}
/// Get a copy of this Vec2 translated in the direction of the input rotation in degrees by the input distance.
// @function Translate
// @function Vec2:Translate
// @tparam Rotation rot Rotation in degrees defining the direction.
// @tparam float dist Distance.
// @treturn Vec2 Translated vector.
@ -125,7 +116,7 @@ Vec2 Vec2::Translate(float rot, float dist)
}
/// Get a copy of this Vec2 translated by an offset, where the input relative offset Vec2 is rotated according to the input rotation in degrees.
// @function Translate
// @function Vec2:Translate
// @tparam float rot Rotation in degrees rotating the input relative offset vector.
// @tparam Vec2 relOffset Relative offset vector before rotation.
// @treturn Vec2 Translated vector.
@ -203,6 +194,15 @@ float Vec2::Length() const
return ToVector2().Length();
}
/// Metafunction. Use tostring(vector).
// @tparam Vec2 This Vec2.
// @treturn string A string showing the X and Y components of the Vec2.
// @function __tostring
std::string Vec2::ToString() const
{
return "{" + std::to_string(x) + ", " + std::to_string(y) + "}";
}
Vec2 Vec2::Add(const Vec2& vector0, const Vec2& vector1)
{
return Vec2(vector0.x + vector1.x, vector0.y + vector1.y);