dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r20284) -Codechange: use ///< for single-line doxygen comments in the AI code

Browse Source
This commit is contained in:
yexo
2010-08-01 19:36:36 +00:00
parent ed4f806f1d
commit 99cb47a382
24 changed files with 250 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
src/ai/api/ai_order.hpp
View File

@@ -87,13 +87,13 @@ public:
*/
enum OrderCondition {
/* Order _is_ important, as it's based on OrderConditionVariable in order_type.h. */
OC_LOAD_PERCENTAGE, //!< Skip based on the amount of load, value is in tons.
OC_RELIABILITY, //!< Skip based on the reliability, value is percent (0..100).
OC_MAX_SPEED, //!< Skip based on the maximum speed, value is in OpenTTD's internal speed unit, see AIEngine::GetMaxSpeed.
OC_AGE, //!< Skip based on the age, value is in years.
OC_REQUIRES_SERVICE, //!< Skip when the vehicle requires service, no value.
OC_UNCONDITIONALLY, //!< Always skip, no compare function, no value.
OC_INVALID = -1, //!< An invalid condition, do not use.
OC_LOAD_PERCENTAGE, ///< Skip based on the amount of load, value is in tons.
OC_RELIABILITY, ///< Skip based on the reliability, value is percent (0..100).
OC_MAX_SPEED, ///< Skip based on the maximum speed, value is in OpenTTD's internal speed unit, see AIEngine::GetMaxSpeed.
OC_AGE, ///< Skip based on the age, value is in years.
OC_REQUIRES_SERVICE, ///< Skip when the vehicle requires service, no value.
OC_UNCONDITIONALLY, ///< Always skip, no compare function, no value.
OC_INVALID = -1, ///< An invalid condition, do not use.
};
/**
@@ -101,29 +101,29 @@ public:
*/
enum CompareFunction {
/* Order _is_ important, as it's based on OrderConditionComparator in order_type.h. */
CF_EQUALS, //!< Skip if both values are equal
CF_NOT_EQUALS, //!< Skip if both values are not equal
CF_LESS_THAN, //!< Skip if the value is less than the limit
CF_LESS_EQUALS, //!< Skip if the value is less or equal to the limit
CF_MORE_THAN, //!< Skip if the value is more than the limit
CF_MORE_EQUALS, //!< Skip if the value is more or equal to the limit
CF_IS_TRUE, //!< Skip if the variable is true
CF_IS_FALSE, //!< Skip if the variable is false
CF_INVALID = -1, //!< Invalid compare function, do not use.
CF_EQUALS, ///< Skip if both values are equal
CF_NOT_EQUALS, ///< Skip if both values are not equal
CF_LESS_THAN, ///< Skip if the value is less than the limit
CF_LESS_EQUALS, ///< Skip if the value is less or equal to the limit
CF_MORE_THAN, ///< Skip if the value is more than the limit
CF_MORE_EQUALS, ///< Skip if the value is more or equal to the limit
CF_IS_TRUE, ///< Skip if the variable is true
CF_IS_FALSE, ///< Skip if the variable is false
CF_INVALID = -1, ///< Invalid compare function, do not use.
};
/** Different constants related to the OrderPosition */
enum OrderPosition {
ORDER_CURRENT = 0xFF, //!< Constant that gets resolved to the current order.
ORDER_INVALID = -1, //!< An invalid order.
ORDER_CURRENT = 0xFF, ///< Constant that gets resolved to the current order.
ORDER_INVALID = -1, ///< An invalid order.
};
/** Where to stop trains in a station that's longer than the train */
enum StopLocation {
STOPLOCATION_NEAR, //!< Stop the train as soon as it's completely in the station
STOPLOCATION_MIDDLE, //!< Stop the train in the middle of the station
STOPLOCATION_FAR, //!< Stop the train at the far end of the station
STOPLOCATION_INVALID = -1, //!< An invalid stop location
STOPLOCATION_NEAR, ///< Stop the train as soon as it's completely in the station
STOPLOCATION_MIDDLE, ///< Stop the train in the middle of the station
STOPLOCATION_FAR, ///< Stop the train at the far end of the station
STOPLOCATION_INVALID = -1, ///< An invalid stop location
};
/**