GSIndustryType Class Reference

Class that handles all industry-type related functions. More...


Public Types

enum  SpecialIndustryType {
  INDUSTRYTYPE_UNKNOWN,
  INDUSTRYTYPE_TOWN
}
 Special IndustryTypes. More...

Static Public Member Functions

static bool IsValidIndustryType (IndustryType industry_type)
 Checks whether the given industry-type is valid.
static char * GetName (IndustryType industry_type)
 Get the name of an industry-type.
static GSListGetProducedCargo (IndustryType industry_type)
 Get a list of CargoID possible produced by this industry-type.
static GSListGetAcceptedCargo (IndustryType industry_type)
 Get a list of CargoID accepted by this industry-type.
static bool IsRawIndustry (IndustryType industry_type)
 Is this industry type a raw industry? Raw industries usually produce cargo without any prerequisites.
static bool IsProcessingIndustry (IndustryType industry_type)
 Is this industry type a processing industry? Processing industries usually produce cargo when delivered with input cargo.
static bool ProductionCanIncrease (IndustryType industry_type)
 Can the production of this industry increase?
static Money GetConstructionCost (IndustryType industry_type)
 Get the cost for building this industry-type.
static bool CanBuildIndustry (IndustryType industry_type)
 Can you build this type of industry?
static bool CanProspectIndustry (IndustryType industry_type)
 Can you prospect this type of industry?
static bool BuildIndustry (IndustryType industry_type, TileIndex tile)
 Build an industry of the specified type.
static bool ProspectIndustry (IndustryType industry_type)
 Prospect an industry of this type.
static bool IsBuiltOnWater (IndustryType industry_type)
 Is this type of industry built on water.
static bool HasHeliport (IndustryType industry_type)
 Does this type of industry have a heliport?
static bool HasDock (IndustryType industry_type)
 Does this type of industry have a dock?


Detailed Description

Class that handles all industry-type related functions.

Member Enumeration Documentation

Special IndustryTypes.

Enumerator:
INDUSTRYTYPE_UNKNOWN  Unknown/unspecific industrytype. (Usable for GSRail::BuildNewGRFRailStation()).
INDUSTRYTYPE_TOWN  No industry, but town. (Usable for GSRail::BuildNewGRFRailStation()).


Member Function Documentation

static bool GSIndustryType::IsValidIndustryType ( IndustryType  industry_type  )  [static]

Checks whether the given industry-type is valid.

Parameters:
industry_type The type check.
Returns:
True if and only if the industry-type is valid.

static char* GSIndustryType::GetName ( IndustryType  industry_type  )  [static]

Get the name of an industry-type.

Parameters:
industry_type The type to get the name for.
Precondition:
IsValidIndustryType(industry_type).
Returns:
The name of an industry.

static GSList* GSIndustryType::GetProducedCargo ( IndustryType  industry_type  )  [static]

Get a list of CargoID possible produced by this industry-type.

Warning:
This function only returns the default cargoes of the industry type. Industries can specify new cargotypes on construction.
Parameters:
industry_type The type to get the CargoIDs for.
Precondition:
IsValidIndustryType(industry_type).
Returns:
The CargoIDs of all cargotypes this industry could produce.

static GSList* GSIndustryType::GetAcceptedCargo ( IndustryType  industry_type  )  [static]

Get a list of CargoID accepted by this industry-type.

Warning:
This function only returns the default cargoes of the industry type. Industries can specify new cargotypes on construction.
Parameters:
industry_type The type to get the CargoIDs for.
Precondition:
IsValidIndustryType(industry_type).
Returns:
The CargoIDs of all cargotypes this industry accepts.

static bool GSIndustryType::IsRawIndustry ( IndustryType  industry_type  )  [static]

Is this industry type a raw industry? Raw industries usually produce cargo without any prerequisites.

("Usually" means that advanced NewGRF industry concepts might not fit the "raw"/"processing" classification, so it's up to the interpretation of the NewGRF author.)

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if it should be handled as a raw industry.
Note:
Industries might be neither raw nor processing. This is usually the case for industries which produce nothing (e.g. power plants), but also for weird industries like temperate banks and tropic lumber mills.

static bool GSIndustryType::IsProcessingIndustry ( IndustryType  industry_type  )  [static]

Is this industry type a processing industry? Processing industries usually produce cargo when delivered with input cargo.

("Usually" means that advanced NewGRF industry concepts might not fit the "raw"/"processing" classification, so it's up to the interpretation of the NewGRF author.)

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if it is a processing industry.
Note:
Industries might be neither raw nor processing. This is usually the case for industries which produce nothing (e.g. power plants), but also for weird industries like temperate banks and tropic lumber mills.

static bool GSIndustryType::ProductionCanIncrease ( IndustryType  industry_type  )  [static]

Can the production of this industry increase?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if the production of this industry can increase.

static Money GSIndustryType::GetConstructionCost ( IndustryType  industry_type  )  [static]

Get the cost for building this industry-type.

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
The cost for building this industry-type.

static bool GSIndustryType::CanBuildIndustry ( IndustryType  industry_type  )  [static]

Can you build this type of industry?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if you can build this type of industry at locations of your choice.
Note:
If no valid GSCompanyMode active in scope, this method returns false if you can only prospect this type of industry, or not build it at all.

If no valid GSCompanyMode active in scope, the script can build as long as the industry type can be built. (a NewGRF can for example reject construction based on current year)

static bool GSIndustryType::CanProspectIndustry ( IndustryType  industry_type  )  [static]

Can you prospect this type of industry?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if you can prospect this type of industry.
Note:
If no valid GSCompanyMode is active in scope, and if the setting "Manual primary industry construction method" is set to either "None" or "as other industries" this function always returns false.

If no valid GSCompanyMode active in scope, the script can prospect as long as the industry type can be built. (a NewGRF can for example reject construction based on current year)

static bool GSIndustryType::BuildIndustry ( IndustryType  industry_type,
TileIndex  tile 
) [static]

Build an industry of the specified type.

Parameters:
industry_type The type of the industry to build.
tile The tile to build the industry on.
Precondition:
CanBuildIndustry(industry_type).
Returns:
True if the industry was successfully build.

static bool GSIndustryType::ProspectIndustry ( IndustryType  industry_type  )  [static]

Prospect an industry of this type.

Prospecting an industries let the game try to create an industry on a random place on the map.

Parameters:
industry_type The type of the industry.
Precondition:
CanProspectIndustry(industry_type).
Returns:
True if no error occurred while trying to prospect.
Note:
Even if true is returned there is no guarantee a new industry is build.

If true is returned the money is paid, whether a new industry was build or not.

if no valid GSCompanyMode exist in scope, prospection will not fail due to the general chance that prospection may fail. However prospection can still fail if OpenTTD is unable to find a suitable location to place the industry.

static bool GSIndustryType::IsBuiltOnWater ( IndustryType  industry_type  )  [static]

Is this type of industry built on water.

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True when this type is built on water.

static bool GSIndustryType::HasHeliport ( IndustryType  industry_type  )  [static]

Does this type of industry have a heliport?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True when this type has a heliport.

static bool GSIndustryType::HasDock ( IndustryType  industry_type  )  [static]

Does this type of industry have a dock?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True when this type has a dock.


Generated on Mon Jun 1 19:25:13 2015 for OpenTTD Game API by  doxygen 1.5.6