GSIndustry Class Reference

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...

Static Public Member Functions

static int32 GetIndustryCount ()
 Gets the number of industries.
static bool IsValidIndustry (IndustryID industry_id)
 Checks whether the given industry index is valid.
static IndustryID GetIndustryID (TileIndex tile)
 Get the IndustryID of a tile, if there is an industry.
static char * GetName (IndustryID industry_id)
 Get the name of the industry.
static CargoAcceptState IsCargoAccepted (IndustryID industry_id, CargoID cargo_id)
 See whether an industry currently accepts a certain cargo.
static int32 GetStockpiledCargo (IndustryID industry_id, CargoID cargo_id)
 Get the amount of cargo stockpiled for processing.
static int32 GetLastMonthProduction (IndustryID industry_id, CargoID cargo_id)
 Get the total last month's production of the given cargo at an industry.
static int32 GetLastMonthTransported (IndustryID industry_id, CargoID cargo_id)
 Get the total amount of cargo transported from an industry last month.
static int32 GetLastMonthTransportedPercentage (IndustryID industry_id, CargoID cargo_id)
 Get the percentage of cargo transported from an industry last month.
static TileIndex GetLocation (IndustryID industry_id)
 Gets the location of the industry.
static int32 GetAmountOfStationsAround (IndustryID industry_id)
 Get the number of stations around an industry.
static int32 GetDistanceManhattanToTile (IndustryID industry_id, TileIndex tile)
 Get the manhattan distance from the tile to the GSIndustry::GetLocation() of the industry.
static int32 GetDistanceSquareToTile (IndustryID industry_id, TileIndex tile)
 Get the square distance from the tile to the GSIndustry::GetLocation() of the industry.
static bool IsBuiltOnWater (IndustryID industry_id)
 Is this industry built on water.
static bool HasHeliport (IndustryID industry_id)
 Does this industry have a heliport?
static TileIndex GetHeliportLocation (IndustryID industry_id)
 Gets the location of the industry's heliport.
static bool HasDock (IndustryID industry_id)
 Does this industry have a dock?
static TileIndex GetDockLocation (IndustryID industry_id)
 Gets the location of the industry's dock.
static IndustryType GetIndustryType (IndustryID industry_id)
 Get the IndustryType of the industry.

Detailed Description

Class that handles all industry related functions.

Member Enumeration Documentation

enum GSIndustry::CargoAcceptState

Ways for an industry to accept a cargo.

Enumerator:
CAS_NOT_ACCEPTED  The CargoID is not accepted by this industry.
CAS_ACCEPTED  The industry currently accepts this CargoID.
CAS_TEMP_REFUSED  The industry temporarily refuses to accept this CargoID but may do so again in the future.

Member Function Documentation

static int32 GSIndustry::GetIndustryCount (  )  [static]

Gets the number of industries.

Returns:
The number of industries.
Note:
The maximum valid IndustryID can be higher than the value returned.

static bool GSIndustry::IsValidIndustry ( IndustryID  industry_id  )  [static]

Checks whether the given industry index is valid.

Parameters:
industry_id The index to check.
Returns:
True if and only if the industry is valid.

static IndustryID GSIndustry::GetIndustryID ( TileIndex  tile  )  [static]

Get the IndustryID of a tile, if there is an industry.

Parameters:
tile The tile to find the IndustryID of.
Returns:
IndustryID of the industry.
Postcondition:
Use IsValidIndustry() to see if the industry is valid.
Note:
GetIndustryID will return an invalid IndustryID for the station tile of industries with a dock/heliport.

static char* GSIndustry::GetName ( IndustryID  industry_id  )  [static]

Get the name of the industry.

Parameters:
industry_id The industry to get the name of.
Precondition:
IsValidIndustry(industry_id).
Returns:
The name of the industry.

static CargoAcceptState GSIndustry::IsCargoAccepted ( IndustryID  industry_id,
CargoID  cargo_id 
) [static]

See whether an industry currently accepts a certain cargo.

Parameters:
industry_id The index of the industry.
cargo_id The index of the cargo.
Precondition:
IsValidIndustry(industry_id).

GSCargo::IsValidCargo(cargo_id).

