Save Data Functions
Functions related to Save Data manipulation.
initSaveData
initSaveData(save:String, ?folder:String = 'psychenginemods'):Void
Initializes a Save Data.
- save - Save Data Name, make it unique to avoid overwriting!
- folder (Optional) - Folder in "%appdata%/ShadowMario/PsychEngine/".
Examples:
- initSaveData('my_mod_savedata') - Initializes "my_mod_savedata.sol".
Note: Save Data does NOT save automatically! Use "flushSaveData" in moderation for saving it.
flushSaveData
flushSaveData(save:String):Void
Flushes (Saves) the Save Data, recommended to call this on "function onDestroy" in your Lua Script to avoid any changes from being lost.
- save - Save Data Name, make it unique to avoid overwriting!
Examples:
- flushSaveData('my_mod_savedata') - Saves "my_mod_savedata.sol".
eraseSaveData
eraseSaveData(save:String):Void
Erases the save file specified.
Examples:
- eraseSaveData('my_mod_savedata') - Erases "my_mod_savedata.sol".
getDataFromSave
getDataFromSave(save:String, field:String, ?defaultValue:Dynamic = null):Dynamic
Returns a field data from the Save file specified.
- save - Save Data Name.
- field - Field/Property to get from the Save Data loaded.
- defaultValue (Optional) - Default value to use in case the field isn't available in the Save Data.
Examples:
- getDataFromSave('my_mod_savedata', 'score', 0) - Returns "score" from "my_mod_savedata.sol", in case it's missing, it will use 0.
setDataFromSave
setDataFromSave(save:String, field:String, defaultValue:Dynamic):Void
Sets a field data to the Save file specified.
- save - Save Data Name.
- field - Field/Property to get from the Save Data loaded.
- defaultValue (Optional) - Default value to use in case the field isn't available in the Save Data.
Examples:
- setDataFromSave('my_mod_savedata', 'score', 1000) - Saves "score" to "my_mod_savedata.sol".