OpenTTD Source 20261112-master-gbcbec5e63f
LegendAndColour Struct Reference

Structure for holding relevant data for legends in small map. More...

Data Fields

StringID legend {}
 String corresponding to the coloured item.
PixelColour colour {}
 Colour of the item on the map.
IndustryType industry_type = IT_INVALID
 Type of industry. Only valid for industry entries.
CargoType cargo_type = INVALID_CARGO
 Type of cargo. Only valid for cargo entries.
uint8_t height = 0
 Height in tiles. Only valid for height legend entries.
CompanyID company = CompanyID::Invalid()
 Company to display. Only valid for company entries of the owner legend.
bool show_on_map = true
 For filtering industries, if true, industry is shown on the map in colour.
bool end = false
 This is the end of the list.
bool col_break = false
 Perform a column break and go further at the next column.

Detailed Description

Structure for holding relevant data for legends in small map.

Definition at line 48 of file smallmap_gui.cpp.

Field Documentation

◆ cargo_type

CargoType LegendAndColour::cargo_type = INVALID_CARGO

Type of cargo. Only valid for cargo entries.

Definition at line 52 of file smallmap_gui.cpp.

◆ col_break

bool LegendAndColour::col_break = false

Perform a column break and go further at the next column.

Definition at line 57 of file smallmap_gui.cpp.

◆ colour

PixelColour LegendAndColour::colour {}

Colour of the item on the map.

Definition at line 50 of file smallmap_gui.cpp.

◆ company

CompanyID LegendAndColour::company = CompanyID::Invalid()

Company to display. Only valid for company entries of the owner legend.

Definition at line 54 of file smallmap_gui.cpp.

◆ end

bool LegendAndColour::end = false

This is the end of the list.

Definition at line 56 of file smallmap_gui.cpp.

Referenced by SmallMapWindow::OnClick().

◆ height

uint8_t LegendAndColour::height = 0

Height in tiles. Only valid for height legend entries.

Definition at line 53 of file smallmap_gui.cpp.

◆ industry_type

IndustryType LegendAndColour::industry_type = IT_INVALID

Type of industry. Only valid for industry entries.

Definition at line 51 of file smallmap_gui.cpp.

◆ legend

StringID LegendAndColour::legend {}

String corresponding to the coloured item.

Definition at line 49 of file smallmap_gui.cpp.

Referenced by SmallMapWindow::DrawIndustryNames(), and SmallMapWindow::OnClick().

◆ show_on_map

bool LegendAndColour::show_on_map = true

For filtering industries, if true, industry is shown on the map in colour.

Definition at line 55 of file smallmap_gui.cpp.

Referenced by SmallMapWindow::DrawIndustryNames(), SmallMapWindow::OnClick(), and SmallMapWindow::SelectLegendItem().


The documentation for this struct was generated from the following file: