ISaveGame

class mobase.ISaveGame

Bases: object

Base class for information about what is in a save game.

Methods Summary

allFiles()

rtype:

Sequence[Union[str, PathLike[str], QFileInfo]]

getCreationTime()

Retrieve the creation time of the save.

getFilepath()

rtype:

Union[str, PathLike[str], QFileInfo]

getName()

rtype:

str

getSaveGroupIdentifier()

Retrieve the name of the group this files belong to.

Methods Documentation

allFiles()
Return type:

Sequence[Union[str, PathLike[str], QFileInfo]]

Returns:

The list of all files related to this save.

getCreationTime()

Retrieve the creation time of the save.

The creation time of a save is not always the same as the creation time of the file containing the save.

Return type:

QDateTime

Returns:

The creation time of the save.

getFilepath()
Return type:

Union[str, PathLike[str], QFileInfo]

Returns:

The path name to the (main) file or folder for the save.

getName()
Return type:

str

Returns:

The name of this save, for display purpose.

getSaveGroupIdentifier()

Retrieve the name of the group this files belong to.

The name can be used to identify sets of saves to transfer between profiles. For RPG games, this is usually the name of a character.

Return type:

str

Returns:

The group identifier for this save game.