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