Struct about stories, current and completed. More...
#include <story_base.h>
Public Member Functions | |
| StoryPage (StoryPageID index) | |
| StoryPage (StoryPageID index, uint32_t sort_value, TimerGameCalendar::Date date, CompanyID company, const EncodedString &title) | |
Data Fields | |
| uint32_t | sort_value = 0 |
| A number that increases for every created story page. Used for sorting. The id of a story page is the pool index. | |
| TimerGameCalendar::Date | date {} |
| Date when the page was created. | |
| CompanyID | company = CompanyID::Invalid() |
| StoryPage is for a specific company; CompanyID::Invalid() if it is global. | |
| EncodedString | title |
| Title of story page. | |
Detailed Description
Struct about stories, current and completed.
Definition at line 164 of file story_base.h.
Constructor & Destructor Documentation
◆ StoryPage() [1/2]
|
inline |
Definition at line 171 of file story_base.h.
◆ StoryPage() [2/2]
|
inline |
Definition at line 172 of file story_base.h.
◆ ~StoryPage()
Field Documentation
◆ company
| CompanyID StoryPage::company = CompanyID::Invalid() |
StoryPage is for a specific company; CompanyID::Invalid() if it is global.
Definition at line 167 of file story_base.h.
Referenced by CmdShowStoryPage(), and CmdStoryPageButton().
◆ date
| TimerGameCalendar::Date StoryPage::date {} |
Date when the page was created.
Definition at line 166 of file story_base.h.
Referenced by CmdSetStoryPageDate(), and StoryBookWindow::DrawWidget().
◆ sort_value
| uint32_t StoryPage::sort_value = 0 |
A number that increases for every created story page. Used for sorting. The id of a story page is the pool index.
Definition at line 165 of file story_base.h.
Referenced by STPAChunkHandler::Load(), and StoryBookWindow::PageOrderSorter().
◆ title
| EncodedString StoryPage::title |
Title of story page.
Definition at line 169 of file story_base.h.
Referenced by CmdSetStoryPageTitle(), StoryBookWindow::DrawWidget(), StoryBookWindow::GetHeadHeight(), StoryBookWindow::GetWidgetString(), StoryBookWindow::RefreshSelectedPage(), and StoryBookWindow::UpdateWidgetSize().
The documentation for this struct was generated from the following files:
- src/story_base.h
- src/story.cpp
