(svn r23526) -Codechange: unify cargos vs cargoes
This commit is contained in:
@@ -214,7 +214,7 @@
|
||||
* including houses instead the number of producing tiles. This means that
|
||||
* also industries that do not have a tile within the radius, but where
|
||||
* the search bounding box and the industry's bounding box intersect, are
|
||||
* counted. Previously these industries (and their cargos), although they
|
||||
* counted. Previously these industries (and their cargoes), although they
|
||||
* produced cargo for a station at the given location, were not returned.
|
||||
* \li AIRail::BuildRail will now fail completely if there is an obstacle
|
||||
* between the begin and end, instead of building up to the obstacle and
|
||||
|
@@ -7,7 +7,7 @@
|
||||
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/** @file script_cargo.hpp Everything to query cargos. */
|
||||
/** @file script_cargo.hpp Everything to query cargoes. */
|
||||
|
||||
#ifndef SCRIPT_CARGO_HPP
|
||||
#define SCRIPT_CARGO_HPP
|
||||
@@ -27,7 +27,7 @@ public:
|
||||
*/
|
||||
enum CargoClass {
|
||||
/* Note: these values represent part of the in-game CargoClass enum */
|
||||
CC_PASSENGERS = ::CC_PASSENGERS, ///< Passengers. Cargos of this class appear at bus stops. Cargos not of this class appear at truck stops.
|
||||
CC_PASSENGERS = ::CC_PASSENGERS, ///< Passengers. Cargoes of this class appear at bus stops. Cargoes not of this class appear at truck stops.
|
||||
CC_MAIL = ::CC_MAIL, ///< Mail
|
||||
CC_EXPRESS = ::CC_EXPRESS, ///< Express cargo (Goods, Food, Candy, but also possible for passengers)
|
||||
CC_ARMOURED = ::CC_ARMOURED, ///< Armoured cargo (Valuables, Gold, Diamonds)
|
||||
|
@@ -7,7 +7,7 @@
|
||||
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/** @file script_cargolist.hpp List all the cargos. */
|
||||
/** @file script_cargolist.hpp List all the cargoes. */
|
||||
|
||||
#ifndef SCRIPT_CARGOLIST_HPP
|
||||
#define SCRIPT_CARGOLIST_HPP
|
||||
@@ -15,7 +15,7 @@
|
||||
#include "script_list.hpp"
|
||||
|
||||
/**
|
||||
* Creates a list of cargos that can be produced in the current game.
|
||||
* Creates a list of cargoes that can be produced in the current game.
|
||||
* @api ai
|
||||
* @ingroup ScriptList
|
||||
*/
|
||||
@@ -25,8 +25,8 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a list of cargos that the given industry accepts.
|
||||
* @note This list also includes cargos that are temporarily not accepted
|
||||
* Creates a list of cargoes that the given industry accepts.
|
||||
* @note This list also includes cargoes that are temporarily not accepted
|
||||
* by this industry, @see ScriptIndustry::IsCargoAccepted.
|
||||
* @api ai
|
||||
* @ingroup ScriptList
|
||||
@@ -34,33 +34,33 @@ public:
|
||||
class ScriptCargoList_IndustryAccepting : public ScriptList {
|
||||
public:
|
||||
/**
|
||||
* @param industry_id The industry to get the list of cargos it accepts from.
|
||||
* @param industry_id The industry to get the list of cargoes it accepts from.
|
||||
*/
|
||||
ScriptCargoList_IndustryAccepting(IndustryID industry_id);
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a list of cargos that the given industry can produce.
|
||||
* Creates a list of cargoes that the given industry can produce.
|
||||
* @api ai
|
||||
* @ingroup ScriptList
|
||||
*/
|
||||
class ScriptCargoList_IndustryProducing : public ScriptList {
|
||||
public:
|
||||
/**
|
||||
* @param industry_id The industry to get the list of cargos it produces from.
|
||||
* @param industry_id The industry to get the list of cargoes it produces from.
|
||||
*/
|
||||
ScriptCargoList_IndustryProducing(IndustryID industry_id);
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a list of cargos that the given station accepts.
|
||||
* Creates a list of cargoes that the given station accepts.
|
||||
* @api ai
|
||||
* @ingroup ScriptList
|
||||
*/
|
||||
class ScriptCargoList_StationAccepting : public ScriptList {
|
||||
public:
|
||||
/**
|
||||
* @param station_id The station to get the list of cargos it accepts from.
|
||||
* @param station_id The station to get the list of cargoes it accepts from.
|
||||
*/
|
||||
ScriptCargoList_StationAccepting(StationID station_id);
|
||||
};
|
||||
|
@@ -46,7 +46,7 @@ public:
|
||||
static char *GetName(EngineID engine_id);
|
||||
|
||||
/**
|
||||
* Get the cargo-type of an engine. In case it can transport multiple cargos, it
|
||||
* Get the cargo-type of an engine. In case it can transport multiple cargoes, it
|
||||
* returns the first/main.
|
||||
* @param engine_id The engine to get the cargo-type of.
|
||||
* @pre IsValidEngine(engine_id).
|
||||
@@ -82,7 +82,7 @@ public:
|
||||
static bool CanPullCargo(EngineID engine_id, CargoID cargo_id);
|
||||
|
||||
/**
|
||||
* Get the capacity of an engine. In case it can transport multiple cargos, it
|
||||
* Get the capacity of an engine. In case it can transport multiple cargoes, it
|
||||
* returns the first/main.
|
||||
* @param engine_id The engine to get the capacity of.
|
||||
* @pre IsValidEngine(engine_id).
|
||||
|
@@ -231,14 +231,14 @@ public:
|
||||
char *GetName();
|
||||
|
||||
/**
|
||||
* Get the cargo-type of the offered engine. In case it can transport multiple cargos, it
|
||||
* Get the cargo-type of the offered engine. In case it can transport multiple cargoes, it
|
||||
* returns the first/main.
|
||||
* @return The cargo-type of the engine.
|
||||
*/
|
||||
CargoID GetCargoType();
|
||||
|
||||
/**
|
||||
* Get the capacity of the offered engine. In case it can transport multiple cargos, it
|
||||
* Get the capacity of the offered engine. In case it can transport multiple cargoes, it
|
||||
* returns the first/main.
|
||||
* @return The capacity of the engine.
|
||||
*/
|
||||
|
@@ -45,7 +45,7 @@ public:
|
||||
|
||||
/**
|
||||
* Get a list of CargoID possible produced by this industry-type.
|
||||
* @warning This function only returns the default cargos of the industry type.
|
||||
* @warning This function only returns the default cargoes of the industry type.
|
||||
* Industries can specify new cargotypes on construction.
|
||||
* @param industry_type The type to get the CargoIDs for.
|
||||
* @pre IsValidIndustryType(industry_type).
|
||||
@@ -55,7 +55,7 @@ public:
|
||||
|
||||
/**
|
||||
* Get a list of CargoID accepted by this industry-type.
|
||||
* @warning This function only returns the default cargos of the industry type.
|
||||
* @warning This function only returns the default cargoes of the industry type.
|
||||
* Industries can specify new cargotypes on construction.
|
||||
* @param industry_type The type to get the CargoIDs for.
|
||||
* @pre IsValidIndustryType(industry_type).
|
||||
|
Reference in New Issue
Block a user