ScummVM API documentation
Public Member Functions | List of all members
Wintermute::PackageSet Class Reference
Inheritance diagram for Wintermute::PackageSet:
Common::Archive

Public Member Functions

 PackageSet (Common::FSNode package, const Common::String &filename="", bool searchSignature=false)
 
bool hasFile (const Common::Path &path) const override
 
int listMembers (Common::ArchiveMemberList &list) const override
 
const Common::ArchiveMemberPtr getMember (const Common::Path &path) const override
 
Common::SeekableReadStream * createReadStreamForMember (const Common::Path &path) const override
 
int getPriority () const
 
uint32 getVersion () const
 
- Public Member Functions inherited from Common::Archive
virtual bool isPathDirectory (const Path &path) const
 
virtual int listMatchingMembers (ArchiveMemberList &list, const Path &pattern, bool matchPathComponents=false) const
 
virtual SeekableReadStream * createReadStreamForMemberAltStream (const Path &path, AltStreamType altStreamType) const
 
virtual SeekableReadStream * createReadStreamForMemberNext (const Path &path, const Archive *starting) const
 
Common::Error dumpArchive (const Path &destPath)
 
virtual char getPathSeparator () const
 

Member Function Documentation

◆ hasFile()

bool Wintermute::PackageSet::hasFile ( const Common::Path &  path) const
overridevirtual

Check if a member with the given name is present in the Archive. Patterns are not allowed, as this is meant to be a quick File::exists() replacement.

Implements Common::Archive.

◆ listMembers()

int Wintermute::PackageSet::listMembers ( Common::ArchiveMemberList &  list) const
overridevirtual

Add all members of the Archive to list. Must only append to list, and not remove elements from it.

Returns
the number of names added to list

Implements Common::Archive.

◆ getMember()

const Common::ArchiveMemberPtr Wintermute::PackageSet::getMember ( const Common::Path &  path) const
overridevirtual

Returns a ArchiveMember representation of the given file.

Implements Common::Archive.

◆ createReadStreamForMember()

Common::SeekableReadStream* Wintermute::PackageSet::createReadStreamForMember ( const Common::Path &  path) const
overridevirtual

Create a stream bound to a member with the specified name in the archive. If no member with this name exists, 0 is returned.

Returns
the newly created input stream

Implements Common::Archive.

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