Skip to content

Settings

IMPORT THE MODULE, NOT THE VALUES!

To change these settings, import the module: from AoE2ScenarioParser import settings. Then you can change the settings like: settings.RAISE_ERROR_ON_WARNING = True

If you import the values directly like: from ... import RAISE_ERROR_ON_WARNING (not written out because it wouldn't work), change the value would overwrite the reference and not the value which means the change wouldn't transfer to the settings module.

Attributes

NOTIFY_UNKNOWN_BYTES = True module-attribute

Value: True

Show a notification of extra bytes being available at the end of the file, so you can notify the maintainer

PRINT_STATUS_UPDATES = True module-attribute

Value: True

If status updates of what is being read and written should be printed to console

ALLOW_OVERWRITING_SOURCE = False module-attribute

Value: False

Disable the error being raised when overwriting source scenario

ALLOW_DIRTY_RETRIEVER_OVERWRITE = False module-attribute

Value: False

If it is allowed to overwrite a retriever that is dirty (it has been changed manually)

SHOW_VARIANT_WARNINGS = True module-attribute

Value: True

If warnings about incorrect variants should be shown or not

MAIN_CHARSET = 'utf-8' module-attribute

Value: 'utf-8'

The charset used to decode the text in the scenario. If it fails, will try the settings.FALLBACK_CHARSET

FALLBACK_CHARSET = 'latin-1' module-attribute

Value: 'latin-1'

The charset used to decode the text in the scenario when the settings.MAIN_CHARSET fails