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

Inheritance diagram for AIIndustry:

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 char *	GetName (IndustryID industry_id)
	Get the name of the industry.
static bool	IsCargoAccepted (IndustryID industry_id, CargoID cargo_id)
	See if an industry 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 AIIndustry::GetLocation() of the industry.
static int32	GetDistanceSquareToTile (IndustryID industry_id, TileIndex tile)
	Get the square distance from the tile to the AIIndustry::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 Function Documentation

static int32 AIIndustry::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 AIIndustry::GetDistanceManhattanToTile	(	IndustryID	industry_id,
		TileIndex	tile
	)			`[static]`

Get the manhattan distance from the tile to the AIIndustry::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).; AIMap::IsValidTile(tile).

Returns:: The distance between industry and tile.

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

Get the square distance from the tile to the AIIndustry::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).; AIMap::IsValidTile(tile).

Returns:: The distance between industry and tile.

static TileIndex AIIndustry::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 TileIndex AIIndustry::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 int32 AIIndustry::GetIndustryCount ( ) [static]

Gets the number of industries.

Returns:: The number of industries.

Postcondition:: Return value is always non-negative.

Note:: The maximum valid IndustryID can be higher then the value returned.

static IndustryType AIIndustry::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.

static int32 AIIndustry::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).; AICargo::IsValidCargo(cargo_id).

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

static int32 AIIndustry::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).; AICargo::IsValidCargo(cargo_id).

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

static int32 AIIndustry::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).; AICargo::IsValidCargo(cargo_id).

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

static TileIndex AIIndustry::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 char* AIIndustry::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 int32 AIIndustry::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).; AICargo::IsValidCargo(cargo_id).

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

static bool AIIndustry::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 bool AIIndustry::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 bool AIIndustry::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 AIIndustry::IsCargoAccepted	(	IndustryID	industry_id,
		CargoID	cargo_id
	)			`[static]`

See if an industry accepts a certain cargo.

Parameters:

	industry_id	The index of the industry.
	cargo_id	The index of the cargo.

Precondition:: IsValidIndustry(industry_id).; AICargo::IsValidCargo(cargo_id).

Returns:: True if and only if the industry accepts the cargo.

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

AIIndustry Class Reference

Static Public Member Functions

Detailed Description

Member Function Documentation