Module for the game flow: which levels there are, and which one is being played.
trx.game.levels (a list of trx.game.Level). The levels of the game, in order, counted from one. (read-only)trx.game.cutscenes (a list of trx.game.Level). The cutscene levels, counted from one. TR4's in-game cutscenes are a different thing, and live in trx.cutscenes. (read-only)trx.game.demos (a list of trx.game.Level). The demos, counted from one. (read-only)trx.game.fmvs (a list of trx.game.FMV). The movies the game flow declares, counted from one. (read-only)trx.game.current_level (trx.game.Level). The level being played, or nil if none is. (read-only)trx.game.gym (trx.game.Level). The gym level, or nil if this game has no gym. (read-only)trx.game.version (integer). Which Tomb Raider this build is: 1, 2, 3 or 4. (read-only)trx.game.is_loaded (boolean). Whether a level is loaded. (read-only)trx.game.measured_fps (integer). How many frames reached the screen in the last second, counted against the wall clock. Frames are drawn more often than the game ticks, so this is not the rate the game runs at. (read-only)trx.game.is_playing (boolean). Whether a level is running: Lara and the creatures move and the game answers to the player. It goes false while the inventory ring, the pause screen or photo mode holds the level still, and outside a level altogether. (read-only)trx.game.is_playable (boolean). Whether the game is loaded and taking input - not in a menu, and not in a cutscene. (read-only)trx.game.signals.is_playing (trx.signal.Signal). Says when a level starts being played, and when it stops. (read-only)trx.game.signals.is_suspended (trx.signal.Signal). Says when the game is held still, and when it runs on again. (read-only)trx.game.signals.is_photo_mode (trx.signal.Signal). Says when photo mode opens and closes. (read-only)trx.game.signals.is_playable (trx.signal.Signal). Says when the kind of level running changes. (read-only)trx.game.real_time (number). Seconds of wall-clock time since the game started, which keeps running while the game is held still. Use it to time something against the player's clock rather than against the frames the game has run. (read-only)trx.game.tr_version (integer). Which Tomb Raider the level being played belongs to: 1 through 4. The games differ in what they draw and in what the player expects, so a script that dresses more than one reads this to tell them apart. Zero before a level is loaded. (read-only)trx.game.is_suspended (boolean). Whether a loaded level is held still: the pause screen, photo mode, or the inventory ring. Lara and the creatures do not move while it is true. It is false outside a level, which is what tells it apart from the opposite of trx.game.is_playing. (read-only)trx.game.is_photo_mode (boolean). Whether the player is in photo mode, where the camera is theirs to move and the game is held still. (read-only)trx.game.photo_mode_target (trx.game.PhotoModeTarget). What photo mode is steering. Outside photo mode, this is always the camera, which is where every session starts. (read-only)trx.game.is_ngplus (boolean). Whether this is a new game plus run, which is what the passport's bonus start sets. Lara keeps her weapons between levels and her ammunition does not run down. (read-only)trx.game.TRX_VERSION = TRX 1.9.3-42-g0f4c2a1 (string)
What this build reports as its version: 1.9.3 for a release, and the tag with the commits since then for a development build.
trx.game.LOGIC_FPS = 30 (integer)
How many logical frames the game runs a second, which is the rate trx.events.before_control fires at. A script that counts frames divides by this to reach seconds.
One of the lists of levels the game flow declares.
trx.game.LevelTable.TITLE = 0trx.game.LevelTable.MAIN = 1trx.game.LevelTable.CUTSCENES = 2trx.game.LevelTable.DEMOS = 3What kind of level it is.
trx.game.LevelType.TITLE = 0trx.game.LevelType.NORMAL = 1trx.game.LevelType.CUTSCENE = 2trx.game.LevelType.DEMO = 3trx.game.LevelType.GYM = 4trx.game.LevelType.BONUS = 5trx.game.LevelType.DUMMY = 6trx.game.LevelType.CURRENT = 7What the player's movement keys steer while photo mode is open.
trx.game.PhotoModeTarget.CAMERA = 0trx.game.PhotoModeTarget.LARA = 1The number a level goes by, which is what the player is shown and what a gameflow names. Not its place in a table: a level the game flow skips does not count, and a gym level has no number at all and reads 0. Counted from 1.
The number an FMV goes by, which is its place in the list the game flow declares. Counted from 1.
Where a demo sits in the table of demos. Counted from 1.
A length of time counted in the frames the engine runs the world at, which is what the engine measures its own timers in.
A length of time in seconds, as a player would read it off a clock.
A level, as the game flow file declares it. Everything on it is read-only: a level is what the game flow says it is.
Handles are live references: if the underlying object is destroyed, using the handle raises an error rather than silently reading an unrelated one.
Properties:
key: string. What the level is called, taken from the name of the file it loads: wall.tr2 reads
back as wall. Lower case, regardless of the case on disk, and nil for a level that loads no file
of its own.
This is the name to write into a table of per-level data. num is a position and
moves as soon as a game flow gains a level, and path is wherever the file sits on
this install. (read-only)
lara_outfit: string. The outfit Lara starts the level in. (read-only)
music_track: trx.catalog.music. The track that plays when the level starts. (read-only)
num: trx.game.LevelNum. (read-only)
script_path: string. Path to the Lua script that runs when the level loads, or nil if it has none. (read-only)
title: string. The level's name, as shown to the player. (read-only)
type: trx.game.LevelType. What kind of level it is. (read-only)
unobtainable_ally_kills: integer. Ally kills the stats screen must not hold against the player. (read-only)
unobtainable_kills: integer. Kills the stats screen must not hold against the player. (read-only)
unobtainable_pickups: integer. Pickups the stats screen must not hold against the player, because they cannot be got. (read-only)
unobtainable_secrets: integer. Secrets the stats screen must not hold against the player. (read-only)
water_particles: boolean. Whether water particles are visible in the level's water. (read-only)
Computed properties (derived, not stored on the object):
inventory: trx.inventory.Inventory. What the level keeps for Lara's return, or nil for a level that keeps nothing: the title screen and the cutscenes. It is what she will arrive there with rather than what she is carrying now, which is trx.inventory itself.stats: trx.stats.Stats. What the level keeps count of, or nil for a level that counts nothing: the title screen and the cutscenes. The level being played is also trx.stats itself.A movie, as the game flow file declares it. Everything on it is read-only.
Handles are live references: if the underlying object is destroyed, using the handle raises an error rather than silently reading an unrelated one.
Properties:
is_credit: boolean. Whether the movie is part of the credits, which the Credits setting hides. (read-only)is_intro: boolean. Whether the movie opens the game. (read-only)is_legal: boolean. Whether the movie is a legal notice, which the Legal screen setting hides. (read-only)num: trx.game.FMVNum. (read-only)path: string. Path to the movie file. (read-only)trx.game.signals
The signals the game's own state speaks through, for a script that would rather hear about a change than ask after one. Each is read once a frame, so what listens runs on a change rather than on a frame.
trx.game.play_level(level_num, [opts])
Starts a level from trx.game.levels.
Parameters:
level_num (trx.game.LevelNum).
opts (table, optional). How to start it.
Keys:
Example:
trx.game.play_level(1)
trx.game.play_cutscene(cutscene_num)
Plays a cutscene.
Parameters:
cutscene_num (trx.cutscenes.Num).trx.game.play_demo([demo_num])
Plays a demo, and returns the one that started.
Parameters:
demo_num (trx.game.DemoNum, optional). Omit to play the next demo in rotation.Returns:
nil. The demo that started, or nil if the game has no demos.trx.game.play_fmv(fmv_num)
Plays a movie, and returns once it has finished. The game resumes where it left off.
Parameters:
fmv_num (trx.game.FMVNum).Example:
trx.game.play_fmv(1)
trx.game.play_gym()
Starts the gym. Raises if this game has no gym.
trx.game.end_level()
Ends the current level, as though Lara had reached its exit.
trx.game.exit_to_title()
Leaves the current game and returns to the title screen.
trx.game.screenshot([path])
Takes a screenshot. Without a path, writes one to the screenshots folder in the player's configured format; with a path, writes to that file.
Parameters: