Files
gymkhana-actions/docs/api/ESCSaveManager.md
Dennis Ploeger 604cccb56d Fix command docs, automate API doc generation (#327)
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-07-27 16:05:14 +02:00

1.8 KiB

ESCSaveManager

Constants Descriptions

SAVE_NAME_TEMPLATE

const SAVE_NAME_TEMPLATE: String = "save_%03d.tres"

Template for savegames filenames

SETTINGS_TEMPLATE

const SETTINGS_TEMPLATE: String = "settings.tres"

Template for settings filename

Property Descriptions

save_folder

var save_folder: String

Variable containing the saves folder obtained from Project Settings

settings_folder

var settings_folder: String

Variable containing the settings folder obtained from Project Settings

Method Descriptions

get_saves_list

func get_saves_list() -> Dictionary

Return a list of savegames metadata (id, date, name and game version)

save_game_exists

func save_game_exists(id: int) -> bool

Returns true whether the savegame identified by id does exist

## Parameters

  • id: integer suffix of the savegame file

save_game

func save_game(id: int, p_savename: String)

Save the current state of the game in a file suffixed with the id value. This id can help with slots development for the game developer.

 ## Parameters

  • id: integer suffix of the savegame file
  • p_savename: name of the savegame

load_game

func load_game(id: int)

Load a savegame file from its id.

 ## Parameters

  • id: integer suffix of the savegame file

save_settings

func save_settings()

Save the game settings in the settings file.

load_settings

func load_settings() -> Resource

Load the game settings from the settings file Returns The Resource structure loaded from settings file