OpenTTD
Public Member Functions | Data Fields
FileReader Struct Reference

Yes, simply reading from a file. More...

Inheritance diagram for FileReader:
LoadFilter

Public Member Functions

 FileReader (FILE *file)
 Create the file reader, so it reads from a specific file.
 ~FileReader ()
 Make sure everything is cleaned up.
size_t Read (byte *buf, size_t size)
 Read a given number of bytes from the savegame.
void Reset ()
 Reset this filter to read from the beginning of the file.
- Public Member Functions inherited from LoadFilter
 LoadFilter (LoadFilter *chain)
 Initialise this filter.
virtual ~LoadFilter ()
 Make sure the writers are properly closed.

Data Fields

FILE * file
 The file to read from.
long begin
 The begin of the file.
- Data Fields inherited from LoadFilter
LoadFilterchain
 Chained to the (savegame) filters.

Detailed Description

Yes, simply reading from a file.

Definition at line 1886 of file saveload.cpp.

Constructor & Destructor Documentation

FileReader::FileReader ( FILE *  file)
inline

Create the file reader, so it reads from a specific file.

Parameters
fileThe file to read from.

Definition at line 1894 of file saveload.cpp.

FileReader::~FileReader ( )
inline

Make sure everything is cleaned up.

Definition at line 1899 of file saveload.cpp.

References file, and SaveLoadParams::sf.

Member Function Documentation

size_t FileReader::Read ( byte *  buf,
size_t  len 
)
inlinevirtual

Read a given number of bytes from the savegame.

Parameters
bufThe bytes to read.
lenThe number of bytes to read.
Returns
The number of actually read bytes.

Implements LoadFilter.

Definition at line 1908 of file saveload.cpp.

References file.


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