summaryrefslogtreecommitdiff
path: root/src/script/api/script_goal.hpp
diff options
context:
space:
mode:
authorzuu <zuu@openttd.org>2013-02-10 19:49:04 +0000
committerzuu <zuu@openttd.org>2013-02-10 19:49:04 +0000
commitb1016f66ba199966d7f1487a51113329b0ca786d (patch)
tree107b2d05cb04ef41ba55f2fecf9daac0ce5ac205 /src/script/api/script_goal.hpp
parente27582d104c7bbcf987c5320edce94d84b6e59f7 (diff)
downloadopenttd-b1016f66ba199966d7f1487a51113329b0ca786d.tar.xz
(svn r24986) -Change: Cleanup goals and cargo monitors of companies when they go bankrupt or are taken over.
Diffstat (limited to 'src/script/api/script_goal.hpp')
-rw-r--r--src/script/api/script_goal.hpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/script/api/script_goal.hpp b/src/script/api/script_goal.hpp
index deca0bd3f..a8511e0d6 100644
--- a/src/script/api/script_goal.hpp
+++ b/src/script/api/script_goal.hpp
@@ -17,6 +17,11 @@
/**
* Class that handles some goal related functions.
+ *
+ * Goals are saved and loaded. Upon bankruptcy or company takeover, all company
+ * specific goals are removed for that company. You can also remove individual
+ * goals using #Remove.
+ *
* @api game
*/
class ScriptGoal : public ScriptObject {