OpenTTD Game API
Public Types | Static Public Member Functions
GSInfrastructure Class Reference

Class that handles all company infrastructure related functions. More...

Inheritance diagram for GSInfrastructure:

Public Types

enum  Infrastructure {
  INFRASTRUCTURE_RAIL,
  INFRASTRUCTURE_SIGNALS,
  INFRASTRUCTURE_ROAD,
  INFRASTRUCTURE_CANAL,
  INFRASTRUCTURE_STATION,
  INFRASTRUCTURE_AIRPORT
}
 Infrastructure categories. More...
 

Static Public Member Functions

static uint32 GetRailPieceCount (GSCompany::CompanyID company, GSRail::RailType railtype)
 Return the number of rail pieces of a specific rail type for a company. More...
 
static uint32 GetRoadPieceCount (GSCompany::CompanyID company, GSRoad::RoadType roadtype)
 Return the number of road pieces of a specific road type for a company. More...
 
static uint32 GetInfrastructurePieceCount (GSCompany::CompanyID company, Infrastructure infra_type)
 Return the number of pieces of an infrastructure category for a company. More...
 
static Money GetMonthlyRailCosts (GSCompany::CompanyID company, GSRail::RailType railtype)
 Return the monthly maintenance costs of a specific rail type for a company. More...
 
static Money GetMonthlyRoadCosts (GSCompany::CompanyID company, GSRoad::RoadType roadtype)
 Return the monthly maintenance costs of a specific road type for a company. More...
 
static Money GetMonthlyInfrastructureCosts (GSCompany::CompanyID company, Infrastructure infra_type)
 Return the monthly maintenance costs of an infrastructure category for a company. More...
 

Detailed Description

Class that handles all company infrastructure related functions.

Member Enumeration Documentation

◆ Infrastructure

Infrastructure categories.

Enumerator
INFRASTRUCTURE_RAIL 

Rail infrastructure.

INFRASTRUCTURE_SIGNALS 

Signal infrastructure.

INFRASTRUCTURE_ROAD 

Road infrastructure.

INFRASTRUCTURE_CANAL 

Canal infrastructure.

INFRASTRUCTURE_STATION 

Station infrastructure.

INFRASTRUCTURE_AIRPORT 

Airport infrastructure.

Member Function Documentation

◆ GetInfrastructurePieceCount()

static uint32 GSInfrastructure::GetInfrastructurePieceCount ( GSCompany::CompanyID  company,
Infrastructure  infra_type 
)
static

Return the number of pieces of an infrastructure category for a company.

Parameters
companyThe company to get the count for.
infra_typeInfrastructure category to get the cost of.
Returns
Count for the wanted category.
Note
INFRASTRUCTURE_RAIL and INFRASTRUCTURE_ROAD return the total count for all rail/road types.

◆ GetMonthlyInfrastructureCosts()

static Money GSInfrastructure::GetMonthlyInfrastructureCosts ( GSCompany::CompanyID  company,
Infrastructure  infra_type 
)
static

Return the monthly maintenance costs of an infrastructure category for a company.

Parameters
companyThe company to get the monthly cost for.
infra_typeInfrastructure category to get the cost of.
Returns
Monthly maintenance cost for the wanted category.
Note
INFRASTRUCTURE_RAIL and INFRASTRUCTURE_ROAD return the total cost for all rail/road types.

◆ GetMonthlyRailCosts()

static Money GSInfrastructure::GetMonthlyRailCosts ( GSCompany::CompanyID  company,
GSRail::RailType  railtype 
)
static

Return the monthly maintenance costs of a specific rail type for a company.

Parameters
companyThe company to get the monthly cost for.
railtypeRail type to get the cost of.
Returns
Monthly maintenance cost for the rail type.

◆ GetMonthlyRoadCosts()

static Money GSInfrastructure::GetMonthlyRoadCosts ( GSCompany::CompanyID  company,
GSRoad::RoadType  roadtype 
)
static

Return the monthly maintenance costs of a specific road type for a company.

Parameters
companyThe company to get the monthly cost for.
roadtypeRoad type to get the cost of.
Returns
Monthly maintenance cost for the road type.

◆ GetRailPieceCount()

static uint32 GSInfrastructure::GetRailPieceCount ( GSCompany::CompanyID  company,
GSRail::RailType  railtype 
)
static

Return the number of rail pieces of a specific rail type for a company.

Parameters
companyThe company to get the count for.
railtypeRail type to get the count of.
Returns
Count for the rail type.

◆ GetRoadPieceCount()

static uint32 GSInfrastructure::GetRoadPieceCount ( GSCompany::CompanyID  company,
GSRoad::RoadType  roadtype 
)
static

Return the number of road pieces of a specific road type for a company.

Parameters
companyThe company to get the count for.
roadtypeRoad type to get the count of.
Returns
Count for the road type.