|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.ctdp.rfdynhud.gamedata.GameFileSystem
public abstract class GameFileSystem
Model of the game's (e.g. rFactor) filesystem
Field Summary | |
---|---|
static GameFileSystem |
INSTANCE
This is the public singleton instance of this class. |
Constructor Summary | |
---|---|
protected |
GameFileSystem()
|
Method Summary | |
---|---|
protected java.io.File |
findBordersFolder(java.io.File pluginFolder,
PluginINI pluginINI,
java.io.File configFolder)
Called once at instantiation time to initialize the plugin's border folder. |
protected java.io.File |
findCacheFolder(java.io.File pluginFolder,
PluginINI pluginINI)
Called once at instantiation time to initialize the plugin's cache folder. |
protected java.io.File |
findConfigFolder(java.io.File pluginFolder,
PluginINI pluginINI)
Called once at instantiation time to initialize the plugin's config folder. |
protected java.io.File |
findEditorFolder(java.io.File pluginFolder,
PluginINI pluginINI)
Called once at instantiation time to initialize the plugin's editor folder. |
protected abstract java.io.File |
findGameFolder(java.io.File pluginFolder)
Called once at instantiation time to initialize the game's root folder. |
protected abstract java.io.File |
findGameScreenshotsFolder(java.io.File gameFolder)
Called once at instantiation time to initialize the game's screenshots folder. |
protected java.io.File |
findImagesFolder(java.io.File pluginFolder,
PluginINI pluginINI,
java.io.File configFolder)
Called once at instantiation time to initialize the plugin's images folder. |
protected abstract java.io.File |
findLocationsFolder(java.io.File gameFolder)
Called once at instantiation time to initialize the game's "Locations" folder. |
protected java.io.File |
findSubPluginsFolder(java.io.File pluginFolder)
Called once at instantiation time to initialize the sub plugins' folder. |
protected java.io.File |
findWidgetSetsFolder(java.io.File pluginFolder)
Called once at instantiation time to initialize the widget sets' folder. |
java.io.File |
getBordersFolder()
Gets the plugin's borders folder. |
java.lang.String |
getBordersPath()
Gets the plugin's borders folder. |
java.io.File |
getCacheFolder()
Gets the plugin's cache folder. |
java.lang.String |
getCachePath()
Gets the plugin's cache folder. |
java.io.File |
getConfigFolder()
Gets the plugin's config folder. |
java.lang.String |
getConfigPath()
Gets the plugin's config folder. |
java.io.File |
getEditorFolder()
Gets the plugin's editor folder. |
java.lang.String |
getEditorPath()
Gets the plugin's editor folder. |
java.io.File |
getGameFolder()
Gets the game's root folder. |
java.lang.String |
getGamePath()
Gets the game's root folder. |
java.io.File |
getGameScreenshotsFolder()
Gets the game's screenshots folder. |
java.io.File |
getImagesFolder()
Gets the plugin's images folder. |
java.lang.String |
getImagesPath()
Gets the plugin's images folder. |
java.io.File |
getLocationsFolder()
Gets the game's "Locations" folder. |
java.lang.String |
getLocationsPath()
Gets the game's "Locations" folder. |
abstract java.io.File |
getPathFromGameConfigINI(java.lang.String setting,
java.lang.String fallback)
Gets an absolute path from the game's config ini file. |
java.io.File |
getPluginFolder()
Gets the plugin's main folder. |
PluginINI |
getPluginINI()
Gets an abstraction of the plugin's main ini file. |
java.lang.String |
getPluginPath()
Gets the plugin's main folder. |
java.io.File |
getSubPluginsFolder()
Gets sub plugins' folder. |
java.lang.String |
getSubPluginsPath()
Gets sub plugins' folder. |
java.io.File |
getWidgetSetsFolder()
Gets widget sets' folder. |
java.lang.String |
getWidgetSetsPath()
Gets widget sets' folder. |
abstract java.io.File |
locateSetupFile(LiveGameData gameData)
Locates the current vehicle setup file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final GameFileSystem INSTANCE
Constructor Detail |
---|
protected GameFileSystem()
Method Detail |
---|
protected abstract java.io.File findGameFolder(java.io.File pluginFolder)
pluginFolder
- the plugin's main folder
protected abstract java.io.File findLocationsFolder(java.io.File gameFolder)
gameFolder
- the game's root folder
protected java.io.File findConfigFolder(java.io.File pluginFolder, PluginINI pluginINI)
pluginFolder
- the plugin's main folderpluginINI
- an interface to the main plugin's ini file
protected java.io.File findWidgetSetsFolder(java.io.File pluginFolder)
pluginFolder
- the plugin's main folder
protected java.io.File findSubPluginsFolder(java.io.File pluginFolder)
pluginFolder
- the plugin's main folder
protected java.io.File findCacheFolder(java.io.File pluginFolder, PluginINI pluginINI)
pluginFolder
- the plugin's main folderpluginINI
- an interface to the main plugin's ini file
protected java.io.File findBordersFolder(java.io.File pluginFolder, PluginINI pluginINI, java.io.File configFolder)
pluginFolder
- the plugin's main folderpluginINI
- an interface to the main plugin's ini fileconfigFolder
- the plugin's config folder
protected java.io.File findImagesFolder(java.io.File pluginFolder, PluginINI pluginINI, java.io.File configFolder)
pluginFolder
- the plugin's main folderpluginINI
- an interface to the main plugin's ini fileconfigFolder
- the plugin's config folder
protected java.io.File findEditorFolder(java.io.File pluginFolder, PluginINI pluginINI)
pluginFolder
- the plugin's main folderpluginINI
- an interface to the main plugin's ini file
public abstract java.io.File getPathFromGameConfigINI(java.lang.String setting, java.lang.String fallback)
setting
- the setting to queryfallback
- the fallback value, if the setting couldn't be read
protected abstract java.io.File findGameScreenshotsFolder(java.io.File gameFolder)
gameFolder
- the game's root folder
public final java.io.File getPluginFolder()
public final java.lang.String getPluginPath()
public final PluginINI getPluginINI()
public final java.io.File getGameFolder()
public final java.lang.String getGamePath()
public final java.io.File getLocationsFolder()
public final java.lang.String getLocationsPath()
public abstract java.io.File locateSetupFile(LiveGameData gameData)
gameData
- the live game data
public final java.io.File getConfigFolder()
public final java.lang.String getConfigPath()
public final java.io.File getWidgetSetsFolder()
public final java.lang.String getWidgetSetsPath()
public final java.io.File getSubPluginsFolder()
public final java.lang.String getSubPluginsPath()
public final java.io.File getCacheFolder()
public final java.lang.String getCachePath()
public final java.io.File getBordersFolder()
public final java.lang.String getBordersPath()
public final java.io.File getImagesFolder()
public final java.lang.String getImagesPath()
public final java.io.File getEditorFolder()
public final java.lang.String getEditorPath()
public final java.io.File getGameScreenshotsFolder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |