Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Win32LocalFileSystem Class Reference

#include <Win32LocalFileSystem.h>

Inherits LocalFileSystem.

Public Member Functions

 Win32LocalFileSystem ()
 
virtual ~Win32LocalFileSystem ()
 
virtual void init ()
 
virtual void reset ()
 
virtual void update ()
 
virtual FileopenFile (const Char *filename, Int access=0)
 open the given file.
 
virtual Bool doesFileExist (const Char *filename) const
 does the given file exist?
 
virtual 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.
 
virtual Bool getFileInfo (const AsciiString &filename, FileInfo *fileInfo) const
 see FileSystem.h
 
virtual Bool createDirectory (AsciiString directory)
 see FileSystem.h
 
- Public Member Functions inherited from LocalFileSystem
virtual ~LocalFileSystem ()
 
- Public Member Functions inherited from SubsystemInterface
 SubsystemInterface ()
 
virtual ~SubsystemInterface ()
 
virtual void postProcessLoad ()
 
virtual void draw (void)
 
void UPDATE (void)
 
void DRAW (void)
 
AsciiString getName (void)
 
void setName (AsciiString name)
 

Additional Inherited Members

- Protected Attributes inherited from SubsystemInterface
AsciiString m_name
 

Detailed Description

Definition at line 35 of file Win32LocalFileSystem.h.

Constructor & Destructor Documentation

◆ Win32LocalFileSystem()

Win32LocalFileSystem::Win32LocalFileSystem ( )

Definition at line 37 of file Win32LocalFileSystem.cpp.

◆ ~Win32LocalFileSystem()

Win32LocalFileSystem::~Win32LocalFileSystem ( )
virtual

Definition at line 41 of file Win32LocalFileSystem.cpp.

Member Function Documentation

◆ createDirectory()

Bool Win32LocalFileSystem::createDirectory ( AsciiString directory)
virtual

see FileSystem.h

Implements LocalFileSystem.

Definition at line 208 of file Win32LocalFileSystem.cpp.

◆ doesFileExist()

Bool Win32LocalFileSystem::doesFileExist ( const Char * filename) const
virtual

does the given file exist?

Implements LocalFileSystem.

Definition at line 115 of file Win32LocalFileSystem.cpp.

◆ getFileInfo()

Bool Win32LocalFileSystem::getFileInfo ( const AsciiString & filename,
FileInfo * fileInfo ) const
virtual

see FileSystem.h

Implements LocalFileSystem.

Definition at line 188 of file Win32LocalFileSystem.cpp.

◆ getFileListInDirectory()

void Win32LocalFileSystem::getFileListInDirectory ( const AsciiString & currentDirectory,
const AsciiString & originalDirectory,
const AsciiString & searchName,
FilenameList & filenameList,
Bool searchSubdirectories ) const
virtual

search the given directory for files matching the searchName (egs. *.ini, *.rep). Possibly search subdirectories.

Implements LocalFileSystem.

Definition at line 124 of file Win32LocalFileSystem.cpp.

◆ init()

void Win32LocalFileSystem::init ( )
virtual
  • Assign any default values to data required for the class
    • Allocate any memory and resources needed throughout the lifetime of the class

Implements LocalFileSystem.

Definition at line 106 of file Win32LocalFileSystem.cpp.

◆ openFile()

File * Win32LocalFileSystem::openFile ( const Char * filename,
Int access = 0 )
virtual

open the given file.

Implements LocalFileSystem.

Definition at line 45 of file Win32LocalFileSystem.cpp.

◆ reset()

void Win32LocalFileSystem::reset ( )
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 LocalFileSystem.

Definition at line 110 of file Win32LocalFileSystem.cpp.

◆ update()

void Win32LocalFileSystem::update ( )
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 LocalFileSystem.

Definition at line 102 of file Win32LocalFileSystem.cpp.


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