Module game_qu.getting_started.platforming game (example game)

This is an example of a simple platformer made using the game engine. Click the see 'Expand Source Code' button below to see the code.

"""This is an example of a simple platformer made using the game engine. Click the see 'Expand Source Code' button below
to see the code."""

# This must be before the other imports, so we can actually modify the constants. Otherwise, the constants will remain the
# same as the default values.
from game_qu.base.library_changer import LibraryChanger
from game_qu.base.colors import *

LibraryChanger.set_game_library("pygame")
LibraryChanger.set_screen_dimensions(1000, 600)
LibraryChanger.set_background_color(black)

# The rest of the imports
from game_qu.base.important_variables import *
from game_qu.base.velocity_calculator import VelocityCalculator
from game_qu.base.game_runner_function import run_game
from game_qu.base.paths import Path
from game_qu.math.point import Point
from game_qu.platformer.enemy import Enemy
from game_qu.platformer.platform import Platform
from game_qu.platformer.platformer_screen import PlatformerScreen
from game_qu.platformer.player import Player
from game_qu.gui_components.component import Component


class SimplePlayer(Player):
    """A simple player"""

    eye1 = None
    eye2 = None
    mouth = None

    def __init__(self, left_key, right_key, jump_key, down_key, attack_key):
        """Initializes the object"""

        super().__init__(left_key, right_key, jump_key, down_key, attack_key)
        self.set_color(gray)

        self.eye1 = Component("")
        self.eye2 = Component("")
        self.mouth = Component("")

        self.eye1.set_color(blue)
        self.eye2.set_color(blue)
        self.mouth.set_color(red)

    def render(self):
        """Renders this object onto the screen"""

        super().render()

        # Settings all the dimensions of the subcomponents for rendering (eyes and mouth)
        self.eye1.set_dimensions_within_component(25, 20, 20, 20, self)
        self.eye2.set_dimensions_within_component(55, 20, 20, 20, self)
        self.mouth.set_dimensions_within_component(10, 70, 80, 10, self)

        # Rendering the subcomponents
        self.eye1.render()
        self.eye2.render()
        self.mouth.render()


class SimpleEnemy(Enemy):
    """A simple enemy that moves back and forth across the platform"""

    eye = None

    def __init__(self, platform):
        """Initializes the object"""

        super().__init__(30, 20, platform, "")
        self.set_color(black)

        self.eye = Component("")
        self.eye.set_color(red)

    def get_point_value(self):
        return 100

    def render(self):
        """Renders this component onto the game"""

        super().render()
        self.eye.set_dimensions_within_component(0, 30, 100, 10, self)
        self.eye.render()


class SimplePlatform(Platform):
    """A simple platform"""

    grass = None

    def __init__(self):
        """Initializes the object"""

        super().__init__()
        self.set_color(brown)

        self.grass = Component("")
        self.grass.set_color(green)

    def render(self):
        """Renders this component onto the game"""

        super().render()
        self.grass.set_dimensions_within_component(0, 0, 100, 20, self)
        self.grass.render()


class MainScreen(PlatformerScreen):
    """The main screen of the game"""

    score_to_game_difficulty = Path(Point(0, 50), [Point(1000, 70), Point(1650, 95), Point(5000, 100),
                                    Point(float("inf"), 100)])

    # Here we will be implementing the abstract methods and modifying some methods to get what we want
    def get_enemy_types(self):
        """
            Returns:
                list[Enemy]: all the types of enemies that can be generated
        """

        return [SimpleEnemy]

    def get_game_difficulty(self):
        """
            Returns:
                float: the difficulty of the game based on the score of the player (from 0 to 100 with 100 being the hardest)
        """

        return self.score_to_game_difficulty.get_y_coordinate(self.player_score)

    def get_score_from_passing_platform(self):
        """
            Returns:
                int: the score from passing a platform
        """

        return 100

    def get_start_platform_coordinates(self):
        """
            Returns:
                list[float]: {left_edge, top_edge, length, height} of the start platform
        """

        return [0,
                VelocityCalculator.get_dimension(SCREEN_HEIGHT, 85),
                VelocityCalculator.get_dimension(SCREEN_LENGTH, 50),
                VelocityCalculator.get_dimension(SCREEN_HEIGHT, 15)]

    def get_players(self):
        """
            Returns:
                list[Player]: the players of the game
        """

        return [SimplePlayer(KEY_A, KEY_D, KEY_W, KEY_S, KEY_F)]


if __name__ == "__main__":
    # Finally running the game
    run_game(MainScreen())

Classes

class MainScreen

The main screen of the game

Initializes the object

Expand source code

