[This is preliminary documentation and is subject to change.]
Contains fCraft path settings, and some filesystem-related utilities.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.2 (0.6.3.2)
Syntax
| C# |
public static class Paths
Members
| All Members | Fields  | Properties  | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| AnnouncementsFileName | |
| AutoRankFileName | |
| BackupPath | Path where map backups are stored. |
| BlockDBDirectory | |
| BlockDBPath | Directory where block database files (.fbdb) are stored. |
| Compare(String, String) | Checks whether two paths/file names reference the exact same filesystem location. Accounts for filesystem quirks. |
| Compare(String, String, Boolean) | Checks whether two paths/file names reference the exact same filesystem location.
Allows specifying whether comparison should be case-sensitive or not. |
| ConfigFileName | Path to load/save config to/from (default: .\config.xml)
Can be overridden at startup via command-line argument "--config=" |
| ConfigFileNameDefault | |
| Contains(String, String) | Checks whether childPath is inside parentPath. Accounts for filesystem quirks. |
| Contains(String, String, Boolean) | Checks whether childPath is inside parentPath. |
| DataBackupDirectory | |
| DataBackupFileNameFormat | |
| Exists(FileInfo, Boolean) | Checks whether the file exists in a specified way (case-sensitive or case-insensitive). |
| FileExists(String, Boolean) | Checks whether the file exists in a specified way (case-sensitive or case-insensitive) |
| FindFiles(String) | Find files that match the name in a case-insensitive way. |
| ForceRename(String, String) | Allows making changes to file name capitalization on case-insensitive filesystems. |
| GetDirectoryNameOrRoot(String) | Gets full directory name for a given path, or path root for directory-less paths.
Uses either Path.GetDirectoryName or Path.GetPathRoot to get the result. |
| GreetingFileName | |
| HeartbeatDataFileName | |
| IgnoreMapPathConfigKey | |
| IPBanListFileName | |
| IsProtectedFileName(String) | Checks whether the given file is on a list of protected file names.
Protected file names include all fCraft binaries, configuration files, and data files. |
| IsValidPath(String) | Checks whether the given path is valid.
Does NOT check for existence of the file/directory at the given path. |
| LogPath | Path to save logs to (default: .\logs)
Can be overridden at startup via command-line argument "--logpath=" |
| LogPathDefault | |
| MapPath | Path to save maps to (default: .\maps)
Can be overridden at startup via command-line argument "--mappath=",
or via "MapPath" ConfigKey |
| MapPathDefault | |
| MoveOrReplaceFile(String, String) | Moves file from source to destination, overwriting destination if it exists, as safely as possible.
File.Replace, File.Copy/File.Delete, or File.Move is used depending on circumstances. |
| PlayerDBFileName | |
| RulesDirectory | |
| RulesFileName | |
| RulesPath | Directory where rule sections are stored. |
| TestDirectory(String, String, Boolean) | Makes sure that the path format is valid, that it exists, that it is accessible and writeable. |
| TestFile(String, String, Boolean, FileAccess) | Makes sure that the path format is valid, and optionally whether it is readable/writeable. |
| UpdaterFileName | |
| WorkingPath | Working path (default: whatever directory fCraft.dll is located in)
Can be overridden at startup via command line argument "--path=" |
| WorkingPathDefault | |
| WorldListFileName |
