bastd.ui.config

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Functionality for editing config values and applying them to the game."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8
  9import ba
 10
 11if TYPE_CHECKING:
 12    from typing import Any, Callable
 13
 14
 15class ConfigCheckBox:
 16    """A checkbox wired up to control a config value.
 17
 18    It will automatically save and apply the config when its
 19    value changes.
 20    """
 21
 22    widget: ba.Widget
 23    """The underlying ba.Widget instance."""
 24
 25    def __init__(self,
 26                 parent: ba.Widget,
 27                 configkey: str,
 28                 position: tuple[float, float],
 29                 size: tuple[float, float],
 30                 displayname: str | ba.Lstr | None = None,
 31                 scale: float | None = None,
 32                 maxwidth: float | None = None,
 33                 autoselect: bool = True,
 34                 value_change_call: Callable[[Any], Any] | None = None):
 35        if displayname is None:
 36            displayname = configkey
 37        self._value_change_call = value_change_call
 38        self._configkey = configkey
 39        self.widget = ba.checkboxwidget(
 40            parent=parent,
 41            autoselect=autoselect,
 42            position=position,
 43            size=size,
 44            text=displayname,
 45            textcolor=(0.8, 0.8, 0.8),
 46            value=ba.app.config.resolve(configkey),
 47            on_value_change_call=self._value_changed,
 48            scale=scale,
 49            maxwidth=maxwidth)
 50        # complain if we outlive our checkbox
 51        ba.uicleanupcheck(self, self.widget)
 52
 53    def _value_changed(self, val: bool) -> None:
 54        cfg = ba.app.config
 55        cfg[self._configkey] = val
 56        if self._value_change_call is not None:
 57            self._value_change_call(val)
 58        cfg.apply_and_commit()
 59
 60
 61class ConfigNumberEdit:
 62    """A set of controls for editing a numeric config value.
 63
 64    It will automatically save and apply the config when its
 65    value changes.
 66    """
 67
 68    nametext: ba.Widget
 69    """The text widget displaying the name."""
 70
 71    valuetext: ba.Widget
 72    """The text widget displaying the current value."""
 73
 74    minusbutton: ba.Widget
 75    """The button widget used to reduce the value."""
 76
 77    plusbutton: ba.Widget
 78    """The button widget used to increase the value."""
 79
 80    def __init__(self,
 81                 parent: ba.Widget,
 82                 configkey: str,
 83                 position: tuple[float, float],
 84                 minval: float = 0.0,
 85                 maxval: float = 100.0,
 86                 increment: float = 1.0,
 87                 callback: Callable[[float], Any] | None = None,
 88                 xoffset: float = 0.0,
 89                 displayname: str | ba.Lstr | None = None,
 90                 changesound: bool = True,
 91                 textscale: float = 1.0):
 92        if displayname is None:
 93            displayname = configkey
 94
 95        self._configkey = configkey
 96        self._minval = minval
 97        self._maxval = maxval
 98        self._increment = increment
 99        self._callback = callback
100        self._value = ba.app.config.resolve(configkey)
101
102        self.nametext = ba.textwidget(parent=parent,
103                                      position=position,
104                                      size=(100, 30),
105                                      text=displayname,
106                                      maxwidth=160 + xoffset,
107                                      color=(0.8, 0.8, 0.8, 1.0),
108                                      h_align='left',
109                                      v_align='center',
110                                      scale=textscale)
111        self.valuetext = ba.textwidget(parent=parent,
112                                       position=(246 + xoffset, position[1]),
113                                       size=(60, 28),
114                                       editable=False,
115                                       color=(0.3, 1.0, 0.3, 1.0),
116                                       h_align='right',
117                                       v_align='center',
118                                       text=str(self._value),
119                                       padding=2)
120        self.minusbutton = ba.buttonwidget(
121            parent=parent,
122            position=(330 + xoffset, position[1]),
123            size=(28, 28),
124            label='-',
125            autoselect=True,
126            on_activate_call=ba.Call(self._down),
127            repeat=True,
128            enable_sound=changesound)
129        self.plusbutton = ba.buttonwidget(parent=parent,
130                                          position=(380 + xoffset,
131                                                    position[1]),
132                                          size=(28, 28),
133                                          label='+',
134                                          autoselect=True,
135                                          on_activate_call=ba.Call(self._up),
136                                          repeat=True,
137                                          enable_sound=changesound)
138        # Complain if we outlive our widgets.
139        ba.uicleanupcheck(self, self.nametext)
140        self._update_display()
141
142    def _up(self) -> None:
143        self._value = min(self._maxval, self._value + self._increment)
144        self._changed()
145
146    def _down(self) -> None:
147        self._value = max(self._minval, self._value - self._increment)
148        self._changed()
149
150    def _changed(self) -> None:
151        self._update_display()
152        if self._callback:
153            self._callback(self._value)
154        ba.app.config[self._configkey] = self._value
155        ba.app.config.apply_and_commit()
156
157    def _update_display(self) -> None:
158        ba.textwidget(edit=self.valuetext, text=f'{self._value:.1f}')