com.almasb.fxgl.saving

Class SaveLoadManager

java.lang.Object

com.almasb.fxgl.saving.SaveLoadManager

public final class SaveLoadManager
extends Object

Convenient access to saving and loading game data.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
SaveLoadManager(String profileName) Constructs manager for given profile name.

Method Summary

Modifier and Type	Method and Description
static IOTask<Void>	deleteProfileTask(String profileName) Delete profile.
IOTask<Void>	deleteSaveFileTask(SaveFile saveFile)
IOTask<SaveFile>	loadLastModifiedSaveFileTask() Loads last modified save file from saves directory.
static IOTask<List<String>>	loadProfileNamesTask() Load all profile names.
IOTask<UserProfile>	loadProfileTask() Loads user profile from "profiles/".
IOTask<List<SaveFile>>	loadSaveFilesTask() Loads save files with save file extension from SAVE_DIR.
IOTask<DataFile>	loadTask(SaveFile saveFile) Load serializable data from external file on disk file system from saves directory which is in the directory where the game is run from.
void	querySaveFiles() Asynchronously (with a progress dialog) loads save files into observable list saveFiles().
boolean	saveFileExists(String saveFileName)
javafx.collections.ObservableList<SaveFile>	saveFiles()
IOTask<Void>	saveProfileTask(UserProfile profile) Saves user profile to "profiles/".
IOTask<Void>	saveTask(DataFile dataFile, SaveFile saveFile) Save serializable data onto a disk file system under saves directory, which is created if necessary in the directory where the game is run from.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveLoadManager

public SaveLoadManager(String profileName)

Constructs manager for given profile name.

Parameters:

profileName - profile name

Method Detail

saveFiles

public javafx.collections.ObservableList<SaveFile> saveFiles()

Returns:

read only view of observable save files

querySaveFiles

public void querySaveFiles()

Asynchronously (with a progress dialog) loads save files into observable list saveFiles().

saveTask

public IOTask<Void> saveTask(DataFile dataFile,
                             SaveFile saveFile)

Save serializable data onto a disk file system under saves directory, which is created if necessary in the directory where the game is run from.

All extra directories will also be created if necessary.

Parameters:

dataFile - data file

saveFile - save file

Returns:

saving task

saveProfileTask

public IOTask<Void> saveProfileTask(UserProfile profile)

Saves user profile to "profiles/". Creates "saves/" in that directory.

Parameters:

profile - the profile to save

Returns:

saving task

loadTask

public IOTask<DataFile> loadTask(SaveFile saveFile)

Load serializable data from external file on disk file system from saves directory which is in the directory where the game is run from.

Parameters:

saveFile - save file to load

Returns:

saving task

loadProfileTask

public IOTask<UserProfile> loadProfileTask()

Loads user profile from "profiles/".

Returns:

saving task

deleteSaveFileTask

public IOTask<Void> deleteSaveFileTask(SaveFile saveFile)

Parameters:

saveFile - save file to delete

Returns:

saving task

saveFileExists

public boolean saveFileExists(String saveFileName)

Parameters:

saveFileName - save file name

Returns:

true iff file exists

loadProfileNamesTask

public static IOTask<List<String>> loadProfileNamesTask()

Load all profile names.

Returns:

saving task

deleteProfileTask

public static IOTask<Void> deleteProfileTask(String profileName)

Delete profile.

Parameters:

profileName - name of profile to delete

Returns:

saving task

loadSaveFilesTask

public IOTask<List<SaveFile>> loadSaveFilesTask()

Loads save files with save file extension from SAVE_DIR.

Returns:

saving task

loadLastModifiedSaveFileTask

public IOTask<SaveFile> loadLastModifiedSaveFileTask()

Loads last modified save file from saves directory.

Returns:

saving task