dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r26303) -Add: [nogo] ScriptStoryPageList() - a list of all story pages

Browse Source
This commit is contained in:
zuu
2014-02-06 19:25:39 +00:00
parent 0317163f1b
commit a6e0f162ed
10 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/script/api/script_story_page.hpp
View File

@@ -118,6 +118,16 @@ public:
*/
static bool UpdateElement(StoryPageElementID story_page_element_id, uint32 reference, Text *text);
/**
* Get story page sort value. Each page has a sort value that is internally assigned and used
* to sort the pages in the story book. OpenTTD maintains this number so that the sort order
* is perceived. This API exist only so that you can sort ScriptStoryPageList the same order
* as in GUI. You should not use this number for anything else.
* @param story_page_id The story page to get the sort value of.
* @return Page sort value.
*/
static uint32 GetPageSort(StoryPageID story_page_id);
/**
* Update title of a story page. The title is shown in the page selector drop down.
* @param story_page_id The story page to update.