Updating comments and variable names

Author: JFincher42

arcade-platformer/arcade_platformer/01_game_skeleton.py

@@ -1,22 +1,17 @@
-#
-# Arcade Platformer
-#
-# Demonstrating the capbilities of arcade in a platformer game
-# Supporting the Arcade Platformer article on https://realpython.com
-#
-# All game artwork and sounds, except the tile map, from www.kenney.nl
-#
-
-# Import libraries
+"""
+Arcade Platformer
+
+Demonstrating the capbilities of arcade in a platformer game
+Supporting the Arcade Platformer article on https://realpython.com
+
+All game artwork from www.kenney.nl
+Game sounds and tile maps by author
+"""
+
 import arcade
 
 
-# Classes
 class Platformer(arcade.Window):
-    """Platformer class. Derived from arcade.Window,
-    manages different aspects of the game.
-    """
-
     def __init__(self):
         pass
 
@@ -41,19 +36,17 @@ def on_key_release(self, key: int, modifiers: int):
         """
 
     def on_update(self, delta_time: float):
-        """Updates the position of all screen objects
+        """Updates the position of all game objects
 
         Arguments:
             delta_time {float} -- How much time since the last call
         """
         pass
 
     def on_draw(self):
-        """Draws everything"""
         pass
 
 
-# Main
 if __name__ == "__main__":
     window = Platformer()
     window.setup()

arcade-platformer/arcade_platformer/02_open_game_window.py

@@ -1,14 +1,13 @@
-#
-# Arcade Platformer
-#
-# Demonstrating the capbilities of arcade in a platformer game
-# Supporting the Arcade Platformer article on https://realpython.com
-#
-# All game artwork and sounds, except the tile map and victory sound,
-# from www.kenney.nl
+"""
+Arcade Platformer
 
+Demonstrating the capbilities of arcade in a platformer game
+Supporting the Arcade Platformer article on https://realpython.com
+
+All game artwork from www.kenney.nl
+Game sounds and tile maps by author
+"""
 
-# Import libraries
 import arcade
 import pathlib
 
@@ -22,24 +21,17 @@
 ASSETS_PATH = pathlib.Path(__file__).resolve().parent.parent / "assets"
 
 
-# Classes
 class Platformer(arcade.Window):
-    """Platformer class. Derived from arcade.Window,
-    manages different aspects of the game.
-    """
-
     def __init__(self) -> None:
-        """Create the game view"""
-        # First initialize the parent
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
 
         # These lists will hold different sets of sprites
-        self.coins_list = None
-        self.background_list = None
-        self.walls_list = None
-        self.ladders_list = None
-        self.goals_list = None
-        self.enemies_list = None
+        self.coins = None
+        self.background = None
+        self.walls = None
+        self.ladders = None
+        self.goals = None
+        self.enemies = None
 
         # One sprite for the player, no more is needed
         self.player = None
@@ -69,36 +61,29 @@ def setup(self):
         pass
 
     def on_key_press(self, key: int, modifiers: int):
-        """Processes key presses
-
-        Arguments:
-            key {int} -- Which key was pressed
-            modifiers {int} -- Which modifiers were down at the time
+        """Arguments:
+        key {int} -- Which key was pressed
+        modifiers {int} -- Which modifiers were down at the time
         """
 
     def on_key_release(self, key: int, modifiers: int):
-        """Processes key releases
-
-        Arguments:
-            key {int} -- Which key was released
-            modifiers {int} -- Which modifiers were down at the time
+        """Arguments:
+        key {int} -- Which key was released
+        modifiers {int} -- Which modifiers were down at the time
         """
 
     def on_update(self, delta_time: float):
-        """Updates the position of all screen objects
+        """Updates the position of all game objects
 
         Arguments:
             delta_time {float} -- How much time since the last call
         """
         pass
 
     def on_draw(self):
-        """Draws everything"""
         pass
 
 
-# Main
-# Main
 if __name__ == "__main__":
     window = Platformer()
     window.setup()

arcade-platformer/arcade_platformer/03_read_level_one.py

@@ -1,14 +1,13 @@
-#
-# Arcade Platformer
-#
-# Demonstrating the capbilities of arcade in a platformer game
-# Supporting the Arcade Platformer article on https://realpython.com
-#
-# All game artwork and sounds, except the tile map and victory sound,
-# from www.kenney.nl
+"""
+Arcade Platformer
 
