AIIndustryType 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 AIListGetProducedCargo (IndustryType industry_type)
 Get a list of CargoID possible produced by this industry-type.
static AIListGetAcceptedCargo (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?
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 AIRail::BuildNewGRFRailStation()).
INDUSTRYTYPE_TOWN  No industry, but town. (Usable for AIRail::BuildNewGRFRailStation()).


Member Function Documentation

static bool AIIndustryType::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* AIIndustryType::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 AIList* AIIndustryType::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 AIList* AIIndustryType::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 AIIndustryType::IsRawIndustry ( IndustryType  industry_type  )  [static]

Is this industry type a raw industry?

Parameters:
industry_type The type of the industry.
Precondition:
IsValidIndustryType(industry_type).
Returns:
True if it should be handled as a raw industry.

static bool AIIndustryType::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 AIIndustryType::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 AIIndustryType::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:
Returns false if you can only prospect this type of industry, or not build it at all.

static bool AIIndustryType::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 the setting "Manual primary industry construction method" is set to either "None" or "as other industries" this function always returns false.

static bool AIIndustryType::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 AIIndustryType::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.

static bool AIIndustryType::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 AIIndustryType::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 AIIndustryType::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 Thu May 31 21:43:02 2012 for OpenTTD NoAI API by  doxygen 1.5.6