(svn r13428) [NoAI] -Fix r13427: if you do something, do it right (RandRangeItem of course has the same 'problem') noai
authortruebrain
Sun, 08 Jun 2008 23:12:44 +0000
branchnoai
changeset 10877 bf7154962a83
parent 10876 63ac5bfb1a84
child 10878 6e4f60c7d18c
(svn r13428) [NoAI] -Fix r13427: if you do something, do it right (RandRangeItem of course has the same 'problem')
src/ai/api/ai_base.hpp
--- a/src/ai/api/ai_base.hpp	Sun Jun 08 23:10:34 2008 +0000
+++ b/src/ai/api/ai_base.hpp	Sun Jun 08 23:12:44 2008 +0000
@@ -43,8 +43,8 @@
 	/**
 	 * 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 first number this function will never return (the maximum it returns is max - 1).
+	 * @return A random value between 0 .. max - 1.
 	 */
 	static uint RandRangeItem(int unused_param, uint max);