petern/OpenTTD
1
0
Fork 0
forked from mirror/OpenTTD
Code Pull Requests Activity

(svn r20272) -Doc: [NoAI] document return value of AIGroup::SetAutoReplace

Browse Source
This commit is contained in:
yexo
2010-07-31 22:46:29 +00:00
parent 6d4900ed7c
commit 33ccd9ada8
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/ai/api/ai_group.hpp
View File

@@ -150,6 +150,7 @@ public:
* @param engine_id_new The engine id to replace with. * @param engine_id_new The engine id to replace with.
* @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL. * @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL.
* @pre AIEngine.IsBuildable(engine_id_new). * @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). * @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); static bool SetAutoReplace(GroupID group_id, EngineID engine_id_old, EngineID engine_id_new);