Ultima::Shared::Resources Class Reference

#include <resources.h>

Inheritance diagram for Ultima::Shared::Resources:

Public Member Functions
	Resources ()
bool	open ()
void	addResource (const Common::Path &name, const byte *data, size_t size)
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
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
virtual bool	getChildren (const Common::Path &path, Common::Array< Common::String > &list, ListMode mode=kListDirectoriesOnly, bool hidden=true) const

Additional Inherited Members
Public Types inherited from Common::Archive
enum	ListMode { kListFilesOnly = 1, kListDirectoriesOnly = 2, kListAll = 3 }

Detailed Description

Resources manager

Constructor & Destructor Documentation

Resources()

Ultima::Shared::Resources::Resources ( )

inline

Constructor

Member Function Documentation

open()

bool Ultima::Shared::Resources::open

(

)

Sets up the resources for the engine

Returns

False if setup failed

addResource()

void Ultima::Shared::Resources::addResource	(	const Common::Path &	name,
		const byte *	data,
		size_t	size
	)

Adds a resource created in memory to the ScummVM archive manager, so that it can be later opened like a normal file. Just as it will when eventually shifted to the data file for the engine

hasFile()

bool Ultima::Shared::Resources::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 Ultima::Shared::Resources::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 Ultima::Shared::Resources::getMember ( const Common::Path &  path ) const

overridevirtual

Returns a ArchiveMember representation of the given file.

Implements Common::Archive.

createReadStreamForMember()

Common::SeekableReadStream* Ultima::Shared::Resources::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:

• engines/ultima/shared/engine/resources.h