diff options
Diffstat (limited to 'src/script/api/script_cargo.hpp')
| -rw-r--r-- | src/script/api/script_cargo.hpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/script/api/script_cargo.hpp b/src/script/api/script_cargo.hpp index ab1e1ea74..9379392b4 100644 --- a/src/script/api/script_cargo.hpp +++ b/src/script/api/script_cargo.hpp @@ -17,7 +17,7 @@ /** * Class that handles all cargo related functions. */ -class AICargo : public AIObject { +class ScriptCargo : public ScriptObject { public: /** * The classes of cargo (from newgrf_cargo.h). @@ -72,7 +72,7 @@ public: /** * Gets the string representation of the cargo label. * @param cargo_type The cargo to get the string representation of. - * @pre AICargo::IsValidCargo(cargo_type). + * @pre ScriptCargo::IsValidCargo(cargo_type). * @return The cargo label. * @note Never use this to check if it is a certain cargo. NewGRF can * redefine all of the names. @@ -84,7 +84,7 @@ public: * This defines whether the "freight train weight multiplier" will apply to * trains transporting this cargo. * @param cargo_type The cargo to check on. - * @pre AICargo::IsValidCargo(cargo_type). + * @pre ScriptCargo::IsValidCargo(cargo_type). * @return True if and only if the cargo is freight. */ static bool IsFreight(CargoID cargo_type); @@ -92,7 +92,7 @@ public: /** * Check if this cargo is in the requested cargo class. * @param cargo_type The cargo to check on. - * @pre AICargo::IsValidCargo(cargo_type). + * @pre ScriptCargo::IsValidCargo(cargo_type). * @param cargo_class The class to check for. * @return True if and only if the cargo is in the cargo class. */ @@ -101,7 +101,7 @@ public: /** * Get the effect this cargo has on a town. * @param cargo_type The cargo to check on. - * @pre AICargo::IsValidCargo(cargo_type). + * @pre ScriptCargo::IsValidCargo(cargo_type). * @return The effect this cargo has on a town, or TE_NONE if it has no effect. */ static TownEffect GetTownEffect(CargoID cargo_type); @@ -110,7 +110,7 @@ public: * Get the income for transporting a piece of cargo over the * given distance within the specified time. * @param cargo_type The cargo to transport. - * @pre AICargo::IsValidCargo(cargo_type). + * @pre ScriptCargo::IsValidCargo(cargo_type). * @param distance The distance the cargo travels from begin to end. * @param days_in_transit Amount of (game) days the cargo is in transit. The max value of this variable is 637. Any value higher returns the same as 637 would. * @return The amount of money that would be earned by this trip. |