TombEngine

1 Special Tables

• LevelFuncs
• GlobalVars
• GameVars
• LevelVars

2 Modules

• Effects
• Flow
• Input
• Inventory
• Logic
• Objects
• Sound
• Strings
• Util
• View

3 Classes

• Collision.Ray
• Collision.Probe
• Effects.ParticleGroups
• Flow.Level
• Flow.Settings
• Flow.Statistics
• Objects.AIObject
• Objects.Camera
• Objects.Creature
• Objects.LaraObject
• Objects.Material
• Objects.Moveable
• Objects.Room
• Objects.Sink
• Objects.SoundSource
• Objects.Static
• Objects.Volume
• Strings.DisplayString
• View.DisplayItem
• View.DisplaySprite

4 Primitive Classes

• Flow.Fog
• Flow.Horizon
• Flow.InventoryItem
• Flow.LensFlare
• Flow.SkyLayer
• Flow.Starfield
• Color
• Rotation
• Time
• Vec2
• Vec3
• View.DisplayAnchors

5 Enums

• Collision.IntersectionType
• Collision.FloorMaterialType
• Effects.BlendID
• Effects.EffectID
• Effects.StreamerFeatherMode
• Effects.ParticleAnimationType
• Flow.ErrorMode
• Flow.FreezeMode
• Flow.GameStatus
• Flow.ItemAction
• Flow.LaraType
• Flow.PathfindingMode
• Flow.WeatherType
• Input.ActionID
• Input.AxisID
• Input.InputDevice
• Logic.CallbackPoint
• Logic.EventType
• Logic.EndReason
• Objects.MoodType
• Objects.AmmoType
• Objects.HandStatus
• Objects.WaterStatus
• Objects.WeaponFlashMode
• Objects.WeaponMode
• Objects.WeaponType
• Objects.TextureMaterialType
• Objects.InteractionType
• Objects.MoveableStatus
• Objects.ObjID
• Objects.RoomFlagID
• Objects.RoomReverb
• Sound.SoundTrackType
• Strings.DisplayStringOption
• Util.LogLevel
• View.AlignMode
• View.CameraType
• View.DOFMode
• View.PostProcessMode
• View.ScaleMode

6 Lua utility modules

• CustomBar
• CustomDiary
• EventSequence
• PhotoMode
• RingInventory
• Timer
• Type

Class Objects.Material

Represents a material instance for the texture.

To be used with Objects.GetMaterialByName and Objects.GetMaterialsByObject. Materials are managed in the Tomb Editor's material window. This class is not in any way related to Collision.FloorMaterialType. Name and type setters are not implemented for safety reasons due to low-level nature of the material system.

Functions

Functions

Material:GetName()

Get this material's unique string identifier.

Returns:

string Name string.

Material:GetType()

Get texture material type of this material.

Returns:

TextureMaterialType Texture material type.

Material:GetProperty(name)

Get a material property value. Property can be addressed by its name or zero-based slot index.

Parameters:

• name string Property name.

Returns:

any Property value, or nil if property is not present. Return type depends on property definition and can be bool, number, Vec2, Vec3, or Color.

Material:SetProperty(name, value)

Set a material property value. Property can be addressed by its name or zero-based slot index.

Parameters:

• name string Property name.
• value any Value matching the property's declared type: bool, number, Vec2, Vec3, or Color. Provided value type must match the property type.

Material:ResetProperty(name)

Reset a material property to its default value. Property can be addressed by its name or zero-based slot index.

Parameters:

• name string Property name.

Material:IsPropertyPresent(name)

Check if this material type has a property with the given name.

Parameters:

• name string Property name.

Returns:

bool True if the property with a given name exists for this material.