GameSaver

object GameSaver

Functions

autoSave

fun autoSave(gameInfo: GameInfo, postRunnable: () -> Unit = {})

autoSaveSingleThreaded

fun autoSaveSingleThreaded(gameInfo: GameInfo)

canLoadFromCustomSaveLocation

fun canLoadFromCustomSaveLocation(): Boolean

deleteSave

fun deleteSave(GameName: String, multiplayer: Boolean = false)

equals

open operator fun equals(other: Any?): Boolean

gameInfoFromString

fun gameInfoFromString(gameData: String): GameInfo

gameInfoFromStringWithoutTransients

fun gameInfoFromStringWithoutTransients(gameData: String): GameInfo

WARNING! transitive GameInfo data not initialized The returned GameInfo can not be used for most circumstances because its not initialized! It is therefore stateless and save to call for Multiplayer Turn Notifier, unlike gameInfoFromString().

gameInfoPreviewFromString

fun gameInfoPreviewFromString(gameData: String): GameInfoPreview

getGeneralSettings

fun getGeneralSettings(): GameSettings

getGeneralSettingsFile

fun getGeneralSettingsFile(): FileHandle

getSave

fun getSave(GameName: String, multiplayer: Boolean = false): FileHandle

getSaves

fun getSaves(multiplayer: Boolean = false): Sequence<FileHandle>

getSubfolder

fun getSubfolder(multiplayer: Boolean = false): String

hashCode

open fun hashCode(): Int

json

fun json(): Json

loadGameByName

fun loadGameByName(GameName: String): GameInfo

loadGameFromCustomLocation

fun loadGameFromCustomLocation(loadCompletionCallback: (GameInfo?, Exception?) -> Unit)

loadGameFromFile

fun loadGameFromFile(gameFile: FileHandle): GameInfo

loadGamePreviewByName

fun loadGamePreviewByName(GameName: String): GameInfoPreview

loadGamePreviewFromFile

fun loadGamePreviewFromFile(gameFile: FileHandle): GameInfoPreview

saveGame

fun saveGame(game: GameInfo, GameName: String, saveCompletionCallback: (Exception?) -> Unit? = null)

fun saveGame(game: GameInfoPreview, GameName: String, saveCompletionCallback: (Exception?) -> Unit? = null)

Overload of function saveGame to save a GameInfoPreview in the MultiplayerGames folder

saveGameToCustomLocation

fun saveGameToCustomLocation(game: GameInfo, GameName: String, saveCompletionCallback: (Exception?) -> Unit)

setGeneralSettings

fun setGeneralSettings(gameSettings: GameSettings)

toString

open fun toString(): String

Properties

customSaveLocationHelper

@Volatile

var customSaveLocationHelper: CustomSaveLocationHelper? = null

externalFilesDirForAndroid

var externalFilesDirForAndroid: String

When set, we know we're on Android and can save to the app's personal external file directory See https://developer.android.com/training/data-storage/app-specific#external-access-files

multiplayerFilesFolder

private const val multiplayerFilesFolder: String

saveFilesFolder

private const val saveFilesFolder: String

settingsFileName

const val settingsFileName: String

Sources

jvm source