Returns:
Whether the industry accepts, temporarily refuses or never accepts this cargo.

static int32 GSIndustry::GetStockpiledCargo ( IndustryID  industry_id,
CargoID  cargo_id 
) [static]

Get the amount of cargo stockpiled for processing.

Parameters:
industry_id The index of the industry.
cargo_id The index of the cargo.
Precondition:
IsValidIndustry(industry_id).

GSCargo::IsValidCargo(cargo_id).

Returns:
The amount of cargo that is waiting for processing.

static int32 GSIndustry::GetLastMonthProduction ( IndustryID  industry_id,
CargoID  cargo_id 
) [static]

Get the total last month's production of the given cargo at an industry.

Parameters:
industry_id The index of the industry.
cargo_id The index of the cargo.
Precondition:
IsValidIndustry(industry_id).

GSCargo::IsValidCargo(cargo_id).

Returns:
The last month's production of the given cargo for this industry.

static int32 GSIndustry::GetLastMonthTransported ( IndustryID  industry_id,
CargoID  cargo_id 
) [static]

Get the total amount of cargo transported from an industry last month.

Parameters:
industry_id The index of the industry.
cargo_id The index of the cargo.
Precondition:
IsValidIndustry(industry_id).

GSCargo::IsValidCargo(cargo_id).

Returns:
The amount of given cargo transported from this industry last month.

static int32 GSIndustry::GetLastMonthTransportedPercentage ( IndustryID  industry_id,
CargoID  cargo_id 
) [static]

Get the percentage of cargo transported from an industry last month.

Parameters:
industry_id The index of the industry.
cargo_id The index of the cargo.
Precondition:
IsValidIndustry(industry_id).

GSCargo::IsValidCargo(cargo_id).

Returns:
The percentage of given cargo transported from this industry last month.

static TileIndex GSIndustry::GetLocation ( IndustryID  industry_id  )  [static]

Gets the location of the industry.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
The location of the industry.

static int32 GSIndustry::GetAmountOfStationsAround ( IndustryID  industry_id  )  [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.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
The number of stations around an industry.

static int32 GSIndustry::GetDistanceManhattanToTile ( IndustryID  industry_id,
TileIndex  tile 
) [static]

Get the manhattan distance from the tile to the GSIndustry::GetLocation() of the industry.

Parameters:
industry_id The industry to get the distance to.
tile The tile to get the distance to.
Precondition:
IsValidIndustry(industry_id).

GSMap::IsValidTile(tile).

Returns:
The distance between industry and tile.

static int32 GSIndustry::GetDistanceSquareToTile ( IndustryID  industry_id,
TileIndex  tile 
) [static]

Get the square distance from the tile to the GSIndustry::GetLocation() of the industry.

Parameters:
industry_id The industry to get the distance to.
tile The tile to get the distance to.
Precondition:
IsValidIndustry(industry_id).

GSMap::IsValidTile(tile).

Returns:
The distance between industry and tile.

static bool GSIndustry::IsBuiltOnWater ( IndustryID  industry_id  )  [static]

Is this industry built on water.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
True when the industry is built on water.

static bool GSIndustry::HasHeliport ( IndustryID  industry_id  )  [static]

Does this industry have a heliport?

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
True when the industry has a heliport.

static TileIndex GSIndustry::GetHeliportLocation ( IndustryID  industry_id  )  [static]

Gets the location of the industry's heliport.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).

HasHeliport(industry_id).

Returns:
The location of the industry's heliport.

static bool GSIndustry::HasDock ( IndustryID  industry_id  )  [static]

Does this industry have a dock?

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
True when the industry has a dock.

static TileIndex GSIndustry::GetDockLocation ( IndustryID  industry_id  )  [static]

Gets the location of the industry's dock.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).

HasDock(industry_id).

Returns:
The location of the industry's dock.

static IndustryType GSIndustry::GetIndustryType ( IndustryID  industry_id  )  [static]

Get the IndustryType of the industry.

Parameters:
industry_id The index of the industry.
Precondition:
IsValidIndustry(industry_id).
Returns:
The IndustryType of the industry.

Generated on Mon Sep 3 17:01:02 2012 for OpenTTD Game API by  doxygen 1.5.6