FixedGRFFileProps< Tcount > Struct Template Reference

Fixed-length list of sprite groups for an entity. More...

#include <newgrf_commons.h>

Inheritance diagram for FixedGRFFileProps< Tcount >:

Public Member Functions
const struct SpriteGroup *	GetSpriteGroup (size_t index=0) const
	Get the SpriteGroup at the specified index.
void	SetSpriteGroup (size_t index, const struct SpriteGroup *spritegroup)
	Set the SpriteGroup at the specified index.
Public Member Functions inherited from GRFFilePropsBase
void	SetGRFFile (const struct GRFFile *grffile)
	Set the NewGRF file, and its grfid, associated with grf props.
bool	HasGrfFile () const
	Test if this entity was introduced by NewGRF.

Data Fields
std::array< const struct SpriteGroup *, Tcount >	spritegroups {}
	pointers to the different sprite groups of the entity
Data Fields inherited from GRFFilePropsBase
uint16_t	local_id = 0
	id defined by the grf file for this entity
uint32_t	grfid = 0
	grfid that introduced this entity.
const struct GRFFile *	grffile = nullptr
	grf file that introduced this entity

Detailed Description

template<size_t Tcount>
struct FixedGRFFileProps< Tcount >

Fixed-length list of sprite groups for an entity.

Template Parameters

Tcount

Number of spritegroups

Definition at line 311 of file newgrf_commons.h.

Member Function Documentation

GetSpriteGroup()

template<size_t Tcount>

const struct SpriteGroup * FixedGRFFileProps< Tcount >::GetSpriteGroup ( size_t  index = 0 ) const

inline

Get the SpriteGroup at the specified index.

Parameters

index

Index to get.

Returns

SpriteGroup at index, or nullptr if not present.

Definition at line 319 of file newgrf_commons.h.

References FixedGRFFileProps< Tcount >::spritegroups.

Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), DoTriggerIndustryTile(), DrawHouseInGUI(), GetAirportTileIDAtOffset(), GetFoundation_Town(), GetIndustryIDAtOffset(), HouseResolverObject::HouseResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), and ObjectResolverObject::ObjectResolverObject().

SetSpriteGroup()

template<size_t Tcount>

void FixedGRFFileProps< Tcount >::SetSpriteGroup ( size_t  index, const struct SpriteGroup *  spritegroup  )

inline

Set the SpriteGroup at the specified index.

Parameters

index	Index to set.
spritegroup	SpriteGroup to set.

Definition at line 326 of file newgrf_commons.h.

References FixedGRFFileProps< Tcount >::spritegroups.

Field Documentation

spritegroups

template<size_t Tcount>

std::array<const struct SpriteGroup *, Tcount> FixedGRFFileProps< Tcount >::spritegroups {}

pointers to the different sprite groups of the entity

Definition at line 312 of file newgrf_commons.h.

Referenced by FixedGRFFileProps< Tcount >::GetSpriteGroup(), and FixedGRFFileProps< Tcount >::SetSpriteGroup().

---

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

• src/newgrf_commons.h