FIFE::VFSDirectory Class Reference
#include <vfsdirectory.h>
Public Member Functions | |
| VFSDirectory (VFS *vfs, const std::string &root="./") | |
| virtual | ~VFSDirectory () |
| virtual bool | fileExists (const std::string &filename) const |
| virtual RawData * | open (const std::string &filename) const |
| std::set< std::string > | listFiles (const std::string &path) const |
| std::set< std::string > | listDirectories (const std::string &path) const |
Detailed Description
The most basic VFSSource for "normal" filesystems. For example, '/' or './tests/data'.
Uses boost_filesystem to achieve Plattform independancy. This also means you have to use slashes as directory separators.
Definition at line 44 of file vfsdirectory.h.
Constructor & Destructor Documentation
| FIFE::VFSDirectory::VFSDirectory | ( | VFS * | vfs, | |
| const std::string & | root = "./" | |||
| ) |
Constructor Creates the given file system's VFS Source, Uses boost_filesystem to achieve Plattform independancy.
Definition at line 65 of file vfsdirectory.cpp.
| FIFE::VFSDirectory::~VFSDirectory | ( | ) | [virtual] |
Destructor
Definition at line 72 of file vfsdirectory.cpp.
Member Function Documentation
| bool FIFE::VFSDirectory::fileExists | ( | const std::string & | filename | ) | const [virtual] |
Tests whether a file can be opened.
- Parameters:
-
filename The file to test.
- Returns:
- True, if the file filename can be opened.
Implements FIFE::VFSSource.
Definition at line 76 of file vfsdirectory.cpp.
| std::set< std::string > FIFE::VFSDirectory::listDirectories | ( | const std::string & | path | ) | const [virtual] |
List directories in a directory
- Parameters:
-
path The directory to list the directories in
- Returns:
- A string list of directories Will return an empty list on any error
Implements FIFE::VFSSource.
Definition at line 93 of file vfsdirectory.cpp.
| std::set< std::string > FIFE::VFSDirectory::listFiles | ( | const std::string & | path | ) | const [virtual] |
List files in a directory
- Parameters:
-
path The directory to list the files in
- Returns:
- A string list of filenames Will return an empty list on any error
Implements FIFE::VFSSource.
Definition at line 89 of file vfsdirectory.cpp.
| RawData * FIFE::VFSDirectory::open | ( | const std::string & | filename | ) | const [virtual] |
Opens a file.
- Parameters:
-
filename The file to open.
Implements FIFE::VFSSource.
Definition at line 85 of file vfsdirectory.cpp.
The documentation for this class was generated from the following files:
- engine/core/vfs/vfsdirectory.h
- engine/core/vfs/vfsdirectory.cpp
