TombEngine

• Index

1 Modules

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

2 Classes

• View.DisplaySprite
• Flow.Animations
• Flow.Fog
• Flow.InventoryItem
• Flow.LensFlare
• Flow.Level
• Flow.Mirror
• Flow.Settings
• Flow.SkyLayer
• Flow.Starfield
• Objects.AIObject
• Objects.Camera
• Objects.LaraObject
• Objects.Moveable
• Objects.Room
• Objects.Sink
• Objects.SoundSource
• Objects.Static
• Objects.Volume
• Strings.DisplayString

3 Primitive Classes

• Color
• Rotation
• Vec2
• Vec3

4 Enums

• Effects.BlendID
• Effects.EffectID
• Flow.FreezeMode
• Flow.GameStatus
• Input.ActionID
• Objects.AmmoType
• Objects.MoveableStatus
• Objects.ObjID
• Objects.RoomFlagID
• Objects.RoomReverb
• Sound.SoundTrackType
• Strings.DisplayStringOption
• Util.LogLevel
• View.AlignMode
• View.CameraType
• View.PostProcessMode
• View.ScaleMode

5 Lua utility modules

• EventSequence
• Timer

Class Flow.Settings

Settings that will be run on game startup.

Members

errorMode	How should the application respond to script errors?
fastReload	Can the game utilize the fast reload feature?

Members

errorMode

How should the application respond to script errors?
Must be one of the following: ErrorMode.TERMINATE - print to the log file and return to the title level when any script error is hit. This is the one you will want to go for if you want to know IMMEDIATELY if something has gone wrong.

ErrorMode.WARN - print to the log file and continue running the application when a recoverable script error is hit. Choose this one if booting to the title level is too much for you.

ErrorMode.SILENT - do nothing when a recoverable script error is hit. Think very 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.

In all of these modes, an unrecoverable error will boot you to the title level. If the title level itself has an unrecoverable error, the game will close.

fastReload

Can the game utilize the fast reload feature?
When set to true, 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 false, this functionality is turned off.