NGRFChunkHandler Struct Reference

Inheritance diagram for NGRFChunkHandler:

Public Member Functions
void	SaveParameters (const GRFConfig &config) const
void	Save () const override
	Save the chunk.
void	LoadParameters (GRFConfig &config) const
void	LoadCommon (GRFConfigList &grfconfig) const
void	Load () const override
	Load the chunk.
void	LoadCheck (size_t) const override
	Load the chunk for game preview.
Public Member Functions inherited from ChunkHandler
	ChunkHandler (uint32_t id, ChunkType type)
virtual	~ChunkHandler ()=default
	Ensure the destructor of the sub classes are called as well.
virtual void	FixPointers () const
	Fix the pointers.
std::string	GetName () const

Static Public Attributes
static std::array< uint32_t, GRFConfig::MAX_NUM_PARAMS >	param
static uint8_t	num_params
static const SaveLoad	description []

Additional Inherited Members
Data Fields inherited from ChunkHandler
uint32_t	id
	Unique ID (4 letters).
ChunkType	type
	Type of the chunk.

Detailed Description

Definition at line 64 of file newgrf_sl.cpp.

Constructor & Destructor Documentation

NGRFChunkHandler()

NGRFChunkHandler::NGRFChunkHandler ( )

inline

Definition at line 65 of file newgrf_sl.cpp.

Member Function Documentation

Load()

void NGRFChunkHandler::Load ( ) const

inlineoverridevirtual

Load the chunk.

Must be overridden.

Implements ChunkHandler.

Definition at line 123 of file newgrf_sl.cpp.

References _grfconfig, AppendStaticGRFConfigs(), Menu, ResetGRFConfig(), and SlErrorCorrupt().

LoadCheck()

void NGRFChunkHandler::LoadCheck ( size_t len ) const

inlineoverridevirtual

Load the chunk for game preview.

Default implementation just skips the data.

Parameters

len	Number of bytes to skip.

Reimplemented from ChunkHandler.

Definition at line 139 of file newgrf_sl.cpp.

References _load_check_data.

LoadCommon()

void NGRFChunkHandler::LoadCommon ( GRFConfigList & grfconfig ) const

inline

Definition at line 109 of file newgrf_sl.cpp.

LoadParameters()

void NGRFChunkHandler::LoadParameters ( GRFConfig & config ) const

inline

Definition at line 102 of file newgrf_sl.cpp.

Save()

void NGRFChunkHandler::Save ( ) const

inlineoverridevirtual

Save the chunk.

Must be overridden, unless Chunk type is ChunkType::ReadOnly.

Reimplemented from ChunkHandler.

Definition at line 88 of file newgrf_sl.cpp.

References _grfconfig, SlObject(), and SlTableHeader().

SaveParameters()

void NGRFChunkHandler::SaveParameters ( const GRFConfig & config ) const

inline

Definition at line 80 of file newgrf_sl.cpp.

Field Documentation

description

const SaveLoad NGRFChunkHandler::description[]

inlinestatic

Initial value:

                                       = {
     SLE_SSTR(GRFConfig, filename,         VarTypes::STR),
      SLE_VAR(GRFConfig, ident.grfid,      VarTypes::U32),
      SLE_ARR(GRFConfig, ident.md5sum,     VarTypes::U8,  16),
  SLE_CONDVAR(GRFConfig, version, VarTypes::U32, SaveLoadVersion::StoreNewGRFVersion, SaveLoadVersion::MaxVersion),
     SLEG_ARR("param", param,              VarTypes::U32, std::size(param)),
     SLEG_VAR("num_params", num_params,    VarTypes::U8),
  SLE_CONDVAR(GRFConfig, palette, VarTypes::U8, SaveLoadVersion::NewGRFPalette, SaveLoadVersion::MaxVersion),
}

Definition at line 70 of file newgrf_sl.cpp.

num_params

uint8_t NGRFChunkHandler::num_params

inlinestatic

Definition at line 68 of file newgrf_sl.cpp.

param

std::array<uint32_t, GRFConfig::MAX_NUM_PARAMS> NGRFChunkHandler::param

inlinestatic

Definition at line 67 of file newgrf_sl.cpp.

---

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

• src/saveload/newgrf_sl.cpp