User Tools

Site Tools


script:module:savedsession

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
script:module:savedsession [2019-11-17 16:20] skyjakescript:module:savedsession [2019-11-17 16:20] (current) – [Functions] skyjake
Line 1: Line 1:
 +====== SavedSession (Module) ======
 +
 +Module that provides access to the savegame manipulation features of the resource subsystem.
 +
 +
 +===== Functions =====
 +
 +
 +#@Identifier_HTML~convert~@# ( #@Arg_HTML~Text,gameId~@#, #@Arg_HTML~Text,savegamePath~@# )
 +
 +Performs conversion of a single legacy savegame into the native **.save** package format. When this function is called the //savegamePath// (which is assumed to be a path to a legacy savegame, in the internal file system) is offered to each converter plugin in turn. If a plugin supports conversion of the given file type a conversion attempt is made. Returns ''True'' or ''False'' to indicate the source file was located and a at least one plugin signalled that conversion was attempted.
 +
 +
 +  SavedSession.convert("doom1-ultimate", "/legacysavegames/doom1-ultimate/DoomSav0.dsg")
 +
 +
 +#@Identifier_HTML~convertAll~@# ( #@Arg_HTML~Text,gameId~@# )
 +
 +Performs conversion of __all__ legacy savegames located for the given //gameId//. Otherwise functions identically to ''convert''.
 +
 +