+Demonstrating the capbilities of arcade in a platformer game
+Supporting the Arcade Platformer article on https://realpython.com
+
+All game artwork from www.kenney.nl
+Game sounds and tile maps by author
+"""
 
-# Import libraries
 import arcade
 import pathlib
 
@@ -30,24 +29,17 @@
 ASSETS_PATH = pathlib.Path(__file__).resolve().parent.parent / "assets"
 
 
-# Classes
 class Platformer(arcade.Window):
-    """Platformer class. Derived from arcade.Window,
-    manages different aspects of the game.
-    """
-
     def __init__(self) -> None:
-        """Create the game view"""
-        # First initialize the parent
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
 
         # These lists will hold different sets of sprites
-        self.coins_list = None
-        self.background_list = None
-        self.walls_list = None
-        self.ladders_list = None
-        self.goals_list = None
-        self.enemies_list = None
+        self.coins = None
+        self.background = None
+        self.walls = None
+        self.ladders = None
+        self.goals = None
+        self.enemies = None
 
         # One sprite for the player, no more is needed
         self.player = None
@@ -87,29 +79,29 @@ def setup(self) -> None:
         ladders_layer = "ladders"
 
         # Load the current map
-        map = arcade.tilemap.read_tmx(str(map_path))
+        game_map = arcade.tilemap.read_tmx(str(map_path))
 
         # Load the layers
-        self.background_list = arcade.tilemap.process_layer(
-            map, layer_name=background_layer, scaling=MAP_SCALING
+        self.background = arcade.tilemap.process_layer(
+            game_map, layer_name=background_layer, scaling=MAP_SCALING
         )
-        self.goals_list = arcade.tilemap.process_layer(
-            map, layer_name=goal_layer, scaling=MAP_SCALING
+        self.goals = arcade.tilemap.process_layer(
+            game_map, layer_name=goal_layer, scaling=MAP_SCALING
         )
-        self.walls_list = arcade.tilemap.process_layer(
-            map, layer_name=wall_layer, scaling=MAP_SCALING
+        self.walls = arcade.tilemap.process_layer(
+            game_map, layer_name=wall_layer, scaling=MAP_SCALING
         )
-        self.ladders_list = arcade.tilemap.process_layer(
-            map, layer_name=ladders_layer, scaling=MAP_SCALING
+        self.ladders = arcade.tilemap.process_layer(
+            game_map, layer_name=ladders_layer, scaling=MAP_SCALING
         )
-        self.coins_list = arcade.tilemap.process_layer(
-            map, layer_name=coin_layer, scaling=MAP_SCALING
+        self.coins = arcade.tilemap.process_layer(
+            game_map, layer_name=coin_layer, scaling=MAP_SCALING
         )
 
         # Set the background color
         background_color = arcade.color.FRESH_AIR
-        if map.background_color:
-            background_color = map.background_color
+        if game_map.background_color:
+            background_color = game_map.background_color
         arcade.set_background_color(background_color)
 
         # Create the player sprite, if they're not already setup
@@ -125,42 +117,35 @@ def setup(self) -> None:
         # Load the physics engine for this map
         self.physics_engine = arcade.PhysicsEnginePlatformer(
             player_sprite=self.player,
-            platforms=self.walls_list,
+            platforms=self.walls,
             gravity_constant=GRAVITY,
-            ladders=self.ladders_list,
+            ladders=self.ladders,
         )
 
     def on_key_press(self, key: int, modifiers: int):
-        """Processes key presses
-
-        Arguments:
-            key {int} -- Which key was pressed
-            modifiers {int} -- Which modifiers were down at the time
+        """Arguments:
+        key {int} -- Which key was pressed
+        modifiers {int} -- Which modifiers were down at the time
         """
 
     def on_key_release(self, key: int, modifiers: int):
-        """Processes key releases
-
-        Arguments:
-            key {int} -- Which key was released
-            modifiers {int} -- Which modifiers were down at the time
+        """Arguments:
+        key {int} -- Which key was released
+        modifiers {int} -- Which modifiers were down at the time
         """
 
     def on_update(self, delta_time: float):
-        """Updates the position of all screen objects
+        """Updates the position of all game objects
 
         Arguments:
             delta_time {float} -- How much time since the last call
         """
         pass
 
     def on_draw(self):
-        """Draws everything"""
         pass
 
 
-# Main
-# Main
 if __name__ == "__main__":
     window = Platformer()
     window.setup()