Builtin.Type

Part of builtin

Source: base/tealdef/scripts/builtin.d.tl

Builtin.Type

record base/tealdef/scripts/builtin.d.tl:4

record Type

Notes

Enumerations and helper classes of the built-in widgets, reached as builtin.type (lower case).

Builtin.Type.Orientation

record base/tealdef/scripts/builtin.d.tl:5

record Orientation

Notes

Layout direction of box layouts and lists.

Used in the base game: 4 times in 3 files

base/content/gui/gui/entity_window/station_group/station_group.tl:551

legendOrientation : Builtin.Type.Orientation

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:43

legendOrientation : Builtin.Type.Orientation

base/content/gui/gui/entity_window/line/line_eow.script.tl:262

legendOrientation : Builtin.Type.Orientation

Fields

Name	Type	Description
Horizontal	Orientation	Children side by side.
Vertical	Orientation	Children one below the other.

Builtin.Type.TabOrientation

record base/tealdef/scripts/builtin.d.tl:10

record TabOrientation

Notes

Side of a tab widget on which the tabs are placed.

Fields

Name	Type	Description
North	TabOrientation	Tabs above the content.
South	TabOrientation	Tabs below the content.
East	TabOrientation	Tabs right of the content.
West	TabOrientation	Tabs left of the content.

Builtin.Type.ImageViewScaling

record base/tealdef/scripts/builtin.d.tl:17

record ImageViewScaling

Notes

How an image is scaled to the size of its view.

Fields

Name	Type	Description
AutoFit	ImageViewScaling
AutoZoom	ImageViewScaling
Stretch	ImageViewScaling	Stretches the image to the view size.

Builtin.Type.ScrollBarPolicy

record base/tealdef/scripts/builtin.d.tl:23

record ScrollBarPolicy

Notes

When a scroll area or list shows its scroll bar.

Used in the base game: 1 time in 1 file

base/content/gui/gui/main/collapsible_checkbox_list.tl:26

verticalScrollPolicy : Builtin.Type.ScrollBarPolicy

Fields

Name	Type	Description
AlwaysOff	ScrollBarPolicy	Never shows the scroll bar.
AlwaysOn	ScrollBarPolicy	Always shows the scroll bar.
AsNeededButAlwaysReserveSpace	ScrollBarPolicy	Shows the scroll bar when the content does not fit, and keeps its space free otherwise.
AsNeeded	ScrollBarPolicy	Shows the scroll bar only when the content does not fit.
Simple	ScrollBarPolicy

Builtin.Type.ListBehavior

record base/tealdef/scripts/builtin.d.tl:31

record ListBehavior

Notes

Selection behaviour of a list.

Fields

Name	Type	Description
Default	ListBehavior	Normal list selection.
AutoDeselectDisabledItems	ListBehavior	Deselects items that become disabled.
Navigational	ListBehavior

Builtin.Type.ToolTipPosition

record base/tealdef/scripts/builtin.d.tl:37

record ToolTipPosition

Notes

Where a tooltip appears relative to its widget.

Fields

Name	Type	Description
Cursor	ToolTipPosition	At the mouse cursor.
Left	ToolTipPosition	Left of the widget.
Right	ToolTipPosition	Right of the widget.
Below	ToolTipPosition	Below the widget.
Above	ToolTipPosition	Above the widget.
Center	ToolTipPosition	Centred on the widget.

Builtin.Type.EdgeRenderable

record base/tealdef/scripts/builtin.d.tl:46

record EdgeRenderable

Notes

Types for Builtin.EdgeRenderable.

Builtin.Type.EdgeRenderable.Edge

record userdata base/tealdef/scripts/builtin.d.tl:47

record Edge

Notes

A coloured line drawn along an edge geometry in the 3D view.

Fields

Name	Type	Description
geometry	EdgeGeometry	The curve to draw.
colors	{Vec4f}	Colours (RGBA) of the line.
width	number	Line width.
offsetZ	number	Height offset above the geometry.
stepSize	number

Functions

new(EdgeGeometry) : Edge base/tealdef/scripts/builtin.d.tl:50

Notes

Creates an edge for the given geometry.

Returns Edge

Builtin.Type.MissionArrowRenderable

record base/tealdef/scripts/builtin.d.tl:59

record MissionArrowRenderable

Notes

Types for Builtin.MissionArrowRenderable.

