xoreos  0.0.5
Public Member Functions | List of all members
Aurora::KEYDataFile Class Referenceabstract

#include <keydatafile.h>

Inheritance diagram for Aurora::KEYDataFile:
Inheritance graph
[legend]
Collaboration diagram for Aurora::KEYDataFile:
Collaboration graph
[legend]

Public Member Functions

virtual ~KEYDataFile ()
 
virtual void mergeKEY (const KEYFile &key, uint32 dataFileIndex)=0
 Merge information from the KEY into the data file. More...
 
- Public Member Functions inherited from Aurora::Archive
 Archive ()
 
virtual ~Archive ()
 
virtual const ResourceListgetResources () const =0
 Return the list of resources. More...
 
virtual uint32 getResourceSize (uint32 index) const
 Return the size of a resource. More...
 
virtual Common::SeekableReadStreamgetResource (uint32 index, bool tryNoCopy=false) const =0
 Return a stream of the resource's contents. More...
 
virtual Common::HashAlgo getNameHashAlgo () const
 Return with which algorithm the name is hashed. More...
 
uint32 findResource (uint64 hash) const
 Return the index of the resource matching the hash, or 0xFFFFFFFF if not found. More...
 
uint32 findResource (const Common::UString &name, FileType type) const
 Return the index of the resource matching the name and type, or 0xFFFFFFFF if not found. More...
 

Additional Inherited Members

- Public Types inherited from Aurora::Archive
typedef std::list< ResourceResourceList
 

Detailed Description

Definition at line 36 of file keydatafile.h.

Constructor & Destructor Documentation

◆ ~KEYDataFile()

virtual Aurora::KEYDataFile::~KEYDataFile ( )
inlinevirtual

Definition at line 38 of file keydatafile.h.

Member Function Documentation

◆ mergeKEY()

virtual void Aurora::KEYDataFile::mergeKEY ( const KEYFile key,
uint32  dataFileIndex 
)
pure virtual

Merge information from the KEY into the data file.

Without this step, this data file archive does not contain any resource names at all.

Parameters
keyA KEYFile with information about this data file.
dataFileIndexThe index this data file has within the KEY file.

Implemented in Aurora::BIFFile, and Aurora::BZFFile.


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