class MainScreen(PlatformerScreen):
    """The main screen of the game"""

    score_to_game_difficulty = Path(Point(0, 50), [Point(1000, 70), Point(1650, 95), Point(5000, 100),
                                    Point(float("inf"), 100)])

    # Here we will be implementing the abstract methods and modifying some methods to get what we want
    def get_enemy_types(self):
        """
            Returns:
                list[Enemy]: all the types of enemies that can be generated
        """

        return [SimpleEnemy]

    def get_game_difficulty(self):
        """
            Returns:
                float: the difficulty of the game based on the score of the player (from 0 to 100 with 100 being the hardest)
        """

        return self.score_to_game_difficulty.get_y_coordinate(self.player_score)

    def get_score_from_passing_platform(self):
        """
            Returns:
                int: the score from passing a platform
        """

        return 100

    def get_start_platform_coordinates(self):
        """
            Returns:
                list[float]: {left_edge, top_edge, length, height} of the start platform
        """

        return [0,
                VelocityCalculator.get_dimension(SCREEN_HEIGHT, 85),
                VelocityCalculator.get_dimension(SCREEN_LENGTH, 50),
                VelocityCalculator.get_dimension(SCREEN_HEIGHT, 15)]

    def get_players(self):
        """
            Returns:
                list[Player]: the players of the game
        """

        return [SimplePlayer(KEY_A, KEY_D, KEY_W, KEY_S, KEY_F)]

Ancestors

• PlatformerScreen
• Screen
• Component
• Dimensions

Class variables

var score_to_game_difficulty

Inherited members

• PlatformerScreen:
  • add_game_objects_to_history_keeper
  • bottom_edge
  • get_additional_generation_items
  • get_code_ready_for_collisions
  • get_components
  • get_enemy_types
  • get_game_difficulty
  • get_players
  • get_scaled_dimensions
  • get_score_from_passing_platform
  • get_start_platform_coordinates
  • got_clicked
  • hide
  • horizontal_midpoint
  • is_platform
  • is_player
  • is_player_weapon
  • mouse_enter_function
  • mouse_exit_function
  • number_set_dimensions
  • percentage_set_dimensions
  • remove_platforms_not_within_screen
  • render
  • render_background
  • reset_game
  • right_edge
  • run
  • run_all_collisions
  • run_collision
  • run_game_code
  • run_platform_generation
  • run_player_collisions
  • run_players
  • run_side_scrolling
  • set_background_color
  • set_color
  • set_dimensions_within_component
  • set_is_visible
  • set_mouse_enter_function
  • set_mouse_exit_function
  • set_mouse_functions
  • set_path_to_background_image
  • setup_platforms
  • setup_players
  • show
  • side_scroll_all_objects
  • side_scroll_objects
  • update_rightmost_platform
  • update_score
  • vertical_midpoint

class SimpleEnemy (platform)

A simple enemy that moves back and forth across the platform

Initializes the object

Expand source code

class SimpleEnemy(Enemy):
    """A simple enemy that moves back and forth across the platform"""

    eye = None

    def __init__(self, platform):
        """Initializes the object"""

        super().__init__(30, 20, platform, "")
        self.set_color(black)

        self.eye = Component("")
        self.eye.set_color(red)

    def get_point_value(self):
        return 100

    def render(self):
        """Renders this component onto the game"""

        super().render()
        self.eye.set_dimensions_within_component(0, 30, 100, 10, self)
        self.eye.render()

Ancestors

• Enemy
• WeaponUser
• GameObject
• Component
• Dimensions
• abc.ABC

Class variables

var eye

Methods

def render(self)

Renders this component onto the game

Expand source code

def render(self):
    """Renders this component onto the game"""

    super().render()
    self.eye.set_dimensions_within_component(0, 30, 100, 10, self)
    self.eye.render()

Inherited members

• Enemy:
  • bottom_edge
  • cause_damage
  • get_all_components
  • get_collidable_components
  • get_collision_data
  • get_components
  • get_point_value
  • get_scaled_dimensions
  • got_clicked
  • horizontal_midpoint
  • mouse_enter_function
  • mouse_exit_function
  • number_set_dimensions
  • percentage_set_dimensions
  • reset_collision_data
  • right_edge
  • run
  • run_collisions
  • run_enemy_collision
  • run_inanimate_object_collision
  • run_player_interactions
  • run_upon_activation
  • set_color
  • set_dimensions_within_component
  • set_mouse_enter_function
  • set_mouse_exit_function
  • set_mouse_functions
  • update_collision_data
  • update_for_side_scrolling
  • update_platform_collision_data
  • update_top_collision_data
  • vertical_midpoint

class SimplePlatform

A simple platform

Initializes the object

Expand source code

class SimplePlatform(Platform):
    """A simple platform"""

    grass = None

    def __init__(self):
        """Initializes the object"""

        super().__init__()
        self.set_color(brown)

        self.grass = Component("")
        self.grass.set_color(green)

    def render(self):
        """Renders this component onto the game"""

        super().render()
        self.grass.set_dimensions_within_component(0, 0, 100, 20, self)
        self.grass.render()

