diff -r 9abe20fc83e5 -r 2541c2d325ed src/ai/api/ai_base.hpp --- a/src/ai/api/ai_base.hpp Mon Mar 31 06:48:59 2008 +0000 +++ b/src/ai/api/ai_base.hpp Mon Mar 31 07:21:39 2008 +0000 @@ -11,12 +11,10 @@ * Class that handles some basic functions. * * @note The random functions are not called Random and RandomRange, because - * when including them the RANDOM_DEBUG stuff messes with their names. - * However, because in MP we cannot use Random because that will cause - * desyncs (AIs are ran locally, not on all clients). This means that - * we use InteractiveRandom in MP, thus the whole random debugging is - * pointless for the AIs. Therefor the random functions are called - * differently. + * RANDOM_DEBUG does some tricky stuff, which messes with those names. + * @note In MP we cannot use Random because that will cause desyncs (AIs are + * ran on the server only, not on all clients). This means that + * we use InteractiveRandom in MP. Rand() takes care of this for you. */ class AIBase : public AIObject { public: @@ -24,38 +22,38 @@ /** * Get a random value. - * @return a random value between 0 and MAX(uint32). + * @return A random value between 0 and MAX(uint32). */ static uint32 Rand(); /** * Get a random value. * @param unused_param This param is not used, but is needed to work with lists. - * @return a random value between 0 and MAX(uint32). + * @return A random value between 0 and MAX(uint32). */ static uint32 RandItem(int unused_param); /** * Get a random value in a range. - * @param max the maximum value it will return. - * @return a random value between 0 .. max. + * @param max The maximum value it will return. + * @return A random value between 0 .. max. */ static uint RandRange(uint max); /** * Get a random value in a range. * @param unused_param This param is not used, but is needed to work with lists. - * @param max the maximum value it will return. - * @return a random value between 0 .. max. + * @param max The maximum value it will return. + * @return A random value between 0 .. max. */ static uint RandRangeItem(int unused_param, uint max); /** * Returns approximatelly 'out' times true when called 'max' times. * After all, it is a random function. - * @param out how many times it should return true. - * @param max out of this many times. - * @return true if the chance worked out. + * @param out How many times it should return true. + * @param max Out of this many times. + * @return True if the chance worked out. */ static bool Chance(uint out, uint max); @@ -63,9 +61,9 @@ * Returns approximatelly 'out' times true when called 'max' times. * After all, it is a random function. * @param unused_param This param is not used, but is needed to work with lists. - * @param out how many times it should return true. - * @param max out of this many times. - * @return true if the chance worked out. + * @param out How many times it should return true. + * @param max Out of this many times. + * @return True if the chance worked out. */ static bool ChanceItem(int unused_param, uint out, uint max); };