OpenTTD Source  12.0-beta2
FileWriter Struct Reference

Yes, simply writing to a file. More...

Inheritance diagram for FileWriter:
SaveFilter HeaderFileWriter LanguageFileWriter

Public Member Functions

 FileWriter (FILE *file)
 Create the file writer, so it writes to a specific file. More...
 
 ~FileWriter ()
 Make sure everything is cleaned up.
 
void Write (byte *buf, size_t size) override
 Write a given number of bytes into the savegame. More...
 
void Finish () override
 Prepare everything to finish writing the savegame.
 
 FileWriter (const char *filename)
 Open a file to write to. More...
 
void Finalise ()
 Finalise the writing.
 
virtual ~FileWriter ()
 Make sure the file is closed.
 
- Public Member Functions inherited from SaveFilter
 SaveFilter (SaveFilter *chain)
 Initialise this filter. More...
 
virtual ~SaveFilter ()
 Make sure the writers are properly closed.
 

Data Fields

FILE * file
 The file to write to.
 
FILE * fh
 The file handle we're writing to.
 
const char * filename
 The file name we're writing to.
 
- Data Fields inherited from SaveFilter
SaveFilterchain
 Chained to the (savegame) filters.
 

Detailed Description

Yes, simply writing to a file.

Base class for writing data to disk.

Definition at line 2380 of file saveload.cpp.

Constructor & Destructor Documentation

◆ FileWriter() [1/2]

FileWriter::FileWriter ( FILE *  file)
inline

Create the file writer, so it writes to a specific file.

Parameters
fileThe file to write to.

Definition at line 2387 of file saveload.cpp.

◆ FileWriter() [2/2]

FileWriter::FileWriter ( const char *  filename)
inline

Open a file to write to.

Parameters
filenameThe file to open.

Definition at line 246 of file strgen.cpp.

References filename, and stredup().

Member Function Documentation

◆ Write()

void FileWriter::Write ( byte *  buf,
size_t  len 
)
inlineoverridevirtual

Write a given number of bytes into the savegame.

Parameters
bufThe bytes to write.
lenThe number of bytes to write.

Implements SaveFilter.

Definition at line 2400 of file saveload.cpp.

References SlError().


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