Module botroyale.gui.battle

Battle screen.

Displays the actual battle and is associated with a BattleAPI. The BattleFrame displays the battle and all of it's GUI components, handles user interactions, and interfaces with the API object.

"""Battle screen.

Displays the actual battle and is associated with a `botroyale.api.gui.BattleAPI`.
The `BattleFrame` displays the battle and all of it's GUI components, handles
user interactions, and interfaces with the API object.
"""
from typing import Callable
from botroyale.api.gui import Control, BattleAPI
from botroyale.gui import (
    kex as kx,
    _defaults as defaults,
    register_controls,
    hotkey_logger,
    logger,
)
from botroyale.gui.battle._tilemap import TileMap
from botroyale.gui.menubar import MenuBar


class BattleScreen(kx.ZBox):
    """See module documentation for details."""

    def __init__(self, app_controls: list[Control], return_to_menu: Callable[[], None]):
        """The container screen.

        Args:
            app_controls: A list of Controls for this screen.
            return_to_menu: The function to call for returning to the main menu.
        """
        super().__init__(orientation="vertical")
        self.app_controls = app_controls
        self.return_to_menu = return_to_menu
        self.placeholder = _get_placeholder(return_to_menu)
        self.bar = self.add(MenuBar(app_controls))
        self.battle_frame = self.add(kx.Anchor())
        self.battle_frame.add(self.placeholder)
        self.battle_in_progress = None
        self.im = kx.InputManager(
            name="Battle",
            default_controls=False,
            logger=hotkey_logger,
            log_callback=True,
        )

    def update(self, *args):
        """Update battle GUI if in progress."""
        if self.battle_in_progress:
            self.battle_in_progress.update()

    def activate(self, *args):
        """Activate the Battle GUI."""
        self.im.active = True
        if self.battle_in_progress:
            self.battle_in_progress.set_visible(True)

    def deactivate(self, *args):
        """Deactivate the Battle GUI."""
        self.im.active = False
        if self.battle_in_progress:
            self.battle_in_progress.set_visible(False)

    def start_new_battle(self, api: BattleAPI):
        """Start a new battle given an API object."""
        logger(f"Starting new battle: {api=}")
        assert isinstance(api, BattleAPI)
        self.battle_in_progress = BattleFrame(api=api)
        self.battle_frame.clear_widgets()
        self.battle_frame.add(self.battle_in_progress)
        controls = self.battle_in_progress.get_controls()
        self.bar.set_controls(self.app_controls + controls)
        register_controls(self.im, controls)


class BattleFrame(kx.Anchor):
    """Container for the panel and tilemap."""

    def __init__(self, api: BattleAPI, **kwargs):
        """Initialize with an API object."""
        super().__init__(**kwargs)
        self.api = api
        self.panel = Panel(api)
        self.map = TileMap(api)
        main_frame = self.add(kx.ZBox(orientation="horizontal"))
        main_frame.add(self.panel.set_size(hx=0.5))
        main_frame.add(self.map)

    def get_controls(self):
        """Get the Controls from the different components of the battle API and GUI."""
        map_controls = self.map.get_controls()
        api_controls = self.api.get_controls()
        return map_controls + api_controls

    def set_visible(self, visible):
        """Declare the widget's visibility."""
        self.api.set_visible(visible)

    def update(self):
        """Refresh all things battle-related."""
        self.api.update()
        self.panel.update()
        self.map.update()
        self.app.overlay_calls(self.api.flush_overlays())


class Panel(kx.Box):
    """Container for the info panel."""

    def __init__(self, api: BattleAPI, **kwargs):
        """Initialize with an API object."""
        super().__init__(orientation="vertical")
        self.make_bg(defaults.COLORS["dark"].bg)
        self.api = api
        text_frame = self.add(
            kx.Anchor(anchor_x="left", anchor_y="top", padding=(15, 15))
        )
        self.main_text = text_frame.add(
            kx.Label(
                valign="top",
                halign="left",
                **defaults.TEXT_MONO,
            ),
        )

    def update(self):
        """Update the panel text."""
        text = self.api.get_info_panel_text()
        self.main_text.text = text
        color_name = self.api.get_info_panel_color()
        color = defaults.COLORS[color_name]
        self.main_text.color = color.fg.rgba
        self.make_bg(color.bg)


