OpenTTD
Public Member Functions | Data Fields
StoryPage Struct Reference

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

#include <story_base.h>

Inheritance diagram for StoryPage:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_pool >

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 NULL 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 size, void *ptr)
 Allocates space for new Titem at given memory address.
void operator delete (void *p)
 Marks Titem as free.

Data Fields

uint32 sort_value
 A number that increases for every created story page. Used for sorting. The id of a story page is the pool index.
Date date
 Date when the page was created.
CompanyByte company
 StoryPage is for a specific company; INVALID_COMPANY if it is global.
char * 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

- 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-NULL) 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.

Detailed Description

Struct about stories, current and completed.

Definition at line 70 of file story_base.h.


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