Newspaper templates

Newspaper Templates#

registerNewspaperTemplates#

api.registerNewspaperTemplates(templates: any[]): void

Append newspaper templates to the global list the newspaper service merges into its template pool.

The service appends the list to the base templates every time it draws an article. The list is never cached, so templates registered at any point in the session take part in the next draw. Entries are not validated. The fields the service reads, the metadata options, the requiredGameState filters and the template variables are in the tables on the Newspaper templates reference page. The list is emptied on reloadMods. Logs [Modding API] Registering <n> custom newspaper templates (development builds only).

Parameter templates (any[]): template objects to append; must be an array.

Errors:

• templates not an array: logs [Modding API] Invalid templates - must be an array, appends nothing.
• exception: logs [Modding API] Error registering newspaper templates:.

Side effects: window.__customNewspaperTemplates created or appended.

Changed: Mod templates are merged at every draw instead of being cached with the base templates, so late registrations are picked up and a removed mod's templates do not persist; the list is cleared on reloadMods (PR #1090).

api.registerNewspaperTemplates([{
  headline: '{{CITY}} Opens {{NEWEST_STATION}}',
  content: 'Day {{DAY}}: {{STATIONS}} stations and {{ROUTES}} routes.\nThe treasury holds {{TREASURY}}.',
  metadata: { category: 'expansion', tone: 'celebratory', weight: 8, requiredGameState: { minStations: 5, financialStatus: 'stable' } },
}]);

Template Fields#

Metadata Options#

A 'comedy' template is dropped while the treasury is under $10M, while the system is overcrowded (see isOvercrowded) or has fewer than 5 stations, and otherwise survives a 50% roll. When the comedy checks drop every applicable template, the draw uses all of them.

Required Game State Options#

Among the templates that pass, each requirement scores 1, each ratio 2 and requiredCity 2. Templates more than 2 points below the most specific survivor are dropped before the weighted pick.

Template Variables#

Replaced in headline and content when an article is drawn. Variables on one row are aliases. Ranked stations and routes are sorted by ridership (then route count, waiting and warnings), or by warnings first for the disruption categories and tones above.