2021-08-16 12:55:22 +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 >
2024-11-21 18:27:42 +01:00
< title > TombEngine 1.6 Lua API< / title >
2021-08-16 12:55:22 +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 / >
< h1 > TombEngine< / h1 >
< ul >
< li > < a href = "../index.html" > Index< / a > < / li >
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 1 Modules< / h2 >
2021-08-16 12:55:22 +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-16 12:55:22 +01:00
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 2 Classes< / h2 >
2021-08-16 12:55:22 +01:00
< ul class = "nowrap" >
2023-11-11 12:16:23 +00:00
< li > < a href = "../2 classes/View.DisplaySprite.html" > View.DisplaySprite< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Flow.Animations.html" > Flow.Animations< / a > < / li >
< li > < a href = "../2 classes/Flow.Fog.html" > Flow.Fog< / a > < / li >
< li > < a href = "../2 classes/Flow.InventoryItem.html" > Flow.InventoryItem< / a > < / li >
2024-04-28 06:31:59 +02:00
< li > < a href = "../2 classes/Flow.LensFlare.html" > Flow.LensFlare< / a > < / li >
2022-12-09 22:08:16 +00:00
< li > < a href = "../2 classes/Flow.Level.html" > Flow.Level< / a > < / li >
< li > < a href = "../2 classes/Flow.Mirror.html" > Flow.Mirror< / a > < / li >
< li > < here > Flow.Settings< / here > < / li >
< li > < a href = "../2 classes/Flow.SkyLayer.html" > Flow.SkyLayer< / a > < / li >
2024-04-28 06:31:59 +02:00
< li > < a href = "../2 classes/Flow.Starfield.html" > Flow.Starfield< / 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 >
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" >
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 >
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-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 >
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-16 12:55:22 +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 >
2022-07-29 21:12:54 +01:00
< / ul >
2021-08-16 12:55:22 +01:00
< / div >
< div id = "content" >
2022-04-10 00:38:39 +01:00
< h1 > Class < code > Flow.Settings< / code > < / h1 >
2021-08-16 12:55:22 +01:00
< p > Settings that will be run on game startup.< / p >
< p >
< / p >
< h2 > < a href = "#Members" > Members< / a > < / h2 >
< table class = "function_list" >
< tr >
2021-08-23 19:19:36 +01:00
< td class = "name" > < a href = "#errorMode" > errorMode< / a > < / td >
2021-08-16 12:55:22 +01:00
< td class = "summary" > How should the application respond to script errors?< / td >
< / tr >
2024-11-11 13:55:50 +03:00
< tr >
< td class = "name" > < a href = "#fastReload" > fastReload< / a > < / td >
2024-11-16 22:07:57 +11:00
< td class = "summary" > Can the game utilize the fast reload feature?< / td >
2024-11-11 13:55:50 +03:00
< / tr >
2021-08-16 12:55:22 +01:00
< / table >
< br / >
< br / >
< h2 class = "section-header " > < a name = "Members" > < / a > Members< / h2 >
< dl class = "function" >
< dt >
2021-08-23 19:19:36 +01:00
< a name = "errorMode" > < / a >
< strong > errorMode< / strong >
2021-08-16 12:55:22 +01:00
< / dt >
< dd >
How should the application respond to script errors?
2024-11-11 13:55:50 +03:00
< br >
2021-08-16 12:55:22 +01:00
Must be one of the following:
2022-08-24 15:01:46 +01:00
< code > ErrorMode.TERMINATE< / code > - print to the log file and return to the title level when any script error is hit.
2021-08-16 12:55:22 +01:00
This is the one you will want to go for if you want to know IMMEDIATELY if something has gone wrong.< / p >
< p > < code > ErrorMode.WARN< / code > - print to the log file and continue running the application when a recoverable script error is hit.
2022-08-24 15:01:46 +01:00
Choose this one if booting to the title level is too much for you.< / p >
2021-08-16 12:55:22 +01:00
< p > < code > ErrorMode.SILENT< / code > - do nothing when a recoverable script error is hit.
Think < strong > very< / strong > carefully before using this setting. These error modes are here to help you to keep your scripts
working properly, but if you opt to ignore errors, you won't be alerted if you've misused a function or passed
an invalid argument.< / p >
2022-08-24 15:01:46 +01:00
< p > In all of these modes, an < em > unrecoverable< / em > error will boot you to the title level. If the title level itself
has an unrecoverable error, the game will close.
2021-08-16 12:55:22 +01:00
2022-12-09 22:08:16 +00:00
2024-11-11 13:55:50 +03:00
< / dd >
< dt >
< a name = "fastReload" > < / a >
< strong > fastReload< / strong >
< / dt >
< dd >
2024-11-16 22:07:57 +11:00
Can the game utilize the fast reload feature?
< br >
When set to < code > true< / code > , the game will attempt to perform fast savegame reloading if current level is the same as
the level loaded from the savegame. It will not work if the level timestamp or checksum has changed
(i.e. level was updated). If set to < code > false< / code > , this functionality is turned off.
2024-11-11 13:55:50 +03:00
2021-08-16 12:55:22 +01:00
< / 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-16 12:55:22 +01:00
< / div > <!-- id="about" -->
< / div > <!-- id="container" -->
< / body >
< / html >
