earwax.menus.reverb_editor module

Provides the ReverbEditor class.

class earwax.menus.reverb_editor.ReverbEditor(game: Game, title: Union[str, TitleFunction], dismissible: bool = True, item_select_sound_path: Optional[pathlib.Path] = None, item_activate_sound_path: Optional[pathlib.Path] = None, position: int = -1, search_timeout: float = 0.5, search_time: float = 0.0, reverb: object = NOTHING, settings: earwax.reverb.Reverb = NOTHING, setting_items: List[earwax.menus.menu_item.MenuItem] = NOTHING)

Bases: earwax.menus.menu.Menu

A menu for editing reverbs.

adjust_value(amount: earwax.menus.reverb_editor.ValueAdjustments) → Callable[[], None]

Restore the current menu item to the default.

edit_value(setting: earwax.menus.reverb_editor.ReverbSetting, value: float) → Callable[[], Generator[None, None, None]]

Edit the given value.

get_default_reverb() → object

Raise an error.

get_default_settings() → earwax.reverb.Reverb

Raise an error.

reset() → None

Reload this menu.

set_value(setting: earwax.menus.reverb_editor.ReverbSetting, value: float) → None

Set the value.

class earwax.menus.reverb_editor.ReverbSetting(name: str, description: str, min: float, max: float, default: float, increment: float = 0.05)

Bases: object

A setting for reverb.

class earwax.menus.reverb_editor.ValueAdjustments

Bases: enum.Enum

Possible value adjustments for menu actions.

decrement = 1

default = 0

increment = 2