|
Paths Class |
Furcadia Framework For Third Party Programs |
[This is preliminary documentation and is subject to change.]
***NOTICE: DO NOT REMOVE***
Credits go to Artex for helping me fix Path issues and contributing his code.
***NOTICE: DO NOT REMOVE.***
Log Header
Format: (date,Version) AuthorName, Changes.
(Mar 12,2014,0.2.12) Gerolkae, Adapted Paths to work with a Supplied path
(June 1, 2016) Gerolkae, Added possible missing Registry Paths for x86/x64 Windows and Mono Support. Wine Support also contains these corrections.
Namespace: Furcadia.IO
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 42
public class Paths
Public Class Paths Dim instance As Paths
public ref class Paths
type Paths = class end
The Paths type exposes the following members.
| Name | Description | |
|---|---|---|
 | Paths |
Load Default Furcadia Paths
|
| Paths(String) |
Load Paths Based on path |
| Name | Description | |
|---|---|---|
 | CachePath |
Cache path - contains all the Furcadia cache and resides in the
global user space.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia |
| CharacterPath | Obsolete.
Character file path - contains furcadia.ini files with login
information for each character.
Default: My Documents\Furcadia\Furcadia Characters\ |
| DefaultCachePath |
c:\Program Data\
|
| DefaultCharacterPath | Obsolete.
Default Character Path
|
| DefaultDreamsPath |
Personal Dreams Folder
|
| DefaultFurcadiaPath |
Default Furcadia install folder - this path is used by default
to install Furcadia to.
Default: c:\Program Files\Furcadia |
| DefaultGlobalMapsPath |
Main Maps Default path
|
| DefaultGlobalSkinsPath |
default skins
|
| DefaultLocalSkinsPath |
default local skins
|
| DefaultLogsPath | Obsolete.
default personal log folder
|
| DefaultPatchPath |
Path to the default patch (graphics, sounds, layout) folder used
to display Furcadia itself, its tools and environment.
Default: c:\Program Files\Furcadia\patches\default |
| DefaultPermanentMapsCachePath |
Default Main Maps
|
| DefaultPersonalDataPath |
Default Documents\Furcadia
|
| DefaultPortraitCachePath |
Portrait cache
|
| DefaultScreenshotsPath |
Furcadia Screen Shots default folder
|
| DefaultSettingsPath |
User App Data Settings
|
| DefaultTemporaryDreamsPath |
Temporary dreams
|
| DefaultTemporaryFilesPath |
Default Temporary Files
|
| DefaultTemporaryPatchesPath |
Temporary patches
|
| DefaultWhisperLogsPath | Obsolete.
Whisper Logs
|
| DreamsPath |
Dreams path - contains Furcadia dreams made by the player.
Default: My Documents\Furcadia\Dreams
|
| FurcadiaLocaldirPath |
Furcadia Localdir path - this path (when explicitly set),
indicates the whereabouts of the data files used in Furcadia. If
localdir.ini is present in the Furcadia folder, Furcadia.exe
will load those files from the specific path and not the regular ones.
Default: -NONE-
|
| FurcadiaPath |
Furcadia install path - this path corresponds to the path where
Furcadia is installed on the current machine. If Furcadia is not
found, this property will be null.
|
| GlobalMapsPath |
Path to the global maps, distributed with Furcadia and loadable
during game play in some main dreams.
Default: c:\Program Files\Furcadia\maps |
| GlobalSkinsPath |
Path to the global skins that change Furcadia's graphical
layout. They are stored in the Furcadia program files folder.
Default: c:\Program Files\Furcadia\skins |
| LocaldirPath |
LocalDir path - a specific path where all the player-specific
and cache data is stored in its classic form. Used mainly to
retain the classic path structure or to run Furcadia from a
removable disk.
|
| LocalSkinsPath |
Local skins path - contains Furcadia skins used locally by each user.
Default: My Documents\Furcadia\Skins |
| LogsPath | Obsolete.
Logs path - contains session logs for each character and a
sub-folder with whisper logs, should Pounce be enabled.
Default: My Documents\Furcadia\Logs |
| PermanentMapsCachePath |
Permanent Maps cache path - contains downloaded main maps such
as the festival maps or other DEP-specific customized dreams.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Permanent Maps |
| PersonalDataPath |
Personal data path - contains user-specific files such as logs,
patches, screen shots and character files.
Default: My Documents\Furcadia\ |
| PortraitCachePath |
Portrait cache path - contains downloaded portraits and desctags
cache for faster loading and bandwidth optimization.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Portrait Cache |
| ScreenshotsPath |
Screen shots path - contains screen shot files taken by Furcadia
with the CTRL+F1 hotkey. At the time of writing, in PNG format.
Default: My Documents\Furcadia\Screenshots |
| SettingsPath |
Personal settings path - contains all the Furcadia settings for
each user that uses it.
Default (VISTA+): %USERPROFILE%\Local\AppData\Dragon's Eye Productions\Furcadia |
| TemporaryDreamsPath |
Temporary dreams path - contains downloaded player dreams for
subsequent loading.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Dreams |
| TemporaryFilesPath |
Temporary files path - contains downloaded and uploaded files
that are either used to upload packages or download them for extraction.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Files |
| TemporaryPatchesPath |
Temporary patch path - contains downloaded temporary patches.
This technology is never in use, yet supported, so this folder
is always empty.
Default: %ALLUSERSPROFILE%\Dragon's Eye Productions\Furcadia\Temporary Patches |
| UsingLocaldir |
Has LoclDir.ini been detected?
|
| WhisperLogsPath | Obsolete.
Whisper logs path - contains whisper logs for each character
whispered, recorded by Pounce with the whisper windows.
Default: My Documents\Furcadia\Logs\Whispers
|
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDefaultPatchPath |
Find the path to the default patch folder on the current machine.
|
| GetFurcadiaInstallPath |
Find the path to Furcadia data files currently installed on this system.
|
| GetFurcadiaLocaldirPath |
Find the current localdir path where data files would be stored
on the current machine.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
 | AsDouble | (Defined by ObjectExtensions.) |
| AsInt16 | (Defined by ObjectExtensions.) |
| AsInt32 | (Defined by ObjectExtensions.) |
| AsInt64 | (Defined by ObjectExtensions.) |
| AsString | (Defined by ObjectExtensions.) |
check localdir.ini
then check each registry hives for active CPU type
Then check each give for default 32bit path(Non wow6432node)
then check Wine variants(C++ Win32 client)
then check Mono Versions for before mentioned(C#? Client)
then check default drive folder paths
If all Fail... Throw FurcadiaNotFoundException exception
Clients Should check for this error and then ask the user where to manually locate Furccadia