summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsmatz <smatz@openttd.org>2009-07-01 18:18:12 +0000
committersmatz <smatz@openttd.org>2009-07-01 18:18:12 +0000
commitaaeb53066dff98cac2d66d1f02f545d14c9f650c (patch)
tree08e6f70fb68c84ea6acc1a811566a12180340c7d
parent973adfe98a5eb87fb7ea45289a00606c5b495da7 (diff)
downloadopenttd-aaeb53066dff98cac2d66d1f02f545d14c9f650c.tar.xz
(svn r16713) -Doc: document the Subsidy struct
-rw-r--r--src/subsidy_type.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/subsidy_type.h b/src/subsidy_type.h
index 8aa6738a4..734a9c87c 100644
--- a/src/subsidy_type.h
+++ b/src/subsidy_type.h
@@ -8,12 +8,12 @@
#include "cargo_type.h"
#include "company_type.h"
+/** Struct about subsidies, both offered and awarded */
struct Subsidy {
- CargoID cargo_type;
- byte age;
- /* from and to can either be TownID, StationID or IndustryID */
- uint16 from;
- uint16 to;
+ CargoID cargo_type; ///< Cargo type involved in this subsidy, CT_INVALID for invalid subsidy
+ byte age; ///< Subsidy age; < 12 is unawarded, >= 12 is awarded
+ uint16 from; ///< Index of source. Either TownID, IndustryID or StationID, when awarded.
+ uint16 to; ///< Index of destination. Either TownID, IndustryID or StationID, when awarded.
};
extern Subsidy _subsidies[MAX_COMPANIES];