2021-08-23 19:19:36 +01:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< head >
2025-01-05 16:45:30 +00:00
< title > TombEngine 1.7.2 (Developer) Lua API< / title >
2021-08-23 19:19:36 +01:00
< link rel = "stylesheet" href = "../ldoc.css" type = "text/css" / >
< / head >
< body >
< div id = "container" >
< div id = "product" >
< div id = "product_logo" > < / div >
< div id = "product_name" > < big > < b > < / b > < / big > < / div >
< div id = "product_description" > < / div >
< / div > <!-- id="product" -->
< div id = "main" >
<!-- Menu -->
< div id = "navigation" >
< br / >
2024-12-15 19:24:49 +03:00
< h1 > TombEngine< / h1 >
2021-08-23 19:19:36 +01:00
< ul >
< li > < a href = "../index.html" > Index< / a > < / li >
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 1 Modules< / h2 >
2021-08-23 19:19:36 +01:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../1 modules/Effects.html" > Effects< / a > < / li >
< li > < a href = "../1 modules/Flow.html" > Flow< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../1 modules/Input.html" > Input< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../1 modules/Inventory.html" > Inventory< / a > < / li >
< li > < a href = "../1 modules/Logic.html" > Logic< / a > < / li >
< li > < a href = "../1 modules/Objects.html" > Objects< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../1 modules/Sound.html" > Sound< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../1 modules/Strings.html" > Strings< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../1 modules/Util.html" > Util< / a > < / li >
< li > < a href = "../1 modules/View.html" > View< / a > < / li >
2021-08-23 19:19:36 +01:00
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 2 Classes< / h2 >
2021-08-23 19:19:36 +01:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < here > Flow.Level< / here > < / li >
< li > < a href = "../2 classes/Flow.Settings.html" > Flow.Settings< / a > < / li >
2024-12-15 23:59:31 +01:00
< li > < a href = "../2 classes/Flow.Statistics.html" > Flow.Statistics< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Objects.AIObject.html" > Objects.AIObject< / a > < / li >
< li > < a href = "../2 classes/Objects.Camera.html" > Objects.Camera< / a > < / li >
< li > < a href = "../2 classes/Objects.LaraObject.html" > Objects.LaraObject< / a > < / li >
< li > < a href = "../2 classes/Objects.Moveable.html" > Objects.Moveable< / a > < / li >
2022-12-30 16:33:26 +00:00
< li > < a href = "../2 classes/Objects.Room.html" > Objects.Room< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Objects.Sink.html" > Objects.Sink< / a > < / li >
< li > < a href = "../2 classes/Objects.SoundSource.html" > Objects.SoundSource< / a > < / li >
< li > < a href = "../2 classes/Objects.Static.html" > Objects.Static< / a > < / li >
2022-12-16 18:36:42 +00:00
< li > < a href = "../2 classes/Objects.Volume.html" > Objects.Volume< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Strings.DisplayString.html" > Strings.DisplayString< / a > < / li >
2024-12-15 19:24:49 +03:00
< li > < a href = "../2 classes/View.DisplaySprite.html" > View.DisplaySprite< / a > < / li >
2021-08-23 19:19:36 +01:00
< / ul >
2022-04-10 00:38:39 +01:00
< h2 > 3 Primitive Classes< / h2 >
2021-08-23 19:19:36 +01:00
< ul class = "nowrap" >
2024-12-15 19:24:49 +03:00
< li > < a href = "../3 primitive classes/Flow.Fog.html" > Flow.Fog< / a > < / li >
< 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 >
2022-12-09 22:08:16 +00:00
< li > < a href = "../3 primitive classes/Color.html" > Color< / a > < / li >
< li > < a href = "../3 primitive classes/Rotation.html" > Rotation< / a > < / li >
2024-12-15 19:24:49 +03:00
< li > < a href = "../3 primitive classes/Time.html" > Time< / a > < / li >
2023-05-31 21:48:00 +01:00
< li > < a href = "../3 primitive classes/Vec2.html" > Vec2< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../3 primitive classes/Vec3.html" > Vec3< / a > < / li >
2021-08-23 19:19:36 +01:00
< / ul >
2022-04-10 00:38:39 +01:00
< h2 > 4 Enums< / h2 >
2021-08-23 19:19:36 +01:00
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../4 enums/Effects.BlendID.html" > Effects.BlendID< / a > < / li >
< li > < a href = "../4 enums/Effects.EffectID.html" > Effects.EffectID< / a > < / li >
2024-12-15 19:24:49 +03:00
< li > < a href = "../4 enums/Flow.ErrorMode.html" > Flow.ErrorMode< / a > < / li >
2024-11-20 23:54:39 +03:00
< li > < a href = "../4 enums/Flow.FreezeMode.html" > Flow.FreezeMode< / a > < / li >
2023-12-26 20:47:08 +00:00
< li > < a href = "../4 enums/Flow.GameStatus.html" > Flow.GameStatus< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../4 enums/Input.ActionID.html" > Input.ActionID< / a > < / li >
2023-09-28 19:20:04 +01:00
< li > < a href = "../4 enums/Objects.AmmoType.html" > Objects.AmmoType< / a > < / li >
2024-12-15 23:34:33 +01:00
< li > < a href = "../4 enums/Objects.WeaponType.html" > Objects.WeaponType< / a > < / li >
2023-12-26 20:47:08 +00:00
< li > < a href = "../4 enums/Objects.MoveableStatus.html" > Objects.MoveableStatus< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../4 enums/Objects.ObjID.html" > Objects.ObjID< / a > < / li >
2022-12-30 16:33:26 +00:00
< li > < a href = "../4 enums/Objects.RoomFlagID.html" > Objects.RoomFlagID< / a > < / li >
< li > < a href = "../4 enums/Objects.RoomReverb.html" > Objects.RoomReverb< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../4 enums/Sound.SoundTrackType.html" > Sound.SoundTrackType< / a > < / li >
2024-11-16 22:07:57 +11:00
< li > < a href = "../4 enums/Strings.DisplayStringOption.html" > Strings.DisplayStringOption< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../4 enums/Util.LogLevel.html" > Util.LogLevel< / a > < / li >
2023-11-11 12:16:23 +00:00
< li > < a href = "../4 enums/View.AlignMode.html" > View.AlignMode< / a > < / li >
2023-11-09 18:28:02 +00:00
< li > < a href = "../4 enums/View.CameraType.html" > View.CameraType< / a > < / li >
2024-01-07 13:22:52 +00:00
< li > < a href = "../4 enums/View.PostProcessMode.html" > View.PostProcessMode< / a > < / li >
2023-11-11 12:16:23 +00:00
< li > < a href = "../4 enums/View.ScaleMode.html" > View.ScaleMode< / a > < / li >
2021-08-23 19:19:36 +01:00
< / ul >
2022-07-29 21:12:54 +01:00
< h2 > 5 Lua utility modules< / h2 >
< ul class = "nowrap" >
2022-12-09 22:08:16 +00:00
< li > < a href = "../5 lua utility modules/EventSequence.html" > EventSequence< / a > < / li >
< li > < a href = "../5 lua utility modules/Timer.html" > Timer< / a > < / li >
2024-12-16 21:33:37 +01:00
< li > < a href = "../5 lua utility modules/Type.html" > Type< / a > < / li >
2022-07-29 21:12:54 +01:00
< / ul >
2021-08-23 19:19:36 +01:00
< / div >
< div id = "content" >
2022-04-10 00:38:39 +01:00
< h1 > Class < code > Flow.Level< / code > < / h1 >
2021-08-23 19:19:36 +01:00
< p > Stores level metadata.< / p >
< p > These are things things which aren't present in the compiled level file itself.< / p >
< h2 > < a href = "#Members" > Members< / a > < / h2 >
< table class = "function_list" >
2024-11-29 00:09:29 +03:00
< tr >
< td class = "name" > < a href = "#nameKey" > nameKey< / a > < / td >
< td class = "summary" > (string) string key for the level's (localised) name.< / td >
< / tr >
2021-08-23 19:19:36 +01:00
< tr >
< td class = "name" > < a href = "#scriptFile" > scriptFile< / a > < / td >
< td class = "summary" > (string) Level-specific Lua script file.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#levelFile" > levelFile< / a > < / td >
< td class = "summary" > (string) Compiled file path.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#loadScreenFile" > loadScreenFile< / a > < / td >
< td class = "summary" > (string) Load screen image.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#ambientTrack" > ambientTrack< / a > < / td >
< td class = "summary" > (string) initial ambient sound track to play.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#layer1" > layer1< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (< a href = "../3 primitive classes/Flow.SkyLayer.html#" > Flow.SkyLayer< / a > ) Primary sky layer< / td >
2021-08-23 19:19:36 +01:00
< / tr >
< tr >
< td class = "name" > < a href = "#layer2" > layer2< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (< a href = "../3 primitive classes/Flow.SkyLayer.html#" > Flow.SkyLayer< / a > ) Secondary sky layer< / td >
2021-08-23 19:19:36 +01:00
< / tr >
< tr >
2024-04-28 06:31:59 +02:00
< td class = "name" > < a href = "#starfield" > starfield< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (< a href = "../3 primitive classes/Flow.Starfield.html#" > Flow.Starfield< / a > ) Starfield.< / td >
2024-04-28 06:31:59 +02:00
< / tr >
< tr >
< td class = "name" > < a href = "#lensFlare" > lensFlare< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (< a href = "../3 primitive classes/Flow.LensFlare.html#" > Flow.LensFlare< / a > ) Global lens flare .< / td >
2024-04-28 06:31:59 +02:00
< / tr >
< tr >
2021-08-23 19:19:36 +01:00
< td class = "name" > < a href = "#fog" > fog< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (< a href = "../3 primitive classes/Flow.Fog.html#" > Flow.Fog< / a > ) omni fog RGB color and distance.< / td >
2021-08-23 19:19:36 +01:00
< / tr >
< tr >
< td class = "name" > < a href = "#horizon" > horizon< / a > < / td >
< td class = "summary" > (bool) Draw sky layer?< / td >
< / tr >
< tr >
2021-08-23 20:16:01 +01:00
< td class = "name" > < a href = "#storm" > storm< / a > < / td >
< td class = "summary" > (bool) Enable flickering lightning in the sky.< / td >
< / tr >
< tr >
2021-08-23 19:19:36 +01:00
< td class = "name" > < a href = "#weather" > weather< / a > < / td >
< td class = "summary" > (WeatherType) Choose weather effect.< / td >
< / tr >
< tr >
2022-04-10 00:38:39 +01:00
< td class = "name" > < a href = "#weatherStrength" > weatherStrength< / a > < / td >
< td class = "summary" > (float) Choose weather strength.< / td >
< / tr >
< tr >
2021-08-23 19:19:36 +01:00
< td class = "name" > < a href = "#laraType" > laraType< / a > < / td >
< td class = "summary" > (LaraType) Must be one of the LaraType values.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#rumble" > rumble< / a > < / td >
< td class = "summary" > (bool) Enable occasional screen shake effect.< / td >
< / tr >
< tr >
2024-03-21 11:06:50 +02:00
< td class = "name" > < a href = "#resetHub" > resetHub< / a > < / td >
< td class = "summary" > (bool) Reset hub data.< / td >
2021-08-23 19:19:36 +01:00
< / tr >
< tr >
< td class = "name" > < a href = "#objects" > objects< / a > < / td >
2024-12-15 19:24:49 +03:00
< td class = "summary" > (table of < a href = "../3 primitive classes/Flow.InventoryItem.html#" > Flow.InventoryItem< / a > s) table of inventory object overrides< / td >
2021-08-23 19:19:36 +01:00
< / tr >
2022-08-09 22:59:27 +01:00
< tr >
2022-12-01 21:17:41 +00:00
< td class = "name" > < a href = "#secrets" > secrets< / a > < / td >
< td class = "summary" > (short) Set Secrets for Level< / td >
< / tr >
< tr >
2022-08-09 22:59:27 +01:00
< td class = "name" > < a href = "#farView" > farView< / a > < / td >
< td class = "summary" > (int) The maximum draw distance for level.< / td >
< / tr >
2021-08-23 19:19:36 +01:00
< / table >
< h2 > < a href = "#Functions" > Functions< / a > < / h2 >
< table class = "function_list" >
< tr >
2022-08-24 15:01:46 +01:00
< td class = "name" > < a href = "#Level" > Level()< / a > < / td >
2021-08-23 19:19:36 +01:00
< td class = "summary" > Make a new Level object.< / td >
< / tr >
< / table >
< br / >
< br / >
< h2 class = "section-header " > < a name = "Members" > < / a > Members< / h2 >
< dl class = "function" >
2024-11-29 00:09:29 +03:00
< dt >
< a name = "nameKey" > < / a >
< strong > nameKey< / strong >
< / dt >
< dd >
(string) string key for the level's (localised) name.
Corresponds to an entry in strings.lua.
< / dd >
2021-08-23 19:19:36 +01:00
< dt >
< a name = "scriptFile" > < / a >
< strong > scriptFile< / strong >
< / dt >
< dd >
(string) Level-specific Lua script file.
Path of the Lua file holding the level's logic script, relative to the location of the tombengine executable
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "levelFile" > < / a >
< strong > levelFile< / strong >
< / dt >
< dd >
(string) Compiled file path.
This path is relative to the location of the TombEngine executable.
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "loadScreenFile" > < / a >
< strong > loadScreenFile< / strong >
< / dt >
< dd >
(string) Load screen image.
Path of the level's load screen file (.png or .jpg), relative to the location of the tombengine executable
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "ambientTrack" > < / a >
< strong > ambientTrack< / strong >
< / dt >
< dd >
(string) initial ambient sound track to play.
This is the filename of the track < strong > without< / strong > the .wav extension.
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "layer1" > < / a >
< strong > layer1< / strong >
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(< a href = "../3 primitive classes/Flow.SkyLayer.html#" > Flow.SkyLayer< / a > ) Primary sky layer
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "layer2" > < / a >
< strong > layer2< / strong >
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(< a href = "../3 primitive classes/Flow.SkyLayer.html#" > Flow.SkyLayer< / a > ) Secondary sky layer
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2024-04-28 06:31:59 +02:00
< / dd >
< dt >
< a name = "starfield" > < / a >
< strong > starfield< / strong >
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(< a href = "../3 primitive classes/Flow.Starfield.html#" > Flow.Starfield< / a > ) Starfield.
2024-04-28 06:31:59 +02:00
< / dd >
< dt >
< a name = "lensFlare" > < / a >
< strong > lensFlare< / strong >
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(< a href = "../3 primitive classes/Flow.LensFlare.html#" > Flow.LensFlare< / a > ) Global lens flare .
2024-04-28 06:31:59 +02:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "fog" > < / a >
< strong > fog< / strong >
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(< a href = "../3 primitive classes/Flow.Fog.html#" > Flow.Fog< / a > ) omni fog RGB color and distance.
2021-08-23 19:19:36 +01:00
As seen in TR4's Desert Railroad.
2022-08-09 22:59:27 +01:00
If not provided, distance fog will be black.
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "horizon" > < / a >
< strong > horizon< / strong >
< / dt >
< dd >
(bool) Draw sky layer? (default: false)
2022-12-09 22:08:16 +00:00
2021-08-23 20:16:01 +01:00
< / dd >
< dt >
< a name = "storm" > < / a >
< strong > storm< / strong >
< / dt >
< dd >
(bool) Enable flickering lightning in the sky.
2022-04-10 00:38:39 +01:00
Equivalent to classic TRLE's LIGHTNING setting. As in the TRC Ireland levels.
2021-08-23 20:16:01 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "weather" > < / a >
< strong > weather< / strong >
< / dt >
< dd >
(WeatherType) Choose weather effect.
2022-04-10 00:38:39 +01:00
Must be one of the values < code > WeatherType.None< / code > , < code > WeatherType.Rain< / code > , or < code > WeatherType.Snow< / code > .
2021-08-23 19:19:36 +01:00
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
< a name = "weatherStrength" > < / a >
< strong > weatherStrength< / strong >
< / dt >
< dd >
(float) Choose weather strength.
Must be value between < code > 0.1< / code > and < code > 1.0< / code > .
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "laraType" > < / a >
< strong > laraType< / strong >
< / dt >
< dd >
(LaraType) Must be one of the LaraType values.
These are:< / p >
2022-04-10 00:38:39 +01:00
< pre > < code > Normal
Young
Bunhead
Catsuit
Divesuit
Invisible
2021-08-23 19:19:36 +01:00
< / code > < / pre >
2022-04-10 00:38:39 +01:00
< p > e.g. < code > myLevel.laraType = LaraType.Divesuit< / code > < / p >
2021-08-23 19:19:36 +01:00
< p > < strong > (not yet fully implemented)< / strong >
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
< a name = "rumble" > < / a >
< strong > rumble< / strong >
< / dt >
< dd >
(bool) Enable occasional screen shake effect.
As seen in TRC's Sinking Submarine.
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
2024-03-21 11:06:50 +02:00
< a name = "resetHub" > < / a >
< strong > resetHub< / strong >
2021-08-23 19:19:36 +01:00
< / dt >
< dd >
2024-03-21 11:06:50 +02:00
(bool) Reset hub data.
Resets the state for all previous levels, including items, flipmaps and statistics.
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
2022-08-09 22:59:27 +01:00
< a name = "objects" > < / a >
< strong > objects< / strong >
2021-08-23 19:19:36 +01:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(table of < a href = "../3 primitive classes/Flow.InventoryItem.html#" > Flow.InventoryItem< / a > s) table of inventory object overrides
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2022-12-01 21:17:41 +00:00
< / dd >
< dt >
< a name = "secrets" > < / a >
< strong > secrets< / strong >
< / dt >
< dd >
(short) Set Secrets for Level
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< dt >
2022-08-09 22:59:27 +01:00
< a name = "farView" > < / a >
< strong > farView< / strong >
2021-08-23 19:19:36 +01:00
< / dt >
< dd >
2022-08-09 22:59:27 +01:00
(int) The maximum draw distance for level.
Given in sectors (blocks).
Must be at least 4.< / p >
< p > This is equivalent to TRNG's LevelFarView variable.
2021-08-23 19:19:36 +01:00
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< / dd >
< / dl >
< h2 class = "section-header " > < a name = "Functions" > < / a > Functions< / h2 >
< dl class = "function" >
< dt >
2022-08-24 15:01:46 +01:00
< a name = "Level" > < / a >
< strong > Level()< / strong >
2021-08-23 19:19:36 +01:00
< / dt >
< dd >
Make a new Level object.
2022-12-09 22:08:16 +00:00
2021-08-23 19:19:36 +01:00
< h3 > Returns:< / h3 >
< ol >
2022-12-01 21:17:41 +00:00
< span class = "types" > < a class = "type" href = "../2 classes/Flow.Level.html#Level" > Level< / a > < / span >
2021-08-23 19:19:36 +01:00
a Level object
< / ol >
< / dd >
< / dl >
< / div > <!-- id="content" -->
< / div > <!-- id="main" -->
< div id = "about" >
2023-03-31 20:51:44 +01:00
< i > generated by < a href = "https://github.com/hispidence/TEN-LDoc" > TEN-LDoc< / a > (a fork of < a href = "http://github.com/stevedonovan/LDoc" > LDoc 1.4.6< / a > )< / i >
2021-08-23 19:19:36 +01:00
< / div > <!-- id="about" -->
< / div > <!-- id="container" -->
< / body >
< / html >
