DataArchives

class mobase.DataArchives

Bases: abc.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.

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.

Parameters

profile – Profile to retrieve archives from.

Returns

The list of archives in the given profile.

Return type

List[str]

abstract removeArchive(profile, name)

Remove the given archive from the given profile.

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.

Returns

The list of vanilla archives.

Return type

List[str]