code-battles 1.5.9 → 1.6.0

package/dist/cjs/index.js

@@ -2520,7 +2520,7 @@ const RunSimulationBlock = () => {
     };
     const startRunNoUI = () => {
         setRunningNoUI(true);
-        runNoUI(map, apis, playerBots, seed.toString(), true);
+        runNoUI(map, apis, playerBots, seed.toString(), false);
     };
     const startRunNoUIN = (n) => {
         setLocalStorage("Results", {});
@@ -14575,7 +14575,7 @@ const Round = () => {
                                         React.createElement(core.Button, { leftSection: React.createElement("i", { className: "fa-solid fa-play" }), size: "xs", onClick: () => navigate(`/simulation/${round.map.replaceAll(" ", "-")}/${round.players.join("-")}?showcase=true`) }, "Simulate"),
                                         React.createElement(core.Button, { leftSection: React.createElement("i", { className: "fa-solid fa-forward" }), size: "xs", onClick: () => {
                                                 if (roundIterations === 1) {
-                                                    runNoUI(round.map, apis, round.players, "", true);
+                                                    runNoUI(round.map, apis, round.players, "", false);
                                                 }
                                                 else {
                                                     currentMap = round.map;
@@ -16086,7 +16086,7 @@ const Simulation = () => {
                         React.createElement(PlayPauseButton, null),
                         downloadBytes && (React.createElement(core.Button, { ml: "xs", radius: "20px", leftSection: React.createElement("i", { className: "fa-solid fa-download" }), color: "blue", onClick: () => downloadFile(`${playerNames.join("-")}.btl`, "text/plain", 
                             // @ts-ignore
-                            window.simulationToDownload) }, "Download Simulation"))),
+                            window.simulationToDownload) }, "Download"))),
                     showcaseMode && React.createElement("span", { id: "render-status" }),
                     React.createElement("p", { style: { margin: 0 } }, "Playback Speed"),
                     React.createElement(core.Slider, { style: { flex: "none" }, mb: 30, w: 500, maw: "85%", min: -2, defaultValue: 0, marks: [

package/dist/code_battles/battles.py

@@ -10,7 +10,7 @@ import sys
 import traceback
 import gzip
 
-from typing import Any, Dict, Generic, List, Optional, Tuple, TypeVar
+from typing import Any, Dict, Generic, List, Optional, Set, Tuple, TypeVar
 from code_battles.utilities import (
     GameCanvas,
     console_log,
@@ -135,6 +135,7 @@ class CodeBattles(
     _eliminated: List[int]
     _sounds: Dict[str, "js.Audio"] = {}
     _decisions: List[bytes]
+    _breakpoints: Set[int]
     _since_last_render: int
 
     def render(self) -> None:
@@ -292,6 +293,16 @@ class CodeBattles(
         """Configure the version of the game, which is stored in the simulation files."""
         return "1.0.0"
 
+    @web_only
+    def download_image(self, url: str) -> "asyncio.Future[js.Image]":
+        from js import Image
+
+        result = asyncio.Future()
+        image = Image.new()
+        image.onload = lambda _: result.set_result(image)
+        image.src = url
+        return result
+
     @web_only
     def download_images(
         self, sources: List[Tuple[str, str]]
@@ -393,7 +404,7 @@ class CodeBattles(
             self.play_sound("player_eliminated")
         self._eliminated.append(player_index)
         self.log(
-            f"[Game T{self.step}] Player #{player_index + 1} ({self.player_names[player_index]}) was eliminated: {reason}",
+            f"[Battles {self.step + 1}] Player #{player_index + 1} ({self.player_names[player_index]}) was eliminated: {reason}",
             -1,
             "white",
         )
@@ -420,10 +431,17 @@ class CodeBattles(
             )
 
     @web_only
-    def play_sound(self, sound: str):
-        """Plays the given sound, from the URL given by :func:`configure_sound_url`."""
+    def play_sound(self, sound: str, force=False):
+        """
+        Plays the given sound, from the URL given by :func:`configure_sound_url`.
+
+        If ``force`` is set, will play the sound even if the simulation is not :attr:`verbose`.
+        """
         from js import window, Audio
 
+        if not force and not self.verbose:
+            return
+
         if sound not in self._sounds:
             self._sounds[sound] = Audio.new(self.configure_sound_url(sound))
 
@@ -441,6 +459,14 @@ class CodeBattles(
 
         asyncio.get_event_loop().run_until_complete(p())
 
+    def pause(self):
+        """
+        Pauses the current simulation. Useful for letting bots insert breakpoints wherever they wish.
+
+        **Important:** call this method only from the :func:`make_decisions` method.
+        """
+        self._should_pause = True
+
     @property
     def time(self) -> str:
         """The current step of the simulation, as a string with justification to fill 5 characters."""
@@ -473,6 +499,7 @@ class CodeBattles(
             seed = Random().randint(0, 2**128)
         self._logs = []
         self._decisions = []
+        self._breakpoints = set()
         self._decision_index = 0
         self._seed = seed
         self.step = 0
@@ -511,6 +538,7 @@ class CodeBattles(
         self.verbose = False
         self._initialize_simulation(player_codes, seed)
         while not self.over:
+            self._should_pause = False
             self._logs = []
             decisions = self.make_decisions()
             logs = self._logs
@@ -521,6 +549,7 @@ class CodeBattles(
                 base64.b64encode(decisions).decode(),
                 json.dumps(logs),
                 "true" if self.over else "false",
+                "true" if self._should_pause else "false",
             )
 
             if not self.over:
@@ -644,7 +673,7 @@ class CodeBattles(
             self.player_names = simulation.player_names
             self.background = False
             self.console_visible = True
-            self.verbose = False
+            self.verbose = True
             self._initialize_simulation(
                 ["" for _ in simulation.player_names], simulation.seed
             )
@@ -654,8 +683,8 @@ class CodeBattles(
                 document.getElementById("simulation"),
                 self.configure_board_count(),
                 self.map_image,
-                document.body.clientWidth - 440,
-                document.body.clientHeight - 280,
+                self._get_canvas_width(),
+                self._get_canvas_height(),
                 self.configure_extra_width(),
                 self.configure_extra_height(),
             )
@@ -701,12 +730,8 @@ class CodeBattles(
                     document.getElementById("simulation"),
                     self.configure_board_count(),
                     self.map_image,
-                    document.body.clientWidth - 440
-                    if console_visible
-                    else document.body.clientWidth - 40,
-                    document.body.clientHeight - 280
-                    if console_visible
-                    else document.body.clientHeight - 160,
+                    self._get_canvas_width(),
+                    self._get_canvas_height(),
                     self.configure_extra_width(),
                     self.configure_extra_height(),
                 )
@@ -730,6 +755,26 @@ class CodeBattles(
         except Exception:
             traceback.print_exc()
 
+    @web_only
+    def _get_canvas_width(self):
+        from js import document
+
+        return (
+            document.body.clientWidth - 440
+            if self.console_visible
+            else document.body.clientWidth - 40
+        )
+
+    @web_only
+    def _get_canvas_height(self):
+        from js import document
+
+        return (
+            document.body.clientHeight - 255
+            if self.console_visible
+            else document.body.clientHeight - 180
+        )
+
     def _get_simulation(self):
         return Simulation(
             self.map,
@@ -742,14 +787,19 @@ class CodeBattles(
             self._seed,
         )
 
-    def _update_step(self, decisions_str: str, logs_str: str, is_over_str: str):
+    def _update_step(
+        self, decisions_str: str, logs_str: str, is_over_str: str, should_pause_str: str
+    ):
         from js import window, document
 
         now = time.time()
         decisions = base64.b64decode(str(decisions_str))
         logs: list = json.loads(str(logs_str))
         is_over = str(is_over_str) == "true"
+        should_pause = str(should_pause_str) == "true"
 
+        if should_pause:
+            self._breakpoints.add(len(self._decisions))
         self._decisions.append(decisions)
         self._logs.append(logs)
 
@@ -836,22 +886,24 @@ class CodeBattles(
 
     @web_only
     def _resize_canvas(self):
-        from js import document
-
         if not hasattr(self, "canvas"):
             return
 
         self.canvas._fit_into(
-            document.body.clientWidth - 440
-            if self.console_visible
-            else document.body.clientWidth - 40,
-            document.body.clientHeight - 280
-            if self.console_visible
-            else document.body.clientHeight - 160,
+            self._get_canvas_width(),
+            self._get_canvas_height(),
         )
         if not self.background:
             self.render()
 
+    @web_only
+    def _ensure_paused(self):
+        from js import document
+
+        if "Pause" in document.getElementById("playpause").textContent:
+            # Make it apparent that the game is stopped.
+            document.getElementById("playpause").click()
+
     @web_only
     def _step(self):
         from js import document, setTimeout
@@ -894,12 +946,8 @@ class CodeBattles(
             else:
                 self._since_last_render += 1
 
-            if (
-                self.over
-                and "Pause" in document.getElementById("playpause").textContent
-            ):
-                # Make it apparent that the game is stopped.
-                document.getElementById("playpause").click()
+            if self.over:
+                self._ensure_paused()
         elif self.verbose:
             document.getElementById("noui-progress").style.display = "block"
             document.getElementById(
@@ -924,6 +972,12 @@ class CodeBattles(
         if self.step == self._get_breakpoint():
             return False
 
+        if self.step in self._breakpoints and self.console_visible:
+            self._breakpoints.remove(self.step)
+            self._ensure_paused()
+            self.log(f"[Battles {self.step + 1}] Pause requested!")
+            return False
+
         return True
 
     @web_only

package/dist/code_battles/utilities.py

@@ -5,6 +5,7 @@ import math
 import sys
 from typing import Callable, List, Union
 from enum import Enum
+from functools import wraps
 
 try:
     import js
@@ -33,6 +34,7 @@ def web_only(method):
     if is_web():
         return method
 
+    @wraps(method)
     def wrapper(*args, **kwargs):
         print(f"Warning: {method.__name__} should only be called in a web context.")
 
@@ -223,6 +225,10 @@ class GameCanvas:
         stroke_width=10,
         board_index=0,
     ):
+        """
+        Draws a line between the given ``(start_x, start_y)`` and ``(end_x, end_y)`` coordinates (in map pixels) with the given stroke.
+        """
+
         start_x, start_y = self._translate_position(board_index, start_x, start_y)
         end_x, end_y = self._translate_position(board_index, end_x, end_y)
 

package/dist/esm/index.js

@@ -2518,7 +2518,7 @@ const RunSimulationBlock = () => {
     };
     const startRunNoUI = () => {
         setRunningNoUI(true);
-        runNoUI(map, apis, playerBots, seed.toString(), true);
+        runNoUI(map, apis, playerBots, seed.toString(), false);
     };
     const startRunNoUIN = (n) => {
         setLocalStorage("Results", {});
@@ -14573,7 +14573,7 @@ const Round = () => {
                                         React.createElement(Button, { leftSection: React.createElement("i", { className: "fa-solid fa-play" }), size: "xs", onClick: () => navigate(`/simulation/${round.map.replaceAll(" ", "-")}/${round.players.join("-")}?showcase=true`) }, "Simulate"),
                                         React.createElement(Button, { leftSection: React.createElement("i", { className: "fa-solid fa-forward" }), size: "xs", onClick: () => {
                                                 if (roundIterations === 1) {
-                                                    runNoUI(round.map, apis, round.players, "", true);
+                                                    runNoUI(round.map, apis, round.players, "", false);
                                                 }
                                                 else {
                                                     currentMap = round.map;
@@ -16084,7 +16084,7 @@ const Simulation = () => {
                         React.createElement(PlayPauseButton, null),
                         downloadBytes && (React.createElement(Button, { ml: "xs", radius: "20px", leftSection: React.createElement("i", { className: "fa-solid fa-download" }), color: "blue", onClick: () => downloadFile(`${playerNames.join("-")}.btl`, "text/plain", 
                             // @ts-ignore
-                            window.simulationToDownload) }, "Download Simulation"))),
+                            window.simulationToDownload) }, "Download"))),
                     showcaseMode && React.createElement("span", { id: "render-status" }),
                     React.createElement("p", { style: { margin: 0 } }, "Playback Speed"),
                     React.createElement(Slider, { style: { flex: "none" }, mb: 30, w: 500, maw: "85%", min: -2, defaultValue: 0, marks: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-battles",
-  "version": "1.5.9",
+  "version": "1.6.0",
   "description": "A library for building interactive competitive coding battles",
   "repository": "https://github.com/noamzaks/code-battles",
   "homepage": "https://code-battles.readthedocs.org",