OpenTTD
Public Member Functions | Data Fields
StoryPageElement Struct Reference

Struct about story page elements. More...

#include <story_base.h>

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

Public Member Functions

 StoryPageElement ()
 We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 
 ~StoryPageElement ()
 (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_element_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t size, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 

Data Fields

uint32 sort_value
 A number that increases for every created story page element. Used for sorting. The id of a story page element is the pool index.
 
StoryPageID page
 Id of the page which the page element belongs to.
 
StoryPageElementTypeByte type
 Type of page element.
 
uint32 referenced_id
 Id of referenced object (location, goal etc.)
 
char * text
 Static content text of page element.
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_story_page_element_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_element_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-NULL) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor (size_t index)
 Dummy function called after destructor of each member. More...
 

Detailed Description

Struct about story page elements.

Each StoryPage is composed of one or more page elements that provide page content. Each element only contain one type of content.

Definition at line 47 of file story_base.h.


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