town_marketing_metadata¶

Source: base/tealdef/game_mechanics/towns/town_marketing_metadata.d.tl

Notes

Construction metadata (town_marketing) of marketing campaigns.

TownMarketingMetadata¶

record global base/tealdef/game_mechanics/towns/town_marketing_metadata.d.tl:3

global record TownMarketingMetadata

Load: local town_marketing_metadata = ug_require "::/game_mechanics/towns/town_marketing_metadata.tl"

Notes

Accessor for the town_marketing construction metadata of marketing campaigns. The marketing campaign tool reads it and sends it with the startMarketingCampaign event.

Fields

Name	Type	Description
`constructionDesc`	`MetadataAccessor<ConstructionDescMetadata, TownMarketingMetadata.ConstructionDesc>`	Accessor for `TownMarketingMetadata.ConstructionDesc` in construction definition metadata. used 3× in the base game

Functions

getKey() : string base/tealdef/game_mechanics/towns/town_marketing_metadata.d.tl:10

Call as town_marketing_metadata.getKey

Notes

Metadata key of marketing campaigns.

Returns string: "town_marketing"

TownMarketingMetadata.ConstructionDesc¶

record base/tealdef/game_mechanics/towns/town_marketing_metadata.d.tl:4

record ConstructionDesc

Notes

Settings of one marketing campaign.

Used in the base game: 3 times in 3 files

base/content/game_mechanics/game_mechanics/towns/towns.script.tl:297

local marketingParams = p.marketingParams as TownMarketingMetadata.ConstructionDesc

base/content/game_mechanics/game_mechanics/towns/town_marketing_metadata.tl:8

constructionDesc = metadata_util.constructionDesc.register(getKey()) as MetadataAccessor<ConstructionDescMetadata, TownMarketingMetadata.ConstructionDesc>,

base/content/game_mechanics/game_mechanics/towns/town_util.tl:902

function town_util.applyMarketingCamaign(previous : TownAuthorityEventFactors, params : TownMarketingMetadata.ConstructionDesc) : TownAuthorityEventFactors

Fields

Name	Type	Description
`durationMs`	`integer`	Duration of the campaign in ms of game time.
`lineCostFactor`	`number`	Line cost factor of the town in pathfinding while the campaign runs (`OnModifyPathfinding`). Values below `0.1` are reset to `0.1`.