PersistentData

Store and retrieve persistent data. Persistent data can be saved and loaded from file. Supports float, int, string, and bool types.

Note that any game mode may use the same file names, so it is recommended that you choose unique file names when saving and loading.

Saved files are located in Documents/Aottg2/PersistentData.

Function
Returns
Description

SetProperty(name: string, value: object)

null

Sets the property with given name to the object value. Valid value types are float, string, bool, and int.

GetProperty(name: string, defaultValue: object)

object

Gets the property with given name. If property does not exist, returns defaultValue.

Clear()

null

Clears current persistent data.

SaveToFile(fileName: string, encrypted: bool)

null

Saves current persistent data to given file name. If encrypted is true, will also encrypt the file instead of using plaintext.

LoadFromFile(fileName: string, encrypted: bool)

null

Loads persistent data from given file name. If encrypted is true, will treat the file as having been saved as encrypted.

IsValidFileName(fileName: string)

bool

Determines whether or not the given fileName will be allowed for use when saving/loading a file.

FileExists(fileName: string)

bool

Determines whether the file given already exists. Throws an error if given an invalid file name.

Last updated