Builtin.Type.MissionArrowRenderable.Arrow

record userdata base/tealdef/scripts/builtin.d.tl:60

record Arrow

Notes

An arrow drawn in the 3D view to point at an entity or position (mission markers).

Used in the base game: 1 time in 1 file

base/content/mission/mission/mission_framework/mission_framework_react.tl:493

local arrows : {Builtin.Type.MissionArrowRenderable.Arrow} = {}

Fields

Name	Type	Description
entity	Engine.Entity	Entity the arrow points at.
position	Vec3f	Position the arrow points at.
scaling	number	Size factor.
color	Vec4f	Colour (RGBA).

Functions

new() : Arrow base/tealdef/scripts/builtin.d.tl:63

Notes

Creates a new, empty Arrow.

Returns Arrow

Builtin.Type.ConstructionAction

record base/tealdef/scripts/builtin.d.tl:71

record ConstructionAction

Notes

Descriptor classes for Builtin.ConstructionAction; each one configures one kind of building tool.

Builtin.Type.ConstructionAction.ConstructionBuilder

record userdata base/tealdef/scripts/builtin.d.tl:73

record ConstructionBuilder

Construction builder action descriptor.

Fields

Name	Type	Description
constructions	{ResName}	Resource names of the constructions
constructionTemplate	integer	Construction template (-1 for no template)
params	table	Parameters of the construction
height	number	Height of the construction.
rotation	number	Rotation around the vertical axis, in radians.
rotationY	number	Rotation around the Y axis, in radians.
rotationX	number	Rotation around the X axis, in radians.
assetRandomize	boolean	Randomize option for assets
builderAudioRes	{ResName}	Set audio played when building

Functions

new() : ConstructionBuilder base/tealdef/scripts/builtin.d.tl:75

Notes

Creates a new, empty ConstructionBuilder.

Returns ConstructionBuilder

onRotationChangeFn(newRotation : number) base/tealdef/scripts/builtin.d.tl:92

Set rotation change function

Builtin.Type.ConstructionAction.StreetEdgeBuilder

record userdata base/tealdef/scripts/builtin.d.tl:96

record StreetEdgeBuilder

Edge builder action descriptor.

Fields

Name	Type	Description
resName	ResName	Resource name of the street
busLane	boolean	Bus lane option
tramTrackType	TramTrackType	Tram track type option
playerOwned	boolean	Player owned option
curved	boolean	Curved option
alignToTerrain	number	Align to terrain option
enableSnapping	boolean	Enable snapping option
level	number	Level option
height	number	Height option
slope	number | nil	Slope option
bridgeTypeId	integer	Bridge type ID
tunnelTypeId	integer	Tunnel type ID
railroadCrossingTypeId	integer	Railroad crossing type ID
undergroundMode	boolean	Enable underground mode option
bridgeHeight	number
bridgeMinHeight	number
tunnelHeight	number
tunnelMinHeight	number
builderAudioRes	ResName	Audio played while building.

Functions

new() : StreetEdgeBuilder base/tealdef/scripts/builtin.d.tl:98

Notes

Creates a new, empty StreetEdgeBuilder.

Returns StreetEdgeBuilder

onClearFn() base/tealdef/scripts/builtin.d.tl:129

Set align to terrain function

onFixSlopeToggledFn(enabled : boolean) base/tealdef/scripts/builtin.d.tl:131

Set slope fixed

onHeightChangeFn(newHeight : number) base/tealdef/scripts/builtin.d.tl:133

Set height change function

onFollowTerrainEnabledFn(enabled : boolean) base/tealdef/scripts/builtin.d.tl:135

Set follow terrain enabled function

Builtin.Type.ConstructionAction.ModifierColor

record userdata base/tealdef/scripts/builtin.d.tl:143

record ModifierColor

Notes

Highlight colours (RGBA) of modifier tools.

Used in the base game: 1 time in 1 file

base/content/gui/gui/construction/construction_react_util.tl:35

local makeModifierColor = function() : Builtin.Type.ConstructionAction.ModifierColor

Fields

Name	Type	Description
validSubtle	Vec4f	Light highlight of a valid target.
validIntense	Vec4f	Strong highlight of a valid target.
invalidSubtle	Vec4f	Light highlight of an invalid target.
invalidIntense	Vec4f	Strong highlight of an invalid target.
upgrade	Vec4f	Highlight of an upgrade.
downgrade	Vec4f	Highlight of a downgrade.
inProgress	Vec4f	Highlight while the change is in progress.

