(svn r16713) -Doc: document the Subsidy struct

This commit is contained in:
smatz 2009-07-01 18:18:12 +00:00
parent 973adfe98a
commit aaeb53066d
1 changed files with 5 additions and 5 deletions

View File

@ -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];