DataArchives

class mobase.DataArchives

Bases: ABC

Methods Summary

addArchive(profile, index, name)	Add an archive to the archive list.
archives(profile)	Retrieve the list of archives in the given profile.
removeArchive(profile, name)	Remove the given archive from the given profile.
vanillaArchives()	Retrieve the list of vanilla archives.

Methods Documentation

abstract addArchive(profile, index, name)

Add an archive to the archive list.

Return type:

None

Parameters:

• profile – Profile to add the archive to.

• index – Index to insert before. Use 0 for the beginning of the list or INT_MAX for the end of the list).

• name – Name of the archive to add.

abstract archives(profile)

Retrieve the list of archives in the given profile.

Return type:

Sequence[str]

Parameters:

profile – Profile to retrieve archives from.

Returns:

The list of archives in the given profile.

abstract removeArchive(profile, name)

Remove the given archive from the given profile.

Return type:

None

Parameters:

• profile – Profile to remove the archive from.

• name – Name of the archive to remove.

abstract vanillaArchives()

Retrieve the list of vanilla archives.

Vanilla archives are archive files that are shipped with the original game.

Return type:

Sequence[str]

Returns:

The list of vanilla archives.