SaveGameInfo

class mobase.SaveGameInfo

Bases: abc.ABC

Feature to get hold of stuff to do with save games.

Methods Summary

getMissingAssets(filepath)

Retrieve missing assets from the save.

getSaveGameInfo(filepath)

Retrieve the information about the supplied save game.

getSaveGameWidget(parent)

Retrieve a widget to display over the save game list.

hasScriptExtenderSave(filepath)

Check whether or not the save has a paired script extender save.

Methods Documentation

abstract getMissingAssets(filepath)

Retrieve missing assets from the save.

Parameters

filepath – Path to the save file.

Returns

A collection of missing assets and the modules that can supply those assets.

Return type

Dict[str, List[str]]

abstract getSaveGameInfo(filepath)

Retrieve the information about the supplied save game.

Parameters

filepath – Path to the save file.

Returns

A SaveGame corresponding to the given save file.

Return type

ISaveGame

abstract getSaveGameWidget(parent)

Retrieve a widget to display over the save game list.

This method is allowed to return None in case no widget has been implemented.

Parameters

parent – The parent widget.

Returns

A SaveGameInfoWidget to display information about save game.

Return type

Optional[ISaveGameInfoWidget]

abstract hasScriptExtenderSave(filepath)

Check whether or not the save has a paired script extender save.

Parameters

filepath – Path to the save file.

Returns

True if the given save file has a paired script extender save, False otherwise.

Return type

bool