ScummVM API documentation
Ultima::Ultima8::Archive Class Referenceabstract
Inheritance diagram for Ultima::Ultima8::Archive:
Ultima::Ultima8::MusicFlex Ultima::Ultima8::RawArchive Ultima::Ultima8::ShapeArchive Ultima::Ultima8::SoundFlex Ultima::Ultima8::UsecodeFlex Ultima::Ultima8::FontShapeArchive Ultima::Ultima8::GumpShapeArchive Ultima::Ultima8::MainShapeArchive Ultima::Ultima8::MouseShapeArchive Ultima::Ultima8::SpeechFlex

Public Member Functions

 Archive ()
 create Archive without any input sources
 
 Archive (Common::SeekableReadStream *rs)
 
bool addSource (FlexFile *af)
 
bool addSource (Common::SeekableReadStream *rs)
 add input source, autodetecting the type (as the constructor)
 
void cache ()
 Cache all objects.
 
virtual void cache (uint32 index)=0
 Cache a single object. More...
 
void uncache ()
 
virtual void uncache (uint32 index)=0
 
virtual bool isCached (uint32 index) const =0
 Check if an object is cached. More...
 
uint32 getCount () const
 

Protected Member Functions

uint8 * getRawObject (uint32 index, uint32 *sizep=0)
 
uint32 getRawSize (uint32 index) const
 

Protected Attributes

uint32 _count
 

Constructor & Destructor Documentation

◆ Archive()

Ultima::Ultima8::Archive::Archive ( Common::SeekableReadStream *  rs)
explicit

create Archive with a single input source, autodetecting the type Will create FlexFile; ids will be deleted.

Member Function Documentation

◆ addSource()

bool Ultima::Ultima8::Archive::addSource ( FlexFile *  af)

add input source. FlexFile will be deleted on destruction Input sources are used in the reversed order they are added. Effect of adding sources after having accessed objects is undef.

◆ cache()

virtual void Ultima::Ultima8::Archive::cache ( uint32  index)
pure virtual

◆ uncache() [1/2]

void Ultima::Ultima8::Archive::uncache ( )

Uncache all objects Potentially dangerous: all stored objects will be deleted; make sure they are no longer in use.

◆ uncache() [2/2]

virtual void Ultima::Ultima8::Archive::uncache ( uint32  index)
pure virtual

◆ isCached()

virtual bool Ultima::Ultima8::Archive::isCached ( uint32  index) const
pure virtual

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