Functions

new() : ModifierColor base/tealdef/scripts/builtin.d.tl:145

Notes

Creates a new, empty ModifierColor.

Returns ModifierColor

Builtin.Type.ConstructionAction.StreetEdgeNodeModifier

record userdata base/tealdef/scripts/builtin.d.tl:157

record StreetEdgeNodeModifier

Edge and node modifier action descriptor.

Fields

Name	Type	Description
resName	ResName	Resource name of the street
busLane	boolean	Bus lane option
tramTrackType	TramTrackType	Tram track type option
playerOwned	boolean	Player owned option
roadDevelopmentLocked	boolean	Prevent towns from updating or extending this road
makePlayerOwnedOnChange	boolean	Make player owned when changing something
symmetricLanes	boolean	Symmetric lanes option
trafficLights	boolean	Traffic lights option
overrideLaneConfigs	boolean	Override lane configs option
overrideEdgeDecorations	boolean	Override edge decoration options
undergroundMode	boolean	Set underground mode
color	ModifierColor	Set color
builderAudioRes	ResName	Set audio played when building

Functions

new() : StreetEdgeNodeModifier base/tealdef/scripts/builtin.d.tl:159

Notes

Creates a new, empty StreetEdgeNodeModifier.

Returns StreetEdgeNodeModifier

Builtin.Type.ConstructionAction.TrackEdgeBuilder

record userdata base/tealdef/scripts/builtin.d.tl:190

record TrackEdgeBuilder

Track edge builder action descriptor.

Fields

Name	Type	Description
resName	ResName	Resource name of the track
catenary	boolean	Build the track with catenary.
alignToTerrain	number	Align to terrain option
enableSnapping	boolean	Enable snapping option
level	number	Level option
height	number	Height option
slope	number | nil	Slope option
bridgeTypeId	integer	Bridge type ID
tunnelTypeId	integer	Tunnel type ID
railroadCrossingTypeId	integer	Railroad crossing type ID
undergroundMode	boolean	Set underground mode
bridgeHeight	number
bridgeMinHeight	number
tunnelHeight	number
tunnelMinHeight	number
builderAudioRes	ResName	Audio played while building.

Functions

new() : TrackEdgeBuilder base/tealdef/scripts/builtin.d.tl:192

Notes

Creates a new, empty TrackEdgeBuilder.

Returns TrackEdgeBuilder

onClearFn() base/tealdef/scripts/builtin.d.tl:216

Set align to terrain function

onFixSlopeToggledFn(enabled : boolean) base/tealdef/scripts/builtin.d.tl:218

Set slope fixed

onHeightChangeFn(newHeight : number) base/tealdef/scripts/builtin.d.tl:220

Set height change function

onFollowTerrainEnabledFn(enabled : boolean) base/tealdef/scripts/builtin.d.tl:222

Set follow terrain enabled function

Builtin.Type.ConstructionAction.TrackEdgeModifier

record userdata base/tealdef/scripts/builtin.d.tl:231

record TrackEdgeModifier

Track edge modifier action descriptor.

Fields

Name	Type	Description
resName	ResName	Resource name of the track
resNameRevert	ResName	Resource name of the track to revert to
catenary	boolean	Catenary option
highSpeed	boolean	High speed option
edgeDecoration	integer	Edge decoration option
overrideLaneConfigs	boolean	Override lane configs option
overrideEdgeDecorations	boolean	Override edge decoration options
undergroundMode	boolean	Set underground mode
color	ModifierColor	Set color
builderAudioRes	ResName	Set audio played when building

Functions

new() : TrackEdgeModifier base/tealdef/scripts/builtin.d.tl:233

Notes

Creates a new, empty TrackEdgeModifier.

Returns TrackEdgeModifier

Builtin.Type.ConstructionAction.EdgeObjectBuilder

record userdata base/tealdef/scripts/builtin.d.tl:258

record EdgeObjectBuilder

Street terminal builder action descriptor.

Fields

Name	Type	Description
resName	ResName	Resource name of the terminal
params	table	Construction parameters of the edge object.
oneWay	boolean	One way choice
undergroundMode	boolean	Enable underground mode
builderAudioRes	ResName	Audio played while building.

Functions

