Struct to store engine replacements. More...

#include <autoreplace_base.h>

Inheritance diagram for EngineRenew:

Public Member Functions
	EngineRenew (EngineID from=INVALID_ENGINE, EngineID to=INVALID_ENGINE)

Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_enginerenew_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
EngineID	from

EngineID	to

EngineRenew *	next

GroupID	group_id

bool	replace_when_old
	Do replacement only when vehicle is old.

Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_enginerenew_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<&_enginerenew_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<&_enginerenew_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 to store engine replacements.

DO NOT USE outside of engine.c. Is placed here so the only exception to this rule, the saveload code, can use it.

Definition at line 33 of file autoreplace_base.h.

Constructor & Destructor Documentation

◆ EngineRenew()

EngineRenew::EngineRenew	(	EngineID	from = `INVALID_ENGINE`,
		EngineID	to = `INVALID_ENGINE`
	)

inline

Definition at line 40 of file autoreplace_base.h.

◆ ~EngineRenew()

EngineRenew::~EngineRenew ( )

inline

Definition at line 41 of file autoreplace_base.h.

Field Documentation

◆ from

EngineID EngineRenew::from

Definition at line 34 of file autoreplace_base.h.

◆ group_id

GroupID EngineRenew::group_id

Definition at line 37 of file autoreplace_base.h.

◆ next

EngineRenew* EngineRenew::next

Definition at line 36 of file autoreplace_base.h.

◆ replace_when_old

bool EngineRenew::replace_when_old

Do replacement only when vehicle is old.

Definition at line 38 of file autoreplace_base.h.

Referenced by AddEngineReplacement(), and EngineReplacement().

◆ to

EngineID EngineRenew::to

Definition at line 35 of file autoreplace_base.h.

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

src/autoreplace_base.h

Public Member Functions

Data Fields

Additional Inherited Members