(svn r15101) -Change [API CHANGE]: more consistant naming for consts:

INVALID_TOWN_RATING        -> TOWN_RATING_INVALID
   INVALID_TRANSPORT          -> TRANSPORT_INVALID
   INVALID_ORDER              -> ORDER_INVALID
   INVALID_GROUP              -> GROUP_INVALID
   GROUP_ALL/DEFAULT          -> ALL/DEFAULT_GROUP
   VEHICLE_RAIL/ROAD/..       -> VT_RAIL/ROAD/..
   MY_COMPANY                 -> COMPANY_SELF
   FIRST/LAST/INVALID_COMPANY -> COMPANY_FIRST/LAST/INVALID
This commit is contained in:
truebrain
2009-01-16 00:05:26 +00:00
parent 5119132dda
commit 94dd36d1ec
32 changed files with 206 additions and 195 deletions

View File

@@ -81,7 +81,7 @@ public:
TOWN_RATING_VERY_GOOD, ///< The company got an very good rating in the town.
TOWN_RATING_EXCELLENT, ///< The company got an excellent rating in the town.
TOWN_RATING_OUTSTANDING, ///< The company got an outstanding rating in the town.
INVALID_TOWN_RATING = -1, ///< The town rating for invalid towns/companies.
TOWN_RATING_INVALID = -1, ///< The town rating for invalid towns/companies.
};
/**
@@ -228,7 +228,7 @@ public:
* @param town_id The town to check.
* @pre IsValidTown(town_id).
* @return The company that has the exclusive rights. The value
* AICompany::INVALID_COMPANY means that there are currently no
* AICompany::COMPANY_INVALID means that there are currently no
* exclusive rights given out to anyone.
*/
static AICompany::CompanyID GetExclusiveRightsCompany(TownID town_id);
@@ -267,7 +267,7 @@ public:
* @param town_id The town to get the rating for.
* @param company_id The company to get the rating for.
* @pre IsValidTown(town_id).
* @pre AICompany.ResolveCompanyID(company) != AICompany::INVALID_COMPANY.
* @pre AICompany.ResolveCompanyID(company) != AICompany::COMPANY_INVALID.
* @return The rating as shown to humans.
*/
static TownRating GetRating(TownID town_id, AICompany::CompanyID company_id);