Globals A–Z

Every global name the definition files declare.

Name	Kind	Description
_	function	Used to mark strings localized string (eg. _("Some text to localize"))
_rootData	field	Start parameters handed to the root GUI. The main menu reads it as its MainMenuParams (e.g. showNews); the campaign page clears its campaign field.
AchievementDesc	record	The description of an achievement
AchievementRep	record	Repository for all achievement types (static data) To access the current state of a player achievements, use UserProfile:getUnlockedAchievementIds
AchievementSFX	record	Sound of earned achievements, defined in ::/game_mechanics/achievements/sound/achievement_sfx.gres.
addModifier	function	Registers a modifier function for a resource loader. The modifier receives every loaded resource of that kind and returns it, possibly changed.
AdjustFeederConfig	record	Settings for RiverMapGenUtil.adjustFeeders (no fields are used).
AircraftInfo	record	Movement information for aircraft
AircraftMoveSystem	record	Aircraft Move System. System managing the movement of airplanes.
AnimalDespawnNotificationParams	record	Params of the animaldespawn notification ("A Grieving Day", category Info).
AnimalEow	record	Extension point and plugins of the animal window.
AnimalMoveSystem	record	Animal Move System. Manages animals.
AnimalSetStateCommandData	record	Sends a command object to be executed later or immediately depending on the context.
AnimalSpawnAtCommandData	record	Command data for cmd.makeAnimalSpawnAtCmd.
AnyAxis	record
AnyKey	record
api	record	Global table with the engine scripting API; each field is one sub-API.
ApiUtil	record	main util interface
App	record	Type of the global app object, which controls the application (save games, load progress, user profile, mods).
app	field	Global application object (App), e.g. app.getProgressMonitor() or app.getUserProfile(); used by the main menu and the in-game menus.
AppConfig	record	Game settings
AppUtil	record	Input-mode helpers returned by ug_require "/scripts/app_util.tl".
ArrivalTracker	record	Counts passengers and cargo that arrive by line between two places, through the ::/game_mechanics/arrival_tracker/arrivaltracker.gs game script. Used by the transport-cargo tasks.
ArriveAtStop	record	Payload of a vehicle-arrives-at-stop event.
AssetUtil	record	The asset group table returned by ug_require "/scripts/construction/asset_util.tl". Generated data that names a group gets a random model from assets[name].
Async	record	Asynchronous operation wrapper for background tasks
AudioEffectSettings	record	Specification for audio settings
AudioUtil	record	Sound curve helpers from /scripts/audioutil.lua.
AutoGroundTex	record	Specification for auto-generated ground textures
AutoRename	record	Data types of the line auto-rename schemes (resources of type rename_scheme and rename_scheme_component).
AvailabilityNotificationParams	record	Params of the availability notification about newly available vehicles (category Info), sent by availability_notifications.script.tl.
BackgroundContrastMode	record	Where the white background contrast layer replaces normal world rendering. Stored in AppConfig.backgroundContrastMode (setting "Enable Background Contrast Layer").
BaseConfig	record	Base configuration of a single game
BaseEdgeType	record	Base edge type
BaseGUISaveData	record	GUI data the base game stores in the savegame, read with api.gui.game.getGuiSaveData("") and written with api.gui.game.setGuiSaveData("", data).
BaseParallelStripSystem	record	Base Parallel Strip System. Contain information about parallel edge ranges.
BlimpUtil	record	Airship that flies to a town when a marketing campaign starts there, circles it while the campaign runs, and then leaves the map.
BoundingInfo	record	Information about the axis aligned bounding box of the model
Box2f	record	A 2d bounding box
Box3f	record	A 3d bounding box
BridgeType	record	Specification for bridge types and also tunnels
BufferedLVMSendData	record	A send-to-line command that failed and is retried when the line is selected again.
BuildConstructionUtil	record	Proposal checks for mission tasks. Each checkX tests one property of a build proposal; each makeCheckX returns that check as a function for a HandleProposalEventConfig field.
BuilderAudioSet	record	Sound set of a construction tool (a .builder_audio resource): sounds for dragging, building, bulldozing and terraforming.
BuilderUtil	record	Geometry helpers for checking build proposals.
BuildingType	record	Specification for town building types
Builtin	record	The built-in widget library returned by ug_require "::/gui/main/builtin.lua": recipes for layouts, text, images, buttons, inputs, windows, charts and the game's tool and renderer components. Most widget parameters are engine classes, so a parameter table may only contain the declared fields (an unknown key raises an error). Enumerations are in builtin.type.
ButtonReactUtil	record	Functions that return ready-made button nodes (text, icon, icon plus text, icon toggle).
CalcTicketPriceCargoEvent	record	One element of the param list of the OnCalcTicketPrice event sent by TransportVehicleSystem for cargo. A handler can return a table {index : multiplier} to scale the price of selected elements.
CalcTicketPriceEvent	record	One element of the param list of the OnCalcTicketPrice event sent by SimEntityAtVehicleSystem for passengers. A handler can return a table {index : multiplier} to scale the ticket price of selected elements (index 0 applies to all).
Calendar	record	Date helper for missions.
CalloutApi	record	API of the callout container, a floating layer that shows one callout (a popup recipe placed next to a GUI element or at a position) at a time.
CalloutReactUtil	record	Recipes for toggle buttons that open callouts, and a default callout frame.
CampaignDesc	record	Campaign description
CampaignParam	record	Page parameters of the Campaign page.
CargoCategory	record	Represent a group of cargo types that are transported with similar packaging/containers: e.g. liquid, bulk, ...
CargoClass	record	Specification for cargo types
CargoClassId	type	Integer id of a cargo class, as returned by api.res.cargoClassRep.getCargoClassId.
CargoClassRep	record	Type of api.res.cargoClassRep, the cargo class repository; adds lookups by cargo class name.
CargoFilterUtil	record	Per-stop cargo filter popover of the line manager (CargoFilterWindow).
CargoReactUtil	record	Recipes and builders that show cargo icons and cargo lists.
CargoRtcWarningNotificationParams	record	Params of the persistent cargo_rtc_warning notification ("Cargo Unload Problem", category Caution) for vehicles that carry cargo around their line without unloading it.
CargoRtcWarningNotificationSimParams	record	Sim params of cargo_rtc_warning.
CargoThrownAwayNotificationParams	record	Params for a cargo-thrown-away notification. No notification type in the base game uses it.
CargoThrownAwayNotificationSimParams	record	Sim params for a cargo-thrown-away notification. No notification type in the base game uses it.
CargoType	record	Specification for cargo types
CargoTypeId	type	Integer id of a cargo type in api.res.cargoTypeRep.
CargoTypeRep	record	Type of api.res.cargoTypeRep, the cargo type repository; adds cargo type set helpers and getPassengerCargoTypeId.
CargoTypeSet	record	Specification for cargo type set
CargoTypeSupplyDemand	record	Supply and demand of one cargo type in a town district.
CargoTypeSupplyDemands	record	Supply and demand per cargo type for each district type.
CargoUtil	record	Read-only helpers for cargo types, stocks and vehicle cargo in the UI.
CarriageInfo	record	Information about carriages
CarriageListSystem	record	Carriage list System. Manages vehicles that are groups of multiple carriages.
Carrier	record	Carrier types for journal entries
CatchmentArea	record	A catchment area is a cylinder around a position with a specific radius
CatchmentAreaSystem	record	Catchment Area System. Contains cached information about reachability of stations and destinations.
CelebrationAddedEventParams	record	Param of the GUI React event celebration-add, fired by the celebrations game script (guiUpdate). CelebrationsContainer queues and shows it.
CelebrationColors	record	Color of celebration callouts, defined in ::/game_mechanics/celebrations/gui/celebration_colors.gres and used by celebration.css.lua.
CelebrationReactUtil	record	GUI recipe for celebration callouts.
CelebrationsContainerParams	record	Params of CelebrationsContainer.
CelebrationSFX	record	Sound of celebration callouts, defined in ::/game_mechanics/celebrations/gui/sound/celebration_sfx.gres.
CelebrationType	enum	Kind of celebration callout. The celebrations game script tracks these firsts and level-ups.
ChartConfig	record	A structure that holds config for a chart
ChartResult	record	A structure that holds data for a chart
CheckboxList	record	Recipes for checkbox lists with a header.
ClimateDesc	record	Contains all data relevant for the climate
Clock	record	A very precise clock.
Cmd	record	contains all commmand factory methods.
Collider	record	Information about the collider of the model Forward declaration of the Collider type, which is defined in api/type.d.tl. Used by Engine.Component.ColliderList.
ColliderUtilSerialized	record	Collider helpers returned by ug_require "/scripts/construction/collider_util_serialized.tl".
ColorUtil	record	Conversion and mixing helpers for GUI resource colours (GResColor, a list of 3 or 4 numbers in 0..1).
Command	record	Command object sent via cmd.sendCommand.
CommandProgress	record	Command progress tracker
CommonActionParams	interface	Shared state, refs and actions of the Line & Vehicle Manager, created once by the manager tool and passed to its panels, tooltips and HUD icons.
CommonMenuParams	record	Services that the main menu or the in-game pause menu hands to each of its pages as commonParams.
CompaniesGrowthState	record	State of the company progression game script.
CompaniesState	record	State of the company game script.
CompanyGreenifyNotificationParams	record	Params of the industry-greenify notification (company_notification_greenify.script).
CompanyGreenifyNotificationSimParams	record	Data the notification resolves on the simulation side.
CompanyGrowthConfig	record	Config of company growth (game_script_config resource ::/game_mechanics/company/company_growth_config.res).
CompanyLegacyUtil	record	Upgrades a company state saved by an older game version.
CompanyMarketingNotificationParams	record	Params of the marketing-campaign notification (company_notification_marketing.script).
CompanyMarketingNotificationSimParams	record	Data the notification resolves on the simulation side.
CompanyMetadata	record	Accessors for the company metadata of construction resources, construction instances and savegames.
CompanyProgressionUtil	record	Company experience and rank.
CompanyProspectionNotificationParams	record	Params of the prospection notification (company_notification_prospection.script).
CompanyProspectionNotificationSimParams	record	Data the notification resolves on the simulation side.
CompanyRankUpNotificationParams	record	Params of the rank-up notification (company_notification_rank_up.script).
CompanyReactUtil	record	GUI helpers of the company window.
CompanySFX	record	Sound effects of the company window.
CompanyState	record	Saved state of one company (player) in the company game script.
CompanyStaticUtil	record	Rank names and permit-key definitions.
CompanyToolParam	record	Params of the company window.
CompanyUtil	record	Permit counting, disable reasons and state access of the company.
CompanyValue	record	A structure that holds information about the company's value
ComponentCustomState	record	A custom component might contain any data in form of a lua table (without functions) and can used with custom scripts to create new custom objects in game
ComponentExchangeCommandDataDEBUG	record	Debug command data for api.cmd.debug.makeComponentExchangeCmd, which replaces a component (EmissionEmitter or ModelInstanceList) on an entity.
ComputeEmittedModelsFn	type	Signature of a function that emits models through the ModelEmitter in each update.
ConAvailabilityNotificationParams	record	Params of the con_availability notification about newly available constructions, streets and tracks (category Info), sent by availability_notifications.script.tl.
ConfigUtil	record	Helper returned by ug_require "/scripts/util/config_util.tl".
Connection	record	An object used to disconnect callbacks.
ConsoleGen	record
ConstructionActionCustomHudIcons	enum	Extra HUD icons a construction action can show.
ConstructionActionHudIconConstructionType	enum	Restricts station and depot HUD icons to a carrier.
ConstructionActionHudIconParams	record	User parameters of the HUD icon master used while a construction action is active.
ConstructionActionHudIcons	record	HUD icon configuration of a construction menu entry. Construction descriptions set it through configureHudIconsScript.
ConstructionActionHudIconStationType	enum	Restricts station HUD icons to cargo or passenger stations.
ConstructionActionRepository	record	Data shared by all construction menu entries, created by ConstructionReactUtil.getConstructionActionRepository.
ConstructionAvailability	record	Years in which a construction menu entry is available.
ConstructionColors	record	Colors of the construction tools (GUI resource ::/gui/construction/construction_colors.gres).
ConstructionConfigMetadata	record	Metadata accessors for the constructionConfig key (see getKey).
ConstructionCustomAction	record	A custom action of a construction menu entry; create one for perk tools with ConstructionReactUtil.RegisterCustomSelectorBasedActionRecipe.
ConstructionCustomActionParams	record	Parameters passed to the recipe of a custom construction action (ConstructionDefinition.customAction).
ConstructionDefinition	record	An entry of the construction menu. The menu builds these from constructions, streets, tracks, modules, terrain materials, edge decorations and construction_tool resources.
ConstructionDesc	record	Describes a construction
ConstructionDescMetadata	record	Opaque type of the metadata table of a construction description.
ConstructionDescReactUtil	record	Helper module for the info panel of construction menu entries. Load it with ug_require "::/gui/construction/construction_desc_react_util.tl".
ConstructionId	type	Integer id of a construction resource in api.res.constructionRep.
ConstructionInstanceMetadata	record	Opaque type of the metadata stored with a built construction.
ConstructionMenu	enum	Top-level tab of the construction menu. Menu categories (menu_category resources) name the tab they belong to.
ConstructionMenuAction	enum	Kind of action a construction menu entry starts; selects which built-in construction action is configured.
ConstructionMenuActionParams	record	Everything the construction menu needs to run the action of an entry, returned by ConstructionReactUtil.getActionParams.
ConstructionMenuCategory	record	Data of a menu_category resource, a sub tab of a construction menu tab.
ConstructionMenuModuleCategory	record
ConstructionMenuParam	record	A parameter of a construction menu entry, shown in the parameter window or the toolbar.
ConstructionMenuParamInfo	record	A parameter of the active definition with its position and current value, as returned by ConstructionMenuParamsAPI.getParamByKey.
ConstructionMenuParamsAPI	record	API of the parameter list of the construction menu (side window or bottom bar), passed to parameter callbacks such as ConstructionMenuParam.onChangeFn.
ConstructionReactUtil	record	Helper module of the construction menu. Load it with ug_require "::/gui/construction/construction_react_util.tl".
ConstructionResult	record	Contains the processed result of a construction
ConstructionScriptParam	record	Parameter of a meta-construction (MetaConstructionDesc.params), shown in the construction menu. Unlike ScriptParam it uses string enums for uiType, location and displayMode.
ConstructionSFX	record	Sound effects of the construction tools (GUI resource ::/gui/construction/sound/construction_sfx.gres). Each entry is a list of sound files.
ConstructionSpecializationMetadata	record	Metadata accessors for construction and module specializations.
ConstructionTemplate	record	Construction template with availability and type information
ConstructionTemplateData	record	Specify additional variants of the construction by providing a list of modules and the slot in which they belong
ConstructionToolData	record	Data of a construction_tool resource, which adds an entry to the construction menu.
ConstructionToolParam	record	Tool parameters of the construction menu tool (construction.ConstructionTool in gui/construction/construction.tl).
ConstructionToolWindowParam	record	Parameters of the construction menu window (ConstructionListWindow). The payload carries the ConstructionToolParam.
ConstructionType	record	Type of the construction for displaying in the correct UI category and controlling specific behaviour for the type.
ConstructionUtilSerialized	record	Plain-table types of what construction scripts (updateFn, module updateFn, getModelsFn, createTemplateFn) return; the engine converts these tables. The legacy helper /scripts/construction/constructionutil.lua is loaded with this type to get addModelsAndGroups.
ConstructionWindowParam	record	Parameters of ViewManager.MakeEntityWindowContentFn.ConstructionWindow, the window of a construction with several parts shown as tabs.
ContentCard	record	Content card recipes and helpers.
Context	record	Proposal context to configure how the proposal is to be applied
ContextHelperScriptState	record	Game script state of the context helper (gui/context_helper/context_helper.script.tl).
ContextHelperWindowParam	record	Parameters of the context help window (gui/context_helper/context_helper_react.tl), which the game bar opens as a singleton window.
CreateIndustryExtendProposalCommandData	record	Command data for cmd.makeCreateIndustryExtendProposalCmd.
CreditsReactUtil	record	Credits recipe and the data types of the credits slides.
CurveConfig	record	Settings for RiverMapGenUtil.makeCurves.
CustomEntityCreateCommandData	record	Command data for cmd.makeCustomEntityCreateCmd.
CustomEntityDestroyCommandData	record	Command data for cmd.makeCustomEntityDestroyCmd.
CustomEntityUpdateStateCommandData	record	Command data for cmd.makeCustomEntityUpdateStateCmd.
CustomEntityUpdateTransformationCommandData	record	Command data for cmd.makeCustomEntityUpdateTransformationCmd.
CustomEntityUtil	record	Helpers for custom entities (models placed and moved by script) and movement maths for flying ones.
CustomUpdateEventScript	record	Script reference for a Custom sound update function that triggers an event.
CustomUpdateScript	record	Script reference for a Custom sound update function that drives a track.
CustomVehicleCreateCommandData	record	Command data for cmd.makeCustomVehicleCreateOrUpdateCmd.
Date	record	Date representation with year, month, and day
DateFormat	record	DateFormat used for formatting calendar entries
debugPrint	function	Prints text to the console/log file
DecoratorParam	record	Params of a decorated task.
DecoratorState	record	State of a decorated task.
DefaultColors	record	Base GUI colour palette (neutral greys, the blue theme colours, status colours).
DeliverCargoSubventionParam	record	Spawn parameters of the deliver_cargo subsidy ("Supply Industry").
DeliverCargoTownSubventionParam	record	Spawn parameters of the deliver_cargo_town subsidy ("Supply Town").
DeliverPassengersSubventionParam	record	Spawn parameters of the deliver_passengers subsidy ("Connect Towns"), a transfer-free passenger line between two towns.
DeliverWorkersSubventionParam	record	Spawn parameters of the deliver_workers subsidy ("Transport Workers").
DialogReactUtil	record	Util table of dialog_react_util.tl; holds the DialogWindow recipe.
DialogueOverlayApi	record	API of the mission dialogue overlay that plays voice-over dialogues, instructions and the credits.
DifficultyReactUtil	record	Util table of difficulty_react_util.tl; holds the DifficultyPresetToggles recipe.
DifficultyUtil	record	Difficulty helpers returned by ug_require "/base/difficulty_util.tl".
DisableFeatures	enum	Keys of the feature-switch table {DisableFeatures : boolean}; a key set to true disables that UI feature.
DismissNotification	record	Param of the Notifications/dismiss event (hides a notification from the pop-ups) and of the enlist event (shows it again).
DistanceSpeedUnit	record	DistanceSpeedUnit represents the unit of measurement used for distance and speed.
DistrictColors	record	Colour ranges (min, max) for residential, commercial and industrial districts. The town window styles, the finance charts and the cargo flow and civilization layers use them.
DndDragContext	record	Items being dragged over a node (given to enter and exit).
DndDropContext	record	Items available when something is dropped on a node.
DndGrabContext	record	Context for adding drag-and-drop items.
DragAndDropHandler	record	Callbacks given to React.onDragAndDrop.
DuplicateVehiclesParam	record	Parameter of the duplicateVehicles event, which buys copies of vehicles (new purchase time, full maintenance state) and sends them to the best line and depot.
DynamicConstructionTemplate	record	Dynamic construction template configuration
Easing	record	Easing functions for particle curve interpolation
EconomyDesc	record	Contains all data relevant for the economy.
Edge	record	A single edge within a Transport Network.
EdgeDecoration	record	An addon to the sides (or the center) of BaseEdge like noise barrier and alleys
EdgeGeometry	record	Defines the geometry (shape) of an edge
EdgeId	record	References a single transport network edge within a transport network entity
EdgeIsect	record	Specifies the intersection of two edges, with waiting area for vehicles.
EdgeObjectType	record	Types of objects that can be placed on a BaseEdge
EdgePos	record	References a position inside an EdgeId
EmissionConfig	record	Emission config (emission/emission_config.tl), used for the layers and the noise and pollution town ratings.
EmissionConfigMeta	record	The metadata.emissionConfig table of a construction or module, shown in its description.
EmissionConfigMetadata	record	Accessors for emissionConfig metadata.
EmissionDb	record	Emission of a construction (metadata.emission); industries list one entry per production level.
EmissionGridSystem	record	Emission grid system. Manages emission grid data.
EmissionLegacyUtil	record	Upgrades an emissions state saved by an older game version.
EmissionMetadata	record	Accessors for emission metadata.
EmissionSimState	record	State of the emissions game script.
EmptyConstructionEow	record	Extension point and plugins of the window of constructions without a more specific window ("Empty Construction").
Engine	record	Main Engine interface
EngineReactUtil	record	React hooks that keep a React state in sync with engine data and send commands to change it.
EngineUtil	record	Collection of engine specific utils grouped by system Forward declaration of the EngineUtil record (defined in api/engine/util.d.tl), the type of api.engine.util.
EntitySetColorCommandData	record	Command data for cmd.makeEntitySetColorCmd.
EntitySetEmissionsCommandData	record	Command data for cmd.makeEntitySetEmissionsCmd.
EntitySetNameCommandData	record	Command data for cmd.makeEntitySetNameCmd.
EntitySetPlayerCommandData	record	Command data for cmd.makeEntitySetPlayerCmd.
EntityUtil	record	Entity helpers returned by ug_require "/scripts/entity_util.tl".
EntityWindowHud	record	HUD icon configuration of the entity windows (industry, perk, line, subsidy, town building, station, town, maintenance, vehicle).
EntityWindowUtil	record	Library of React recipes and helper functions shared by the entity windows.
Enum	record	Collection of all enumerations of the API, reached as api.type.enum.
Environment	record	Specification for environment
EowExtensionUtil	record	Shared parts of the entity window extension points.
EventData	record	Generic pair of an event parameter param and the handler's result.
Exploration	record	Definition of a prospection (generic resource of type company_exploration, e.g. explorations/exploration_clay.res.lua).
ExplorationPlaneCustomState	record	Custom state of the plane entity that circles a town during a prospection.
ExtensionPoint	record	A named place in the GUI where plugin recipes with the parameter RecipeParam can be added.
ExtensionPoint0	record	A named place in the GUI where other mods can add plugin recipes without parameters. Created with React.RegisterExtensionPoint0.
Extent	record	Information about the game-logic related bounds, usually for vehicles (bbMax.x being the vehicle's front)
ExtPath	record	A path comprised of EdgePathEdges that does not necessarily start/end on a Port
Failure	record	Why a vehicle cannot use a line, as returned by api.engine.util.line.getFailedPathReason.
FeedbackListUtil	record	Feedback strip for short command results and confirmation questions; the recipe is FeedbackList.
FilePath	type	Path to a file (for example an icon .tga or a sound file), as a string.
FinanceData	record	Finance table of a player, as returned by api.engine.util.finance.computeFinanceTable. Each value list has one entry per column of header; amounts are in game currency.
FinanceSFX	record	Sound effects of the finances window.
FinancesReactUtil	record	Recipes of the finances window.
FinancesUtil	record	Labels and ordering of journal entries.
FinanceToolParam	record	Params of the finances window.
FirstStopToSend	record	Data types of the "first stop to send" schemes (resources of type firstStopToSend_scheme), which decide at which stop vehicles start when sent to a line.
FlightState	record	Flight State of an Aircraft
FontScaleClass	record	FontScaleClass represents the current UI font scaling factor.
ForceUnit	record	ForceUnit represents the unit of measurement used for force.
FreeCamOptions	record	Free camera tool and its input-handling recipe.
FunElementsEow	record	Extension point and plugins of the window of fun elements (UFOs, blimps and similar).
FunElementsState	record	Saved state of the game script ::/game_mechanics/fun_elements/fun_elements.gs.
FunElementsUtil	record	Access to the fun elements state.
FunElementType	enum	Kind of a fun element entity.
GainPitch	record	Gain and pitch of one sound track or event.
GainPitchTrigger	record	Gain and pitch of a sound event plus whether to trigger it now.
game	record	Global table under which loaded scripts and their functions are reachable; base script scripts/util.tl (util.useFn) resolves a reference "<file>@<a.b.c>" by walking game[file].a.b.c.
GameAddPlayerCommandData	record	Command data for cmd.makeGameAddPlayerCmd.
GameBar	record	Module of the game bar recipe and the main radial menu recipe.
GameBarWidgets	record	Widgets of the game bar.
GameContext	record	Shared context of the in-game GUI. Holds references to the main renderer component, window container and tool stack, plus mission filters, disabled features and a few shared states.
GameDifficulty	enum	Difficulty preset of the new-game settings.
GameEditionTextParam	record	Which edition packs are installed; used to choose the logo and the release-note texts.
GameMap	record	Information about the map, for map generation purposes.
GameMetadata	record	Game metadata from a savegame
GamepadType	record	GamepadType represents the current gamepad.
GamePerformSimulationStepsCommandDataDEBUG	record	Debug command data for api.cmd.debug.makeGamePerformSimulationStepsCmd, which advances the simulation.
GameplayColors	record	GUI colours of gameplay concepts (boosts, growth, maintenance, satisfaction, cargo shipping states), from gameplay_colors.gres.lua.
GameReactGlobals	record	Functions returning the in-game renderer component, window container, tool stack and disabled features.
GameSaveCommandData	record	Command data for saving the game.
GameScreenshot	record	Game screenshot data
GameScript	record	The functions a game script file exports; *.gs.lua names them as "file.script@functionName".
GameScriptDesc	record	Contains all data describing a game script
GameScriptState	record	Persistent state object of a game script, passed to update, postUpdate and handleEvent. The state table is saved with the game; change it by reading with get, modifying and writing back with set.
GameScriptStateReadOnly	record	Read-only view of a game script's state, given to the GUI functions.
GameScriptSystem	record	Game Script System Manages entities and components for gamescript.
GameScriptType	record	Game script resource, the entry type of api.res.gameScriptRep.
GameScriptWithGui	record	A game script that also exports GUI-side functions, with separate engine state StateT and GUI state GuiStateT.
GameSetCalendarSpeedCommandData	record	Command data for cmd.makeGameSetCalendarSpeedCmd.
GameSetCloudCoverageCommandData	record	Command data for cmd.makeGameSetCloudCoverageCmd.
GameSetDateCommandData	record	Command data for cmd.makeGameSetDateCmd.
GameSetSpeedCommandData	record	Command data for cmd.makeGameSetSpeedCmd.
GameSetTimeOfDayCommandData	record	Command data for cmd.makeGameSetTimeOfDayCmd.
GameSpeedApi	record	API of the game speed helper used by the game bar to read and change the simulation speed.
GameTimeConfig	record	Initial time-of-day mode of a new game, in the generic resource ::/game_mechanics/game_time/game_time_config.res. The base mod sets it from the game settings.
GameTimeGUIState	record	GUI state of the game-time script. It is empty; the script has no GUI functions.
GameTimeState	record	State of the game script ::/game_mechanics/game_time/game_time.gs, which sets the time of day and the cloud coverage.
GameTimeStateMode	enum	How the game script game_time.gs moves the time of day. The calendar's "Cycle" box sets it.
GameTooltips	record	Tooltip recipes for hovered entities and terrain in the 3D view.
Gender	record	Gender of a person model, used in ModelMetadata.Person.gender.
GenericGameRes	record	Describes a generic game resource
GenericGameResT	record	Describes a generic game resource
GenericRep	record	Type of api.res.genericRep, the repository of generic game resources (GenericGameRes, a type string plus a data table); adds getAllOfType.
getBuildVersion	function	Returns the build version
getCurrentModId	function	Returns the mod id of the current mod scope This is the outermost mod in the require hierarchy (i.e. the current file might belong to a different mod)
GetEmittableModelsFn	type	Signature of a function that lists the model files a transformator may emit.
getOwningModId	function	Returns the mod id of the mod owning the current file Note: This means you can not delegate calls to this function into helper files!
getStringForPlatform	function	Returns the appropriate string based on the current platform
GlobalType	type	Global alias of Type, the type namespace reached as api.type.
GPUCapabilities	record	Information about the graphics card, returned by app.getGPUCapabilities().
GraphicsPresetsUtil	record	Util table of graphics_presets_util.tl.
GResColor	record	{number} is expected to have length 3 or 4
GResColorArray	record	A list of GUI resource colours.
GResColorRange	record	A pair of GUI resource colours (minimum and maximum), e.g. for a colour gradient.
GResTransparency	record	Standard alpha values of the GUI, from the resource ::/gui/main/transparency.gres.
GridCollision	record	Contains multiple grids holding data Contains multiple grids holding diverse data
GridCollisionSystem	record	Grid Collision System. Single instance of the grid collision system.
Gridf	record	A 2D grid of float values
GridVec2f	record	A 2D grid of Vec2f values
GroundTexture	record	Specification for ground textures
GroupId	record	Identifies a save-game group, i.e. all saves of one game (manual saves, autosaves, ...).
GrowthSummand	record
Gui	record	Main GUI interface
GuiCompSFX	record	Sound files of the standard GUI components (data of gui/sound/gui_comp_sfx.gres).
GuideEvent	record	Guide task triggered by an engine-side script event that matches all given fields.
GuideGeneric	record	Guide task triggered when a custom function returns true.
GuideSystemParams	record	Params of the guide-system recipe.
GuideSystemReact	record	GUI of the guide system.
GuideSystemSFX	record	Sound effects of the guide system (GUI resource ::/gui/guidesystem/sound/guidesystem_sfx.gres).
GuideTimer	record	Guide task triggered after a delay given by its importance, when no other guide is pending and the last task completed at least a minute ago. Completes early when a listed construction is proposed or shouldSkipGuide returns true.
GuideUiEvent	record	Guide task triggered by a GUI event that matches all given fields.
GuiReactUtil	record	General React helpers (indicators, layout shortcuts, focus scopes, plugin rendering).
HeadquarterUtilSerialized	record	Types of the company headquarter construction.
HeighmapGenerationMode	record	Map generation mode for heightmap generation
HeightmapNew	record	Abstraction of heightmap data, consisting of a cell with floating point values at each point
HudEffectMode	record	HudEffectMode configures the HUD effects
HUDFilter	record	The "HUD Filters" layer window.
HudGuiConfig	record	Content of the GUI resource ::/gui/hud/hud_gui_config.gres, the base settings for HUD icons in the 3D view.
HudIconMaster	record	Types for HUD icons; same as the ones in HudIconToolbox, which the base game uses.
HudIconToolbox	record	HUD icon recipes and their parameter types.
HudReactUtil	record	Helpers to build and modify the Builtin.Type.VisibilityThresholds that control when and in which draw order HUD icons appear.
ICommandData	interface	Marker interface for command data payloads.
IconAndLabelParams	record	Parameters of IndustryReactUtil.IconAndLabelWidget.
IconWithAvailability	record	Icon of a construction menu entry.
IEntityWindowParam	interface	Base parameters passed to every entity window content recipe (vehicle, town, industry, station ... windows).
IGuideState	interface	State shared by all guide task scripts. A guide is shown once triggeredTime is set and completes when the GUI sends the guide-system / guide-complete event for it.
IMenuPageParam	interface	Parameters every menu page recipe receives: the shared commonParams and page-specific params.
ImportBiomesMode	record	Map generation mode for importing biomes
ImportExportHeightmapMode	record	Map generation mode for importing or exporting heightmaps
Index	type	Integer index, for example the default value index of a script parameter (ScriptParam.defaultIndex).
IndustriesConfig	record	Config of the industries game script (game_script_config resource industries_config.res).
IndustriesState	record	State of the industries game script.
IndustriesWorkersState	record	State of the industry_workers game script.
IndustryEow	record	Plugin types of the industry window.
IndustryInfo	record	Industry placement information
IndustryNotificationParams	record	Params of the industry_spawn ("New Industry Founded", Info) and industry_close (Caution, persistent) notifications.
IndustryNotificationSimParams	record	Sim params of the industry notifications.
IndustryProductivityUtil	record	Worker boost helpers returned by ug_require "/industries/industry_productivity_util.tl".
IndustryReactUtil	record	React recipes and helpers for production rules and the workers boost in the industry and perk windows.
IndustryResult	record	Results of industry generation operations
IndustrySetDespawnTimeCommandData	record	Command data for cmd.makeIndustrySetDespawnTimeCmd._
IndustrySetManualDevelopmentCommandData	record	Command data for cmd.makeIndustrySetManualDevelopmentCmd.
IndustryUtil	record	Helpers that read industry stock lists and rules for the UI.
IndustryWindowRuleDurationParams	record	Parameters of IndustryReactUtil.IndustryWindowRuleDurationWidget.
InputActionColors	record	Gamepad face-button colours; read with api.gui.genericRep.get(api.gui.genericRep.find("::/gui/main/input_action_colors.gres")).data.
InputActionDesc	record	Description of an input action for key binding
InputActionRep	record	Contains all input actions that can be bound to keys. Get it with app.getInputActionRep().
InputMode	record	InputMode represents the current input mode.
ipairs_native	record	Global iterator like ipairs for a native Vector: iterates the elements in order via Vector.at until it returns nil.
IReactToolDefinition	interface	A tool registered with React.RegisterTool (the tool stack of the game GUI, e.g. windows such as the pause menu).
IRecipe	interface	Anything that can be called as a recipe.
IRecipeParamWithMeta	interface	Recipe parameters that accept a meta table.
ISubvention	interface	One subsidy instance as stored in SubventionState.
ISystem	interface	Common interface of engine systems that can loop over their entities with forEach; AircraftMoveSystem declares that it implements it.
JournalBookAssetCommandData	record	Command data for cmd.makeJournalBookAssetCmd.
JournalClearAllCommandData	record	Command data for cmd.makeJournalClearAllCmd.
JournalEntry	record	One finance journal booking (api.type.JournalEntry). Create it with api.type.JournalEntry.new(), set amount, time and category, and book it with api.cmd.makeJournalBookAssetCmd.
JournalLogEntryCommandData	record	Command data for cmd.makeJournalLogEntryCmd.
KeyCombo	record	Key combination for input binding
KeyComboDef	record	Key combination definition for input binding
LakeConfig	record	Settings for RiverMapGenUtil.makeLakes.
LandmarkEngineUtil	record	Landmark bonus helpers returned by ug_require "/landmarks/landmark_util.tl".
LandmarksNotificationParam	record	Parameters of the notification shown when a landmark is finished.
LandmarksState	record	State of the landmarks game script.
LandmarkSystem	record	Landmark system. Manages landmarks data.
LandmarkUtilSerialized	record	Landmark construction helper returned by ug_require "::/landmarks/landmark_util_serialized.tl".
LandUseGrowth	record
LandUseType	record	Enumeration for land use types
LandVehicleMoveInfo	record	Movement information for land vehicles (trains, trams, road vehicles)
LandVehicleMoveSystem	record	Land Vehicle Move System. Manages the movement of land vehicles.
LaneConfig	record	Specification for the lanes of street
LaneConnection	record	A custom configuration for lanes on crossings
LaneUtilSerialized	record	Lane helper from /scripts/construction/laneutil.lua.
LangKey	record	Localization information
LanguageRep	record	Contains all available languages of the application, including languages added by mods
LangUtil	record	Text formatting helpers for the GUI, returned by ug_require "/scripts/lang_util.tl".
LayerCargo	record	The "Cargo Satisfaction" layer, which colors warehouses and network edges by cargo satisfaction.
LayerCargoFlow	record	The "Cargo Flow" layer, which shows where cargo is supplied and demanded.
LayerColors	record	Content of the GUI resource ::/gui/layers/layer_colors.gres, the colors of all map layers.
LayerConfig	record	Describes configuration for 3d layers that can be enabled with the react interface
LayerNoise	record	The "Noise" layer, which shows noise emission and the affected town buildings.
LayerPollution	record	The "Pollution" layer, which shows pollution emission, the averaged pollution map, wind and town areas.
LayerPublicTransport	record	The "Passenger Satisfaction" layer, which colors stations, waiting passengers and network edges by passenger satisfaction.
LayerReactUtil	record	Shared helpers of the map layers.
LayersButtonRidge	record	The layers button with its ridge of layer buttons and the types shared by the layer windows.
LayerTraffic	record	The "Traffic" layer, which colors roads and vehicles by congestion.
Line	record	Namespace for the GUI-side line types used by the Line & Vehicle Manager.
LineAndDepotListApi	record	API of the line and depot list, reached through CommonActionParams.lineAndDepotListRef.
LineAndDepotListParams	record	Parameters of the line and depot list of the Line & Vehicle Manager.
LineCargoInfo	record	Information about cargo on a line
LineCreateCommandData	record	Command data for cmd.makeLineCreateCmd.
LineDestroyCommandData	record	Command data for cmd.makeLineDestroyCmd.
LineEow	record	Plugins and widgets of the line window.
LineIssue	record	Problem with the cargo configuration of a line, as returned by api.engine.util.line.getLineIssues.
LineManagerPanelParams	record	Parameters of the line panel of the Line & Vehicle Manager (line_manager_panel.tl).
LineManagerState	record	Selection of the line and depot list.
LineOrEdges	record	Start of a path search: either a section of a line (line with stop indices) or a list of edge positions (edges). Used in PathFactoryInput.fromLineOrEdges.
LinePick	record
LineProblem	record	Information about the problem of a line.
LineProblemNotificationParams	record	Params of the persistent line_warning notification ("Line Problem", category Problem), created from api.engine.util.line.getLineProblems() and getLinesIssues().
LineProblemNotificationSimParams	record	Sim params of line_warning.
LineReactUtil	record	React widgets for lines and vehicles. Load with ug_require "/gui/line_vehicle_mgmt/line_react_util.tl".
LineStationProblem	record	Information about the problem of station within a line.
LineStationProblemNotificationParams	record	Params of the persistent line_station_warning notification ("Station Issue", category Problem), created from api.engine.util.line.getLineStationProblems().
LineStationProblemNotificationSimParams	record	Sim params of line_station_warning.
LineStationVehicleSelectorParams	record
LineSystem	record	Line System. Contains cached information about lines.
LineUpdateCommandData	record	Command data for cmd.makeLineUpdateCmd.
LineUtil	record	Line utilities of the Line & Vehicle Manager. Load with ug_require "/gui/line_vehicle_mgmt/line_util.tl".
LineVehicleInfo	record	Configuration of vehicles that can use the line
ListUtil	record	List helper returned by ug_require "/scripts/util/listutil.tl".
LoadConfig	record	Configuration for loading cargo into a vehicle compartment
LoaderHelper	record	Helper class that allows loading and calling files in other modules
loaderHelper	field	Global LoaderHelper object; the base script scripts/util.tl calls loaderHelper:useFn(ref) before it resolves a script function reference of the form "<file>@<path>".
Loan	record	A loan offer or a taken loan.
LoanTable	record	State of the loan game script.
LoanType	enum	Size class of a loan.
LoanUtil	record	Creation and payment calculation of loans.
log	record	Global logging functions available to all game scripts.
LogLevel	record	LogLevel for logging
LVM2D3DMode	enum	Whether the Line & Vehicle Manager is operated in the panels (2D) or in the 3D world view; relevant for gamepad input.
LVMActionButtons	enum	Action button bar of the Line & Vehicle Manager that has the focus.
LVMButtonIAs	record	Input action keys of the Line & Vehicle Manager's gamepad buttons; several buttons share a key and differ by 2D/3D mode.
LVMCountData	record	Counts and selection ratios shown by the Line & Vehicle Manager (respecting the carrier and visibility filters).
LVMDeleteSell	record	What the gamepad "delete / sell" button acts on, depending on the focused section (line list, vehicle list or line panel).
LVMDisplayData	record
LVMDnDData	record	Line and revision at the start of a stop drag-and-drop in the line panel.
LVMFilterConfig	record	Category filter configuration of the Line & Vehicle Manager's line list.
LVMIconPaths	record	Icon paths used by the Line & Vehicle Manager; row* for list rows (20 px), reg* regular size, ab* action buttons, hud* HUD icons.
LVMMode	enum	Mode of the Line & Vehicle Manager tool, stored as {mode, param}.
LVMSection	enum	Section of the Line & Vehicle Manager that has the gamepad focus.
LvmSFX	record	Sound-effect file lists of the line and vehicle manager. Each field is a list of sound files; one is picked at random when played.
MainMenuSFX	record	Sounds of the main menu.
MainModButtonArea	record	Mod button bar of the game UI and its extension point.
MainModButtonAreaParams	record	Parameters of the MainModButtonArea recipe (none).
MainPageParam	record	Page parameters of the Main page.
MaintenanceCostUpdateCommandDataDEBUG	record	Command data to set new maintenance cost (debug).
MaintenanceStationEow	record	Plugin types of the maintenance station window (depots and buildings with a maintenance pool).
ManagerHudUtil	record	HUD icons of the Line & Vehicle Manager.
ManagerTooltipsUtil	record	Cursor tooltips of the Line & Vehicle Manager, set with ContextBuilder.tooltip.
ManagerWindow	record	The Line & Vehicle Manager tool and window. Open it by firing the openVehicleManager event; closeVehicleManager closes it.
Map	record	Native (C++) map exposed to Lua. Look values up with find, or iterate it with pairs_native; asTable converts it to a Lua table.
MapBounds	record	Rectangle of the map area, in metres.
MapEditor	record	The map editor tools.
MapGenUtil	record	River and ridge generation, returned by ug_require "/climates/gen/mapgenutil.tl".
MapPreviewColors	record	Colours of the town and industry markers in the map preview (MapPreviewComp).
Mat4f	record	A 4x4 transformation matrix Supports addition +, subtraction - and multiplication *. Supports array subscript with mat[i] access (16 elements in column-major order).
Mat4Serialized	record	The 4x4 matrix library returned by ug_require "/scripts/mat4.tl", and the namespace of its Mat4 type. Matrices are flat 16-number tables in column-major order; the translation is in elements 13-15.
MatCols	type	4x4 matrix as a plain Lua table, as made by CustomEntityUtil.convertMatrixToTable.
MathUtil	record	Scalar math helpers from /scripts/mathutil.lua. Loading that file also defines the same functions on Lua's global math table.
MemoryStatistics	record	Collection of useful memory statistics
MenuCategoryUtil	record	Menu category filtering helpers and recipes.
MenuIconReactUtil	record	Layout helpers and recipes for main menu pages.
MenuPageParam	record	IMenuPageParam with a typed params field; page recipes declare their parameter as e.g. MenuPageParam<CampaignParam>.
MenuUtil	record	Util table of menu_util.tl.
Meta	record	Settings in the meta field of recipe parameters. class and localKey apply to the node itself; the other fields wrap the node in a Builtin.WithComponentParams node.
MetaConstructionDesc	record	A Metaconstruction is a collection of constructions and modules that can be simultaneously be built (replaces the deprecated construction templates)
MetadataAccessor	record	Typed access to one key of a metadata table, obtained from MetadataTypeUtil.register(key). C is the kind of metadata table, T the type stored under the key.
MetadataUtil	record	Accessor factories for the four kinds of metadata tables; returned by ug_require "/scripts/metadata_util.tl".
MissionBootUtil	record	Builds the script module (vtable factory and boot function) of a mission or guide-system story from a task-data factory.
MissionCampaign	record	Campaign and mission identifier
MissionColors	record	Colour palette of mission markers, zones and highlights (::/mission/mission_colors.gres).
MissionDesc	record	Campaign mission description
MissionDialogueData	record	Data format of dialogue and cutscene keyframe files (function data() return { ... } end) and of task instructions. Times and durations are in seconds.
MissionEndWindowUtil	record	GUI of the mission-end window.
MissionFrameworkReact	record	GUI of the mission window.
MissionFrameworkReactUtil	record	GUI building blocks of the mission window.
MissionFrameworkUtil	record	Low-level access to task vtables, task contexts and the saved mission state.
MissionFrameworkUtilEntity	record	Commands that change ownership of, build, upgrade or bulldoze entities.
MissionFrameworkUtilLine	record	Finds lines between stations in two areas.
MissionInterface	record	Namespace of the core mission-framework types. A mission is a list of tasks; each task is run by a TaskScript and described by static data.
MissionLocalization	type	List of { entity, name } pairs used to rename the entities of a mission savegame (see NameUtil.setName).
MissionOutline	record	Helpers that build zone shapes (polygons around the origin, circles) for mission tasks.
MissionPageContentParam	record	Parameters of the mission page content recipe (/gui/menu/mission_page_content.tl) of the campaign page.
MissionPathfindingUtil	record	Path finding on the transport network for mission checks.
MissionReactUtil	record	GUI of the mission dialogue and instruction overlay.
MissionTaskAssignVehicle	record	Task (assign_vehicle) that completes when at least minCount player vehicles of the carrier run on a matching player line. The line is line, any line between a pos1 area and a pos2 area, or the line returned by getRuntimeLine; cargoTypeRes limits the count to vehicles that can carry that cargo.
MissionTaskAutoBulldoze	record	Task (auto_bulldoze) that removes the given constructions that still exist and completes.
MissionTaskBuildConstruction	record	Task (build_construction) that checks every build proposal with proposalHandler. A proposal that fails a check is blocked with the check's message; each applied proposal that passes counts, and the task completes at minCount (default 1).
MissionTaskBuildConstructionVariant	record	Task (build_construction_variant) that completes when at least minCount constructions of the listed files exist in the areas (circles or polygons), or when customCheckFn returns enough entities. The areas are drawn as zones.
MissionTaskBuildPath	record	Task (build_path) that completes when a path exists for every pair, between the network nodes in two areas or between two entities. With more than one pair a counter is shown, and the unconnected areas are drawn.
MissionTaskBulldoze	record	Task (bulldoze) that completes when the player has bulldozed every listed entity with the bulldozer. Each remaining entity gets an arrow marker; with more than one entity a counter is shown.
MissionTaskBuyVehicle	record	Task (buy_vehicle) that completes when the player owns minCount vehicles of a carrier that can carry cargoTypeRes, or, with allowBuyVehicles, has bought the listed number of each model in the vehicle store.
MissionTaskCargoNeeds	record	Task (cargo_needs) that replaces the cargo needs of a town for the given land-use types and completes at once.
MissionTaskCheckEntities	record	Task (check_entities) that checks that every entity in a mission params table exists (keys entity_*, entityList_*, entityListBulldozable_*, entityMap_*). It completes only if all exist; otherwise an error is logged and it stays open.
MissionTaskCheckLandmarkLevel	record	Task (check_landmark_level) that completes when the construction of a landmark has the given level.
MissionTaskClickEntity	record	Task (click_entity) that completes when the player has selected every candidate entity or clicked every marker (or one of them with clickJustOne). The candidates cannot be bulldozed meanwhile.
MissionTaskCloneVehicle	record	Task (clone_vehicle) that completes when the player clones a vehicle of the carrier with capacity for the cargo type in the vehicle store.
MissionTaskClouds	record	Task (clouds) that changes the cloud coverage linearly from its current value to coverage over seconds of GUI time.
MissionTaskCollectEntity	record	Task (collect_entity) in which the player selects custom entities to collect them. A collected entity is removed with a dust effect and an optional sound. The task completes when all are collected; with more than one entity it shows a counter.
MissionTaskConnectNodes	record	Task (connect_nodes) that blocks every street or track proposal that does not connect one of the configured node pairs (the bulldozer stays allowed). It completes when all pairs were connected.
MissionTaskCreateLine	record	Task (create_line) that completes when one line serves all station areas, or with target, a line between the target and any station area. transportModes limits the accepted lines; deleteLine inverts the check.
MissionTaskCreateLineForTowns	record	Task (create_line_for_towns) that completes when one line without line problems, with one of the transport modes, has stations in all towns. Each town gets an arrow marker.
MissionTaskCutscene	record	Task (cutscene) that plays a cutscene file when it starts (api.gui.mission.playCutscene) and completes when the cutscene ends or is skipped. Tool actions are disabled meanwhile; afterwards the game speed is set to gameSpeed.
MissionTaskDialogue	record	Task (dialogue) that plays a dialogue in the dialogue overlay when it starts and completes when the dialogue ends. If the GUI reloads while it plays, it is started again.
MissionTaskElectrify	record	Task (electrify) that finds the train path between each node pair and rebuilds its edges with the simple_catenary track template, then completes.
MissionTaskEmptyStocks	record	Task (empty_stocks) that completes when all target stocks are empty, or when the countdown runs out. Shows the amount removed and, for several targets, how many are empty.
MissionTaskFinish	record	Task (finish) that ends the mission. The mission window shows the end screen for it; the task completes when the player confirms (MissionEndWindow / completeMission).
MissionTaskGuide	record	Task (guide) that queues the instruction instructionKey and completes when it has played.
MissionTaskGuideCollectEntity	record	Decorator for MissionTaskCollectEntity. After delay seconds it shows the zone and marker of the first entity not collected yet and queues its instruction; the next hint follows once that entity is collected. It pauses while a voice-over or the guide window is visible.
MissionTaskGuideSubsidies	record	Decorator for MissionTaskSubsidies that queues the instruction wins<n> or fails<n> when the n-th subsidy completes or fails.
MissionTaskHighlight	record	Task (highlight) that shows markers and zones. It completes at once, so it is used with requiredTaskToComplete to stay open until another task completes.
MissionTaskIndustryActivity	record	Task (industry_activity) that rebuilds an industry construction with the disableStocks and disableStation construction params set, keeping its name, and completes at once.
MissionTaskIndustryBoosted	record	Task (industry_boosted) that completes when any industry of the given constructions has the given booster active (or, without boosterIndex, a boosted person capacity).
MissionTaskJoin	record	Task (join) that completes when all listed tasks are complete. Without params it never completes, which keeps its generic params (disabled menus, filters) active.
MissionTaskLandmarkRequirements	record	Task (landmark_requirements) that replaces a construction with <baseName>_<n>, where n comes from getRequirements, keeping its name and params.
MissionTaskNonBulldozable	record	Task (non_bulldozable) that never completes and keeps its entities from being bulldozed for the rest of the mission.
MissionTaskObserveEntity	record	Task (observe_entity) that completes when observe has returned true once for every entity. The entities and marked entities cannot be bulldozed meanwhile.
MissionTaskPage	record	Task (page) without own logic. It shows its task info and completes when the player picks an option with key "finish". Also used with medals only, to award a medal.
MissionTaskPlaySound	record	Task (play_sound) that plays a sound effect in the GUI when it starts and completes at once.
MissionTaskProtectedEntities	record	Task (protected_entities) that protects entities from player changes; lines are protected together with their station groups. It completes at once, so it is used with requiredTaskToComplete to stay open.
MissionTaskRelayUpdate	record	Task (relay_update) that calls onUpdateFn every update and completes when it returns true.
MissionTaskReplaceVehicles	record	Task (replace_vehicles) that replaces each vehicle with a single-part vehicle of one model and completes at once.
MissionTaskSellVehicles	record	Task (sell_vehicles) that sells vehicles and completes at once.
MissionTaskSendCommand	record	Task (send_command) that sends the command returned by getCommand and completes when it succeeded (or when no command is returned).
MissionTaskSendEvent	record	Task (send_event) that sends one script event (engine side) or fires a React event in the GUI (isGuiEvent), then completes.
MissionTaskSpawnEntity	record	Task (spawn_entity) that spawns one custom entity per position, names it with tooltip and completes at once.
MissionTaskSpawnSims	record	Task (spawn_sims) that spawns custom person entities on the pedestrian lanes of the given network entities, spread by Poisson-disk sampling, then completes.
MissionTaskStartVehicles	record	Task (start_vehicles) that starts (or stops) vehicles once conditionFn holds, then completes.
MissionTaskStopConfig	record	Task (stop_config) that completes when the stop of a line in the loadStop area is set to load the cargo type.
MissionTaskStoreAny	record	Task (store_any) that stores the first non-nil result of storeFn in its state and then completes. Other tasks read it through getTaskState(key).specific.data.
MissionTaskSubsidies	record	Task (subsidies) that spawns subventions through the Subvention script and completes when none of them is still proposed or being verified. Its progress counts completed subsidies against those not failed.
MissionTaskSubstituteConstructions	record	Task (substitute_constructions) that replaces, refreshes or rebuilds constructions with a new file or new params, optionally giving them to the player, then completes.
MissionTaskTimeOfDay	record	Task (time_of_day) that moves the time of day forward to a target time, at once or in steps per update, and completes when it is reached.
MissionTaskTownDevelopment	record	Task (town_development) that switches the development of towns on or off and completes at once.
MissionTaskTownRating	record	Task (town_rating) that checks every update whether a town has a good rating (rank 5 or 6) for one rating key and receives at least minCount of a cargo per year. It completes at once and is read by MissionTaskTownRatingObserver; a disconnected town always fails the check.
MissionTaskTownRatingObserver	record	Task (town_rating_observer) that sums +1 for each passing and -1 for each failing rating task every update. A positive sum adds twice its value to the progress, otherwise the progress drops by 1. It completes with success at 100 % and with failure at 0 %, starting at 50 %. A star icon drops one level every two game years.
MissionTaskTownSize	record	Task (town_size) that completes when a town's residential capacity exceeds minSize, showing it as a counter with a star icon (town_size_page shows the same progress without completing).
MissionTaskTrackBuilder	record	Task (track_builder) that builds a list of track segments (simple_catenary template) one after the other up to a target count, then completes.
MissionTaskTransferOwnership	record	Task (transfer_ownership) that gives lines and constructions to the player or moves them to a newly spawned AI player, then completes.
MissionTaskTransportCargo	record	Task (transport_cargo) that counts deliveries of a cargo type to the targets (optionally only from given sources) through the arrival tracker and completes at minCount. Shows a counter with the cargo icon.
MissionTaskTransportCargoFaster	record	Task (transport_cargo_faster) in which the player must deliver minCount cargo to a target before a simulated adversary, whose count grows linearly to minCount over the time limit. Completes when either side reaches it.
MissionTaskTransportCargoObserver	record	Task (transport_cargo_observer) that shows the counters of several transport_cargo tasks as sub-tasks and completes when all of them are complete.
MissionTaskTransportPassengers	record	Task (transport_passengers) that counts persons who start using a line between two towns (either direction) and completes at minCount.
MissionTaskTutorialInit	record	First task of the base-game tutorial. Picks a story branch from the industries on the map, adjusts the capital's cargo needs, spawns missing industries and removes the road of the industry the player must connect.
MissionTaskUtil	record	Declarative task description used by stories, plus helpers for task keys and areas.
MissionTaskVehicleModifier	record	Task (vehicle_modifier) that sends VehicleModifier / ChangeModifier events for the given vehicles or for all vehicles (of a carrier), then completes.
MissionTaskVehiclePosition	record	Task (vehicle_position) that completes when a vehicle is within distance of a position, drawing that circle as a zone.
MissionTaskVisitStationsOrdered	record	Task (visit_stations_ordered) that completes when a player vehicle on a line between the two areas has stopped at a terminal in pos1 and then at one in pos2.
MissionTaskWait	record	Task (wait) that completes after a time span in GUI time or in simulation time.
MissionTaskWaitEvent	record	Task (wait_event) that completes when an engine-side script event matches one of the candidates.
MissionTaskWaitFor	record	Task (wait_for) that completes when waitFn returns true. With countdown it also ends when the time runs out, showing the remaining time as sub-task progress.
MissionTaskWaitUiEvent	record	Task (wait_ui_event) that completes when a GUI event matches one of the candidates, optionally after an extra instruction has played, or after a timeout.
MissionTaskWaypoints	record	Task (waypoints) that completes when a line serving the station group passes all waypoints. It draws the next missing waypoint and the station as zones.
MissionTownUtil	record	Town helper used by mission tasks.
MissionVehicleUtil	record	Vehicle and line helpers used by mission tasks.
Mod	record	Refer to https://wiki.transportfever3.com/doku.php?id=modding:moddefinition for more details about mod and mod interface in general Forward declaration of the Mod record, which is defined in api/type/mod.d.tl.
ModColors	record	Colours of the mod browser.
Model	record	Information about a single model file: metadata and bounding information
ModelInstance	record	A model in the world, with complete information
ModelMetadata	record	Contains all metadata of a model. A specific metadata might be nil.
ModelMetadataUtil	record	loadModel modifiers from /base/model_metadata_util.lua. Each (fileName, data) function gets the model's file name and its data table and returns the (changed) data.
ModelRep	record	Type of api.res.modelRep, the model repository; adds forEachModelWithMetadata to the generic repository functions.
ModEntryPoint	record	Holds the extension point for mod UI in the game view.
Modhub	record	modhub types
ModhubApi	record	Main Modhub interface
ModId	type	Global alias of integer. It is the type of SaveGameInfo.modId; mod identifiers used by the mod repository are Mod.ModId records instead.
Modifier	record	Resource-modifier helper for missions.
Modifiers	record	Environmental modifiers affecting construction or vehicle performance
ModManagerReactUtil	record	Util table of mod_manager_react_util.tl with the Mod Hub recipes, dialogs and backend helpers.
ModRep	record	Contains all active and installed mods and their description
ModuleDesc	record	Used to configure new modules
ModulesUtilSerialized	record	Module helpers from /scripts/construction/modulesutil.lua.
ModUtil	record	Util table of mod_util.tl.
MoneyMode	record	MoneyMode represents the money mode.
MoreCapacityMetadata	record	Extra capacity a station module adds (the moreCapacity metadata key).
MoveMode	record	How a sim person moves: walking, driving, or using transport lines. Used in SimEntityMoving.lastMoveMode, SimEntityMoving.moveModes and PathFactoryOutput.moveMode.
MultipleUnit	record	Specification for multiple units
NameDesc	record	Name list description for procedural name generation
NameUtil	record	Renames entities of a mission savegame.
NativeLuaTable	record	Lua table data held natively by the engine, for example the state of a game script (state_native of a GAME_SCRIPT component). Read single entries with find/findPath or convert it with asTable.
NativeLuaValue	type	Value stored in a NativeLuaTable: a string, number, boolean, nil or a nested NativeLuaTable.
NewCargoDemandNotificationParams	record	Params of the newcargodemand notification ("New Cargo Demand", category Info).
NewCargoDemandNotificationSimParams	record	Sim params of newcargodemand.
NewGameReactUtil	record	Helpers for building the new game / new map settings pages.
NewOrLoadPage	enum	Tab of the new-game / map settings page and of the load-game settings.
nGetText	function	Returns a localized string, with plural handling
NinePatch	record	Nine-patch image description.
Node	record	A single node within a TRANSPORT_NETWORK component.
NodeId	record	References a single transport network node within a transport network entity
NodeViewerData	record	Layer Types Struct containing information for rendering transport network edges of a BaseNode
NoRoadConnection	record	Params of the persistent noroadconnection notification ("Station Not Connected", category Caution), created from api.engine.util.line.getNoRoadConnectionProblems().
NoRoadConnectionSimParams	record	Sim params of noroadconnection.
Notification	record	A notification as sent with the Notifications/add script event and stored in NotificationsState.
NotificationButtonParam	record	Params of the NotificationButton recipe (notifications/gui/notification_button.tl), the game-bar button that opens and closes the notification log.
NotificationColors	record	Colors of the notification categories, defined in ::/game_mechanics/notifications/gui/notification_colors.gres. Style sheets of notifications, statistics and the line and vehicle manager use them.
NotificationGuiData	record	What a notification type's useDataState returns; the pop-up, the log, entity windows and the HUD display it.
NotificationLegacyUtil	record	Initial state and save-game migration of NotificationsState.
NotificationLogToolParam	record	Params of the notification log tool window, pushed by the notification button.
NotificationReactUtil	record	GUI recipes for notification icons and progress bars, used by pop-ups, the log, entity windows, the HUD and the line and vehicle manager.
NotificationSFX	record	Sounds of notification pop-ups, defined in ::/game_mechanics/notifications/gui/sound/notification_sfx.gres.
NotificationSimType	record	Sim update script of a notification type, referenced by simUpdateScript in the type's .res file (e.g. "::/game_mechanics/notifications/types/overcrowding.sim.script@updateData").
NotificationsState	record	State of the game script ::/game_mechanics/notifications/notifications.gs. Read it with NotificationUtil.externalGetNotificationsState().
NotificationType	record	GUI script of a notification type; the script named by Notification.type returns it.
NotificationUtil	record	Helpers for notification type resources and the notifications game-script state.
npGetText	function	Returns a localized string associated with a context, with plural handling
OctreeSystem	record	Octree System. An octree that contains all entities with a bounding box. It enables fast query and location of entities in the map.
orderedPairs	record	Global iterator like pairs, but returning the keys of a Lua table in sorted order (implemented in base/init.lua).
OvercrowdingNotificationParams	record	Params of the persistent overcrowding notification ("Station Overcrowded", category Caution) for player-served station groups whose cargo overflows.
OverwriteGuiRes	record
Page	enum	Name of a menu page, passed to CommonMenuParams.setPage.
pairs_native	record	Global iterator like pairs for a native Map: walks the keys with Map.next and returns each value with Map.find.
ParadoxReactUtil	record	Recipes and helper texts for the Paradox account.
ParamUtil	record	Construction parameter helpers returned by ug_require "::/scripts/construction/param_util.tl".
ParcelData	record	Entities attached to a segment
ParcelSystem	record	Parcel System. Manages and returns information about parcels.
ParsedSavegameName	record	Savegame info extracted solely from its filename
ParticleColors	record	Particle effect colours; read with api.gui.genericRep.get(api.gui.genericRep.find("::/gui/main/particle_colors.gres")).data.
ParticleParamCurveFloat	record	Particle system parameter curve for float values
ParticleParamCurveVec2f	record	Particle system parameter curve for vec2f values
ParticleParamCurveVec3f	record	Particle system parameter curve for vec3f values
ParticleParamFloat	record	Particle system parameter for float values
ParticleParamVec2f	record	Particle system parameter for vec2f values
ParticleReactUtil	record	GUI particle effect helpers.
Path	record	A path comprised of EdgeId and directions
PathFactoryInput	record	Input of a pathfinding request for a simulated entity, stored in SimEntityNeedsPath.input; the result is written to SimEntityNeedsPath.output.
PathFactoryOutput	record	Output result from pathfinding
PathPos	record	The position on a Path
PathPosData	record	The position in the world
PdxAccountInfo	record	Result of api.gui.backend.getAccountInfo.
PdxCountry	record	Country entry from api.gui.backend.getCountries, used for account creation.
PdxErrorCodes	record	Error codes of Paradox account operations (PdxResult.errorCode).
PdxFuture	record	Handle to the result of an asynchronous Paradox account operation. Poll getResult (e.g. every step) until it returns a value.
PdxLegalDocument	record	Legal document fetched with api.gui.backend.getLegalDocument.
PdxLoginResult	record	Result of api.gui.backend.loginAccount and loginThirdPartyAccount.
PdxProfileResult	record	Result of api.gui.backend.getProfile.
PdxResult	interface	Result of an asynchronous Paradox account operation (via PdxFuture).
PdxThirdPartyAutoLoginPromptState	record	Answer to the prompt that offers automatic login to the linked Paradox account.
PdxThirdPartyLinkState	record	Link state between the Paradox account and the platform account (Steam, PlayStation Network, Xbox network), from api.gui.backend.getThirdPartyLinkState.
PerkEow	record	Plugin types of the perk window (landmarks, headquarters).
PersistentNotifications	record	Param of the Notifications/updatePersistent event. Sets the complete list of persistent notifications of one type.
pGetText	function	Returns a localized string associated with a context
PlacementParams	record	Rules for placing one industry type on the map: placementParams entries of an economy (.eco.lua).
Platform	record	Platform represents the platform type.
PlatformDeviceSpec	record	Platform device specifications
PlayerStatDesc	record	A player stat, used for start tracking
PlayerStatProgress	record	The value of a player stat
PlayerStatRep	record	Repository for all player stat types (static data) Access the current state of a player stats, use UserProfile:getPlayerStatProgress
PlaylistDesc	record	Music playlist description
PlaylistTrack	record	Music playlist track information
PolygonUtil	record	Polygon helpers returned by ug_require "/scripts/polygon_util.tl".
PopoverReactUtil	record	Popover window recipes.
PortId	record	Identifies a Port of a Node within a transport network
PostRunUtil	record	Cost scaling helpers returned by ug_require "/base/post_run_util.tl".
PowerUnit	record	PowerUnit represents the unit of measurement used for power.
PrecedencePreference	record	Preference for the right of way (precedence) of a street at one of its nodes; see BaseEdgeStreet.precedenceNode0 and precedenceNode1.
PrepareTrackBuildingUtil	record	Development helper for the track-builder task.
PreviewColoring	record	Minimap preview colouring of a climate (ClimateDesc.mapColoring). The API declares no fields; base-game climates set ambientColor and levels of { color, height }.
ProblemCache	record	Problem information the Line & Vehicle Manager refreshes a few lines per frame, to mark lines and vehicles with problems.
ProductionIconWithBubbleParams	record	Parameters of IndustryReactUtil.ProductionIconWithBubble.
ProductionRulesWidgetParams	record	Parameters of IndustryReactUtil.ProductionRulesWidget.
ProgressData	record	Mission and save game shown by the loading screen; also the payload of the SetProgressData GUI event.
ProgressPageMissionParam	record	Page parameters of the ProgressPage (loading screen).
Proposal	record	A more complete version of the SimpleProposal. Most data can be read from a ProposalData or in the result of api.cmd.makeWorldBuildProposalCmd.
ProposalData	record	Contains the processed result of a Proposal.
ProposalEventData	record	Event data provided in builder.proposalApply event
ProposalStats	record	Effects of a construction proposal on each town nearby, from TownUtil.getProposalStats. The town script turns them into reputation penalties before the proposal is built.
ProspectionMetadata	record	Accessor for the prospection metadata of construction resources.
RadialMenuExtension	record	Holds the extension point for the main radial menu.
RailRoadCrossingSystem	record	Railroad Crossing System. Contains information about raiload crossings.
RailroadCrossingType	record	Specification for railroad crossings
RandomUtil	record	Random helpers returned by ug_require "/scripts/random_util.tl".
RatingLevel	enum	Six-step level of a town rating. TownUtil.getFactorRatingLevel maps a value between 0 and 1 to a level in steps of 1/6.
React	record	The GUI library returned by ug_require "::/gui/main/react.lua".
ReactNodeRef	record	Access to a created node, from an untyped ReactRefWrap.
ReactNodeRefApi0	record	Access to a created node of a parameterless recipe with an API.
ReactNodeRefApiT	record	Access to a created node of a recipe with an API.
ReactNodeRefT	record	Access to a created node of a recipe with parameter type T.
ReactPlugin	record	A loaded plugin of an extension point with parameters.
ReactPlugin0	record	A loaded plugin of an extension point without parameters.
ReactPluginDesc	record	data of a "react-plugin <extension point id>" generic resource.
ReactRefT	record	A value kept between renders, created with React.useRef. Unlike a state, changing it does not render the recipe again.
ReactRefWrap	record	A ref to a GUI node, from React.useNodeRef() or React.useSelfRef().
ReactRefWrapApi0	record	Node ref for a parameterless recipe with an API.
ReactRefWrapApiT	record	Node ref from React.useNodeRef(SomeRecipeWithApi); its node has getApi().
ReactRefWrapT	record	Typed node ref from React.useNodeRef(SomeRecipe).
ReactReplacementApi	record	API given to a replacement config's doReplaceFn.
ReactReplacementConfig	record	A loaded replacement config.
ReactReplacementConfigDesc	record	data of a "react-replacement-config" generic resource, which replaces GUI recipes before the GUI starts.
ReactState	record	State created with React.useState. A change with set or transform renders the recipe again. old() returns the value of the current render.
ReactStateT	record	Typed state created with React.useState(initialValue); see ReactState.
ReactStyleParams	record	Parameters of React.style.
ReactToolDefinition	record	Callbacks of a tool on the tool stack, with tool parameters P. tool_react_util builds the usual window tools with prepareDefaultToolWithWindowDefinition.
Recipe	record	A recipe with one parameter table T.
Recipe0	record	A recipe without parameters, as returned by RegisterRecipe for a function without arguments.
Recipe2	record	A recipe with two parameters.
Recipe3	record	A recipe with three parameters.
Recipe4	record	A recipe with four parameters.
RecipeWithApi	record	A recipe with one parameter whose nodes offer an API (set with React.provideApi).
RecipeWithApi0	record	A recipe without parameters whose nodes offer an API (set with React.provideApi), reached through a node ref's getApi().
RecipeWithApi2	record	A recipe with two parameters whose nodes offer an API.
RecipeWithApi3	record	A recipe with three parameters whose nodes offer an API.
RefFill	record	Marker returned by React.ref; pass it as the first argument of a recipe call to fill a node ref with the created node.
RegisterCustomSelectorBasedActionRecipeParams	record	Callbacks of a custom action that selects an entity on the map, for ConstructionReactUtil.RegisterCustomSelectorBasedActionRecipe.
ReleaseNoteData	record	Content of the release-notes window, returned by data(edition) in /gui/menu/configs/release_notes.lua.
ReleaseNotesUtil	record	Util table of releasenotes_util.tl.
RemovePersistentNotifications	record	Param of the Notifications/removePersistent event. Expires the persistent notifications of type whose entities equal entities.
Res	record	List of all repositories
ResName	type	Resource name of a game resource file, such as "::/climates/dry/dry.clima" or "industry/coal_mine.con".
resolve	function	Resolves a file paths relative to the current file
ResTypeRep	interface	Generic interface for repositories Resources are generally static (initialized when the game starts and don't change) Make sure that resource exists before trying to access them Resource ids are only valid within the same repository
RidgeResult	record	A generated mountain ridge.
RidgesBuilderConfig	record	Settings for MapGenUtil.makeRidges.
RidgesConfig	record	Settings of MapGenUtil.makeRidges (see RidgesBuilderConfig).
RidgesResult	record	A generated ridge with points as {x, y} pairs.
RiverBuilderConfig	record	Settings for MapGenUtil.makeRivers.
RiverData	record	A sampled river position in the collision grid.
RiverId	type	Number identifying a generated river.
RiverMap	record	Collision grid of river samples, used to keep rivers apart.
RiverMapGenUtil	record	River post-processing, returned by ug_require "/climates/gen/rivermapgenutil.tl".
RiverResult	record	A generated river with values per point.
RiverResult2	record	A river in the format the terrain generator takes, with {x, y} pairs instead of vectors.
RiverStartConfig	record	Settings for MapGenUtil.findGoodRiverStarts.
RiverStartResult	record	A river start point.
RiverSystem	record	River System. Contains information about water in the map.
RoadType	record	Road vs Track type.
RocketParams	record	Flight parameters of a rocket.
RocketState	record	Saved state of the rocket game script of campaign mission 8.
RocketUtil	record	Spawning and flight of rockets.
RombergUtil	record	Numerical integration returned by ug_require "/scripts/util/romberg.tl".
RuleDurationInfoParams	record	Result of IndustryReactUtil.GetRuleDurationTextAndBoosted.
RuleInputOutputWidgetParams	record	Parameters of IndustryReactUtil.IndustryWindowRuleInputOutputWidget.
RuleProgressBarParams	record	Parameters of IndustryReactUtil.RuleProgressBar.
RuleWidgetParams	record	Parameters of IndustryReactUtil.ProductionRuleWidget.
Runway	record	Contains runway data
RunwaySystem	record	Runway System. Contains information about runway edges.
RunwayType	record	Runway type enumeration
SampleCurveParams	record	Parameters of the SampleCurve sound update function, which reads values from the transformator info and maps them through curves.
SamplingUtil	record	Point sampling helper.
SaveGameData	record	Savegame data with info and error message
SaveGameId	record	Savegame identifier with path and namespace
SaveGameInfo	record	Information about a savegame
SavegameReactUtil	record	Savegame helpers and recipes for the main menu and pause menu pages.
SavegameScriptMetadata	record	Marker for type-safe savegame metadata table Opaque type of the metadata a game script stores in the savegame (returned from the storeSavegameMetadata event).
SaveGameStorageInfo	record	Information about savegame storage capacity
SaveGameType	record	Kind of savegame, as derived from its file name by app.parseSavegameName.
SaveGroup	record	Saves of one game grouped together, as returned by savegame_react_util.groupSaves.
ScriptingSendEventCommandData	record	Command data for cmd.makeScriptingSendEventCmd.
ScriptParam	record	Used to configure the parameter-based UI
ScriptParamDisplayMode	record	Controls how the parameter is displayed in the UI
ScriptParamLocation	record	Controls bottom bar mode of the parameter
ScriptParamType	record	UI Type for displaying the parameter. Used to configure the parameters used for constructions.
ScriptParamUtil	record	Builds UI widgets for script parameters and looks up the base game's parameters.
ScriptRef	record	References a function in a lua script file with ".script" extension.
SelectionGuiConfig	record	Selection highlight colour sets; read with api.gui.genericRep.get(api.gui.genericRep.find("::/gui/main/selection_colors.gres")).data.
SelectorBasedActionHoverResult	record	Result of RegisterCustomSelectorBasedActionRecipeParams.onHover.
SelectorPick	record
SelectorReactUtil	record	Default entity selector, action descriptors and the inspector tool of the game view.
SelectorTooltipConfig	record
Set	record	Native (C++) set exposed to Lua.
SetActionFnAndProxy	record	An action setter function together with its comparison proxy, returned by ViewManager.MakeEntityWindowContentFn.makeSetActionFnWithCombinedKey.
SetModeCommand	record	Param of the GameTime/SetMode script event, which changes the time-of-day mode.
SetWeatherModeCommand	record	Param of the CloudCoverage/SetMode script event, which changes the weather mode.
Shape	record	Contains a procedurally generated shape.
ShipInfo	record	Movement information for ships
ShipMoveSystem	record	Ship Move System. Contains information about the movement of ships.
Signal	record	Contains information about a street/track signal
SignalId	record	Identifies a street/track signal
SignalPick	record
SignalSystem	record	Signal System. Contains information about Signals (waypoints, path and one way signals)
SignalType	record	Enum containing the type of the signal
SimCargoSystem	record	Cargo System. System managing cargo.
SimEntityAtStockSystem	record	Sim Entity At Stock System. System managing cargo produced by industries or transported to a warehouse.
SimEntityAtTerminalSystem	record	Sim Entity At Terminal System. System managing entities waiting at terminals.
SimEntityAtVehicleSystem	record	Sim Entity At Vehicle System. System managing entities travelling in a vehicle.
SimPersonAtBuildingSystem	record	Person At Building System. System managing persons at a building.
SimPersonAtTerminalSystem	record	Person At Terminal System. System managing persons waiting at terminal.
SimPersonAtVehicleSystem	record	Sim Person At Vehicle System. System managing persons travelling on a vehicle.
SimPersonEow	record	Plugin types of the resident (sim person) window.
SimPersonSetStateCommandDataDEBUG	record	Debug command data for api.cmd.debug.makeSimPersonSetStateCmd, which forces a new state on a simulated person.
SimPersonSystem	record	Sim Person System. System managing persons.
SimpleProposal	record	A structure holding information to build/remove and update constructions and streets.<p/> It offers much more functionality than a simple ".con" file. See also build_street.lua for an example. The most important operations that can be performed with a Simple Proposal is adding/removing and modifying the following objects: constructions (stations, depots, ), (base) edges and (base) nodes, and edgeobjects (signals, street terminals, waypoints). <p/> In general, there are a few rules concerning this proposal. First, old entities are reference with the usual non-negative id, whilst new entities are assigned a decreasing negative number starting at -1. <p/> The general rule is that the modification/upgrade of a construction entails removing it and adding it anew. The same rule applies to streets and edgeobjects. <p/> The proposal will take care of updating lines, stop, people and cargo.
SimpleStreetProposal	record	A structure holding information to add street and track entities together with a SimpleProposal. <p/> A street proposal can add, remove and modify street, tracks, nodes and edge objects. To modify a street, you need to remove all appropriate entities and add them with the correct information.
Slot	record	Modular construction slot
SlotConfig	record	Slot configuration can specify additional properties for slots of a given type
SoundAttributes	record	SoundClip attributes
SoundClip	record	SoundClip for SoundSet, BuilderAudioSet, ...
SoundClipList	record	SoundClipList for SoundSet
SoundSet	record	Configure sound effects for entities
SoundTransfOutput	record	Sound Transformation output, which contains user transformations of events and tracks from transformation lua scripts
StampData	record	Data of a stamp resource, a heightmap stamp for the terrain heightmap tool.
StartedLineUsage	record	Payload of the OnStartedLineUsage event sent by SimPersonSystem when persons start a trip on a line.
StartGameParams	record	Parameters for starting a new game
StaticConstructionTemplate	record	Static construction template configuration
Station	record	Data for a Station
StationBusyNotificationSimParams	record	Sim params of overcrowding.
StationGroupEow	record	Extension point of the station window.
StationGroupSystem	record	Station Group System. Contains cached information about station groups.
StationMetadata	record	Accessors returned by ug_require "/stations/station_metadata.tl".
StationPick	record
StationSamples	record	Loaded and lost items per year of a town's stations. Only commented-out code in town_util.tl uses it.
StationSystem	record	Station System. Contains cached information about stations.
StationTerminal	record	Identifies a Terminal inside a StationGroup
Statistics	record	The statistics module.
StatisticsReactUtil	record	Helpers for the statistics tabs.
StatisticsRecipeApi	record	API of the lines tab, used by the statistics window to draw the listed lines in the 3D view.
StatisticsRecipeParams	record	Parameters the statistics window passes to the recipe of each tab (for example gui/statistics/statistic_lines.tl).
StockId	type	Integer id of one stock within a stock holding entity (for example an industry); used together with that entity, e.g. in api.engine.system.simEntityAtStockSystem.getStockCount.
StockListDiscardCargoCommandData	record	Command data for cmd.makeStockListDiscardCargoCmd.
StockListSetModifiersCommandData	record	Command data for cmd.makeStockListSetModifiersCmd.
StockListSetStocksCargoTypeCommandData	record	Command data for cmd.makeStockListSetStocksCargoTypeCmd.
StockListSystem	record	Stock List System. Manages stocks.
StockListType	record	Defines the stock list type
StockSetCargoAmountCommandDataDEBUG	record	Debug command data for api.cmd.debug.makeStockSetCargoAmountCmd, which sets the cargo amount of a stock.
StopState	record	Information about the problem state of a stop within a line.
StreetConnectorSystem	record	Street Connector System. Manages street connections.
StreetGenerationMode	record	Map generation mode for street generation
StreetStyle	record	Specifies the look and feel of streets and tracks
StreetSystem	record	Street System. Manages base edges.
StreetTemplate	record	Specification for street templates which define simulation relevant quantities like lanes, costs and transport modes
StreetUtilSerialized	record	Street/track edge helpers returned by ug_require "/scripts/construction/street_util_serialized.tl".
StringUtil	record	String helpers returned by ug_require "/scripts/string_util.tl".
StyleSheet	record	Stylesheet used by GUI components.
StyleUtil	record	Style sheet helper.
SubconstructionInstanceMetadata	record	Opaque type of the metadata stored with a subconstruction instance.
SubdivideConfig	record	Settings for RiverMapGenUtil.subdivide.
SubShape	record	Contains a procedurally generated sub-shape.
Subvention	record	Subsidy instance with its data typed as T.
SubventionBonusMalus	record	One reward or penalty of a subsidy, applied with SubventionUtil.applyBonusMalus on accept, completion or failure.
SubventionCardData	record	Content of a subsidy card and window, returned by the type's getCardData.
SubventionDesc	record	Data of a generic res of type subvention, one per subsidy type.
SubventionFailedNotificationParams	record	Params of the subvention notification ("Subsidy Failed", category Opportunity), sent by subventions.script.tl.
SubventionFailedNotificationSimParams	record	Sim params of subvention.
SubventionIcons	record	Icon paths of a subsidy type for each status, read by SubventionUtil.getIcon.
SubventionLegacyUtil	record	Upgrade of SubventionState from older savegames, run by the subsidy game script on handleLegacy.
SubventionMissedNotificationParams	record	Params of the subvention_missed notification ("Subsidy Missed", category Info), sent by subventions.script.tl when an offered subsidy despawns.
SubventionMissedNotificationSimParams	record	Sim params of subvention_missed.
SubventionNotificationParams	record	Params of the persistent subvention_notification notification ("Subsidy Status", category Opportunity) for proposed, active and completed subsidies.
SubventionNotificationSimParams	record	Sim params of subvention_notification.
SubventionScript	record	Functions a subsidy type script implements. The subsidy game script calls them through the scriptFile of the type's SubventionDesc.
SubventionsGui	record	Builder of the subsidy window.
SubventionState	record	Saved state of the subsidy game script ::/game_mechanics/subventions/subventions.gs.
SubventionUtil	record	Helpers for subsidy type scripts and the subsidy game script.
System	record	A system is a simulation object that controls entities with specific components or caches additional computed data for entities after listening for component changes Forward declaration of the System record (defined in api/engine/system.d.tl), the type of api.engine.system.
TableUtil	record	Table helpers returned by ug_require "/scripts/table_util.tl".
TargetData	record	Information about target destinations
TargetDataEntry	record	Target data for land use types
TargetsByLandUse	record	Target destinations organized by land use type
TaskDecorator	record	Combines a task script with a decorator script into one task script.
Terminal	record	Data for a Station terminal.
TerrainAlignment	record	Terrain alignment configuration
TerrainAlignmentType	record	Terrain alignment type enumeration
TerrainGeneratorDesc	record	Contains all data relevant for the heightmap generation
TerrainMaterialType	record	Specification for terrain material types
TexUtil	record	Texture description helpers returned by ug_require "/scripts/tex_util.tl".
ThinModelInstance	record	A model in the world, with very light information
TileListReactUtil	record	Tile grid and tile recipes.
ToolReactUtil	record	Tool registration helpers.
TownAuthorityEventFactors	record	Reputation state of a town (TownState.eventFactors). It holds the score, the penalty per reason, item delivery statistics and the running marketing campaign.
TownAuthoritySeveredConnection	record
TownAutoDetectConnectionsCommandData	record	Command to automatically detect connection existing between towns.
TownBuildingEow	record	Extension point of the town building window.
TownBuildingParams	record	Town building parameters
TownBuildingSetBlockedDevelopment	record	town building
TownBuildingSystem	record	Town Building System. Manages town buildings and parcels.
TownCapacities	record	Person capacity of a town per district type.
TownCapacityUsages	record	Used and total capacity of a town per district type.
TownCargoUtil	record	Constants and state access of the town growth script (game_mechanics/towns/town_cargo_util.tl).
TownConnectWithIndustriesCommandData	record	Command data for cmd.makeTownConnectWithIndustriesCmd.
TownConstructionBoni	record	Bonuses of a town from nearby constructions with town_growth metadata, summed and refreshed every 20 updates.
TownCreateCommandData	record	Command data for cmd.makeTownCreateCmd.
TownCustomDistributionWeightsCommandData	record	Command data for cmd.makeTownCustomDistributionWeightsCmd.
TownDestroyCommandData	record	Command data for cmd.makeTownDestroyCmd.
TownDevelopAtCommandData	record	Command data for cmd.makeTownDevelopAtCmd.
TownEow	record	Plugin types and charts of the town window.
TownGrowthConfig	record	Experience settings of the town growth script, loaded from town_growth_config.res.
TownGrowthFunction	record	Growth polynomials returned by ug_require "/scripts/util/town_growth_function.tl".
TownGrowthMetadata	record	Accessors for the town_growth construction metadata, which gives the closest town a bonus while the construction stands.
TownHudReactUtil	record	Town HUD icon recipe.
TownIndustryGenerationMode	record	Map generation mode for adding towns and industries
TownInfo	record	Extended town information for map generation
TownLegacyUtil	record	Migration of old TownsState layouts (game_mechanics/towns/town_legacy_util.tl).
TownLevelNotificationInput	record	Params of the town level-up notification (town_notification.script).
TownLevelNotificationSimInput	record	Data the notification's sim update script fills in.
TownMarketingMetadata	record	Accessor for the town_marketing construction metadata of marketing campaigns. The marketing campaign tool reads it and sends it with the startMarketingCampaign event.
TownNotificationSimParams	record	Sim params of the town notifications.
TownProblem	record	Town connection problem.
TownProblemNotificationParams	record	Params of the persistent town_warning notification ("Town Not Connected", category Problem), created from api.engine.util.town.getTownProblems().
TownProposalActions	record	Actions of a proposal that a town's rating may forbid, per affected town (TownUtil.getProposalActions).
TownProposalImpact	record	Reputation penalties of one town caused by a construction proposal, from TownUtil.calculateProposalImpact. Positive values lower the reputation.
TownRatingKey	enum	Keys of the six town ratings (TownUtil.Rating.key).
TownRatingNotificationParams	record	Params of the persistent town_rating_warning ("Town Rating Very Poor", Problem) and town_rating_warning_nonperistent ("Town Rating Decreasing", Caution) notifications.
TownRatingsSensitivityConfig	type	Option index per sensitivity key, as stored in town_ratings_sensitivity.res (2 for urban care, 4 for the others). difficulty_util.getScale turns the index into the sensitivity value.
TownRatingsSensitivityConfigName	enum	Keys of the default rating sensitivities in town_ratings_sensitivity.res, one per TownRatingKey.
TownReactUtil	record	React recipes and label helpers for the town window (game_mechanics/towns/town_react_util.tl).
TownResult	record	Results of town generation operations
TownSetDevelopmentActiveCommandData	record	Command data for cmd.makeTownSetDevelopmentActiveCmd.
TownSetInitialLandUseCapacitiesCommandData	record	Command data for cmd.makeTownSetInitialLandUseCapacitiesCmd.
TownSFX	record	Sound files for town events. Each field is a list; api.gui.sound.playRandomSoundEffect picks one entry.
TownsGrowthState	record	State of the town growth game script town_cargo.gs (town_growth.script). Read it with TownCargoUtil.getTownCargoState.
TownSizeTaskUtil	record	Shared code of the town-size tasks.
TownsState	record	State of the town game script town.gs (towns.script).
TownState	record	Reputation and rating state of one town in the town.gs game script. Get it with TownUtil.getTownState or TownUtil.externalGetTownState.
TownUpdateCargoNeedsCommandData	record	Command data for cmd.makeTownUpdateCargoNeedsCmd.
TownUpdateSizeCommandData	record	Command data for cmd.makeTownUpdateSizeCmd.
TownUtil	record	Town ratings, reputation and helper functions (game_mechanics/towns/town_util.tl).
TownUtilParallel	record	Town functions for GUI widgets. The GUI calls them by script path through engine_react_util.useStepStateParallel or useStepStateParallelSimple, so they return plain tables without userdata.
TpNetData	record	Contains additional data about the transport network
TpNetLinkProposal	record	Contains the processed result with all edge links.
TpNetLinkSystem	record	Transport Network Link System. Manages transport networks links (small links between roads and constructions).
TrackDescriptionMetadata	record	Metadata accessor that stores a street or track type's speed and lane count in the metadata of its construction menu entry.
TrackModifierMetadata	record	Metadata accessor that stores noise, pollution and speed modifiers in the metadata of a construction menu entry.
TrackType	type	Opaque type without declared members; it is exposed as api.type.TrackType.
TrafficLightConfig	record	Config values for traffic lights
TrafficLightData	record	Additional traffic light data for a base node
TrafficLightPreference	record	TrafficLightPreference: controls whether a node/edge has a traffic light.
TrafficLightType	record	Specification for traffic lights
TramTrackType	record	Defines the type of a tram track.
TransferOwnershipUtil	record	Ownership helpers used by mission tasks.
Transformator	record	Transformator types
TransformatorParams	record	Everything a transformator update function receives about the model instance it animates: current and previous dynamic info, static vehicle info, model metadata and the params table from the model's transformatorConfig.
TransformatorUtil	record	Shared transformator helpers returned by ug_require "::/scripts/transformator_util.tl".
TransportationStats	record	A structure that holds information about the transportation data statistics.
TransportMode	record	Defines the transport mode (this is used to blacklist/whitelist vehicles onto transport network edges). These values are mosly used in a bit field to influence the pathfinding for vehicles and people.
TransportNetworkSystem	record	Transport Network System. Manages transport networks (and transport network edges and nodes).
TransportVehicleConfig	record	Complete configuration for a TransportVehicle (train consist, bus, etc.)
TransportVehicleInfo	record	Information about all cargo of a transport vehicle
TransportVehiclePart	record	A subsection of a Transport Vehicle.
TransportVehicleState	record	Current state of TransportVehicle
TransportVehicleSystem	record	Transport Vehicle System. Manages the movement and behaviour of transport vehicles. This covers all vehicles transporting cargo and passengers.
TreeNodeId	record	Handle of a GUI node created by a recipe call. Recipes return one, a list of them, or nil.
TutorialStoryUtil	record	Helpers of the base-game tutorial story.
Type	record	Types namespace (used in api.type....)
UfoUtil	record	UFO that flies in from the map edge, lifts a cow from a livestock farm field and flies off again.
ug_require	function	Used instead of the regular lua require to include game related script
UgcAccessLimitedReason	record	Represent the reason why the user doesn't have access to UGC content
UILoansWindowParam	record
UIMarketingWindowParam	record
UpdateFn	type	Signature of a transformator update function: receives the capture parameters, the TransformatorParams and the output object, on which it sets animation states and user transforms.
UpdateParticleSystemFn	type	Signature of a transformator particle update function (see TransformatorUtil.updateParticleSystemFn).
UserProfile	record	UserProfile
Util	record	Miscellaneous script helpers returned by ug_require "/scripts/util.tl".
UtilCargo	record	Cargo and passenger quality data (delivery time, happiness) for lines, vehicles, stations and stocks, available as api.engine.util.cargo.
UtilChart	record	Helpers for chart labels and results, available as api.engine.util.chart.
UtilConstruction	record	Construction helpers (owning construction entity, slots, construction results, cost multipliers), available as api.engine.util.construction.
UtilEmission	record	Emission values and noise / pollution emitters near settlements, available as api.engine.util.emission.
UtilFinance	record	Account, balance and finance chart helpers, available as api.engine.util.finance.
UtilHeadquarters	record	Company transport statistics and company value, available as api.engine.util.headquarters.
UtilIndustry	record	Industry productivity, closing industries and economy cargo dependencies, available as api.engine.util.industry.
UtilLine	record	Line helpers (capacity, frequency, line problems and issues, compatibility), available as api.engine.util.line.
UtilLogbook	record	Read and write named logbook values and charts of entities with a logbook component, available as api.engine.util.logbook.
UtilMaintenance	record	Maintenance cost calculation for station groups and subconstructions, available as api.engine.util.maintenance.
UtilOctree	record	Spatial queries (entities or transport network nodes within a circle), available as api.engine.util.octree.
UtilParallelStrip	record	Information about parallel strip entities (bridges and tunnels), available as api.engine.util.parallelStrip.
UtilPathfinding	record	Path searches on the transport network and Dubins paths, available as api.engine.util.pathfinding.
UtilProposal	record	Builds Proposals (industry spawn and extension, removal, replacement, bridges and tunnels, traffic lights, refresh), available as api.engine.util.proposal.
UtilStation	record	Station and station group usage and capacity helpers, available as api.engine.util.station.
UtilStock	record	Stock and production statistics of stock lists (industries, warehouses), available as api.engine.util.stock.
UtilTown	record	Town statistics (capacities, reachability, emissions, happiness, deliveries) and town lookups, available as api.engine.util.town.
UtilTransport	record	Transport-edge helpers (positions along edge geometry, ports, carriers), available as api.engine.util.transport.
UtilVehicle	record	Vehicle queries (position, speed, costs, capacities, maintenance penalties, problems), available as api.engine.util.vehicle.
Vec2f	record	A 2d vector of floats Supports array subscript with vec[i] access. Supports addition +, subtraction -, multiplication * and division /.
Vec2i	record	A 2d vector of integers Supports array subscript with vec[i] access. Supports addition +, subtraction -, multiplication * and division /.
Vec2iSerialized	record	Namespace of the integer 2D vector type Vec2i.
Vec2Serialized	record	The 2D vector library returned by ug_require "/scripts/vec2.tl", and the namespace of its Vec2 type.
Vec3f	record	A 3d vector of floats Supports array subscript with vec[i] access. Supports addition +, subtraction -, multiplication * and division /.
Vec3iSerialized	record	Namespace of the integer 3D vector type Vec3i.
Vec3Serialized	record	The 3D vector library returned by ug_require "/scripts/vec3.tl", and the namespace of its Vec3 type.
Vec4f	record	A 4d vector of floats Supports array subscript with vec[i] access. Supports addition +, subtraction -, multiplication * and division /.
Vec4iSerialized	record	Namespace of the integer 4D vector type Vec4i.
Vec4Serialized	record	The 4D vector library returned by ug_require "/scripts/vec4.tl", and the namespace of its Vec4 type.
Vec5f	record	A 5d vector of floats Supports array subscript with vec[i] access. Supports addition +, subtraction -, multiplication * and division /.
VecCol	type	Four numbers of one matrix row in a MatCols table.
Vector	record	Native (C++) vector exposed to Lua, used for the *_native fields of game objects. Index it with at (1-based) or iterate it with ipairs_native; asTable converts it to a Lua array.
VehicleBuyCommandData	record	Command data for cmd.makeVehicleBuyCmd.
VehicleCargoInfo	record	Information about cargo of a single compartment of a transport vehicle
VehicleConditionNotificationParams	record	Params of the persistent vehiclecondition notification ("Vehicle Condition", category Caution) for vehicles in bad condition (see NotificationsState.wastedVehicles).
VehicleConditionNotificationSimParams	record	Sim params of vehiclecondition.
VehicleData	record	Information about an entire vehicle (consist of carriages)
VehicleDepotSystem	record	Vehicle Depot System. Manages depots and vehicles in depots.
VehicleEngineType	record	Engine type of a vehicle (ModelMetadata.VehicleEngine.type); the vehicle store filters and labels vehicles by it.
VehicleEow	record	Plugin types of the vehicle window.
VehicleExtent	record	Information about travel-direction extent of an entire vehicle (consist of carriages)
VehicleIconType	record	Icon type used to represent a vehicle.
VehicleListReactUtil	record	Vehicle list table of the line and vehicle manager.
VehicleManagerApi	record	API of the vehicle manager, reached through CommonActionParams.vehicleManagerRef.
VehicleManagerParams	record	Parameters of the vehicle manager (vehicle list) of the Line & Vehicle Manager.
VehicleManagerState	record	Contents of the vehicle list; kept between openings of the manager.
VehicleModifierChanger	record	Payload of the ChangeModifier event of the VehicleModifier game script.
VehicleModifierState	record	State of the VehicleModifier game script.
VehiclePart	record	Configuration for a single vehicle part/unit
VehiclePartInfo	record	Details about a vehicle part
VehicleProblem	record	Information about the problem of a vehicle.
VehicleProblemNotificationParams	record	Params of the persistent vehicle_warning notification ("Vehicle Problem", category Problem), created from api.engine.util.vehicle.getVehicleProblems().
VehicleProblemNotificatioSimParams	record	Sim params of vehicle_warning (the record name is misspelled in the game files).
VehicleProblems	record
VehicleReactUtil	record	GUI recipes for vehicles and the helper that applies vehicle store results.
VehicleReplaceCommandData	record	Command data for cmd.makeVehicleReplaceCmd.
VehicleReverseCommandData	record	Command data for cmd.makeVehicleReverseCmd.
VehicleSellCommandData	record	Command data for cmd.makeVehicleSellCmd.
VehicleSendToDepotCommandData	record	Command data for cmd.makeVehicleSendToDepotCmd.
VehicleSetLineCommandData	record	Command data for cmd.makeVehicleSetLineCmd.
VehicleSetManualDepartureCommandData	record	Command data for cmd.makeVehicleSetManualDepartureCmd.
VehicleSetModifiersCommandData	record	Command data for cmd.makeVehicleSetModifiersCmd.
VehicleSetStoppedByUserCommandData	record	Command data for cmd.makeVehicleSetStoppedByUserCmd.
VehicleState	record	Current state of a vehicle's movement
VehicleStore	record	Shared types of the vehicle store window.
VehicleStoreOpenInfo	record	Depot and line the vehicle store window was opened for from the Line & Vehicle Manager.
VehicleStoreTableRecipeParams	record	Parameters of the table layout of the vehicle store.
VehicleStoreUtil	record	Helpers of the vehicle store.
VehicleStoreWindow	record	Vehicle store window and its entry point.
VehicleTryToDepartCommandData	record	Command data for cmd.makeVehicleTryToDepartCmd.
VehicleUtil	record	Small helpers for vehicles and depots.
Vendor	record	Vendor represents the vendor (store) type.
View	record	Camera view information
ViewManager	record	Manager of the entity windows; opens a window when an entity is selected.
ViewManagerUtil	record	Helpers that decide whether and for which entity an entity window is opened.
WarehouseEow	record	Plugin types of the warehouse window.
Waypoint	record	References the position of a waypoint, which is either an EdgePos or a Vec3f
WeatherConfig	record	Initial weather mode of a new game, in the generic resource ::/game_mechanics/game_time/weather_config.res. The base mod sets it from the game settings.
WeatherStateMode	enum	How the game script game_time.gs changes the cloud coverage.
WeightUnit	record	WeightUnit represents the unit of measurement used for weight.
WorkplacesBoosterMinimumIconParams	record	Parameters of the workers count icon in the workplaces booster row.
WorkplacesBoosterParams	record	Parameters of IndustryReactUtil.WorkplacesBoosterRow.
WorkplacesBoosterProgressBarParams	record	Parameters of the workers progress bar in the workplaces booster row.
WorkplacesBoostFactorIconParams	record	Parameters of the boost factor icon in the workplaces booster row.
WorldBuildProposalCommandData	record	Command data for cmd.makeWorldBuildProposalCmd.
WorldChangeWindCommandData	record	Command data for cmd.makeWorldChangeWindCmd.
WorldReplaceTerrainCommandData	record	Command data for cmd.makeWorldReplaceTerrainCmd.
WorldSetBulldozableCommandData	record	Command data for cmd.makeWorldSetBulldozableCmd.
WrapperExtensionPoint	record	An extension point with parameters whose plugins must return a node of wrappedRecipe.
WrapperExtensionPoint0	record	An extension point whose plugins must return a node of wrappedRecipe (or nothing).