Skip to content

config_util

Source: base/tealdef/scripts/util/config_util.d.tl

Notes

Types of /scripts/util/config_util.tl (ConfigUtil) for editing the data of a generic script resource.

ConfigUtil

record global base/tealdef/scripts/util/config_util.d.tl:3

global record ConfigUtil

Load: local config_util = ug_require "::/scripts/util/config_util.tl"

Notes

Helper returned by ug_require "/scripts/util/config_util.tl".

Functions

changeScriptConfig<T>(configRes : ResName, fn : function(config : T)) base/tealdef/scripts/util/config_util.d.tl:4

Call as config_util.changeScriptConfig

Notes

Loads a generic script resource, lets fn modify its data table and writes the data back.

Parameter Type Description
configRes ResName Resource name, for example "::/gui/construction/tools/traffic_light_tool.res".
fn function(config : T) Function that receives the resource's data and changes it in place.

Example

-- from base/content/base/base/mod.script.tl
config_util.changeScriptConfig("::/gui/construction/tools/traffic_light_tool.res", function(config : ConstructionToolData)
    config.getDefinitionFn.params.yearFrom = trafficLightConfig.trafficLightYearFrom
end)
Used in the base game: 7 times in 3 files

base/content/base/base/mod.script.tl:397

config_util.changeScriptConfig("::/gui/construction/tools/traffic_light_tool.res", function(config : ConstructionToolData)
mods/release/urbangames_campaign_mission_07/content/mod.script.tl:56
config_util.changeScriptConfig("::/game_mechanics/towns/town_growth_config.res", function(config : TownGrowthConfig)
mods/release/urbangames_campaign_mission_04/content/mod.script.tl:111
config_util.changeScriptConfig("::/game_mechanics/towns/town_growth_config.res", function(config : TownGrowthConfig)