Aurora::ERFFile::ERFHeader Struct Reference

The header of an ERF file. More...

Collaboration diagram for Aurora::ERFFile::ERFHeader:

Public Member Functions
	ERFHeader ()
	~ERFHeader ()
void	clear ()
void	clearStringTable ()
bool	isSensible (size_t fileSize=SIZE_MAX)

Public Attributes
uint32	resCount
	Number of resources in this ERF. More...
uint32	langCount
	Number of language strings in the description. More...
uint32	descriptionID
	ID of the description. More...
uint32	offDescription
	Offset to the description. More...
uint32	offKeyList
	Offset to the key list. More...
uint32	offResList
	Offset to the resource list. More...
uint32	descriptionSize
	Number of bytes in the description structure. More...
uint32	buildYear
	The year the ERF was built. More...
uint32	buildDay
	The day of year the ERF was built. More...
bool	isNWNPremium
	Is this a Neverwinter Nights premium module? More...
Common::ScopedArray< char >	stringTable
	String table used for hashed ERFs. More...
uint32	stringTableSize
	Size of the string table. More...
uint32	moduleID
	ID of the module this ERF belongs to. More...
Encryption	encryption
	The encryption algorithm in use. More...
Compression	compression
	The compression algorithm in use. More...
std::vector< byte >	passwordDigest
	Digest of the encryption password, if any. More...

Detailed Description

The header of an ERF file.

Definition at line 163 of file erffile.h.

Constructor & Destructor Documentation

ERFHeader()

Aurora::ERFFile::ERFHeader::ERFHeader

(

)

Definition at line 94 of file erffile.cpp.

References clear().

Here is the call graph for this function:

~ERFHeader()

Aurora::ERFFile::ERFHeader::~ERFHeader

(

)

Definition at line 98 of file erffile.cpp.

Member Function Documentation

clear()

void Aurora::ERFFile::ERFHeader::clear

(

)

Definition at line 101 of file erffile.cpp.

References Aurora::ERFFile::kCompressionNone, and Aurora::ERFFile::kEncryptionNone.

Referenced by ERFHeader(), and Aurora::ERFFile::readERFHeader().

Here is the caller graph for this function:

clearStringTable()

void Aurora::ERFFile::ERFHeader::clearStringTable

(

)

Definition at line 126 of file erffile.cpp.

Referenced by Aurora::ERFFile::load(), and Aurora::ERFFile::readV30Header().

Here is the caller graph for this function:

isSensible()

bool Aurora::ERFFile::ERFHeader::isSensible

(

size_t

fileSize = SIZE_MAX

)

Definition at line 132 of file erffile.cpp.

Referenced by Aurora::ERFFile::decryptNWNPremiumHeader(), and Aurora::ERFFile::readV11Header().

Here is the caller graph for this function:

Member Data Documentation

buildDay

uint32 Aurora::ERFFile::ERFHeader::buildDay

The day of year the ERF was built.

Definition at line 176 of file erffile.h.

Referenced by Aurora::ERFFile::getBuildDay(), Aurora::ERFFile::readV10Header(), Aurora::ERFFile::readV11Header(), Aurora::ERFFile::readV20Header(), Aurora::ERFFile::readV21Header(), and Aurora::ERFFile::readV22Header().

buildYear

uint32 Aurora::ERFFile::ERFHeader::buildYear

The year the ERF was built.

Definition at line 175 of file erffile.h.

Referenced by Aurora::ERFFile::getBuildYear(), Aurora::ERFFile::readV10Header(), Aurora::ERFFile::readV11Header(), Aurora::ERFFile::readV20Header(), Aurora::ERFFile::readV21Header(), and Aurora::ERFFile::readV22Header().

compression

Compression Aurora::ERFFile::ERFHeader::compression

The compression algorithm in use.

Definition at line 186 of file erffile.h.

Referenced by Aurora::ERFFile::decompress(), Aurora::ERFFile::getResource(), Aurora::ERFFile::readV21Header(), Aurora::ERFFile::readV22Header(), and Aurora::ERFFile::readV30Header().

descriptionID

uint32 Aurora::ERFFile::ERFHeader::descriptionID

ID of the description.

Definition at line 167 of file erffile.h.

Referenced by Aurora::ERFFile::readDescription(), Aurora::ERFFile::readV10Header(), and Aurora::ERFFile::readV11Header().

descriptionSize

uint32 Aurora::ERFFile::ERFHeader::descriptionSize

Number of bytes in the description structure.