new() : EdgeObjectBuilder base/tealdef/scripts/builtin.d.tl:260

Notes

Creates a new, empty EdgeObjectBuilder.

Returns EdgeObjectBuilder

Builtin.Type.ConstructionAction.LaneModifier

record userdata base/tealdef/scripts/builtin.d.tl:273

record LaneModifier

Lane modifier action descriptor.

Fields

Name	Type	Description
color	ModifierColor	Highlight colours.
lineColors	{Vec3f}	Colours of the lines.
tramMode	boolean	Work on tram lanes.
undergroundMode	boolean	Set underground mode
builderAudioRes	ResName	Audio played while building.

Functions

new() : LaneModifier base/tealdef/scripts/builtin.d.tl:275

Notes

Creates a new, empty LaneModifier.

Returns LaneModifier

Builtin.Type.ConstructionAction.CrosswalkModifier

record userdata base/tealdef/scripts/builtin.d.tl:286

record CrosswalkModifier

Crosswalk modifier action descriptor.

Fields

Name	Type	Description
color	ModifierColor	Highlight colours.
undergroundMode	boolean	Set underground mode
builderAudioRes	ResName	Audio played while building.

Functions

new() : CrosswalkModifier base/tealdef/scripts/builtin.d.tl:288

Notes

Creates a new, empty CrosswalkModifier.

Returns CrosswalkModifier

Builtin.Type.ConstructionAction.BrushParams

record userdata base/tealdef/scripts/builtin.d.tl:297

record BrushParams

Brush parameters action descriptor.

Fields

Name	Type	Description
radius	number	Radius of the brush
brushIndex	integer	Index of the brush
opacity	number	Opacity/strength of the brush
rotation	number	Rotation of the brush
material	number	Material of the brush

Functions

new() : BrushParams base/tealdef/scripts/builtin.d.tl:299

Notes

Creates a new, empty BrushParams.

Returns BrushParams

Builtin.Type.ConstructionAction.TerrainModifier

record userdata base/tealdef/scripts/builtin.d.tl:314

record TerrainModifier

Terrain modifier action descriptor.

Fields

Name	Type	Description
mode	Mode	Mode of the terrain modifier
brushParams	ConstructionAction.BrushParams	Brush parameters
invert	boolean	Invert option
heightMap	string	Height map file path
builderAudioRes	ResName	Audio played while modifying.

Functions

new() : TerrainModifier base/tealdef/scripts/builtin.d.tl:316

Notes

Creates a new, empty TerrainModifier.

Returns TerrainModifier

Builtin.Type.ConstructionAction.TerrainModifier.Mode

record base/tealdef/scripts/builtin.d.tl:319

record Mode

Terrain modifier mode

Fields

Name	Type	Description
Raise	Mode	Raises the terrain.
Lower	Mode	Lowers the terrain.
Smooth	Mode	Smooths the terrain.
Flatten	Mode	Flattens the terrain.
Textured	Mode

Builtin.Type.ConstructionAction.TerrainPainter

record userdata base/tealdef/scripts/builtin.d.tl:339

record TerrainPainter

Terrain painter action descriptor.

Fields

Name	Type	Description
brushParams	ConstructionAction.BrushParams	Brush parameters
slope	number	Slope of the brush
slopeInvert	boolean	Invert slope option
builderAudioRes	ResName	Audio played while painting.

Functions

new() : TerrainPainter base/tealdef/scripts/builtin.d.tl:341

Notes

Creates a new, empty TerrainPainter.

Returns TerrainPainter

Builtin.Type.ConstructionAction.AssetBrush

record userdata base/tealdef/scripts/builtin.d.tl:353

record AssetBrush

Asset brush action descriptor.

Fields

Name	Type	Description
brushParams	ConstructionAction.BrushParams	Brush parameters
ignoreCollision	boolean	Skip collision option
assets	{ResName}	List of asset resource names
slope	number	Slope of the brush
slopeInvert	boolean	Invert slope option
randomRotation	boolean	Random rotation option
eraseWhenEmpty	boolean	When no assets are provided, this flag signals if assets should be erased instead
builderAudioRes	ResName	Audio played while placing assets.

Functions

new() : AssetBrush base/tealdef/scripts/builtin.d.tl:355

Notes

Creates a new, empty AssetBrush.

Returns AssetBrush

Builtin.Type.ConstructionAction.TownBuilder

