StoryPage Struct Reference

Struct about stories, current and completed. More...

#include <story_base.h>

Inheritance diagram for StoryPage:

Public Member Functions
	StoryPage ()
	We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
	~StoryPage ()
	(Empty) destructor has to be defined else operator delete might be called with nullptr parameter
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >
void *	operator new (size_t size)
	Allocates space for new Titem.
void *	operator new (size_t size, size_t index)
	Allocates space for new Titem with given index.
void *	operator new (size_t, void *ptr)
	Allocates space for new Titem at given memory address.
void	operator delete (void *p)
	Marks Titem as free.

Data Fields
uint32_t	sort_value
	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
	StoryPage is for a specific company; INVALID_COMPANY if it is global.
std::string	title
	Title of story page.
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >
Tindex	index
	Index of this pool item.

Additional Inherited Members
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >	Pool
	Type of the pool this item is going to be part of.
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >
static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no.
static bool	IsValidID (size_t index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem *	Get (size_t index)
	Returns Titem with given index.
static Titem *	GetIfValid (size_t index)
	Returns Titem with given index.
static size_t	GetPoolSize ()
	Returns first unused index.
static size_t	GetNumItems ()
	Returns number of valid items in the pool.
static void	PostDestructor (size_t index)
	Dummy function called after destructor of each member.
static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem.

Detailed Description

Struct about stories, current and completed.

Definition at line 164 of file story_base.h.

Constructor & Destructor Documentation

StoryPage()

StoryPage::StoryPage ( )

inline

We need an (empty) constructor so struct isn't zeroed (as C++ standard states)

Definition at line 174 of file story_base.h.

~StoryPage()

StoryPage::~StoryPage ( )

inline

(Empty) destructor has to be defined else operator delete might be called with nullptr parameter

Definition at line 179 of file story_base.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >::CleaningPool(), and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_element_pool >::Iterate().

Field Documentation

company

CompanyID StoryPage::company

StoryPage is for a specific company; INVALID_COMPANY if it is global.

Definition at line 167 of file story_base.h.

Referenced by CmdCreateStoryPage(), 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 CmdCreateStoryPage(), CmdSetStoryPageDate(), and StoryBookWindow::DrawWidget().

sort_value

uint32_t StoryPage::sort_value

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 CmdCreateStoryPage(), STPAChunkHandler::Load(), and StoryBookWindow::PageOrderSorter().

title

std::string StoryPage::title

Title of story page.

Definition at line 169 of file story_base.h.

Referenced by CmdCreateStoryPage(), CmdSetStoryPageTitle(), StoryBookWindow::DrawWidget(), StoryBookWindow::GetHeadHeight(), StoryBookWindow::RefreshSelectedPage(), StoryBookWindow::SetStringParameters(), and StoryBookWindow::UpdateWidgetSize().

---

The documentation for this struct was generated from the following file:

• src/story_base.h