Definition at line 173 of file erffile.h.

Referenced by Aurora::ERFFile::readV10Header(), and Aurora::ERFFile::readV11Header().

encryption

Encryption Aurora::ERFFile::ERFHeader::encryption

The encryption algorithm in use.

Definition at line 185 of file erffile.h.

Referenced by Aurora::ERFFile::decryptNWNPremium(), Aurora::ERFFile::getResource(), Aurora::ERFFile::load(), Aurora::ERFFile::readDescription(), Aurora::ERFFile::readERFHeader(), Aurora::ERFFile::readNWNPremiumHeader(), Aurora::ERFFile::readV11Header(), Aurora::ERFFile::readV22Header(), Aurora::ERFFile::readV30Header(), and Aurora::ERFFile::verifyPasswordDigest().

isNWNPremium

bool Aurora::ERFFile::ERFHeader::isNWNPremium

Is this a Neverwinter Nights premium module?

Definition at line 178 of file erffile.h.

Referenced by Aurora::ERFFile::readNWNPremiumHeader(), Aurora::ERFFile::readResources(), and Aurora::ERFFile::readV11Header().

langCount

uint32 Aurora::ERFFile::ERFHeader::langCount

Number of language strings in the description.

Definition at line 166 of file erffile.h.

Referenced by Aurora::ERFFile::readDescription(), Aurora::ERFFile::readV10Header(), and Aurora::ERFFile::readV11Header().

moduleID

uint32 Aurora::ERFFile::ERFHeader::moduleID

ID of the module this ERF belongs to.

Definition at line 183 of file erffile.h.

Referenced by Aurora::ERFFile::readV22Header(), and Aurora::ERFFile::readV30Header().

offDescription

uint32 Aurora::ERFFile::ERFHeader::offDescription

Offset to the description.

Definition at line 169 of file erffile.h.

Referenced by Aurora::ERFFile::readDescription(), Aurora::ERFFile::readV10Header(), and Aurora::ERFFile::readV11Header().

offKeyList

uint32 Aurora::ERFFile::ERFHeader::offKeyList

Offset to the key list.

Definition at line 170 of file erffile.h.

Referenced by Aurora::ERFFile::readV10Header(), Aurora::ERFFile::readV10KeyList(), Aurora::ERFFile::readV11Header(), and Aurora::ERFFile::readV11KeyList().

offResList

uint32 Aurora::ERFFile::ERFHeader::offResList

Offset to the resource list.

Definition at line 171 of file erffile.h.

Referenced by Aurora::ERFFile::readV10Header(), Aurora::ERFFile::readV10ResList(), Aurora::ERFFile::readV11Header(), Aurora::ERFFile::readV20Header(), Aurora::ERFFile::readV20ResList(), Aurora::ERFFile::readV21Header(), Aurora::ERFFile::readV21ResList(), Aurora::ERFFile::readV22Header(), Aurora::ERFFile::readV22ResList(), Aurora::ERFFile::readV30Header(), and Aurora::ERFFile::readV30ResList().

passwordDigest

std::vector<byte> Aurora::ERFFile::ERFHeader::passwordDigest

Digest of the encryption password, if any.

Definition at line 189 of file erffile.h.

Referenced by Aurora::ERFFile::readV22Header(), Aurora::ERFFile::readV30Header(), and Aurora::ERFFile::verifyPasswordDigest().

resCount

uint32 Aurora::ERFFile::ERFHeader::resCount

Number of resources in this ERF.

Definition at line 164 of file erffile.h.

Referenced by Aurora::ERFFile::readResources(), Aurora::ERFFile::readV10Header(), Aurora::ERFFile::readV11Header(), Aurora::ERFFile::readV20Header(), Aurora::ERFFile::readV21Header(), Aurora::ERFFile::readV22Header(), and Aurora::ERFFile::readV30Header().

stringTable

Common::ScopedArray<char> Aurora::ERFFile::ERFHeader::stringTable

String table used for hashed ERFs.

Definition at line 180 of file erffile.h.

Referenced by Aurora::ERFFile::readV30Header(), and Aurora::ERFFile::readV30ResList().

stringTableSize

uint32 Aurora::ERFFile::ERFHeader::stringTableSize

Size of the string table.

Definition at line 181 of file erffile.h.

Referenced by Aurora::ERFFile::readV30Header(), and Aurora::ERFFile::readV30ResList().

---

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

• src/aurora/erffile.h
• src/aurora/erffile.cpp