OpenTTD Source 20260206-master-g4d4e37dbf1
LeagueTableElement Struct Reference

Struct about league table elements. More...

#include <league_base.h>

Inheritance diagram for LeagueTableElement:

Public Member Functions

 LeagueTableElement (LeagueTableElementID index)
 LeagueTableElement (LeagueTableElementID index, LeagueTableID table, int64_t rating, CompanyID company, const EncodedString &text, const EncodedString &score, const Link &link)
 ~LeagueTableElement ()
 (Empty) destructor has to be defined else operator delete might be called with nullptr parameter

Data Fields

LeagueTableID table = LeagueTableID::Invalid()
 Id of the table which this element belongs to.
int64_t rating = 0
 Value that determines ordering of elements in the table (higher=better).
CompanyID company = CompanyID::Invalid()
 Company Id to show the colour blob for or CompanyID::Invalid().
EncodedString text {}
 Text of the element.
EncodedString score {}
 String representation of the score associated with the element.
Link link {}
 What opens when element is clicked.

Detailed Description

Struct about league table elements.

Each LeagueTable is composed of one or more elements. Elements are sorted by their rating (higher=better).

Definition at line 32 of file league_base.h.

Constructor & Destructor Documentation

◆ LeagueTableElement() [1/2]

LeagueTableElement::LeagueTableElement ( LeagueTableElementID index)
inline

Definition at line 40 of file league_base.h.

◆ LeagueTableElement() [2/2]

LeagueTableElement::LeagueTableElement ( LeagueTableElementID index,
LeagueTableID table,
int64_t rating,
CompanyID company,
const EncodedString & text,
const EncodedString & score,
const Link & link )
inline

Definition at line 41 of file league_base.h.

◆ ~LeagueTableElement()

LeagueTableElement::~LeagueTableElement ( )
inline

(Empty) destructor has to be defined else operator delete might be called with nullptr parameter

Definition at line 47 of file league_base.h.

Field Documentation

◆ company

CompanyID LeagueTableElement::company = CompanyID::Invalid()

Company Id to show the colour blob for or CompanyID::Invalid().

Definition at line 35 of file league_base.h.

◆ link

Link LeagueTableElement::link {}

What opens when element is clicked.

Definition at line 38 of file league_base.h.

Referenced by ScriptLeagueWindow::OnClick().

◆ rating

int64_t LeagueTableElement::rating = 0

Value that determines ordering of elements in the table (higher=better).

Definition at line 34 of file league_base.h.

Referenced by ScriptLeagueWindow::BuildTable().

◆ score

EncodedString LeagueTableElement::score {}

String representation of the score associated with the element.

Definition at line 37 of file league_base.h.

◆ table

LeagueTableID LeagueTableElement::table = LeagueTableID::Invalid()

Id of the table which this element belongs to.

Definition at line 33 of file league_base.h.

◆ text

EncodedString LeagueTableElement::text {}

Text of the element.

Definition at line 36 of file league_base.h.


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