record userdata base/tealdef/scripts/builtin.d.tl:375

record TownBuilder

Town builder action descriptor.

Fields

Name	Type	Description
initialLandUseCapacity	{integer, integer, integer}	Initial land use capacity
landUse2CargoNeeds	{{CargoTypeId | nil}, {CargoTypeId | nil}, {CargoTypeId | nil}}	Land use to cargo needs mapping
initialMajorStreetAngleRange	number	Initial major street angle range
capacityScalingFactor	number	Factor on the land use capacity of the new town.
builderAudioRes	ResName	Audio played while building.

Functions

new() : TownBuilder base/tealdef/scripts/builtin.d.tl:377

Notes

Creates a new, empty TownBuilder.

Returns TownBuilder

Builtin.Type.ConstructionAction.Bulldozer

record userdata base/tealdef/scripts/builtin.d.tl:390

record Bulldozer

Bulldozer action descriptor.

Fields

Name	Type	Description
undergroundMode	boolean	Set to bulldozer underground mode
circleBorderColor	Vec4f	Circle border color for bulldozer action
circleFillColor	Vec4f	Circle fill color for bulldozer action
circleBorderWidth	number	Circle border width for bulldozer action
circleAnimEasing	Easing	Circle animation easing for bulldozer action
circleAnimDuration	number	Circle animation duration for bulldozer action
crosshairColor	Vec4f	Crosshair color for bulldozer action
builderAudioResFallback	ResName	Audio played when the bulldozed object defines none.

Functions

new() : Bulldozer base/tealdef/scripts/builtin.d.tl:392

Notes

Creates a new, empty Bulldozer.

Returns Bulldozer

Builtin.Type.ConstructionAction.ModuleBuilder

record userdata base/tealdef/scripts/builtin.d.tl:413

record ModuleBuilder

Module builder action descriptor.

Fields

Name	Type	Description
constructionEntity	Engine.Entity	Construction entity
moduleResName	ResName	Module resource name
builderAudioRes	ResName	Audio played while building.

Functions

new() : ModuleBuilder base/tealdef/scripts/builtin.d.tl:415

Notes

Creates a new, empty ModuleBuilder.

Returns ModuleBuilder

Builtin.Type.ConstructionAction.ModuleBulldozer

record userdata base/tealdef/scripts/builtin.d.tl:425

record ModuleBulldozer

Module bulldozer action descriptor.

Fields

Name	Type	Description
constructionEntity	Engine.Entity	Construction entity
builderAudioResFallback	ResName	Audio played when the bulldozed module defines none.

Functions

new() : ModuleBulldozer base/tealdef/scripts/builtin.d.tl:427

Notes

Creates a new, empty ModuleBulldozer.

Returns ModuleBulldozer

Builtin.Type.ControlPointInfo

record userdata base/tealdef/scripts/builtin.d.tl:435

record ControlPointInfo

Notes

A draggable control point shown by the proposal viewer.

Fields

Name	Type	Description
position	Vec3f	Position of the point.
offsetZ	number	Height offset.
radius	number	Radius of the marker.
state	State	Display state.

Functions

new(Vec3f, number, number, State) : ControlPointInfo base/tealdef/scripts/builtin.d.tl:447

Notes

Creates a control point from position, height offset, radius and state.

Returns ControlPointInfo

Builtin.Type.ControlPointInfo.State

record base/tealdef/scripts/builtin.d.tl:438

record State

Notes

Display state of a control point.

Fields

Name	Type	Description
Invalid	State
Normal	State	Normal display.
Hover	State	The mouse is over the point.
Dragging	State	The point is being dragged.
Idle	State
IdleOverEdge	State

Builtin.Type.FloatingLayoutOverflowMode

record base/tealdef/scripts/builtin.d.tl:454

record FloatingLayoutOverflowMode

Notes

How a floating layout child may extend beyond its parent.

Fields

Name	Type	Description
None	FloatingLayoutOverflowMode
Overflow	FloatingLayoutOverflowMode	this mode will ignore outerSpacing, borderWidth, padding but allow leaving the parent rect
KeepInside	FloatingLayoutOverflowMode	The child is kept inside the parent rectangle.

Builtin.Type.InputActionBubbleUpFilter

record base/tealdef/scripts/builtin.d.tl:460

record InputActionBubbleUpFilter

Notes