def _get_placeholder(return_to_menu):
    anchor = kx.Anchor()
    anchor.make_bg(defaults.COLORS["default"].bg)
    box = anchor.add(kx.Box(orientation="vertical"))
    box.set_size(x=300, y=300)
    label = kx.Label(
        text="No battle in progress.\nStart a new battle in the menu.",
        **(defaults.TEXT | {"color": defaults.COLORS["default"].fg.rgba}),
    )
    label.set_size(hy=4)
    button = kx.Button(
        text="Return to menu",
        on_release=lambda *a: return_to_menu(),
        **defaults.BUTTON,
    )
    box.add(label, button)
    return anchor

Classes

class BattleFrame (api: BattleAPI, **kwargs)

Container for the panel and tilemap.

Initialize with an API object.

Expand source code Browse git

class BattleFrame(kx.Anchor):
    """Container for the panel and tilemap."""

    def __init__(self, api: BattleAPI, **kwargs):
        """Initialize with an API object."""
        super().__init__(**kwargs)
        self.api = api
        self.panel = Panel(api)
        self.map = TileMap(api)
        main_frame = self.add(kx.ZBox(orientation="horizontal"))
        main_frame.add(self.panel.set_size(hx=0.5))
        main_frame.add(self.map)

    def get_controls(self):
        """Get the Controls from the different components of the battle API and GUI."""
        map_controls = self.map.get_controls()
        api_controls = self.api.get_controls()
        return map_controls + api_controls

    def set_visible(self, visible):
        """Declare the widget's visibility."""
        self.api.set_visible(visible)

    def update(self):
        """Refresh all things battle-related."""
        self.api.update()
        self.panel.update()
        self.map.update()
        self.app.overlay_calls(self.api.flush_overlays())

Ancestors

• XAnchor
• XWidget
• kivy.uix.anchorlayout.AnchorLayout
• kivy.uix.layout.Layout
• kivy.uix.widget.Widget
• kivy.uix.widget.WidgetBase
• kivy._event.EventDispatcher
• kivy._event.ObjectWithUid

Methods

def get_controls(self)

Get the Controls from the different components of the battle API and GUI.

Expand source code Browse git

def get_controls(self):
    """Get the Controls from the different components of the battle API and GUI."""
    map_controls = self.map.get_controls()
    api_controls = self.api.get_controls()
    return map_controls + api_controls

def set_visible(self, visible)

Declare the widget's visibility.

Expand source code Browse git

def set_visible(self, visible):
    """Declare the widget's visibility."""
    self.api.set_visible(visible)

def update(self)

Refresh all things battle-related.

Expand source code Browse git

def update(self):
    """Refresh all things battle-related."""
    self.api.update()
    self.panel.update()
    self.map.update()
    self.app.overlay_calls(self.api.flush_overlays())

Inherited members

• XAnchor:
  • add
  • app
  • logger
  • make_bg
  • make_fg
  • set_focus
  • set_position
  • set_size

class BattleScreen (app_controls: list[Control], return_to_menu: Callable[[], None])

See module documentation for details.

The container screen.

Args

-----=

app_controls

A list of Controls for this screen.

return_to_menu

The function to call for returning to the main menu.

Expand source code Browse git

class BattleScreen(kx.ZBox):
    """See module documentation for details."""

    def __init__(self, app_controls: list[Control], return_to_menu: Callable[[], None]):
        """The container screen.

        Args:
            app_controls: A list of Controls for this screen.
            return_to_menu: The function to call for returning to the main menu.
        """
        super().__init__(orientation="vertical")
        self.app_controls = app_controls
        self.return_to_menu = return_to_menu
        self.placeholder = _get_placeholder(return_to_menu)
        self.bar = self.add(MenuBar(app_controls))
        self.battle_frame = self.add(kx.Anchor())
        self.battle_frame.add(self.placeholder)
        self.battle_in_progress = None
        self.im = kx.InputManager(
            name="Battle",
            default_controls=False,
            logger=hotkey_logger,
            log_callback=True,
        )

    def update(self, *args):
        """Update battle GUI if in progress."""
        if self.battle_in_progress:
            self.battle_in_progress.update()

    def activate(self, *args):
        """Activate the Battle GUI."""
        self.im.active = True
        if self.battle_in_progress:
            self.battle_in_progress.set_visible(True)

    def deactivate(self, *args):
        """Deactivate the Battle GUI."""
        self.im.active = False
        if self.battle_in_progress:
            self.battle_in_progress.set_visible(False)

    def start_new_battle(self, api: BattleAPI):
        """Start a new battle given an API object."""
        logger(f"Starting new battle: {api=}")
        assert isinstance(api, BattleAPI)
        self.battle_in_progress = BattleFrame(api=api)
        self.battle_frame.clear_widgets()
        self.battle_frame.add(self.battle_in_progress)
        controls = self.battle_in_progress.get_controls()
        self.bar.set_controls(self.app_controls + controls)
        register_controls(self.im, controls)

