bauiv1lib.settings package

Submodules

bauiv1lib.settings.advanced module

UI functionality for advanced settings.

class bauiv1lib.settings.advanced.AdvancedSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for editing advanced app settings.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.settings.allsettings module

UI for top level settings categories.

class bauiv1lib.settings.allsettings.AllSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for selecting a settings category.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.settings.audio module

Provides audio settings UI.

class bauiv1lib.settings.audio.AudioSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for editing audio settings.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.settings.benchmarks module

UIs for debugging purposes.

class bauiv1lib.settings.benchmarks.BenchmarksAndStressTestsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for launching benchmarks or stress tests.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.controls module

Provides a top level control settings window.

class bauiv1lib.settings.controls.ControlsSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Top level control settings window.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.settings.devtools module

UI functionality for Modding Tools.

class bauiv1lib.settings.devtools.DevToolsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for accessing modding tools.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.gamepad module

Settings UI functionality related to gamepads.

class bauiv1lib.settings.gamepad.AwaitGamepadInputWindow(gamepad: bs.InputDevice, button: str, callback: Callable[[str, dict[str, Any], AwaitGamepadInputWindow], Any], message: bui.Lstr | None = None, message2: bui.Lstr | None = None)

Bases: Window

Window for capturing a gamepad button press.

die() → None

Kill the window.

class bauiv1lib.settings.gamepad.GamepadSettingsWindow(inputdevice: InputDevice, *, modal: bool = False, transition: str | None = 'in_right', transition_out: str = 'out_right', origin_widget: Widget | None = None, settings: dict | None = None)

Bases: MainWindow

Window for configuring a gamepad.

get_advanced_button() → Widget

(internal)

get_auto_recalibrate_analog_stick_value() → bool

(internal)

get_control_value_name(control: str) → str | Lstr

(internal)

get_enable_secondary_value() → bool

(internal)

get_ext() → str

(internal)

get_ignore_completely_value() → bool

(internal)

get_input() → InputDevice

(internal)

get_is_secondary() → bool

(internal)

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

get_r() → str

(internal)

get_settings() → dict[str, Any]

(internal)

get_start_button_activates_default_widget_value() → bool

(internal)

get_ui_only_value() → bool

(internal)

get_unassigned_buttons_run_value() → bool

(internal)

popup_menu_closing(popup_window: PopupWindow) → None

Called when the popup is closing.

popup_menu_selected_choice(popup_window: PopupMenuWindow, choice: str) → None

Called when a choice is selected in the popup.

set_auto_recalibrate_analog_stick_value(value: bool) → None

(internal)

set_ignore_completely_value(value: bool) → None

(internal)

set_start_button_activates_default_widget_value(value: bool) → None

(internal)

set_ui_only_value(value: bool) → None

(internal)

set_unassigned_buttons_run_value(value: bool) → None

(internal)

show_secondary_editor() → None

(internal)

bauiv1lib.settings.gamepadadvanced module

UI functionality related to advanced gamepad configuring.

class bauiv1lib.settings.gamepadadvanced.GamepadAdvancedSettingsWindow(parent_window: GamepadSettingsWindow)

Bases: Window

Window for advanced gamepad configuration.

bauiv1lib.settings.gamepadselect module

Settings UI related to gamepad functionality.

class bauiv1lib.settings.gamepadselect.GamepadSelectWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for selecting a gamepad to configure.

gamepad_configure_callback(event: dict[str, Any]) → None

Respond to a gamepad button press during config selection.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.graphics module

Provides UI for graphics settings.

class bauiv1lib.settings.graphics.GraphicsSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for graphics settings.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.settings.keyboard module

Keyboard settings related UI functionality.

class bauiv1lib.settings.keyboard.AwaitKeyboardInputWindow(button: str, ui: Widget, settings: dict)

Bases: Window

Window for capturing a keypress.

class bauiv1lib.settings.keyboard.ConfigKeyboardWindow(c: InputDevice, transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for configuring keyboards.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

popup_menu_closing(popup_window: PopupWindow) → None

Called when the popup is closing.

popup_menu_selected_choice(popup_window: PopupMenuWindow, choice: str) → None

Called when a choice is selected in the popup.

bauiv1lib.settings.nettesting module

Provides ui for network related testing.

class bauiv1lib.settings.nettesting.NetTestingWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window that runs a networking test suite to help diagnose issues.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

print(text: str, color: tuple[float, float, float]) → None

Print text to our console thingie.

bauiv1lib.settings.nettesting.get_net_val_testing_window() → TestingWindow

Create a window for testing net values.

bauiv1lib.settings.plugins module

Plugin Window UI.

class bauiv1lib.settings.plugins.Category(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Categories we can display.

ALL = 'all'

DISABLED = 'disabled'

ENABLED = 'enabled'

property resource: str

Resource name for us.

class bauiv1lib.settings.plugins.PluginWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for configuring plugins.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

popup_menu_closing(popup_window: PopupWindow) → None

Called when the popup is closing.

popup_menu_selected_choice(popup_window: PopupMenuWindow, choice: str) → None

Called when a choice is selected in the popup.

bauiv1lib.settings.pluginsettings module

Plugin Settings UI.

class bauiv1lib.settings.pluginsettings.PluginSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Plugin Settings Window

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.remoteapp module

Settings UI functionality related to the remote app.

class bauiv1lib.settings.remoteapp.RemoteAppSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window showing info/settings related to the remote app.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.testing module

Provides UI for test settings.

class bauiv1lib.settings.testing.TestingWindow(title: bui.Lstr, entries: list[dict[str, Any]], transition: str | None = 'in_right', origin_widget: bui.Widget | None = None)

Bases: MainWindow

Window for conveniently testing various settings.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.touchscreen module

UI settings functionality related to touchscreens.

class bauiv1lib.settings.touchscreen.TouchscreenSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Settings window for touchscreens.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this window, if supported.

bauiv1lib.settings.vrtesting module

Provides UI for testing vr settings.

class bauiv1lib.settings.vrtesting.VRTestingWindow(transition: str = 'in_right')

Bases: TestingWindow

Window for testing vr settings.

Module contents