name_util¶

Source: base/tealdef/mission/name_util.d.tl

Notes

Helpers that rename entities of a mission savegame and check that all of them got a name.

NameUtil¶

record global base/tealdef/mission/name_util.d.tl:3

global record NameUtil

Load: local name_util = ug_require "::/mission/name_util.tl"

Notes

Renames entities of a mission savegame.

Functions

setName(id : Engine.Entity, name : string, tagged : {Engine.Entity : boolean}, missionInitRedundancyChecks? : boolean) base/tealdef/mission/name_util.d.tl:4

Call as name_util.setName

Notes

Sets the name of an entity and propagates it to the stations of a station group or to the station groups of a construction.

Parameter	Type	Description
`id`	`Engine.Entity`	Entity to rename.
`name`	`string`	New name.
`tagged`	`{Engine.Entity : boolean}`	Set of renamed entities, updated in place.
`missionInitRedundancyChecks?`	`boolean`	Logs errors for names set on the wrong level (edge objects, subconstructions, station groups of named constructions).

Used in the base game: 12 times in 12 files

base/content/mission/mission/mission_sim.script.tl:582

name_util.setName(entityAndName[1], entityAndName[2], tagged, true)

base/content/mission/mission/tasks/utility/industry_activity.tl:26

name_util.setName(constructionEntity, originalName, {})

base/content/mission/mission/tasks/utility/landmark_requirements.tl:38

name_util.setName(ctx.params.entity, originalName, {})

base/content/mission/mission/tasks/utility/substitute_constructions.tl:69

name_util.setName(entity, name, {})

mods/release/urbangames_campaign_mission_03/content/mission/mission/tasks/everything/everything.tl:34

name_util.setName(entityAndName[1], entityAndName[2], tagged, true)

mods/release/urbangames_campaign_mission_07/content/mission/mission/tasks/everything/everything.tl:39

name_util.setName(entityAndName[1], entityAndName[2], tagged, true)

… and 6 more files.

checkTagged(tagged : {Engine.Entity : boolean}, printParams? : boolean) base/tealdef/mission/name_util.d.tl:5

Call as name_util.checkTagged

Notes

Logs (or prints) constructions, station groups, depots, towns, vehicles and player lines that were not renamed.

Parameter	Type	Description
`tagged`	`{Engine.Entity : boolean}`	Set of renamed entities.
`printParams?`	`boolean`	Prints `{ entity, _("name") },` lines instead of warnings.

Used in the base game: 9 times in 9 files

base/content/mission/mission/mission_sim.script.tl:584

name_util.checkTagged(tagged, true)

mods/release/urbangames_campaign_mission_03/content/mission/mission/tasks/everything/everything.tl:36

name_util.checkTagged(tagged)

mods/release/urbangames_campaign_mission_07/content/mission/mission/tasks/everything/everything.tl:41

name_util.checkTagged(tagged)

mods/release/urbangames_campaign_mission_02/content/mission/mission/tasks/everything/everything.tl:35

name_util.checkTagged(tagged)

mods/release/urbangames_campaign_mission_06/content/mission/mission/tasks/everything/everything.tl:35

name_util.checkTagged(tagged)

mods/release/urbangames_campaign_mission_01/content/mission/mission/tasks/everything/everything.tl:34

name_util.checkTagged(tagged)

… and 3 more files.