summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryexo <yexo@openttd.org>2010-07-31 22:46:29 +0000
committeryexo <yexo@openttd.org>2010-07-31 22:46:29 +0000
commit33ccd9ada8dbc2984a189e4d2f1b8602f4575fa3 (patch)
treed64fa790f24143370786aba390304c0ca11b7e69
parent6d4900ed7c1631c40aec59cab9c11881107456a5 (diff)
downloadopenttd-33ccd9ada8dbc2984a189e4d2f1b8602f4575fa3.tar.xz
(svn r20272) -Doc: [NoAI] document return value of AIGroup::SetAutoReplace
-rw-r--r--src/ai/api/ai_group.hpp1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/ai/api/ai_group.hpp b/src/ai/api/ai_group.hpp
index 06b51e481..adfd93df9 100644
--- a/src/ai/api/ai_group.hpp
+++ b/src/ai/api/ai_group.hpp
@@ -150,6 +150,7 @@ public:
* @param engine_id_new The engine id to replace with.
* @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL.
* @pre AIEngine.IsBuildable(engine_id_new).
+ * @return True if and if the replacing was successfully started.
* @note To stop autoreplacing engine_id_old, call StopAutoReplace(group_id, engine_id_old).
*/
static bool SetAutoReplace(GroupID group_id, EngineID engine_id_old, EngineID engine_id_new);