Class that handles all industry-type related functions.
More...
#include <script_industrytype.hpp>
Class that handles all industry-type related functions.
◆ SpecialIndustryType
◆ BuildIndustry()
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.
◆ CanBuildIndustry()
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.
◆ CanProspectIndustry()
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.
◆ GetAcceptedCargo()
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.
◆ GetConstructionCost()
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.
◆ GetName()
static string 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.
◆ GetProducedCargo()
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.
◆ HasDock()
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.
◆ HasHeliport()
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.
◆ IsBuiltOnWater()
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.
◆ IsProcessingIndustry()
static bool AIIndustryType::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.
◆ IsRawIndustry()
static bool AIIndustryType::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.
◆ IsValidIndustryType()
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.
◆ ProductionCanIncrease()
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.
◆ ProspectIndustry()
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.
◆ ResolveNewGRFID()
static IndustryType AIIndustryType::ResolveNewGRFID |
( |
int |
grfid, |
|
|
int |
grf_local_id |
|
) |
| |
|
static |
Get a specific industry-type from a grf.
- Parameters
-
grfid | The ID of the NewGRF. |
grf_local_id | The ID of the industry, local to the NewGRF. |
- Precondition
- 0x00 <= grf_local_id < NUM_INDUSTRYTYPES_PER_GRF.
- Returns
- the industry-type ID, local to the current game (this diverges from the grf_local_id).