summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_object.hpp
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-01 09:24:19 +0000
committerrubidium <rubidium@openttd.org>2011-05-01 09:24:19 +0000
commit70c7ec30b1c10bc4502a14e45555fff7a310fca4 (patch)
tree2d4cb9bbe8cba6a7eea42d5695a4901edbe316c6 /src/ai/api/ai_object.hpp
parentabc235253752a5c182ef0bcc28df7d1d6369d149 (diff)
downloadopenttd-70c7ec30b1c10bc4502a14e45555fff7a310fca4.tar.xz
(svn r22396) -Document: some AI doxygen stuff
Diffstat (limited to 'src/ai/api/ai_object.hpp')
-rw-r--r--src/ai/api/ai_object.hpp1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/ai/api/ai_object.hpp b/src/ai/api/ai_object.hpp
index 06d0f9edb..e928bef23 100644
--- a/src/ai/api/ai_object.hpp
+++ b/src/ai/api/ai_object.hpp
@@ -148,6 +148,7 @@ protected:
* from CanSuspend() if the reason we are not allowed
* to execute a DoCommand is in squirrel and not the API.
* In that case use this function to restore the previous value.
+ * @return True iff DoCommands are allowed in the current scope.
*/
static bool GetAllowDoCommand();