Ancestors

• Platform
• GameObject
• Component
• Dimensions

Class variables

var grass

Methods

def render(self)

Renders this component onto the game

Expand source code

def render(self):
    """Renders this component onto the game"""

    super().render()
    self.grass.set_dimensions_within_component(0, 0, 100, 20, self)
    self.grass.render()

Inherited members

• Platform:
  • bottom_edge
  • get_all_components
  • get_collidable_components
  • get_scaled_dimensions
  • got_clicked
  • horizontal_midpoint
  • mouse_enter_function
  • mouse_exit_function
  • number_set_dimensions
  • percentage_set_dimensions
  • right_edge
  • run
  • run_collisions
  • set_color
  • set_dimensions_within_component
  • set_mouse_enter_function
  • set_mouse_exit_function
  • set_mouse_functions
  • update_for_side_scrolling
  • vertical_midpoint

class SimplePlayer (left_key, right_key, jump_key, down_key, attack_key)

A simple player

Initializes the object

Expand source code

class SimplePlayer(Player):
    """A simple player"""

    eye1 = None
    eye2 = None
    mouth = None

    def __init__(self, left_key, right_key, jump_key, down_key, attack_key):
        """Initializes the object"""

        super().__init__(left_key, right_key, jump_key, down_key, attack_key)
        self.set_color(gray)

        self.eye1 = Component("")
        self.eye2 = Component("")
        self.mouth = Component("")

        self.eye1.set_color(blue)
        self.eye2.set_color(blue)
        self.mouth.set_color(red)

    def render(self):
        """Renders this object onto the screen"""

        super().render()

        # Settings all the dimensions of the subcomponents for rendering (eyes and mouth)
        self.eye1.set_dimensions_within_component(25, 20, 20, 20, self)
        self.eye2.set_dimensions_within_component(55, 20, 20, 20, self)
        self.mouth.set_dimensions_within_component(10, 70, 80, 10, self)

        # Rendering the subcomponents
        self.eye1.render()
        self.eye2.render()
        self.mouth.render()

Ancestors

• Player
• WeaponUser
• GameObject
• Component
• Dimensions

Class variables

var eye1

var eye2

var mouth

Methods

def render(self)

Renders this object onto the screen

Expand source code

def render(self):
    """Renders this object onto the screen"""

    super().render()

    # Settings all the dimensions of the subcomponents for rendering (eyes and mouth)
    self.eye1.set_dimensions_within_component(25, 20, 20, 20, self)
    self.eye2.set_dimensions_within_component(55, 20, 20, 20, self)
    self.mouth.set_dimensions_within_component(10, 70, 80, 10, self)

    # Rendering the subcomponents
    self.eye1.render()
    self.eye2.render()
    self.mouth.render()

Inherited members

• Player:
  • acceleration_direction_is_possible
  • alter_player_horizontal_movement
  • alter_player_horizontal_movement_booleans
  • alter_player_left_edge_if_necessary
  • alter_player_vertical_movement
  • bottom_edge
  • cause_damage
  • change_attribute_if
  • continue_acceleration_after_partial_deceleration
  • create_paths
  • decelerate_player
  • get_all_components
  • get_collidable_components
  • get_collision_data
  • get_components
  • get_deceleration_is_rightwards
  • get_distance_to_reach_max_velocity
  • get_horizontal_velocity
  • get_jumping_path_bounded_functions
  • get_max_time_to_top_edge
  • get_scaled_dimensions
  • get_terminal_velocity_delta_time
  • get_topmost_top_edge
  • get_vertical_acceleration
  • get_vertical_velocity
  • got_clicked
  • horizontal_midpoint
  • horizontal_movement_has_stopped
  • jump
  • mouse_enter_function
  • mouse_exit_function
  • number_set_dimensions
  • percentage_set_dimensions
  • player_movement_direction_is_same_as_deceleration
  • reset
  • reset_collision_data
  • right_edge
  • run
  • run_acceleration
  • run_bottom_edge_collision
  • run_collisions
  • run_deceleration
  • run_enemy_collision
  • run_horizontal_movement
  • run_inanimate_object_collision
  • run_jump_type
  • run_respawning
  • run_upon_activation
  • run_vertical_movement
  • set_base_coordinates
  • set_color
  • set_dimensions_within_component
  • set_is_on_platform
  • set_jumping_path_to_default_jump
  • set_jumping_path_to_falling_path
  • set_jumping_path_with_apex
  • set_left_edge
  • set_mouse_enter_function
  • set_mouse_exit_function
  • set_mouse_functions
  • update_collision_data
  • update_falling_path
  • update_for_side_scrolling
  • update_jump_types
  • update_jumping_path
  • update_platform_collision_data
  • vertical_midpoint