OpenTTD GameScript API
1.11.2
|
Class that handles all industry related functions. More...
Public Types | |
enum | CargoAcceptState { CAS_NOT_ACCEPTED, CAS_ACCEPTED, CAS_TEMP_REFUSED } |
Ways for an industry to accept a cargo. More... | |
enum | IndustryControlFlags { INDCTL_NO_PRODUCTION_DECREASE, INDCTL_NO_PRODUCTION_INCREASE, INDCTL_NO_CLOSURE } |
Control flags for industry. More... | |
Static Public Member Functions | |
static int32 | GetIndustryCount () |
Gets the number of industries. More... | |
static bool | IsValidIndustry (IndustryID industry_id) |
Checks whether the given industry index is valid. More... | |
static IndustryID | GetIndustryID (TileIndex tile) |
Get the IndustryID of a tile, if there is an industry. More... | |
static char * | GetName (IndustryID industry_id) |
Get the name of the industry. More... | |
static bool | SetText (IndustryID industry_id, Text *text) |
Set the custom text of an industry, shown in the GUI. More... | |
static CargoAcceptState | IsCargoAccepted (IndustryID industry_id, CargoID cargo_id) |
See whether an industry currently accepts a certain cargo. More... | |
static int32 | GetStockpiledCargo (IndustryID industry_id, CargoID cargo_id) |
Get the amount of cargo stockpiled for processing. More... | |
static int32 | GetLastMonthProduction (IndustryID industry_id, CargoID cargo_id) |
Get the total last month's production of the given cargo at an industry. More... | |
static int32 | GetLastMonthTransported (IndustryID industry_id, CargoID cargo_id) |
Get the total amount of cargo transported from an industry last month. More... | |
static int32 | GetLastMonthTransportedPercentage (IndustryID industry_id, CargoID cargo_id) |
Get the percentage of cargo transported from an industry last month. More... | |
static TileIndex | GetLocation (IndustryID industry_id) |
Gets the location of the industry. More... | |
static int32 | GetAmountOfStationsAround (IndustryID industry_id) |
Get the number of stations around an industry. More... | |
static int32 | GetDistanceManhattanToTile (IndustryID industry_id, TileIndex tile) |
Get the manhattan distance from the tile to the GSIndustry::GetLocation() of the industry. More... | |
static int32 | GetDistanceSquareToTile (IndustryID industry_id, TileIndex tile) |
Get the square distance from the tile to the GSIndustry::GetLocation() of the industry. More... | |
static bool | IsBuiltOnWater (IndustryID industry_id) |
Is this industry built on water. More... | |
static bool | HasHeliport (IndustryID industry_id) |
Does this industry have a heliport? More... | |
static TileIndex | GetHeliportLocation (IndustryID industry_id) |
Gets the location of the industry's heliport. More... | |
static bool | HasDock (IndustryID industry_id) |
Does this industry have a dock? More... | |
static TileIndex | GetDockLocation (IndustryID industry_id) |
Gets the location of the industry's dock. More... | |
static IndustryType | GetIndustryType (IndustryID industry_id) |
Get the IndustryType of the industry. More... | |
static int32 | GetLastProductionYear (IndustryID industry_id) |
Get the last year this industry had any production output. More... | |
static GSDate::Date | GetCargoLastAcceptedDate (IndustryID industry_id, CargoID cargo_type) |
Get the last date this industry accepted any cargo delivery. More... | |
static uint32 | GetControlFlags (IndustryID industry_id) |
Get the current control flags for an industry. More... | |
static bool | SetControlFlags (IndustryID industry_id, uint32 control_flags) |
Change the control flags for an industry. More... | |
static GSCompany::CompanyID | GetExclusiveSupplier (IndustryID industry_id) |
Find out which company currently has the exclusive rights to deliver cargo to the industry. More... | |
static bool | SetExclusiveSupplier (IndustryID industry_id, GSCompany::CompanyID company_id) |
Sets or resets the company that has exclusive right to deliver cargo to the industry. More... | |
static GSCompany::CompanyID | GetExclusiveConsumer (IndustryID industry_id) |
Find out which company currently has the exclusive rights to take cargo from the industry. More... | |
static bool | SetExclusiveConsumer (IndustryID industry_id, GSCompany::CompanyID company_id) |
Sets or resets the company that has exclusive right to take cargo from the industry. More... | |
Class that handles all industry related functions.
Control flags for industry.
|
static |
Get the number of stations around an industry.
All stations that can service the industry are counted, your own stations but also your opponents stations.
industry_id | The index of the industry. |
|
static |
Get the last date this industry accepted any cargo delivery.
industry_id | The index of the industry. |
cargo_type | The cargo to query, or CT_INVALID to query latest of all accepted cargoes. |
|
static |
Get the current control flags for an industry.
industry_id | The index of the industry. |
|
static |
Get the manhattan distance from the tile to the GSIndustry::GetLocation() of the industry.
industry_id | The industry to get the distance to. |
tile | The tile to get the distance to. |
|
static |
Get the square distance from the tile to the GSIndustry::GetLocation() of the industry.
industry_id | The industry to get the distance to. |
tile | The tile to get the distance to. |
|
static |
Gets the location of the industry's dock.
industry_id | The index of the industry. |
|
static |
Find out which company currently has the exclusive rights to take cargo from the industry.
industry_id | The index of the industry. |
|
static |
Find out which company currently has the exclusive rights to deliver cargo to the industry.
industry_id | The index of the industry. |
|
static |
Gets the location of the industry's heliport.
industry_id | The index of the industry. |
|
static |
Gets the number of industries.
|
static |
Get the IndustryID of a tile, if there is an industry.
tile | The tile to find the IndustryID of. |
|
static |
Get the IndustryType of the industry.
industry_id | The index of the industry. |
|
static |
Get the total last month's production of the given cargo at an industry.
industry_id | The index of the industry. |
cargo_id | The index of the cargo. |
|
static |
Get the total amount of cargo transported from an industry last month.
industry_id | The index of the industry. |
cargo_id | The index of the cargo. |
|
static |
Get the percentage of cargo transported from an industry last month.
industry_id | The index of the industry. |
cargo_id | The index of the cargo. |
|
static |
Get the last year this industry had any production output.
industry_id | The index of the industry. |
|
static |
Gets the location of the industry.
industry_id | The index of the industry. |
|
static |
Get the name of the industry.
industry_id | The industry to get the name of. |
|
static |
Get the amount of cargo stockpiled for processing.
industry_id | The index of the industry. |
cargo_id | The index of the cargo. |
|
static |
Does this industry have a dock?
industry_id | The index of the industry. |
|
static |
Does this industry have a heliport?
industry_id | The index of the industry. |
|
static |
Is this industry built on water.
industry_id | The index of the industry. |
|
static |
See whether an industry currently accepts a certain cargo.
industry_id | The index of the industry. |
cargo_id | The index of the cargo. |
|
static |
Checks whether the given industry index is valid.
industry_id | The index to check. |
|
static |
Change the control flags for an industry.
industry_id | The index of the industry. |
control_flags | New flags as a combination of IndustryControlFlags values. |
|
static |
Sets or resets the company that has exclusive right to take cargo from the industry.
industry_id | The index of the industry. |
company_id | The company to set (GSCompany::COMPANY_INVALID to reset). |
|
static |
Sets or resets the company that has exclusive right to deliver cargo to the industry.
industry_id | The index of the industry. |
company_id | The company to set (GSCompany::COMPANY_INVALID to reset). |
|
static |
Set the custom text of an industry, shown in the GUI.
industry_id | The industry to set the custom text of. |
text | The text to set it to (can be either a raw string, or a GSText object). If null is passed, the text will be removed. |