TranslationWriter Struct Reference

Class for writing an encoded language. More...

Inheritance diagram for TranslationWriter:

Public Member Functions
	TranslationWriter (StringList &strings)
	Writer for the encoded data.
void	WriteHeader (const LanguagePackHeader *) override
	Write the header metadata.
void	Finalise () override
	Finalise writing the file.
void	WriteLength (uint) override
	Write the length as a simple gamma.
void	Write (const uint8_t *buffer, size_t length) override
	Write a number of bytes.
Public Member Functions inherited from LanguageWriter
virtual	~LanguageWriter ()=default
	Especially destroy the subclasses.
virtual void	WriteLang (const StringData &data)
	Actually write the language.

Data Fields
StringList &	strings
	The encoded strings.

Detailed Description

Class for writing an encoded language.

Definition at line 111 of file game_text.cpp.

Constructor & Destructor Documentation

TranslationWriter()

TranslationWriter::TranslationWriter ( StringList &  strings )

inline

Writer for the encoded data.

Parameters

strings

The string table to add the strings to.

Definition at line 118 of file game_text.cpp.

Member Function Documentation

Finalise()

void TranslationWriter::Finalise ( )

inlineoverridevirtual

Finalise writing the file.

Implements LanguageWriter.

Definition at line 127 of file game_text.cpp.

Write()

void TranslationWriter::Write ( const uint8_t *  buffer, size_t  length  )

inlineoverridevirtual

Write a number of bytes.

Parameters

buffer	The buffer to write.
length	The amount of byte to write.

Implements LanguageWriter.

Definition at line 137 of file game_text.cpp.

WriteHeader()

void TranslationWriter::WriteHeader ( const LanguagePackHeader *  header )

inlineoverridevirtual

Write the header metadata.

The multi-byte integers are already converted to the little endian format.

Parameters

header

The header to write.

Implements LanguageWriter.

Definition at line 122 of file game_text.cpp.

WriteLength()

void TranslationWriter::WriteLength ( uint  length )

inlineoverridevirtual

Write the length as a simple gamma.

Parameters

length

The number to write.

Reimplemented from LanguageWriter.

Definition at line 132 of file game_text.cpp.

Field Documentation

strings

StringList& TranslationWriter::strings

The encoded strings.

Definition at line 112 of file game_text.cpp.

---

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

• src/game/game_text.cpp