Changes between Version 1 and Version 2 of Exposed_VFS_Functions
- Timestamp:
- May 4, 2014, 6:48:27 AM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Exposed_VFS_Functions
v1 v2 10 10 These stateless functions provide basic file system access within the VFS sandbox. Expected use is in map/saved game selection dialogs; more complex tasks should utilize the complete vfs.h native code interface. 11 11 12 == buildFileList ==12 == !BuildFileList == 13 13 * '''Overview:''' 14 14 * Return an array of pathname strings, one for each matching entry in the specified directory. 15 15 * '''Syntax:''' 16 * pathnames = buildFileList(directory [, filter_string [, recurse]]);16 * pathnames = Engine.!BuildFileList(directory [, filter_string [, recurse]]); 17 17 * '''Parameters:''' 18 18 * directory: VFS path … … 24 24 * Full pathnames of each file/subdirectory are returned, ready for use as a "filename" for the other functions. 25 25 26 == getFileMTime == 26 == !FileExists == 27 * '''Overview:''' 28 * Return true iff the specified file exits. 29 * '''Syntax:''' 30 * filexists = Engine.!FileExists(filename); 31 * '''Parameters:''' 32 * filename: VFS filename (may include path) 33 * '''Returns:''' 34 * true iff file exists, false otherwise 35 * '''Notes:''' 36 37 == GetFileMTime == 27 38 * '''Overview:''' 28 39 * Return time [seconds since 1970] of the last modification to the specified file. 29 40 * '''Syntax:''' 30 * mtime = getFileMTime(filename);41 * mtime = Engine.GetFileMTime(filename); 31 42 * '''Parameters:''' 32 43 * filename: VFS filename (may include path) … … 35 46 * '''Notes:''' 36 47 37 == getFileSize ==48 == !GetFileSize == 38 49 * '''Overview:''' 39 50 * Return current size of file. 40 51 * '''Syntax:''' 41 * size = getFileSize(filename);52 * size = Engine.!GetFileSize(filename); 42 53 * '''Parameters:''' 43 54 * filename: VFS filename (may include path) … … 46 57 * '''Notes:''' 47 58 48 == readFile ==59 == !ReadFile == 49 60 * '''Overview:''' 50 61 * Return file contents in a string. 51 62 * '''Syntax:''' 52 * contents = readFile(filename);63 * contents = Engine.!ReadFile(filename); 53 64 * '''Parameters:''' 54 65 * filename: VFS filename (may include path) … … 57 68 * '''Notes:''' 58 69 59 == readFileLines ==70 == !ReadFileLines == 60 71 * '''Overview:''' 61 72 * Return file contents as an array of lines. 62 73 * '''Syntax:''' 63 * lines = readFileLines(filename);74 * lines = Engine.!ReadFileLines(filename); 64 75 * '''Parameters:''' 65 76 * filename: VFS filename (may include path)
