OpenTTD Source  12.0-beta2
ChunkHandler Struct Referenceabstract

Handlers and description of chunk. More...

#include <saveload.h>

Inheritance diagram for ChunkHandler:
AIPLChunkHandler ANITChunkHandler BKORChunkHandler CAPAChunkHandler CAPRChunkHandler CAPYChunkHandler CHKPChunkHandler CHTSChunkHandler CITYChunkHandler CMDLChunkHandler CMPUChunkHandler DATEChunkHandler DEPTChunkHandler ECMYChunkHandler EIDSChunkHandler ENGNChunkHandler ENGSChunkHandler ERNWChunkHandler GLOGChunkHandler GOALChunkHandler GRPSChunkHandler GSDTChunkHandler GSTRChunkHandler IBLDChunkHandler INDYChunkHandler ITBLChunkHandler LGRJChunkHandler LGRPChunkHandler LGRSChunkHandler M3HIChunkHandler M3LOChunkHandler MAP2ChunkHandler MAP5ChunkHandler MAP7ChunkHandler MAP8ChunkHandler MAPEChunkHandler MAPHChunkHandler MAPOChunkHandler MAPSChunkHandler MAPTChunkHandler NAMEChunkHandler NewGRFMappingChunkHandler NGRFChunkHandler OBJSChunkHandler OPTSChunkHandler ORDLChunkHandler ORDRChunkHandler PATSChunkHandler PLYRChunkHandler PRICChunkHandler PSACChunkHandler RAILChunkHandler ROADChunkHandler SIGNChunkHandler STNNChunkHandler STNSChunkHandler STPAChunkHandler STPEChunkHandler SUBSChunkHandler VEHSChunkHandler VIEWChunkHandler

Public Member Functions

 ChunkHandler (uint32 id, ChunkType type)
 
virtual void Save () const
 Save the chunk. More...
 
virtual void Load () const =0
 Load the chunk. More...
 
virtual void FixPointers () const
 Fix the pointers. More...
 
virtual void LoadCheck (size_t len=0) const
 Load the chunk for game preview. More...
 

Data Fields

uint32 id
 Unique ID (4 letters).
 
ChunkType type
 Type of the chunk. More...
 

Detailed Description

Handlers and description of chunk.

Definition at line 406 of file saveload.h.

Member Function Documentation

◆ FixPointers()

virtual void ChunkHandler::FixPointers ( ) const
inlinevirtual

Fix the pointers.

Pointers are saved using the index of the pointed object. On load, pointers are filled with indices and need to be fixed to point to the real object. Must be overridden if the chunk saves any pointer.

Reimplemented in VEHSChunkHandler, ROADChunkHandler, STNNChunkHandler, PLYRChunkHandler, STNSChunkHandler, LGRSChunkHandler, CITYChunkHandler, BKORChunkHandler, ORDLChunkHandler, CHKPChunkHandler, ORDRChunkHandler, CAPYChunkHandler, INDYChunkHandler, ERNWChunkHandler, DEPTChunkHandler, and OBJSChunkHandler.

Definition at line 432 of file saveload.h.

◆ Load()

◆ LoadCheck()

void ChunkHandler::LoadCheck ( size_t  len = 0) const
virtual

Load the chunk for game preview.

Default implementation just skips the data.

Parameters
lenNumber of bytes to skip.

Reimplemented in PLYRChunkHandler, GLOGChunkHandler, PATSChunkHandler, DATEChunkHandler, NGRFChunkHandler, and MAPSChunkHandler.

Definition at line 2116 of file saveload.cpp.

References _sl, and SaveLoadParams::block_mode.

◆ Save()

Field Documentation

◆ type

ChunkType ChunkHandler::type

Type of the chunk.

See also
ChunkType

Definition at line 408 of file saveload.h.

Referenced by SlSaveChunk().


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