summaryrefslogtreecommitdiff
path: root/src/script/api/script_story_page.hpp
diff options
context:
space:
mode:
authorzuu <zuu@openttd.org>2013-06-09 12:57:22 +0000
committerzuu <zuu@openttd.org>2013-06-09 12:57:22 +0000
commit33ad9774fb7c51f1ec706851c7a96a7ced5ff622 (patch)
treeaf64b06f63d6168eef04bf09172732f6af896027 /src/script/api/script_story_page.hpp
parenta49a4eec6e9b9fd7a9520af882a38697dd3a0ed3 (diff)
downloadopenttd-33ad9774fb7c51f1ec706851c7a96a7ced5ff622.tar.xz
(svn r25352) -Feature: GameScript API for selecting a story page to view
Diffstat (limited to 'src/script/api/script_story_page.hpp')
-rw-r--r--src/script/api/script_story_page.hpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/script/api/script_story_page.hpp b/src/script/api/script_story_page.hpp
index b013f2515..d026650be 100644
--- a/src/script/api/script_story_page.hpp
+++ b/src/script/api/script_story_page.hpp
@@ -129,6 +129,17 @@ public:
static bool SetTitle(StoryPageID story_page_id, Text *title);
/**
+ * Opens the Story Book if not yet open and selects the given page.
+ * @param story_page_id The story page to update. If it is a global page, clients of all
+ * companies are affecetd. Otherwise only the clients of the company which the page belongs
+ * to are affected.
+ * @return True if the action succeeded.
+ * @pre No ScriptCompanyMode may be in scope.
+ * @pre IsValidStoryPage(story_page_id).
+ */
+ static bool Show(StoryPageID story_page_id);
+
+ /**
* Remove a story page from the list.
* @param story_page_id The story page to remove.
* @return True if the action succeeded.