Merge branch 'development' into gui/controller

# Conflicts:
#	CHANGELOG.md
#	arcade/gui/widgets/slider.py

Author: eruvanos

CHANGELOG.md

@@ -8,8 +8,13 @@ Arcade [PyPi Release History](https://pypi.org/project/arcade/#history) page.
 - GUI
   - Fix `UIScrollArea.add` always returning None
   - Support `layer` in `UIView.add_widget()`
+  - Fix a bug which caused `UIScrollArea` to refresh on every frame
+  - Add stepping to `UISlider` (thanks [csd4ni3l](https://github.com/csd4ni3l))
   - Experimental controller support (incl. documentation)
 - Text objects are now lazy and can be created before the window
+- Introduce `arcade.SpriteSequence[T]` as a covariant supertype of `arcade.SpriteList[T]`
+  (this is similar to Python's `Sequence[T]`, which is a supertype of `list[T]`)
+  and various improvements to the typing of the API that leverage it
 
 ## Version 3.1.0
 

arcade/__init__.py

@@ -168,6 +168,7 @@ def configure_logging(level: int | None = None):
 from .sprite import PyMunk
 from .sprite import PymunkMixin
 from .sprite import SpriteType
+from .sprite import SpriteType_co
 from .sprite import Sprite
 from .sprite import BasicSprite
 
@@ -176,6 +177,7 @@ def configure_logging(level: int | None = None):
 from .sprite import SpriteSolidColor
 
 from .sprite_list import SpriteList
+from .sprite_list import SpriteSequence
 from .sprite_list import check_for_collision
 from .sprite_list import check_for_collision_with_list
 from .sprite_list import check_for_collision_with_lists
@@ -283,9 +285,11 @@ def configure_logging(level: int | None = None):
     "BasicSprite",
     "Sprite",
     "SpriteType",
+    "SpriteType_co",
     "PymunkMixin",
     "SpriteCircle",
     "SpriteList",
+    "SpriteSequence",
     "SpriteSolidColor",
     "Text",
     "Texture",

arcade/examples/gui/2_widgets.py

@@ -410,12 +410,35 @@ def _show_interactive_widgets(self):
                 size_hint=(0.3, 0),
             )
         )
-        slider_row.add(
+        s1 = slider_row.add(UISlider(size_hint=(0.3, 1), step=1, style=UISlider.NO_STEP_STYLE))
+        s2 = slider_row.add(
+            UISlider(
+                size_hint=(0.3, 1),
+                step=5,
+            )
+        )
+        s3 = slider_row.add(
             UISlider(
-                size_hint=(0.2, None),
+                size_hint=(0.3, 1),
+                step=10,
             )
         )
 
+        @s1.event("on_change")
+        def _(event: UIOnChangeEvent):
+            s2.value = event.new_value
+            s3.value = event.new_value
+
+        @s2.event("on_change")
+        def _(event: UIOnChangeEvent):
+            s1.value = event.new_value
+            s3.value = event.new_value
+
+        @s3.event("on_change")
+        def _(event: UIOnChangeEvent):
+            s1.value = event.new_value
+            s2.value = event.new_value
+
         tex_slider_row = UIBoxLayout(vertical=False, size_hint=(1, 0.1), space_between=10)
         box.add(tex_slider_row)
 
@@ -428,7 +451,7 @@ def _show_interactive_widgets(self):
             )
         )
 
-        s1 = tex_slider_row.add(
+        ts1 = tex_slider_row.add(
             UITextureSlider(
                 thumb_texture=TEX_SLIDER_THUMB_BLUE,
                 track_texture=NinePatchTexture(10, 10, 10, 10, TEX_SLIDER_TRACK_BLUE),
@@ -440,7 +463,7 @@ def _show_interactive_widgets(self):
         green_style["normal"].filled_track = arcade.uicolor.GREEN_GREEN_SEA
         green_style["hover"].filled_track = arcade.uicolor.GREEN_EMERALD
         green_style["press"].filled_track = arcade.uicolor.GREEN_GREEN_SEA
-        s2 = tex_slider_row.add(
+        ts2 = tex_slider_row.add(
             UITextureSlider(
                 thumb_texture=TEX_SLIDER_THUMB_GREEN,
                 track_texture=NinePatchTexture(10, 10, 10, 10, TEX_SLIDER_TRACK_GREEN),
@@ -453,7 +476,7 @@ def _show_interactive_widgets(self):
         red_style["normal"].filled_track = arcade.uicolor.RED_POMEGRANATE
         red_style["hover"].filled_track = arcade.uicolor.RED_ALIZARIN
         red_style["press"].filled_track = arcade.uicolor.RED_POMEGRANATE
-        s3 = tex_slider_row.add(
+        ts3 = tex_slider_row.add(
             UITextureSlider(
                 thumb_texture=TEX_SLIDER_THUMB_RED,
                 track_texture=NinePatchTexture(10, 10, 10, 10, TEX_SLIDER_TRACK_RED),
@@ -462,20 +485,20 @@ def _show_interactive_widgets(self):
             )
         )
 
-        @s1.event("on_change")
+        @ts1.event("on_change")
         def _(event: UIOnChangeEvent):
-            s2.value = event.new_value
-            s3.value = event.new_value
+            ts2.value = event.new_value
+            ts3.value = event.new_value
 
-        @s2.event("on_change")
+        @ts2.event("on_change")
         def _(event: UIOnChangeEvent):
-            s1.value = event.new_value
-            s3.value = event.new_value
+            ts1.value = event.new_value
+            ts3.value = event.new_value
 
-        @s3.event("on_change")
+        @ts3.event("on_change")
         def _(event: UIOnChangeEvent):
-            s1.value = event.new_value
-            s2.value = event.new_value
+            ts1.value = event.new_value
+            ts2.value = event.new_value
 
         box.add(UISpace(size_hint=(0.2, 0.1)))
         text_area = box.add(

arcade/examples/gui/6_size_hints.py

@@ -98,7 +98,9 @@ def __init__(self):
         width_slider_box = center_box.add(UIBoxLayout(vertical=False, size_hint=(1, 0)))
         width_slider_box.add(UILabel("Modify size_hint:", bold=True))
         width_slider = width_slider_box.add(
-            arcade.gui.UISlider(min_value=0, max_value=10, value=0, size_hint=None, height=30)
+            arcade.gui.UISlider(
+                min_value=0, max_value=1, value=0, size_hint=None, height=30, step=0.1
+            )
         )
         width_value = width_slider_box.add(UILabel(bold=True))
 
@@ -116,17 +118,17 @@ def __init__(self):
 
         def update_size_hint_value(value: float):
             width_value.text = f"({value:.2f})"
-            dummy1.size_hint = (value / 10, 1)
-            dummy1.text = f"size_hint = ({value / 10:.2f}, 1)"
+            dummy1.size_hint = (value, 1)
+            dummy1.text = f"size_hint = ({value:.2f}, 1)"
 
-            dummy2.size_hint = (1 - value / 10, 1)
-            dummy2.text = f"size_hint = ({1 - value / 10:.2f}, 1)"
+            dummy2.size_hint = (1 - value, 1)
+            dummy2.text = f"size_hint = ({1 - value:.2f}, 1)"
 
         @width_slider.event("on_change")
         def on_change(event: UIOnChangeEvent):
             update_size_hint_value(event.new_value)
 
-        initial_value = 10
+        initial_value = 1
         width_slider.value = initial_value
         update_size_hint_value(initial_value)
 

arcade/examples/sprite_bullets_aimed.py

@@ -109,6 +109,9 @@ def on_draw(self):
     def on_mouse_press(self, x, y, button, modifiers):
         """ Called whenever the mouse button is clicked. """
 
+        # Play the gun sound
+        self.gun_sound.play()
+
         # Create a bullet
         bullet = arcade.Sprite(
             ":resources:images/space_shooter/laserBlue01.png",
@@ -159,10 +162,12 @@ def on_update(self, delta_time):
             # Check this bullet to see if it hit a coin
             hit_list = arcade.check_for_collision_with_list(bullet, self.coin_list)
 
-            # If it did, get rid of the bullet
+            # If it did, get rid of the bullet and play the hit sound
             if len(hit_list) > 0:
                 bullet.remove_from_sprite_lists()
 
+                self.hit_sound.play()
+
             # For every coin we hit, add to the score and remove the coin
             for coin in hit_list:
                 coin.remove_from_sprite_lists()

arcade/future/input/input_manager_example.py

@@ -26,7 +26,7 @@ class Player(arcade.Sprite):
     def __init__(
         self,
         texture,
-        walls: arcade.SpriteList,
+        walls: arcade.SpriteSequence[arcade.BasicSprite],
         input_manager_template: InputManager,
         controller: pyglet.input.Controller | None = None,
         center_x: float = 0.0,
@@ -76,11 +76,11 @@ def __init__(
         }
 
         self.players: list[Player | None] = []
-        self.player_list = arcade.SpriteList()
+        self.player_list: arcade.SpriteList[Player] = arcade.SpriteList()
         self.device_labels_batch = pyglet.graphics.Batch()
         self.player_device_labels: list[arcade.Text | None] = []
 
-        self.wall_list = arcade.SpriteList(use_spatial_hash=True)
+        self.wall_list: arcade.SpriteList[arcade.Sprite] = arcade.SpriteList(use_spatial_hash=True)
 
         for x in range(0, self.width + 64, 64):
             wall = arcade.Sprite(":resources:images/tiles/grassMid.png", scale=0.5)

arcade/future/light/light_demo.py

@@ -18,7 +18,7 @@ def __init__(self, width, height, title):
         super().__init__(width, height, title)
         self.background = arcade.load_texture(":resources:images/backgrounds/abstract_1.jpg")
 
-        self.torch_list = arcade.SpriteList()
+        self.torch_list: arcade.SpriteList[arcade.Sprite] = arcade.SpriteList()
         self.torch_list.extend(
             [
                 arcade.Sprite(

arcade/gui/experimental/scroll_area.py

@@ -319,6 +319,7 @@ def _do_render(self, surface: Surface, force=False) -> bool:
             self.do_render_base(surface)
             self.do_render(surface)
             self._rendered = True
+            self._requires_render = False
 
         return rendered