Which input actions a window passes on to its parent, set with WindowParam.inputActionBubbleUpFilter.

Functions

allowAll() : InputActionBubbleUpFilter base/tealdef/scripts/builtin.d.tl:461

Notes

Passes all input actions on to the parent.

Returns InputActionBubbleUpFilter

allowOnly(inputActionIds : {string}) : InputActionBubbleUpFilter base/tealdef/scripts/builtin.d.tl:462

Notes

Passes only the listed input actions on.

Returns InputActionBubbleUpFilter

filterOutAll() : InputActionBubbleUpFilter base/tealdef/scripts/builtin.d.tl:463

Notes

Passes no input actions on (the pause menu window uses this).

Returns InputActionBubbleUpFilter

filterOut(inputActionIds : {string}) : InputActionBubbleUpFilter base/tealdef/scripts/builtin.d.tl:464

Notes

Passes all input actions except the listed ones.

Returns InputActionBubbleUpFilter

Builtin.Type.LineVisualization

record base/tealdef/scripts/builtin.d.tl:467

record LineVisualization

Notes

A line to draw in the line viewer (LineViewerParam.showLines).

Used in the base game: 20 times in 8 files

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:411

local lineVisualizations : {Builtin.Type.LineVisualization} = {}

base/content/gui/gui/line_vehicle_mgmt/line_util.tl:1028

lineVisualizations : {Builtin.Type.LineVisualization},

base/content/gui/gui/statistics/statistic_lines.tl:344

local function makeFilteredKeys(keys : {Engine.Entity}, curVisualizations : {Builtin.Type.LineVisualization})

base/content/gui/gui/statistics/statistics.tl:292

