OpenTTD Source 20241224-master-gf74b0cf984
league_type.h File Reference

basic types related to league tables More...

Go to the source code of this file.

Data Structures

struct  Link
 

Typedefs

typedef uint32_t LinkTargetID
 Contains either tile, industry ID, town ID, story page ID or company ID.
 
typedef uint8_t LeagueTableID
 ID of a league table.
 
typedef uint16_t LeagueTableElementID
 ID of a league table element.
 

Enumerations

enum  LinkType : uint8_t {
  LT_NONE = 0 , LT_TILE = 1 , LT_INDUSTRY = 2 , LT_TOWN = 3 ,
  LT_COMPANY = 4 , LT_STORY_PAGE = 5
}
 Types of the possible link targets. More...
 

Variables

static const LeagueTableID INVALID_LEAGUE_TABLE = 0xFF
 Invalid/unknown index of LeagueTable.
 
static const LeagueTableElementID INVALID_LEAGUE_TABLE_ELEMENT = 0xFFFF
 Invalid/unknown index of LeagueTableElement.
 

Detailed Description

basic types related to league tables

Definition in file league_type.h.

Typedef Documentation

◆ LeagueTableElementID

typedef uint16_t LeagueTableElementID

ID of a league table element.

Definition at line 36 of file league_type.h.

◆ LeagueTableID

typedef uint8_t LeagueTableID

ID of a league table.

Definition at line 32 of file league_type.h.

◆ LinkTargetID

typedef uint32_t LinkTargetID

Contains either tile, industry ID, town ID, story page ID or company ID.

Definition at line 23 of file league_type.h.

Enumeration Type Documentation

◆ LinkType

enum LinkType : uint8_t

Types of the possible link targets.

Enumerator
LT_NONE 

No link.

LT_TILE 

Link a tile.

LT_INDUSTRY 

Link an industry.

LT_TOWN 

Link a town.

LT_COMPANY 

Link a company.

LT_STORY_PAGE 

Link a story page.

Definition at line 14 of file league_type.h.

Variable Documentation

◆ INVALID_LEAGUE_TABLE

const LeagueTableID INVALID_LEAGUE_TABLE = 0xFF
static

Invalid/unknown index of LeagueTable.

Definition at line 34 of file league_type.h.

Referenced by CmdCreateLeagueTable().

◆ INVALID_LEAGUE_TABLE_ELEMENT

const LeagueTableElementID INVALID_LEAGUE_TABLE_ELEMENT = 0xFFFF
static

Invalid/unknown index of LeagueTableElement.

Definition at line 38 of file league_type.h.

Referenced by CmdCreateLeagueTableElement().