OpenTTD Source 20241224-master-gee860a5c8e
LeagueTable Struct Reference

Struct about custom league tables. More...

#include <league_base.h>

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

Public Member Functions

 LeagueTable ()
 We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
 
 ~LeagueTable ()
 (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<&_league_table_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

std::string title
 Title of the table.
 
std::string header
 Text to show above the table.
 
std::string footer
 Text to show below the table.
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_league_table_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<&_league_table_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<&_league_table_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 custom league tables.

Definition at line 52 of file league_base.h.

Constructor & Destructor Documentation

◆ LeagueTable()

LeagueTable::LeagueTable ( )
inline

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

Definition at line 60 of file league_base.h.

◆ ~LeagueTable()

LeagueTable::~LeagueTable ( )
inline

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

Definition at line 65 of file league_base.h.

Field Documentation

◆ footer

std::string LeagueTable::footer

Text to show below the table.

Definition at line 55 of file league_base.h.

Referenced by CmdCreateLeagueTable().

◆ header

std::string LeagueTable::header

Text to show above the table.

Definition at line 54 of file league_base.h.

Referenced by CmdCreateLeagueTable().

◆ title

std::string LeagueTable::title

Title of the table.

Definition at line 53 of file league_base.h.

Referenced by CmdCreateLeagueTable().


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