local lineVisualizationState = engine_react_util.useStepState(function(cur : {Builtin.Type.LineVisualization}) : {Builtin.Type.LineVisualization}

base/content/gui/gui/entity_window/station_group/station_group.tl:912

local makeState = function() : {Builtin.Type.LineVisualization}

base/content/gui/gui/entity_window/vehicle/vehicle.tl:598

local lineVisualizations : {Builtin.Type.LineVisualization} = {}

… and 2 more files.

Fields

Name	Type	Description
entity	Engine.Entity	The line entity.
transparency	number	Transparency of the drawn line.

Functions

new() : LineVisualization base/tealdef/scripts/builtin.d.tl:468

Notes

Creates a new, empty LineVisualization.

Returns LineVisualization

Builtin.Type.VisibilityThresholds

record base/tealdef/scripts/builtin.d.tl:474

record VisibilityThresholds

Notes

Camera distance rules for HUD icons, given to HudIconManagerConfigParam.visibilityThresholds.

Used in the base game: 15 times in 1 file

base/content/gui/gui/hud/hud_react_util.tl:10

hud_react_util.makeVisibilityThresholdsUserdata = function(visibilityThresholds : Builtin.Type.VisibilityThresholds) : Builtin.Type.VisibilityThresholds

Fields

Name	Type	Description
cameraHeightThreshold	number
cameraHeightLowerCutoff	number
hudLodFarRangeThreshold	number
forComponents	{{Engine.ComponentType, OfComponent}}	Rules per component type, as {componentType, OfComponent} pairs.
forSubEntities	{{Gui.SelectionDetails.Type, OfSubEntity}}	Rules per sub-entity type, as {selectionType, OfSubEntity} pairs.

Functions

new() : VisibilityThresholds base/tealdef/scripts/builtin.d.tl:475

Notes

Creates a new, empty VisibilityThresholds.

Returns VisibilityThresholds

Builtin.Type.VisibilityThresholds.OfComponent

record base/tealdef/scripts/builtin.d.tl:477

record OfComponent

Notes

Visibility rule for the HUD icons of entities with one component type.

Used in the base game: 6 times in 1 file

base/content/gui/gui/hud/hud_react_util.tl:23

local forComponents : {{Engine.ComponentType, Builtin.Type.VisibilityThresholds.OfComponent}} = {}

Fields

Name	Type	Description
forceVisible	boolean	Forces the hud icon to always be visible
minDist	number	Minimum camera distance from which the hud icon gets drawn
scale	number	Scale multiplier for hud icon
maxDist	number	Maximum camera distance until which the hud icon gets drawn
randomizeMaxDistBase	number	add random value to add to MaxDist
layer	integer	Controls the draw order of the main hud icon (lower toward front)
physicsImpact	integer	Controls hud icon physics impact, 0 is disabled, 1 is light, >= 2 is heavy

Functions

new() : OfComponent base/tealdef/scripts/builtin.d.tl:478

Notes

Creates a new, empty OfComponent.

Returns OfComponent

Builtin.Type.VisibilityThresholds.OfSubEntity

record base/tealdef/scripts/builtin.d.tl:495

record OfSubEntity

Notes

Visibility rule for the icons of sub-entities of one selection type.

Used in the base game: 7 times in 1 file

base/content/gui/gui/hud/hud_react_util.tl:36

local forSubEntities : {{Gui.SelectionDetails.Type, Builtin.Type.VisibilityThresholds.OfSubEntity}} = {}

Fields

Name	Type	Description
detailsThreshold	number	when exceeding this camera distance, the main icon is shown instead of sub icons, when set to negative number, sub icons are never shown, when set to nil, both parent icon and sub entity icons are shown
layer	integer	Controls the draw order of the subentity hud icon (lower toward front)
physicsImpact	integer	Controls hud icon physics impact, 0 is disabled, 1 is light, >= 2 is heavy

Functions

new() : OfSubEntity base/tealdef/scripts/builtin.d.tl:496

Notes

Creates a new, empty OfSubEntity.

Returns OfSubEntity

Builtin.Type.ParticleSystem2dEmitter

record base/tealdef/scripts/builtin.d.tl:514

record ParticleSystem2dEmitter

one emitter in a particle systen

Used in the base game: 3 times in 1 file

base/content/gui/gui/main/particle_react_util.tl:6

particle_react_util.makeCompanyLevelUpParticles = function(overrides? : ParticleReactUtil.Emitter) : {Builtin.Type.ParticleSystem2dEmitter}

Fields

Name	Type	Description
emissionEnabled	boolean	whether or not this emitter should currently emit ignored for sub-emitters with enableAtBirth or enableAtDeath set to true
speed	number	allow to slowdown or speed up the emission rate
duration	ParticleParamFloat	if > 0, particle system will stop after duration if -1 and this is a sub-emitter, it will stop when the parent particle dies, otherwise it will never stop
texture	string	texture of the particle
emissionInterval	ParticleParamFloat	spawn rate
burstCount	ParticleParamFloat	if >= 0, limits spawned particles per burst (-1 = unlimited)
burstInterval	ParticleParamFloat	wait time between bursts (only used when burstCount >= 0)
lifeTime	ParticleParamFloat	lifetime of each particle
subEmitters	{ParticleSystem2dSubEmitter}	list of sub-emitters started from this emitter's particles
shape	ParticleSystem2dEmitterShape	emitter shape (ContentRect or Circle)
velocity	ParticleParamVec2f	initial velocity
velocityByDirection	ParticleParamFloat	velocity component along emission direction
velocityOverLifeTime	ParticleParamCurveVec2f	additional velocity curve over the lifetime of the particles (added to base velocity)
gravity	ParticleParamVec2f	gravity applied to the particles (added to velocity every frame)
orientation	Vec2f	reference orientation vector for rotation calculations (default: {0, -1}) if 0, 0 and this is a sub-emitter, orientation will be inhertted from parent particle current veloctiy
rotationByDirection	ParticleParamFloat	rotation component along emission direction (multiplier for direction angle in degrees)
rotation	ParticleParamFloat	initial rotation of the particles
rotationSpeed	ParticleParamFloat	rotation speed of the particles (added to rotation every frame)
rotationSpeedByDirection	ParticleParamFloat	rotation speed component along emission direction (multiplier for direction angle in degrees)
colorOverLifeTime	ParticleParamCurveVec3f	color curve over the lifetime of the particles (RGB)
alphaOverLifeTime	ParticleParamCurveFloat	alpha curve over the lifetime of the particles (A)
size	ParticleParamVec2f	initial size of a particle
scaleOverLifeTime	ParticleParamCurveVec2f	size curve over the lifetime of the particles (XY)

Functions

new() : ParticleSystem2dEmitter base/tealdef/scripts/builtin.d.tl:515

Notes

Creates a new, empty ParticleSystem2dEmitter.

Returns ParticleSystem2dEmitter

Builtin.Type.ParticleSystem2dSubEmitter

record base/tealdef/scripts/builtin.d.tl:590

record ParticleSystem2dSubEmitter

Notes

Starts another emitter of the same particle system from the particles of this one.

Used in the base game: 2 times in 1 file

base/content/gui/gui/main/particle_react_util.tl:152

local subEmittersWrapper = function(value : {any}) : {Builtin.Type.ParticleSystem2dSubEmitter}

Fields

Name	Type	Description
emitterIndex	integer	index into ParticleSystem2d.emitters
enableAtBirth	boolean	starts sub-emitter when parent particle is born
enableAtDeath	boolean	starts sub-emitter when parent particle dies

Functions

new() : ParticleSystem2dSubEmitter base/tealdef/scripts/builtin.d.tl:591

Notes

Creates a new, empty ParticleSystem2dSubEmitter.

Returns ParticleSystem2dSubEmitter

new(emitterIndex : integer, enableAtBirth? : boolean, enableAtDeath? : boolean) : ParticleSystem2dSubEmitter base/tealdef/scripts/builtin.d.tl:592

Notes

Creates a new, empty ParticleSystem2dSubEmitter.

Returns ParticleSystem2dSubEmitter

Builtin.Type.ParticleSystem2dEmitterShape

interface base/tealdef/scripts/builtin.d.tl:605

interface ParticleSystem2dEmitterShape

Notes

Marker interface of emitter shapes.

Builtin.Type.ParticleSystem2dEmitterShapeContentRect

record base/tealdef/scripts/builtin.d.tl:609

record ParticleSystem2dEmitterShapeContentRect is ParticleSystem2dEmitterShape

Notes

Emits from a point inside the widget's content rectangle.

Fields

Name	Type	Description
pos01	ParticleParamVec2f	Position in the rectangle, 0 to 1 on both axes.

Functions

new() : ParticleSystem2dEmitterShapeContentRect base/tealdef/scripts/builtin.d.tl:610

Notes

Creates a new, empty ParticleSystem2dEmitterShapeContentRect.

Returns ParticleSystem2dEmitterShapeContentRect

new(pos01 : Vec2f) : ParticleSystem2dEmitterShapeContentRect base/tealdef/scripts/builtin.d.tl:611

Notes

Creates a new, empty ParticleSystem2dEmitterShapeContentRect.

Returns ParticleSystem2dEmitterShapeContentRect

Builtin.Type.ParticleSystem2dEmitterShapeCircle

record base/tealdef/scripts/builtin.d.tl:615

record ParticleSystem2dEmitterShapeCircle is ParticleSystem2dEmitterShape

Notes

Emits from a ring or circle sector.

Fields

Name	Type	Description
minRadius	number	Inner radius.
maxRadius	number	Outer radius.
minAngle	number	Start angle of the sector.
maxAngle	number	End angle of the sector.

Functions

new() : ParticleSystem2dEmitterShapeCircle base/tealdef/scripts/builtin.d.tl:616

Notes

Creates a new, empty ParticleSystem2dEmitterShapeCircle.

Returns ParticleSystem2dEmitterShapeCircle

new(minRadius : number, maxRadius : number, minAngle? : number, maxAngle? : number) : ParticleSystem2dEmitterShapeCircle base/tealdef/scripts/builtin.d.tl:617

Notes

Creates a new, empty ParticleSystem2dEmitterShapeCircle.

Returns ParticleSystem2dEmitterShapeCircle

Builtin.Type.EventTrigger

record base/tealdef/scripts/builtin.d.tl:624

record EventTrigger

No description in the game files yet.

Used in the base game: 7 times in 2 files

base/content/gui/gui/menu/menu_util.tl:36

local logoEventTriggerBigState : ReactStateT<Builtin.Type.EventTrigger> = engine_react_util.useStepState(function() : Builtin.Type.EventTrigger

base/content/gui/gui/menu/main_menu.tl:418

local eventTriggerBigState : ReactStateT<Builtin.Type.EventTrigger> = react.useState(

Fields

Name	Type	Description
time	number
pos	Vec2f

Functions

new() : EventTrigger base/tealdef/scripts/builtin.d.tl:625

Notes

Creates a new, empty EventTrigger.

Returns EventTrigger

new(time : number, pos : Vec2f) : EventTrigger base/tealdef/scripts/builtin.d.tl:626

Notes

Creates a new, empty EventTrigger.

Returns EventTrigger