src/ai/api/ai_cargo.hpp
branchnoai
changeset 9427 ef0c109c5661
parent 9425 8eec6d10844a
child 9447 8f3c1bc72204
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/ai/api/ai_cargo.hpp	Thu Mar 15 22:28:14 2007 +0000
@@ -0,0 +1,50 @@
+/* $Id$ */
+
+/** @file ai_cargo.hpp Everything to query about cargos */
+
+#ifndef AI_CARGO_HPP
+#define AI_CARGO_HPP
+
+#include "ai_object.hpp"
+
+class AICargo : public AIObject {
+public:
+	/**
+	 * Gets the string representation of the cargo label
+	 * @param cargo_type to get the string representation of
+	 * @return the cargo label
+	 * @note the returned cargo label must be freed
+	 */
+	char *GetCargoLabel(CargoID cargo_type);
+
+	/**
+	 * Checks whether the give cargo is a freight or not
+	 * @param cargo_type is this cargo freight or not?
+	 * @return true if and only if the cargo is freight
+	 */
+	bool IsFreight(CargoID cargo_type);
+
+	/**
+	 * Get the income for transporting a piece of cargo over the
+	 * given distance within the specified time.
+	 * @param distance        the distance the cargo travels from begin to end
+	 * @param days_in_transit amount of (game) days the cargo is in transit
+	 * @param cargo_type      the cargo to transport
+	 * @return the amount of money that would be made by this trip
+	 */
+	int32 GetCargoIncome(uint32 distance, uint32 days_in_transit, CargoID cargo_type);
+};
+
+#ifdef DEFINE_SQUIRREL_CLASS
+void SQAICargoRegister(Squirrel *engine) {
+	DefSQClass <AICargo> SQAICargo("AICargo");
+	SQAICargo.PreRegister(engine);
+	SQAICargo.AddConstructor(engine);
+	SQAICargo.DefSQFunction(engine, &AICargo::GetCargoLabel,  "GetCargoLabel");
+	SQAICargo.DefSQFunction(engine, &AICargo::IsFreight,      "IsFreight");
+	SQAICargo.DefSQFunction(engine, &AICargo::GetCargoIncome, "GetCargoIncome");
+	SQAICargo.PostRegister(engine);
+}
+#endif /* SQUIRREL_CLASS */
+
+#endif /* AI_CARGO_HPP */