[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.0 (0.6.3.0)
Syntax
| C# |
public static class Paths
Members
| All Members | Fields | Properties | Methods |
| Member | Description | |
|---|---|---|
| AnnouncementsFileName | ||
| AutoRankFileName | ||
| BackupPath | Path where map backups are stored | |
| BlockDBDirectory | ||
| BlockDBPath | ||
| Compare(String, String) | Returns true if paths or filenames reference the same location (accounts for all the filesystem quirks). | |
| Compare(String, String, Boolean) | Returns true if paths or filenames reference the same location (accounts for all the filesystem quirks). | |
| 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 | |
| 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 filename capitalization on case-insensitive filesystems. | |
| GetDirectoryNameOrRoot(String) | Gets full directory name for a given path, or path root for directory-less paths. | |
| GreetingFileName | ||
| HeartbeatDataFileName | ||
| IgnoreMapPathConfigKey | ||
| IPBanListFileName | ||
| IsDefaultMapPath(String) | ||
| IsProtectedFileName(String) | ||
| IsValidPath(String) | ||
| 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 | ||
| MoveOrReplace(String, String) | ||
| PlayerDBFileName | ||
| RulesDirectory | ||
| RulesFileName | ||
| RulesPath | ||
| 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 |