Win32BIGFileSystem Class Reference

#include <Win32BIGFileSystem.h>

Inherits ArchiveFileSystem.

Public Member Functions
	Win32BIGFileSystem ()
virtual	~Win32BIGFileSystem ()
virtual void	init (void)
virtual void	update (void)
virtual void	reset (void)
virtual void	postProcessLoad (void)
virtual void	closeAllArchiveFiles (void)
	Close all Archivefiles currently open.
virtual ArchiveFile *	openArchiveFile (const Char *filename)
	Create new or return existing Archive file from file name.
virtual void	closeArchiveFile (const Char *filename)
	Close the one specified big file.
virtual void	closeAllFiles (void)
	Close all files associated with ArchiveFiles.
virtual Bool	loadBigFilesFromDirectory (AsciiString dir, AsciiString fileMask, Bool overwrite=FALSE)
Public Member Functions inherited from ArchiveFileSystem
	ArchiveFileSystem ()
virtual	~ArchiveFileSystem ()
virtual File *	openFile (const Char *filename, Int access=0)
	Search Archive files for specified file name and open it if found.
virtual Bool	doesFileExist (const Char *filename) const
	return true if that file exists in an archive file somewhere.
void	getFileListInDirectory (const AsciiString &currentDirectory, const AsciiString &originalDirectory, const AsciiString &searchName, FilenameList &filenameList, Bool searchSubdirectories) const
	search the given directory for files matching the searchName (egs. *.ini, *.rep). Possibly search subdirectories. Scans each Archive file.
Bool	getFileInfo (const AsciiString &filename, FileInfo *fileInfo) const
	see FileSystem.h
AsciiString	getArchiveFilenameForFile (const AsciiString &filename) const
void	loadMods (void)
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Additional Inherited Members
Protected Member Functions inherited from ArchiveFileSystem
virtual void	loadIntoDirectoryTree (const ArchiveFile *archiveFile, const AsciiString &archiveFilename, Bool overwrite=FALSE)
	load the archive file's header information and apply it to the global archive directory tree.
Protected Attributes inherited from ArchiveFileSystem
ArchiveFileMap	m_archiveFileMap
ArchivedDirectoryInfo	m_rootDirectory
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 36 of file Win32BIGFileSystem.h.

Constructor & Destructor Documentation

Win32BIGFileSystem()

Win32BIGFileSystem::Win32BIGFileSystem

(

)

Definition at line 49 of file Win32BIGFileSystem.cpp.

~Win32BIGFileSystem()

Win32BIGFileSystem::~Win32BIGFileSystem ( )

virtual

Definition at line 52 of file Win32BIGFileSystem.cpp.

Member Function Documentation

closeAllArchiveFiles()

void Win32BIGFileSystem::closeAllArchiveFiles ( void )

virtual

Close all Archivefiles currently open.

Implements ArchiveFileSystem.

Definition at line 208 of file Win32BIGFileSystem.cpp.

closeAllFiles()

void Win32BIGFileSystem::closeAllFiles ( void )

virtual

Close all files associated with ArchiveFiles.

Implements ArchiveFileSystem.

Definition at line 211 of file Win32BIGFileSystem.cpp.

closeArchiveFile()

void Win32BIGFileSystem::closeArchiveFile ( const Char * filename )

virtual

Close the one specified big file.

Implements ArchiveFileSystem.

Definition at line 187 of file Win32BIGFileSystem.cpp.

init()

void Win32BIGFileSystem::init ( void )

virtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements ArchiveFileSystem.

Definition at line 55 of file Win32BIGFileSystem.cpp.

loadBigFilesFromDirectory()

Bool Win32BIGFileSystem::loadBigFilesFromDirectory ( AsciiString dir, AsciiString fileMask, Bool overwrite = FALSE )

virtual

Implements ArchiveFileSystem.

Definition at line 214 of file Win32BIGFileSystem.cpp.

openArchiveFile()

ArchiveFile * Win32BIGFileSystem::openArchiveFile ( const Char * filename )

virtual

Create new or return existing Archive file from file name.

Implements ArchiveFileSystem.

Definition at line 85 of file Win32BIGFileSystem.cpp.

postProcessLoad()

void Win32BIGFileSystem::postProcessLoad ( void )

virtual

• Called for all subsystems after all other Subsystems are inited. (allows for initializing inter-system dependencies)

Implements ArchiveFileSystem.

Definition at line 82 of file Win32BIGFileSystem.cpp.

reset()

void Win32BIGFileSystem::reset ( void )

virtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements ArchiveFileSystem.

Definition at line 76 of file Win32BIGFileSystem.cpp.

update()

void Win32BIGFileSystem::update ( void )

virtual

• Update methods are the place to do system per frame processing. You should call the system update once each time through the game loop to service the system.
  • Note that currently the GameClient and GameLogic will be updating at different rates where the logic is running real time, and the client will adjust how many loops can be done during one server time slice in order to improve performance on low end machines.

Implements ArchiveFileSystem.

Definition at line 79 of file Win32BIGFileSystem.cpp.

---

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

• Code/GameEngineDevice/Include/Win32Device/Common/Win32BIGFileSystem.h
• Code/GameEngineDevice/Source/Win32Device/Common/Win32BIGFileSystem.cpp