summaryrefslogtreecommitdiff
path: root/src/script/api
diff options
context:
space:
mode:
authorzuu <zuu@openttd.org>2014-02-06 19:24:01 +0000
committerzuu <zuu@openttd.org>2014-02-06 19:24:01 +0000
commitebcc8462b7d09d36ff74843748ab5277a81bc409 (patch)
tree7c7ba0455eed2b5b2fbdaca1c00d2d41dc333336 /src/script/api
parentfa7eb6dc8c49d5c96ed7000b75a5fe546cbadb38 (diff)
downloadopenttd-ebcc8462b7d09d36ff74843748ab5277a81bc409.tar.xz
(svn r26302) -Doc: [nogo] ScriptStory::Remove does remove both the page and its elements
Diffstat (limited to 'src/script/api')
-rw-r--r--src/script/api/script_story_page.hpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/script/api/script_story_page.hpp b/src/script/api/script_story_page.hpp
index b98864e16..149ac55b8 100644
--- a/src/script/api/script_story_page.hpp
+++ b/src/script/api/script_story_page.hpp
@@ -140,7 +140,8 @@ public:
static bool Show(StoryPageID story_page_id);
/**
- * Remove a story page from the list.
+ * Remove a story page and all the page elements
+ * associated with it.
* @param story_page_id The story page to remove.
* @return True if the action succeeded.
* @pre No ScriptCompanyMode may be in scope.