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-03-28 23:39:49 +01:00
< title > TombEngine 1.8.1 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 >
2022-12-09 22:08:16 +00:00
< h2 > 1 Modules< / h2 >
2022-04-10 00:38:39 +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 >
2022-04-10 00:38:39 +01:00
< / ul >
2022-12-09 22:08:16 +00:00
< h2 > 2 Classes< / h2 >
2022-04-10 00:38:39 +01:00
< 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 > < here > Objects.Static< / here > < / 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 >
2025-03-15 01:01:05 +01:00
< 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-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 >
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 > Class < code > Objects.Static< / code > < / h1 >
2025-02-06 02:35:16 +11:00
< p > Represents a static object in the game world.< / p >
2022-04-10 00:38:39 +01:00
< p >
< / p >
< h2 > < a href = "#Functions" > Functions< / a > < / h2 >
< table class = "function_list" >
2022-09-13 21:23:57 +01:00
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetName" > Static:GetName()< / a > < / td >
< td class = "summary" > Get this static's unique string identifier.< / td >
2022-09-13 21:23:57 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetSlot" > Static:GetSlot()< / a > < / td >
< td class = "summary" > Get this static's slot ID.< / td >
2022-09-13 21:23:57 +01:00
< / tr >
2022-04-10 00:38:39 +01:00
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetPosition" > Static:GetPosition()< / a > < / td >
< td class = "summary" > Get this static's world position.< / td >
2022-09-14 20:05:31 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetRotation" > Static:GetRotation()< / a > < / td >
< td class = "summary" > Get this static's world rotation.< / td >
2022-09-14 20:05:31 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetScale" > Static:GetScale()< / a > < / td >
< td class = "summary" > Get this static's world scale.< / td >
2022-09-14 20:05:31 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetColor" > Static:GetColor()< / a > < / td >
< td class = "summary" > Get this static's color.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetHP" > Static:GetHP()< / a > < / td >
< td class = "summary" > Get this static's hit points.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetActive" > Static:GetActive()< / a > < / td >
2025-02-06 16:35:59 +11:00
< td class = "summary" > Get this static's visibility status.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-03-15 10:51:59 +01:00
< td class = "name" > < a href = "#Static:GetCollidable" > Static:GetCollidable()< / a > < / td >
< td class = "summary" > Get this static's collision status.< / td >
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:GetSolid" > Static:GetSolid()< / a > < / td >
2025-02-06 16:35:59 +11:00
< td class = "summary" > Get this static's solid collision status.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:SetName" > Static:SetName(name)< / a > < / td >
< td class = "summary" > Set this static's unique identifier string.< / td >
2022-09-07 20:57:50 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetSlot" > Static:SetSlot(slotID)< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Set this static's slot ID.< / td >
2024-03-25 20:31:31 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetPosition" > Static:SetPosition(pos)< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Set this static's world position.< / td >
2024-03-25 20:31:31 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetRotation" > Static:SetRotation(rot)< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Set this static's rotation.< / td >
2022-09-07 20:57:50 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetScale" > Static:SetScale(scale)< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Set this static's world scale.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:SetColor" > Static:SetColor(color)< / a > < / td >
2025-02-06 16:35:59 +11:00
< td class = "summary" > Set this static's color.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetHP" > Static:SetHP(hitPoints)< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Set this static's hit points.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 16:35:59 +11:00
< td class = "name" > < a href = "#Static:SetSolid" > Static:SetSolid(status)< / a > < / td >
< td class = "summary" > Set this static's solid collision status.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-03-15 10:51:59 +01:00
< td class = "name" > < a href = "#Static:SetCollidable" > Static:SetCollidable(collidable)< / a > < / td >
< td class = "summary" > Set this static's collision status.< / td >
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:Enable" > Static:Enable()< / a > < / td >
< td class = "summary" > Enable this static.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
< tr >
2025-02-06 02:35:16 +11:00
< td class = "name" > < a href = "#Static:Disable" > Static:Disable()< / a > < / td >
< td class = "summary" > Disable this static.< / td >
2022-04-10 00:38:39 +01:00
< / tr >
2022-09-13 21:23:57 +01:00
< tr >
< td class = "name" > < a href = "#Static:Shatter" > Static:Shatter()< / a > < / td >
2025-02-06 02:35:16 +11:00
< td class = "summary" > Shatter this static.< / td >
2022-09-13 21:23:57 +01:00
< / 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" >
2022-09-13 21:23:57 +01:00
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetName" > < / a >
< strong > Static:GetName()< / strong >
2022-09-13 21:23:57 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's unique string identifier.
2022-09-13 21:23:57 +01:00
2025-02-06 02:35:16 +11: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 >
Name string.
< / ol >
2022-09-13 21:23:57 +01:00
2022-12-09 22:08:16 +00:00
2022-09-13 21:23:57 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetSlot" > < / a >
< strong > Static:GetSlot()< / strong >
2022-09-13 21:23:57 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's slot ID.
2022-09-13 21:23:57 +01:00
2025-02-06 02:35:16 +11:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > int< / span > < / span >
Slot ID.
< / ol >
2022-09-13 21:23:57 +01:00
2022-12-09 22:08:16 +00:00
2022-09-14 20:05:31 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetPosition" > < / a >
< strong > Static:GetPosition()< / strong >
2022-09-14 20:05:31 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's world position.
2022-09-14 20:05:31 +01:00
2022-12-09 22:08:16 +00:00
2022-09-14 20:05:31 +01:00
< h3 > Returns:< / h3 >
< ol >
2025-02-06 02:35:16 +11:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Vec3.html#" > Vec3< / a > < / span >
World position.
2022-09-14 20:05:31 +01:00
< / ol >
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetRotation" > < / a >
< strong > Static:GetRotation()< / strong >
2022-09-14 20:05:31 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's world rotation.
2022-09-14 20:05:31 +01:00
2022-12-09 22:08:16 +00:00
2022-09-14 20:05:31 +01:00
< h3 > Returns:< / h3 >
< ol >
2025-02-06 02:35:16 +11:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Rotation.html#" > Rotation< / a > < / span >
World rotation.
2022-09-14 20:05:31 +01:00
< / ol >
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetScale" > < / a >
< strong > Static:GetScale()< / strong >
2022-09-14 20:05:31 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's world scale.
2022-09-14 20:05:31 +01:00
2022-12-09 22:08:16 +00:00
2022-09-14 20:05:31 +01:00
2025-02-06 02:35:16 +11:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > float< / span > < / span >
World scale.
< / ol >
2022-09-14 20:05:31 +01:00
2022-09-13 21:23:57 +01:00
< / dd >
2022-04-10 00:38:39 +01:00
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetColor" > < / a >
< strong > Static:GetColor()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's color.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Returns:< / h3 >
< ol >
2025-02-06 02:35:16 +11:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Color.html#" > Color< / a > < / span >
Color.
2022-04-10 00:38:39 +01:00
< / ol >
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetHP" > < / a >
< strong > Static:GetHP()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Get this static's hit points. Used only with shatterable statics.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
2025-02-06 02:35:16 +11:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > int< / span > < / span >
Hit points.
< / ol >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetActive" > < / a >
< strong > Static:GetActive()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 16:35:59 +11:00
Get this static's visibility status.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Returns:< / h3 >
< ol >
2025-02-06 02:35:16 +11:00
< span class = "types" > < span class = "type" > bool< / span > < / span >
2025-02-06 16:35:59 +11:00
Status. < strong > true: visible< / strong > , < strong > false: invisible< / strong >
2022-04-10 00:38:39 +01:00
< / ol >
2025-03-15 10:51:59 +01:00
< / dd >
< dt >
< a name = "Static:GetCollidable" > < / a >
< strong > Static:GetCollidable()< / strong >
< / dt >
< dd >
Get this static's collision status.
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > bool< / span > < / span >
Collision status. < strong > true: can be collided with< / strong > , < strong > false: no collision< / strong >
< / ol >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:GetSolid" > < / a >
< strong > Static:GetSolid()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 16:35:59 +11:00
Get this static's solid collision status.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
2025-02-06 02:35:16 +11:00
< h3 > Returns:< / h3 >
< ol >
< span class = "types" > < span class = "type" > bool< / span > < / span >
2025-02-06 16:35:59 +11:00
Solid Status. < strong > true: solid< / strong > , < strong > false: soft< / strong >
2025-02-06 02:35:16 +11:00
< / ol >
2022-04-10 00:38:39 +01:00
2022-09-07 20:57:50 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetName" > < / a >
< strong > Static:SetName(name)< / strong >
2022-09-07 20:57:50 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's unique identifier string.
2022-09-07 20:57:50 +01:00
2025-02-06 02:35:16 +11:00
< 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 >
New name.
< / li >
< / ul >
2022-12-09 22:08:16 +00:00
2022-09-07 20:57:50 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetSlot" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetSlot(slotID)< / strong >
2022-09-07 20:57:50 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's slot ID.
2022-09-07 20:57:50 +01:00
2022-12-09 22:08:16 +00:00
2022-09-07 20:57:50 +01:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > slotID< / span >
2025-02-06 02:35:16 +11:00
< span class = "types" > < span class = "type" > int< / span > < / span >
2025-02-06 16:35:59 +11:00
New slot ID.
2022-09-07 20:57:50 +01:00
< / li >
< / ul >
2024-03-25 20:31:31 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetPosition" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetPosition(pos)< / strong >
2024-03-25 20:31:31 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's world position.
2024-03-25 20:31:31 +01:00
2025-02-06 02:35:16 +11:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > pos< / span >
2025-02-06 02:35:16 +11:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Vec3.html#" > Vec3< / a > < / span >
2025-02-06 16:35:59 +11:00
New world position.
2025-02-06 02:35:16 +11:00
< / li >
< / ul >
2024-03-25 20:31:31 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetRotation" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetRotation(rot)< / strong >
2024-03-25 20:31:31 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's rotation.
2024-03-25 20:31:31 +01:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > rot< / span >
2025-02-06 02:35:16 +11:00
< span class = "types" > < a class = "type" href = "../3 primitive classes/Rotation.html#" > Rotation< / a > < / span >
2025-02-06 16:35:59 +11:00
New rotation.
2024-03-25 20:31:31 +01:00
< / li >
< / ul >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetScale" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetScale(scale)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's world scale.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2025-02-06 02:35:16 +11:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > scale< / span >
< span class = "types" > < span class = "type" > float< / span > < / span >
New world scale.
2025-02-06 02:35:16 +11:00
< / li >
< / ul >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetColor" > < / a >
< strong > Static:SetColor(color)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 16:35:59 +11:00
Set this static's color.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 02:35:16 +11:00
< li > < span class = "parameter" > color< / span >
< span class = "types" > < a class = "type" href = "../3 primitive classes/Color.html#" > Color< / a > < / span >
2025-02-06 16:35:59 +11:00
New color.
2022-04-10 00:38:39 +01:00
< / li >
< / ul >
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetHP" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetHP(hitPoints)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Set this static's hit points. Used only with shatterable statics.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2025-02-06 02:35:16 +11:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > hitPoints< / span >
2025-02-06 02:35:16 +11:00
< span class = "types" > < span class = "type" > int< / span > < / span >
2025-02-06 16:35:59 +11:00
New hit points.
2025-02-06 02:35:16 +11:00
< / li >
< / ul >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:SetSolid" > < / a >
2025-02-06 16:35:59 +11:00
< strong > Static:SetSolid(status)< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 16:35:59 +11:00
Set this static's solid collision status.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
< h3 > Parameters:< / h3 >
< ul >
2025-02-06 16:35:59 +11:00
< li > < span class = "parameter" > status< / span >
2025-02-06 02:35:16 +11:00
< span class = "types" > < span class = "type" > bool< / span > < / span >
2025-02-06 16:35:59 +11:00
New status. < strong > true: solid< / strong > , < strong > false: soft< / strong >
2022-04-10 00:38:39 +01:00
< / li >
< / ul >
2025-03-15 10:51:59 +01:00
< / dd >
< dt >
< a name = "Static:SetCollidable" > < / a >
< strong > Static:SetCollidable(collidable)< / strong >
< / dt >
< dd >
Set this static's collision status.
< h3 > Parameters:< / h3 >
< ul >
< li > < span class = "parameter" > collidable< / span >
< span class = "types" > < span class = "type" > bool< / span > < / span >
New collision status. < strong > true: can be collided with< / strong > , < strong > false: no collision< / strong >
< / li >
< / ul >
2022-04-10 00:38:39 +01:00
< / dd >
< dt >
2025-02-06 02:35:16 +11:00
< a name = "Static:Enable" > < / a >
< strong > Static:Enable()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Enable this static. Used when previously shattered disabled manually.
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 >
2025-02-06 02:35:16 +11:00
< a name = "Static:Disable" > < / a >
< strong > Static:Disable()< / strong >
2022-04-10 00:38:39 +01:00
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Disable this static.
2022-04-10 00:38:39 +01:00
2022-12-09 22:08:16 +00:00
2022-04-10 00:38:39 +01:00
2022-09-13 21:23:57 +01:00
< / dd >
< dt >
< a name = "Static:Shatter" > < / a >
< strong > Static:Shatter()< / strong >
< / dt >
< dd >
2025-02-06 02:35:16 +11:00
Shatter this static.
2022-09-13 21:23:57 +01:00
2022-12-09 22:08:16 +00:00
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 >
