File builtin/vn/save.lua

savescreen.lua Provides the 'built-in' VN save functions.

Functions

autoSave () Performs an auto save (automatically cycles through available auto save slots)
getAutoSaveSlots (slots) Returns the number of auto save slots
getFreeSaveSlot () Returns an empty (regular) save slot
loadScreen () Starts the save screen in load mode
onLoad () Gets called when a regular load failed and the script must restore its previous state using only the information stored in Save.getSavepointStorage().
onSave (slot) Gets called right before saving
quickLoad (slot) Loads a quick save.
quickSave (slot) Performs a save in the specified quick save slot.
saveScreen () Starts the save screen in save mode
savepoint (scriptpos) This function creates a snapshot of the most critical save data and stores this data in Save.getSavepointStorage().
setAutoSaveSlots (slots) Sets the number of auto save slots, use 0 to turn off autosaving


Functions

autoSave ()
Performs an auto save (automatically cycles through available auto save slots)
getAutoSaveSlots (slots)
Returns the number of auto save slots

Parameters:

  • slots:

Return value:

    The number of auto save slots, or 0 if auto saving is turned off.
getFreeSaveSlot ()
Returns an empty (regular) save slot
loadScreen ()
Starts the save screen in load mode
onLoad ()
Gets called when a regular load failed and the script must restore its previous state using only the information stored in Save.getSavepointStorage().
onSave (slot)
Gets called right before saving

Parameters:

  • slot:
quickLoad (slot)
Loads a quick save.

Parameters:

  • slot: The quick save slot (between 1 and 99).
quickSave (slot)
Performs a save in the specified quick save slot.

Parameters:

  • slot: The quick save slot (between 1 and 99).
saveScreen ()
Starts the save screen in save mode
savepoint (scriptpos)
This function creates a snapshot of the most critical save data and stores this data in Save.getSavepointStorage(). This function is automatically called before each new .lvn script.

Parameters:

  • scriptpos:
setAutoSaveSlots (slots)
Sets the number of auto save slots, use 0 to turn off autosaving

Parameters:

  • slots: The number of auto save slots to cycle through

Valid XHTML 1.0!