Ancestors

• XZBox
• XWidget
• kivy.uix.gridlayout.GridLayout
• kivy.uix.layout.Layout
• kivy.uix.widget.Widget
• kivy.uix.widget.WidgetBase
• kivy._event.EventDispatcher
• kivy._event.ObjectWithUid

Methods

def activate(self, *args)

Activate the Battle GUI.

Expand source code Browse git

def activate(self, *args):
    """Activate the Battle GUI."""
    self.im.active = True
    if self.battle_in_progress:
        self.battle_in_progress.set_visible(True)

def deactivate(self, *args)

Deactivate the Battle GUI.

Expand source code Browse git

def deactivate(self, *args):
    """Deactivate the Battle GUI."""
    self.im.active = False
    if self.battle_in_progress:
        self.battle_in_progress.set_visible(False)

def start_new_battle(self, api: BattleAPI)

Start a new battle given an API object.

Expand source code Browse git

def start_new_battle(self, api: BattleAPI):
    """Start a new battle given an API object."""
    logger(f"Starting new battle: {api=}")
    assert isinstance(api, BattleAPI)
    self.battle_in_progress = BattleFrame(api=api)
    self.battle_frame.clear_widgets()
    self.battle_frame.add(self.battle_in_progress)
    controls = self.battle_in_progress.get_controls()
    self.bar.set_controls(self.app_controls + controls)
    register_controls(self.im, controls)

def update(self, *args)

Update battle GUI if in progress.

Expand source code Browse git

def update(self, *args):
    """Update battle GUI if in progress."""
    if self.battle_in_progress:
        self.battle_in_progress.update()

Inherited members

• XZBox:
  • add
  • app
  • logger
  • make_bg
  • make_fg
  • set_focus
  • set_position
  • set_size

class Panel (api: BattleAPI, **kwargs)

Container for the info panel.

Initialize with an API object.

Expand source code Browse git

class Panel(kx.Box):
    """Container for the info panel."""

    def __init__(self, api: BattleAPI, **kwargs):
        """Initialize with an API object."""
        super().__init__(orientation="vertical")
        self.make_bg(defaults.COLORS["dark"].bg)
        self.api = api
        text_frame = self.add(
            kx.Anchor(anchor_x="left", anchor_y="top", padding=(15, 15))
        )
        self.main_text = text_frame.add(
            kx.Label(
                valign="top",
                halign="left",
                **defaults.TEXT_MONO,
            ),
        )

    def update(self):
        """Update the panel text."""
        text = self.api.get_info_panel_text()
        self.main_text.text = text
        color_name = self.api.get_info_panel_color()
        color = defaults.COLORS[color_name]
        self.main_text.color = color.fg.rgba
        self.make_bg(color.bg)

Ancestors

• XBox
• XWidget
• kivy.uix.boxlayout.BoxLayout
• kivy.uix.layout.Layout
• kivy.uix.widget.Widget
• kivy.uix.widget.WidgetBase
• kivy._event.EventDispatcher
• kivy._event.ObjectWithUid

Methods

def update(self)

Update the panel text.

Expand source code Browse git

def update(self):
    """Update the panel text."""
    text = self.api.get_info_panel_text()
    self.main_text.text = text
    color_name = self.api.get_info_panel_color()
    color = defaults.COLORS[color_name]
    self.main_text.color = color.fg.rgba
    self.make_bg(color.bg)

Inherited members

• XBox:
  • add
  • app
  • logger
  • make_bg
  • make_fg
  • set_focus
  • set_position
  • set_size