2022-04-10 00:38:39 +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 >
2022-04-10 00:38:39 +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 >
2022-04-10 00:38:39 +01:00
< ul >
< li > < a href = "../index.html" > Index< / a > < / li >
< / ul >
< h2 > 1 Modules< / h2 >
< 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 > < here > Objects< / here > < / 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 >
2022-04-10 00:38:39 +01:00
< / 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 >
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.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 >
2022-04-10 00:38:39 +01: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 >
< 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 >
2022-04-10 00:38:39 +01:00
< / 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 >
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 >
2025-03-08 23:30:07 -05:00
< li > < a href = "../4 enums/Effects.FeatherMode.html" > Effects.FeatherMode< / 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 >
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 >
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 >
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 >
2022-04-10 00:38:39 +01:00
< / ul >
2022-07-29 21:12:54 +01:00
< 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 >
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 >
2022-04-10 00:38:39 +01:00
< / div >
< div id = "content" >
< h1 > Table < code > Objects< / code > < / h1 >
2025-02-06 02:35:16 +11:00
< p > Objects including moveables, statics, cameras, and others.< / p >
2022-04-10 00:38:39 +01:00
< p >
< / p >
< h2 > < a href = "#Functions" > Functions< / a > < / h2 >
< table class = "function_list" >
< tr >
< td class = "name" > < a href = "#GetMoveableByName" > GetMoveableByName(name)< / a > < / td >
< td class = "summary" > Get a moveable by its name.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#GetStaticByName" > GetStaticByName(name)< / a > < / td >
< td class = "summary" > Get a Static by its name.< / td >
< / tr >
< tr >
2022-11-18 15:34:45 +00:00
< td class = "name" > < a href = "#GetMoveablesBySlot" > GetMoveablesBySlot(slot)< / a > < / td >
< td class = "summary" > Get moveables by its slot.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#GetStaticsBySlot" > GetStaticsBySlot(slot)< / a > < / td >
< td class = "summary" > Get statics by its slot.< / td >
< / tr >
< tr >
2022-12-30 16:33:26 +00:00
< td class = "name" > < a href = "#GetRoomsByTag" > GetRoomsByTag(tag)< / a > < / td >
< td class = "summary" > Get rooms by tag.< / td >
< / tr >
< tr >
2022-04-10 00:38:39 +01:00
< td class = "name" > < a href = "#GetCameraByName" > GetCameraByName(name)< / a > < / td >
< td class = "summary" > Get a Camera by its name.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#GetSinkByName" > GetSinkByName(name)< / a > < / td >
< td class = "summary" > Get a Sink by its name.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#GetSoundSourceByName" > GetSoundSourceByName(name)< / a > < / td >
< td class = "summary" > Get a SoundSource by its name.< / td >
< / tr >
< tr >
< td class = "name" > < a href = "#GetAIObjectByName" > GetAIObjectByName(name)< / a > < / td >
< td class = "summary" > Get an AIObject by its name.< / td >
< / tr >
2022-12-16 18:36:42 +00:00
< tr >
< td class = "name" > < a href = "#GetVolumeByName" > GetVolumeByName(name)< / a > < / td >
< td class = "summary" > Get a Volume by its name.< / td >
< / tr >
2022-12-30 16:33:26 +00:00
< tr >
< td class = "name" > < a href = "#GetRoomByName" > GetRoomByName(name)< / a > < / td >
< td class = "summary" > Get a Room by its name.< / td >
< / tr >
2022-04-10 00:38:39 +01:00
< / table >
< br / >
< br / >
< h2 class = "section-header " > < a name = "Functions" > < / a > Functions< / h2 >
< dl class = "function" >
< dt >
< a name = "GetMoveableByName" > < / a >
< strong > GetMoveableByName(name)< / strong >
< / dt >
< dd >
Get a moveable by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the Moveable as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Moveable< / span > < / span >
a non-owning Moveable referencing the item.
< / ol >
< / dd >
< dt >
< a name = "GetStaticByName" > < / a >
< strong > GetStaticByName(name)< / strong >
< / dt >
< dd >
Get a Static by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the mesh as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Static< / span > < / span >
a non-owning Static referencing the mesh.
< / ol >
2022-11-18 15:34:45 +00:00
< / dd >
< dt >
< a name = "GetMoveablesBySlot" > < / a >
< strong > GetMoveablesBySlot(slot)< / strong >
< / dt >
< dd >
Get moveables by its slot.
2022-12-09 22:08:16 +00:00
2022-11-18 15:34:45 +00:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > slot< / span >
2022-12-11 18:40:31 +00:00
< span class = "types" > < a class = "type" href = "../4 enums/Objects.ObjID.html#" > ObjID< / a > < / span >
2022-11-18 15:34:45 +00:00
the unique slot of the Moveable, e.g. < code > Objects.ObjID.ANIMATING1< / code >
< / li >
< / ul >
< 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 >
table of Moveables referencing the given slot.
< / ol >
< / dd >
< dt >
< a name = "GetStaticsBySlot" > < / a >
< strong > GetStaticsBySlot(slot)< / strong >
< / dt >
< dd >
Get statics by its slot.
2022-12-09 22:08:16 +00:00
2022-11-18 15:34:45 +00:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > slot< / span >
< span class = "types" > < span class = "type" > int< / span > < / span >
the unique slot of the mesh like 10
< / li >
< / ul >
< 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 >
table of Statics referencing the given slot ID.
< / ol >
2022-12-30 16:33:26 +00:00
< / dd >
< dt >
< a name = "GetRoomsByTag" > < / a >
< strong > GetRoomsByTag(tag)< / strong >
< / dt >
< dd >
Get rooms by tag.
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > tag< / span >
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
to select rooms by
< / li >
< / ul >
< 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 >
table of Rooms containing the given tag.
< / ol >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
< a name = "GetCameraByName" > < / a >
< strong > GetCameraByName(name)< / strong >
< / dt >
< dd >
Get a Camera by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the camera as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Camera< / span > < / span >
a non-owning Camera referencing the camera.
< / ol >
< / dd >
< dt >
< a name = "GetSinkByName" > < / a >
< strong > GetSinkByName(name)< / strong >
< / dt >
< dd >
Get a Sink by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the sink as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Sink< / span > < / span >
a non-owning Sink referencing the sink.
< / ol >
< / dd >
< dt >
< a name = "GetSoundSourceByName" > < / a >
< strong > GetSoundSourceByName(name)< / strong >
< / dt >
< dd >
Get a SoundSource by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the sound source as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > SoundSource< / span > < / span >
a non-owning SoundSource referencing the sound source.
< / ol >
< / dd >
< dt >
< a name = "GetAIObjectByName" > < / a >
< strong > GetAIObjectByName(name)< / strong >
< / dt >
< dd >
Get an AIObject by its name.
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > name< / span >
2022-11-18 15:34:45 +00:00
< span class = "types" > < a class = "type" href = "https://www.lua.org/manual/5.4/manual.html#6.4" > string< / a > < / span >
2022-04-10 00:38:39 +01:00
the unique name of the AIObject as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > AIObject< / span > < / span >
a non-owning SoundSource referencing the AI moveable.
< / ol >
2022-12-16 18:36:42 +00:00
< / dd >
< dt >
< a name = "GetVolumeByName" > < / a >
< strong > GetVolumeByName(name)< / strong >
< / dt >
< dd >
Get a Volume by its name.
< h3 > Parameters:< / h3 >
< 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 >
the unique name of the volume as set in, or generated by, Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Volume< / span > < / span >
a non-owning Volume referencing the room.
< / ol >
2022-12-30 16:33:26 +00:00
< / dd >
< dt >
< a name = "GetRoomByName" > < / a >
< strong > GetRoomByName(name)< / strong >
< / dt >
< dd >
Get a Room by its name.
< h3 > Parameters:< / h3 >
< 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 >
the unique name of the room as set in Tomb Editor
< / li >
< / ul >
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > Room< / span > < / span >
a non-owning Room referencing the room.
< / ol >
2022-04-10 00:38:39 +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 >
2022-04-10 00:38:39 +01:00
< / div > <!-- id="about" -->
< / div > <!-- id="container" -->
< / body >
< / html >
