org.mini2Dx.libgdx.desktop

Class DesktopPlayerData

java.lang.Object

org.mini2Dx.core.PlayerData

org.mini2Dx.libgdx.desktop.DesktopPlayerData

public class DesktopPlayerData
extends PlayerData

Constructor Summary

Constructors

Constructor and Description
DesktopPlayerData(java.lang.String gameIdentifier)

Method Summary

Modifier and Type	Method and Description
protected void	ensureDataDirectoryExists() Internal method for setting up the save data directory (if required)
java.lang.String	getSaveDirectoryForGame(java.lang.String gameIdentifier)
boolean	isDataStorageConnected() Returns if the player data storage is connected
boolean	isDataStorageFull() Returns if the player data storage is full
protected FileHandle	resolve(java.lang.String[] filepath) Returns a FileHandle for a file or directory within the save data directory
protected FileHandle	resolveTmp(java.lang.String[] filepath) Returns a FileHandle for a temporary file or directory within the save data directory
void	wipe() Wipes all data within the game data location

Methods inherited from class org.mini2Dx.core.PlayerData

createDirectory, delete, ensureDirectoryExistsForFile, getFileHandle, hasDirectory, hasFile, readBytes, readJson, readString, readXml, writeBytes, writeJson, writeString, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DesktopPlayerData

public DesktopPlayerData(java.lang.String gameIdentifier)

Method Detail

resolve

protected FileHandle resolve(java.lang.String[] filepath)

Description copied from class: PlayerData

Returns a FileHandle for a file or directory within the save data directory

Specified by:

resolve in class PlayerData

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

resolveTmp

protected FileHandle resolveTmp(java.lang.String[] filepath)

Description copied from class: PlayerData

Returns a FileHandle for a temporary file or directory within the save data directory

Specified by:

resolveTmp in class PlayerData

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

ensureDataDirectoryExists

protected void ensureDataDirectoryExists()
                                  throws java.io.IOException

Description copied from class: PlayerData

Internal method for setting up the save data directory (if required)

Specified by:

ensureDataDirectoryExists in class PlayerData

Throws:

java.io.IOException

isDataStorageFull

public boolean isDataStorageFull()
                          throws java.lang.Exception

Description copied from class: PlayerData

Returns if the player data storage is full

Specified by:

isDataStorageFull in class PlayerData

Returns:

True if storage is full

Throws:

java.lang.Exception - Thrown if storage cannot be accessed

isDataStorageConnected

public boolean isDataStorageConnected()

Description copied from class: PlayerData

Returns if the player data storage is connected

Specified by:

isDataStorageConnected in class PlayerData

Returns:

False if not connected

wipe

public void wipe()
          throws PlayerDataException

Description copied from class: PlayerData

Wipes all data within the game data location

Specified by:

wipe in class PlayerData

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed or the data could not be wiped

getSaveDirectoryForGame

public java.lang.String getSaveDirectoryForGame(java.lang.String gameIdentifier)