param_util

Source: base/tealdef/scripts/construction/param_util.d.tl

Notes

Types of /scripts/construction/param_util.tl (ParamUtil), ready-made construction parameters (track type, catenary, rotation).

ParamUtil

record global base/tealdef/scripts/construction/param_util.d.tl:3

global record ParamUtil

Load: local param_util = require "::/scripts/construction/param_util.tl"

Notes

Construction parameter helpers returned by ug_require "::/scripts/construction/param_util.tl".

Fields

Name	Type	Description
tramCatenaryYearFrom	integer	Year from which catenaries are available for tram tracks used 1× in the base game

Functions

makeTrackTypeDefaultParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:13

Call as param_util.makeTrackTypeDefaultParam

Create default rail track type parameters.

Returns ScriptParam: script param for default rail track type selection

Used in the base game: 3 times in 2 files

base/content/depots/rail/rail/rail_depot.con.lua:40

-- param_util.makeTrackTypeDefaultParam(),

base/content/stations/rail/rail/modular_station/modular_station.con.lua:46

param_util.makeTrackTypeDefaultParam(),

makeTrackTypeHighSpeedParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:16

Call as param_util.makeTrackTypeHighSpeedParam

Create high-speed rail track type parameters.

Returns ScriptParam: script param for high-speed rail track type selection

Used in the base game: 3 times in 2 files

base/content/depots/rail/rail/rail_depot.con.lua:41

-- param_util.makeTrackTypeHighSpeedParam(),

base/content/stations/rail/rail/modular_station/modular_station.con.lua:47

param_util.makeTrackTypeHighSpeedParam(),

makeTrackCatenaryParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:19

Call as param_util.makeTrackCatenaryParam

Create rail catenary parameters.

Returns ScriptParam: script param for rail catenary toggle

Used in the base game: 3 times in 2 files

base/content/depots/rail/rail/rail_depot.con.lua:42

-- param_util.makeTrackCatenaryParam()

base/content/stations/rail/rail/modular_station/modular_station.con.lua:48

param_util.makeTrackCatenaryParam(),

makeTramTrackDefaultParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:23

Call as param_util.makeTramTrackDefaultParam

Create default tram track type parameters.

Returns ScriptParam: script param for default tram track type selection

Used in the base game: 1 time in 1 file

base/content/stations/street/street/modular_street_station/modular_terminal.con.lua:189

param_util.makeTramTrackDefaultParam(),

makeTramTrackElectricParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:26

Call as param_util.makeTramTrackElectricParam

Create electric tram track type parameters.

Returns ScriptParam: script param for electric tram track type selection

Used in the base game: 1 time in 1 file

base/content/stations/street/street/modular_street_station/modular_terminal.con.lua:190

param_util.makeTramTrackElectricParam(),

makeTramCatenaryParam() : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:29

Call as param_util.makeTramCatenaryParam

Create tram catenary parameters.

Returns ScriptParam: script param for tram catenary toggle

Used in the base game: 3 times in 2 files

base/content/depots/road/road/tram_depot/tram_depot.con.lua:39

params = param_util.makeTramCatenaryParam(),

base/content/stations/street/street/underground_station/underground_station.con.lua:150

param_util.makeTramCatenaryParam(),

getRailTrackTypes(withCaternay : boolean) : {string} base/tealdef/scripts/construction/param_util.d.tl:34

Call as param_util.getRailTrackTypes

Get available rail track type values.

Parameter	Type	Description
withCaternay	boolean	whether to include catenary variants

Returns {string}: list of track type template paths

Used in the base game: 2 times in 1 file

base/content/depots/rail/rail/rail_depot.script.lua:278

local trackTypes = param_util.getRailTrackTypes(params.catenary == 2)

makeRotationParam(key : string, name : string) : ScriptParam base/tealdef/scripts/construction/param_util.d.tl:40

Call as param_util.makeRotationParam

Create rotation parameters.

Parameter	Type	Description
key	string	unique parameter key
name	string	display name

Returns ScriptParam: script param for rotation selection

Used in the base game: 2 times in 1 file

base/content/scripts/scripts/construction/assetbuilderutil.lua:57

local paramX = param_util.makeRotationParam("constructOpt56", _("Rotation X"))

ParamUtil.ScriptRef

record base/tealdef/scripts/construction/param_util.d.tl:4

record ScriptRef

Notes

Reference to a script function and the parameters passed to it.

Fields

Name	Type	Description
fileName	string	Path to the script file
params	table	Parameters passed to the script