bauiv1lib.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 bauiv1 as bui
 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: bui.Widget
 23    """The underlying bui.Widget instance."""
 24
 25    def __init__(
 26        self,
 27        parent: bui.Widget,
 28        configkey: str,
 29        position: tuple[float, float],
 30        size: tuple[float, float],
 31        displayname: str | bui.Lstr | None = None,
 32        scale: float | None = None,
 33        maxwidth: float | None = None,
 34        autoselect: bool = True,
 35        value_change_call: Callable[[Any], Any] | None = None,
 36    ):
 37        if displayname is None:
 38            displayname = configkey
 39        self._value_change_call = value_change_call
 40        self._configkey = configkey
 41        self.widget = bui.checkboxwidget(
 42            parent=parent,
 43            autoselect=autoselect,
 44            position=position,
 45            size=size,
 46            text=displayname,
 47            textcolor=(0.8, 0.8, 0.8),
 48            value=bui.app.config.resolve(configkey),
 49            on_value_change_call=self._value_changed,
 50            scale=scale,
 51            maxwidth=maxwidth,
 52        )
 53        # complain if we outlive our checkbox
 54        bui.uicleanupcheck(self, self.widget)
 55
 56    def _value_changed(self, val: bool) -> None:
 57        cfg = bui.app.config
 58        cfg[self._configkey] = val
 59        if self._value_change_call is not None:
 60            self._value_change_call(val)
 61        cfg.apply_and_commit()
 62
 63
 64class ConfigNumberEdit:
 65    """A set of controls for editing a numeric config value.
 66
 67    It will automatically save and apply the config when its
 68    value changes.
 69    """
 70
 71    nametext: bui.Widget
 72    """The text widget displaying the name."""
 73
 74    valuetext: bui.Widget
 75    """The text widget displaying the current value."""
 76
 77    minusbutton: bui.Widget
 78    """The button widget used to reduce the value."""
 79
 80    plusbutton: bui.Widget
 81    """The button widget used to increase the value."""
 82
 83    def __init__(
 84        self,
 85        parent: bui.Widget,
 86        configkey: str,
 87        position: tuple[float, float],
 88        minval: float = 0.0,
 89        maxval: float = 100.0,
 90        increment: float = 1.0,
 91        callback: Callable[[float], Any] | None = None,
 92        xoffset: float = 0.0,
 93        displayname: str | bui.Lstr | None = None,
 94        changesound: bool = True,
 95        textscale: float = 1.0,
 96        as_percent: bool = False,
 97        fallback_value: float = 0.0,
 98        f: int = 1,
 99    ):
100        if displayname is None:
101            displayname = configkey
102
103        self._configkey = configkey
104        self._minval = minval
105        self._maxval = maxval
106        self._increment = increment
107        self._callback = callback
108        try:
109            self._value = bui.app.config.resolve(configkey)
110        except ValueError:
111            self._value = bui.app.config.get(configkey, fallback_value)
112        self._value = (
113            self._minval
114            if self._minval > self._value
115            else self._maxval if self._maxval < self._value else self._value
116        )
117        self._as_percent = as_percent
118        self._f = f
119
120        self.nametext = bui.textwidget(
121            parent=parent,
122            position=(position[0], position[1] + 12.0),
123            size=(0, 0),
124            text=displayname,
125            maxwidth=150 + xoffset,
126            color=(0.8, 0.8, 0.8, 1.0),
127            h_align='left',
128            v_align='center',
129            scale=textscale,
130        )
131        self.valuetext = bui.textwidget(
132            parent=parent,
133            position=(position[0] + 216 + xoffset, position[1] + 12.0),
134            size=(0, 0),
135            editable=False,
136            color=(0.3, 1.0, 0.3, 1.0),
137            h_align='right',
138            v_align='center',
139            text=str(self._value),
140            padding=2,
141        )
142        self.minusbutton = bui.buttonwidget(
143            parent=parent,
144            position=(position[0] + 230 + xoffset, position[1]),
145            size=(28, 28),
146            label='-',
147            autoselect=True,
148            on_activate_call=bui.Call(self._down),
149            repeat=True,
150            enable_sound=changesound,
151        )
152        self.plusbutton = bui.buttonwidget(
153            parent=parent,
154            position=(position[0] + 280 + xoffset, position[1]),
155            size=(28, 28),
156            label='+',
157            autoselect=True,
158            on_activate_call=bui.Call(self._up),
159            repeat=True,
160            enable_sound=changesound,
161        )
162        # Complain if we outlive our widgets.
163        bui.uicleanupcheck(self, self.nametext)
164        self._update_display()
165
166    def _up(self) -> None:
167        self._value = min(self._maxval, self._value + self._increment)
168        self._changed()
169
170    def _down(self) -> None:
171        self._value = max(self._minval, self._value - self._increment)
172        self._changed()
173
174    def _changed(self) -> None:
175        self._update_display()
176        if self._callback:
177            self._callback(self._value)
178        bui.app.config[self._configkey] = self._value
179        bui.app.config.apply_and_commit()
180
181    def _update_display(self) -> None:
182        if self._as_percent:
183            val = f'{round(self._value*100.0)}%'
184        else:
185            val = f'{self._value:.{self._f}f}'
186        bui.textwidget(edit=self.valuetext, text=val)