free_cam_options¶

Source: base/tealdef/gui/main/free_cam_options.d.tl

Notes

The free camera tool of the game UI: a tool for the tool stack that switches to the free camera (or the cockpit camera of a vehicle) and a recipe that handles leaving it.

FreeCamOptions¶

record global base/tealdef/gui/main/free_cam_options.d.tl:3

global record FreeCamOptions

Load: local free_cam_options = ug_require "/gui/main/free_cam_options.tl"

Notes

Free camera tool and its input-handling recipe.

Fields

Name	Type	Description
`FreeCamOptions`	`Recipe<FreeCamOptionsParam>`	Recipe without visible content that pops `FreeCamTool` on `IA_BACK`, `IA_MENU_BACK` or when the engine reports `stoppedFollowAction`; on PC it also takes screenshots on `IA_GAME_SCREENSHOT`. used 1× in the base game
`FreeCamTool`	`ReactToolDefinition<FreeCamToolParam>`	Tool (name `"FreeCam"`) that enters the cockpit camera or toggles the free camera when pushed, and leaves the cockpit camera when popped. used 3× in the base game

FreeCamOptions.FreeCamOptionsParam¶

record base/tealdef/gui/main/free_cam_options.d.tl:4

record FreeCamOptionsParam

Notes

Parameters of the FreeCamOptions recipe.

Used in the base game: 2 times in 1 file

base/content/gui/gui/main/free_cam_options.tl:7

local function getToolStackApi(param : FreeCamOptions.FreeCamOptionsParam) : Builtin.ToolStackAPI

Functions

getGameContext() : GameContext base/tealdef/gui/main/free_cam_options.d.tl:5

Notes

Returns the game context; its tool stack is used to pop FreeCamTool.

Returns GameContext

FreeCamOptions.FreeCamToolParam¶

record base/tealdef/gui/main/free_cam_options.d.tl:7

record FreeCamToolParam

Notes

Tool parameter of FreeCamTool.

Used in the base game: 2 times in 1 file

base/content/gui/gui/main/free_cam_options.tl:38

push = function(ctx : Builtin.ToolStackContext<FreeCamOptions.FreeCamToolParam>, toolParam : FreeCamOptions.FreeCamToolParam)

Fields

Name	Type	Description
`cockpitCameraForEntity`	`Engine.Entity`	Vehicle entity whose cockpit camera to enter; when `nil`, the free camera is toggled instead.