2024-04-28 06:31:59 +02: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-03-28 23:39:49 +01:00
< title > TombEngine 1.8.1 Lua API< / title >
2024-04-28 06:31:59 +02: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 >
2024-04-28 06:31:59 +02:00
< ul >
< li > < a href = "../index.html" > Index< / a > < / li >
< / ul >
< h2 > 1 Modules< / h2 >
< ul class = "nowrap" >
< li > < a href = "../1 modules/Effects.html" > Effects< / a > < / li >
< li > < a href = "../1 modules/Flow.html" > Flow< / a > < / li >
< li > < a href = "../1 modules/Input.html" > Input< / a > < / li >
< 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 >
< li > < a href = "../1 modules/Sound.html" > Sound< / a > < / li >
< li > < a href = "../1 modules/Strings.html" > Strings< / a > < / li >
< li > < a href = "../1 modules/Util.html" > Util< / a > < / li >
< li > < a href = "../1 modules/View.html" > View< / a > < / li >
< / ul >
< h2 > 2 Classes< / h2 >
< ul class = "nowrap" >
2025-03-05 03:13:48 -05:00
< li > < a href = "../2 classes/Collision.Probe.html" > Collision.Probe< / a > < / li >
2024-04-28 06:31:59 +02:00
< li > < a href = "../2 classes/Flow.Level.html" > Flow.Level< / a > < / 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 >
2024-04-28 06:31:59 +02: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 >
< li > < a href = "../2 classes/Objects.Room.html" > Objects.Room< / a > < / li >
< 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 >
< li > < a href = "../2 classes/Objects.Volume.html" > Objects.Volume< / a > < / li >
< 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 >
2024-04-28 06:31:59 +02:00
< / ul >
< h2 > 3 Primitive Classes< / h2 >
< ul class = "nowrap" >
2024-12-15 19:24:49 +03:00
< li > < a href = "../3 primitive classes/Flow.Fog.html" > Flow.Fog< / a > < / li >
2025-03-08 23:30:07 -05:00
< li > < a href = "../3 primitive classes/Flow.Horizon.html" > Flow.Horizon< / a > < / li >
2024-12-15 19:24:49 +03:00
< 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 >
2025-03-15 01:01:05 +01:00
< li > < a href = "../3 primitive classes/Flow.Starfield.html" > Flow.Starfield< / a > < / li >
2024-04-28 06:31:59 +02: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 > < here > Time< / here > < / li >
2024-04-28 06:31:59 +02:00
< li > < a href = "../3 primitive classes/Vec2.html" > Vec2< / a > < / li >
< li > < a href = "../3 primitive classes/Vec3.html" > Vec3< / a > < / li >
< / ul >
< h2 > 4 Enums< / h2 >
< ul class = "nowrap" >
2025-03-05 03:13:48 -05:00
< li > < a href = "../4 enums/Collision.MaterialType.html" > Collision.MaterialType< / a > < / li >
2024-04-28 06:31:59 +02: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 >
2025-03-15 20:19:13 +01:00
< li > < a href = "../4 enums/Effects.StreamerFeatherMode.html" > Effects.StreamerFeatherMode< / a > < / li >
2025-03-08 22:45:25 -05:00
< li > < a href = "../4 enums/Effects.ParticleAnimationType.html" > Effects.ParticleAnimationType< / 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 >
2024-04-28 06:31:59 +02:00
< li > < a href = "../4 enums/Flow.GameStatus.html" > Flow.GameStatus< / a > < / li >
< li > < a href = "../4 enums/Input.ActionID.html" > Input.ActionID< / a > < / li >
< li > < a href = "../4 enums/Objects.AmmoType.html" > Objects.AmmoType< / a > < / li >
2025-02-06 16:35:59 +11:00
< li > < a href = "../4 enums/Objects.HandStatus.html" > Objects.HandStatus< / a > < / li >
2024-12-15 23:34:33 +01:00
< li > < a href = "../4 enums/Objects.WeaponType.html" > Objects.WeaponType< / a > < / li >
2024-04-28 06:31:59 +02:00
< li > < a href = "../4 enums/Objects.MoveableStatus.html" > Objects.MoveableStatus< / a > < / li >
< li > < a href = "../4 enums/Objects.ObjID.html" > Objects.ObjID< / a > < / li >
< li > < a href = "../4 enums/Objects.RoomFlagID.html" > Objects.RoomFlagID< / a > < / li >
< li > < a href = "../4 enums/Objects.RoomReverb.html" > Objects.RoomReverb< / a > < / li >
< 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 >
2024-04-28 06:31:59 +02:00
< li > < a href = "../4 enums/Util.LogLevel.html" > Util.LogLevel< / a > < / li >
< li > < a href = "../4 enums/View.AlignMode.html" > View.AlignMode< / a > < / li >
< li > < a href = "../4 enums/View.CameraType.html" > View.CameraType< / a > < / li >
< li > < a href = "../4 enums/View.PostProcessMode.html" > View.PostProcessMode< / a > < / li >
< li > < a href = "../4 enums/View.ScaleMode.html" > View.ScaleMode< / a > < / li >
< / ul >
< h2 > 5 Lua utility modules< / h2 >
< ul class = "nowrap" >
2025-03-08 23:59:49 -05:00
< li > < a href = "../5 lua utility modules/CustomBar.html" > CustomBar< / a > < / li >
2025-02-06 18:05:25 -05:00
< li > < a href = "../5 lua utility modules/Diary.html" > Diary< / a > < / li >
2024-04-28 06:31:59 +02: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 >
2024-04-28 06:31:59 +02:00
< / ul >
< / div >
< div id = "content" >
2024-12-15 19:24:49 +03:00
< h1 > Primitive Class < code > Time< / code > < / h1 >
2024-12-15 23:50:41 +01:00
< p > Represents a time value in game frames, with support for formatting to hours, minutes, seconds, and centiseconds (1/100th of a second).< / p >
2024-04-28 06:31:59 +02:00
< p >
< / p >
2024-12-15 19:24:49 +03:00
< h2 > < a href = "#Members" > Members< / a > < / h2 >
2024-04-28 06:31:59 +02:00
< table class = "function_list" >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#h" > h< / a > < / td >
< td class = "summary" > (int) Hours component.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#m" > m< / a > < / td >
< td class = "summary" > (int) Minutes component.< / td >
2024-04-28 06:31:59 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#s" > s< / a > < / td >
< td class = "summary" > (int) Seconds component.< / td >
2024-04-28 06:31:59 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#c" > c< / a > < / td >
< td class = "summary" > (int) Centiseconds component.< / td >
2024-04-28 06:31:59 +02:00
< / tr >
2024-12-15 19:24:49 +03:00
< / table >
< h2 > < a href = "#Functions" > Functions< / a > < / h2 >
< table class = "function_list" >
2024-05-09 05:42:36 +02:00
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time" > Time()< / a > < / td >
< td class = "summary" > Create a Time object.< / td >
2024-05-10 22:19:36 +10:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time" > Time(gameFrames)< / a > < / td >
< td class = "summary" > Create a Time object from a total game frame count (1 second = 30 frames).< / td >
2024-05-09 05:42:36 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time" > Time(formattedTime)< / a > < / td >
< td class = "summary" > Create a Time object from a formatted string.< / td >
2024-05-09 05:42:36 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time" > Time(timeUnits)< / a > < / td >
< td class = "summary" > Create a Time object from a time unit table (hours, minutes, seconds, centiseconds).< / td >
2024-05-09 05:42:36 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time:GetFrameCount" > Time:GetFrameCount()< / a > < / td >
< td class = "summary" > Get the total game frame count.< / td >
2024-05-10 22:19:36 +10:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#Time:GetTimeUnits" > Time:GetTimeUnits()< / a > < / td >
< td class = "summary" > Get the time in hours, minutes, seconds, and centiseconds as a table.< / td >
2024-05-09 05:42:36 +02:00
< / tr >
< tr >
2024-12-15 19:24:49 +03:00
< td class = "name" > < a href = "#tostring" > tostring(this)< / a > < / td >
< td class = "summary" > Convert this Time object to a formatted string.< / td >
2024-05-09 05:42:36 +02:00
< / tr >
2024-04-28 06:31:59 +02:00
< / table >
< br / >
< br / >
2024-12-15 19:24:49 +03:00
< h2 class = "section-header " > < a name = "Members" > < / a > Members< / h2 >
2024-04-28 06:31:59 +02:00
< dl class = "function" >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "h" > < / a >
< strong > h< / strong >
2024-04-28 06:31:59 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(int) Hours component.
2024-05-08 13:47:47 +10:00
2024-04-28 06:31:59 +02:00
2024-05-08 13:47:47 +10:00
2024-12-15 19:24:49 +03:00
< / dd >
< dt >
< a name = "m" > < / a >
< strong > m< / strong >
< / dt >
< dd >
(int) Minutes component.
2024-05-08 13:47:47 +10:00
2024-04-28 06:31:59 +02:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "s" > < / a >
< strong > s< / strong >
2024-04-28 06:31:59 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(int) Seconds component.
2024-04-28 06:31:59 +02:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "c" > < / a >
< strong > c< / strong >
2024-04-28 06:31:59 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
(int) Centiseconds component.
2024-04-28 06:31:59 +02:00
2024-05-09 05:42:36 +02:00
< / dd >
2024-12-15 19:24:49 +03:00
< / dl >
< h2 class = "section-header " > < a name = "Functions" > < / a > Functions< / h2 >
< dl class = "function" >
2024-05-09 05:42:36 +02:00
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time" > < / a >
< strong > Time()< / strong >
2024-05-09 05:42:36 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Create a Time object.
2024-05-09 05:42:36 +02:00
< h3 > Returns:< / h3 >
< ol >
2024-12-15 19:24:49 +03:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Time.html#" > Time< / a > < / span >
A new Time object initialized to zero time.
2024-05-10 22:19:36 +10:00
< / ol >
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time" > < / a >
< strong > Time(gameFrames)< / strong >
2024-05-10 22:19:36 +10:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Create a Time object from a total game frame count (1 second = 30 frames).
2024-05-10 22:19:36 +10:00
2024-12-15 19:24:49 +03:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > gameFrames< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
Total game frame count.
< / li >
< / ul >
2024-05-10 22:19:36 +10:00
< h3 > Returns:< / h3 >
< ol >
2024-12-15 19:24:49 +03:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Time.html#" > Time< / a > < / span >
A new Time object initialized with the given frame count.
2024-05-09 05:42:36 +02:00
< / ol >
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time" > < / a >
< strong > Time(formattedTime)< / strong >
2024-05-09 05:42:36 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Create a Time object from a formatted string.
2024-05-09 05:42:36 +02:00
2024-12-15 19:24:49 +03:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > formattedTime< / span >
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
Time in the format "HH:MM:SS[.CC]", where [.CC] is centiseconds and is optional.
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
2024-05-09 05:42:36 +02:00
2024-12-15 19:24:49 +03:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Time.html#" > Time< / a > < / span >
A new Time object parsed from the given string.
< / ol >
2024-05-09 05:42:36 +02:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time" > < / a >
< strong > Time(timeUnits)< / strong >
2024-05-09 05:42:36 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Create a Time object from a time unit table (hours, minutes, seconds, centiseconds).
2024-05-09 05:42:36 +02:00
< h3 > Parameters:< / h3 >
< ul >
2024-12-15 19:24:49 +03:00
< li > < span class = "parameter" > timeUnits< / span >
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.6" > table< / a > < / span >
A time unit table in the format {HH, MM, SS, [CC]}, where [CC] is optional.
2024-05-09 05:42:36 +02:00
< / li >
< / ul >
2024-12-15 19:24:49 +03:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < a class = "type" href = "../3 primitive classes/Time.html#" > Time< / a > < / span >
A new Time object initialized with the given values.
< / ol >
2024-05-09 05:42:36 +02:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time:GetFrameCount" > < / a >
< strong > Time:GetFrameCount()< / strong >
2024-05-10 22:19:36 +10:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Get the total game frame count.
2024-05-10 22:19:36 +10:00
2024-12-15 19:24:49 +03:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > int< / span > < / span >
Total number of game frames.
< / ol >
2024-05-10 22:19:36 +10:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "Time:GetTimeUnits" > < / a >
< strong > Time:GetTimeUnits()< / strong >
2024-05-09 05:42:36 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Get the time in hours, minutes, seconds, and centiseconds as a table.
2024-05-09 05:42:36 +02:00
2024-12-15 19:24:49 +03:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.6" > table< / a > < / span >
A table in the format {HH, MM, SS, CC}.
< / ol >
2024-05-09 05:42:36 +02:00
< / dd >
< dt >
2024-12-15 19:24:49 +03:00
< a name = "tostring" > < / a >
< strong > tostring(this)< / strong >
2024-05-09 05:42:36 +02:00
< / dt >
< dd >
2024-12-15 19:24:49 +03:00
Convert this Time object to a formatted string.
2024-05-09 05:42:36 +02:00
< h3 > Parameters:< / h3 >
< ul >
2024-12-15 19:24:49 +03:00
< li > < span class = "parameter" > this< / span >
< span class = "types" > < a class = "type" href = "../3 primitive classes/Time.html#" > Time< / a > < / span >
Time object.
2024-05-09 05:42:36 +02:00
< / li >
< / ul >
2024-12-15 19:24:49 +03:00
< 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 time in "HH:MM:SS.CC" format.
< / ol >
2024-05-09 05:42:36 +02:00
2024-04-28 06:31:59 +02:00
< / dd >
< / dl >
< / div > <!-- id="content" -->
< / div > <!-- id="main" -->
< div id = "about" >
< 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 >
< / div > <!-- id="about" -->
< / div > <!-- id="container" -->
< / body >
< / html >
