PyGameExamplesAndAnswers

           reply.it

“It is not enough for code to work.”
Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship

---

Sprite, Group and Sprite mask

Sprite

Related Stack Overflow questions:

• What is the difference between pygame sprite and surface?
• Created multiple instances of the same image using a loop, can I move each instance of the image independently?

• How can I deepcopy a pygame sprite group?

• How to use sprites in PyGame?

• Making and using pygame sprites for donkey kong style game**

  📁 Minimal example - Minimal sprite image

  repl.it/@Rabbid76/PyGame-Sprite

• Why We Have to Use self.rect and self.image to Determine Rect and Surf on Sprites?

  📁 Minimal example - Minimal sprite update

A pygame.sprite.Sprite encapsulates an pygame.Surface object and an pygame.Rect object. It should have and an image and a rect attribute. image stores the sprite and rect stores the position and size of the sprite.

pygame.sprite.Group.draw() and pygame.sprite.Group.update() are methods which are provided by pygame.sprite.Group.

The latter delegates to the update method of the contained pygame.sprite.Sprites — you have to implement the method. See pygame.sprite.Group.update():

Calls the update() method on all Sprites in the Group. […]

The former uses the image and rect attributes of the contained pygame.sprite.Sprites to draw the objects — you have to ensure that the pygame.sprite.Sprites have the required attributes. See pygame.sprite.Group.draw():

Draws the contained Sprites to the Surface argument. This uses the Sprite.image attribute for the source surface, and Sprite.rect. […]

The Sprites in the Groups can be removed and thus destroyed by calling pygame.sprite.Sprite.kill. When the object is no longer referenced, it is destroyed:

The Sprite is removed from all the Groups that contain it. This won’t change anything about the state of the Sprite. It is possible to continue to use the Sprite after this method has been called, including adding it to Groups.

If chased is a pygame.sprite.Group object, then you can get a list of pygame.sprite.Sprite objects by the method sprites():

enemy = min([e for e in chased.sprites()], 
            key=lambda e: pow(e.x-entity.x, 2) + pow(e.y-entity.y, 2))

Text sprite

Related Stack Overflow questions:

• pygame. How to render the text like a all_sprites.update() but all_texts.update()?
  

📁 Minimal example - Text sprite

Sprite Groups

Related Stack Overflow questions:

• What does pygame.sprite.Group() do

  📁 Minimal example - Minimal sprite group

• Why We Have to Use self.rect and self.image to Determine Rect and Surf on Sprites?
• Why do group lists in pygame have to have “update” functions, and not any other?
• Why is my PyGame Sprite, in a Group, not drawn - AttributeError: ‘Group’ object has no attribute ‘blitme’
• Can I create and handle a pygame sprite not in a group the same way as if it’s in a group?
• How to have each sprite in a group A chasing the closest sprite in group B?
• How to remove image, then blit it again?
• How to reference and manipulate a single entity in a sprite group in pygame?

A pygame.sprite.Group is iterable. Hence you can go through the elements in a for-loop:

for sprite in sprite_group:
    # [...]

Alternatively, you can use the sprites() method:

Return a list of all the Sprites this group contains.

Get a list of Sprites and access them by subscription:

sprite_list = sprite_group.sprites()
sprite_1 = sprite_list[0]

Extend pygame.sprite.Group.draw with special_flags

class MyGroup(pygame.sprite.Group):
    def __init__(self, *args):
        super().__init__(*args) 
    def draw(self, surface, special_flags=0):
        for sprite in self:
            surface.blit(sprite.image, sprite.rect, special_flags = special_flags)

Layers and layered Group

Related Stack Overflow questions:

• Pygame sprite disappearing with layeredUpdates at a certain Y coordinate

• pygame.sprite.LayeredUpdates.move_to_front() does not work

Render update Group

Related Stack Overflow questions:

• Background image change glitches

  📁 Minimal example - Minimal sprite group - render update

Destroy (kill) Sprite objects

• end the pygame when player mises the target more than three times
• Found a strange hitbox bug in pygame. If the player dies in my game, the hitbox stays which creates some problems
• How to determine why objects pass through each other in Colliderect
• When I use pygame.sprite.spritecollide(), why does only the bullets disappear?

You can get a list of pygame.sprite.Sprite objects by the method sprites():

enemy = min([e for e in chased.sprites()], key=lambda e: pow(e.x-entity.x, 2) + pow(e.y-entity.y, 2))

• Why is self.kill() not removing the object from the group?

  📁 Minimal example - sprite group kill issue

Sprite collide

Related Stack Overflow questions:

• How do you program collision in classes?
• Collisions still aren’t getting detected in pygame
• How do you assign a “rect” attribute to a pygame.sprite.rect rectangle in Pygame?
• pygame-‘pygame.Rect’ object has no attribute ‘rect’
• Collisions still aren’t getting detected in pygame
  

📁 Minimal example - Minimal sprite collide

📁 Minimal example - Minimal sprite collide (class)

Sprite collide with Sprite

Related Stack Overflow questions:

• How do I register collisions with objects from the same class without an unwanted object from another class in my group?

User defined collide function

Related Stack Overflow questions:

• How to make entities take damage with color collision in pygame?
  ![How to make entities take damage with color collision in pygame?

  📁 Minimal example - User defined collision function

Sprite collide with Group

Related Stack Overflow questions:

• Pygame - getting a sprite to cycle through images in a class, and assign a hitbox
• Tank collides with walls in pygame

Group collide with Group

Related Stack Overflow questions:

• How to verify collision between two sprites in the same pygame.sprite.Group()?
• Permanently delete sprite from memory Pygame
• pygame.sprite.groupcollide() does not work when trying to implement collision in pygame
• How to use groupcollide?

Circular sprite collision

Related Stack Overflow questions:

• Curvy snake collision with itself

Sprite collide with frame, window border and restrict to rectangle

Related Stack Overflow questions:

• How to make my sprite bounce off the boundaries in pygame

Bounding rectangle

Related Stack Overflow questions:

• How to pin an image in the center of sprite rect
  

Sprite mask

Related Stack Overflow questions:

• Can’t figure out how to check mask collision between two sprites
  

  📁 Minimal example - Find the mask intersection of sprites

• How can I made a collision mask?

• Pygame mask collision
  

  📁 Minimal example - Find the intersection of rotating sprites

  repl.it/@Rabbid76/PyGame-SpriteMask

• Make a line as a sprite with its own collision in Pygame
  

  📁 Minimal example - Find the intersection of sprites a nd line

pygame.sprite.collide_mask() use the .rect and .mask attribute of the sprite object for the collision detection.

See the documentation of pygame.sprite.collide_mask():

Collision detection between two sprites, using masks.

collide_mask(SpriteLeft, SpriteRight) -> point

Tests for collision between two sprites, by testing if their bitmasks overlap. If the sprites have a “mask” attribute, that is used as the mask, otherwise a mask is created from the sprite image. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a “rect” and an optional “mask” attribute.

Sprite chang color of area

Related Stack Overflow questions:

• Changing colour of a surface without overwriting transparency
  

  📁 Minimal example - Chang the color of an area of a Sprite

  repl.it/@Rabbid76/PyGame-ChangeColorOfSpriteArea

Animation, timing and Sprite sheet

Related Stack Overflow questions:

• How do I create animated sprites using Sprite Sheets in Pygame?
  
• Play animation upon collision with enemy
• trying to get sprite to disappear from screen after certain amount of time

• Animated sprite from few images c For an animated Sprite a list of images (pygame.Surface objects) must be generated. A different picture of the list is displayed in each frame, just like in the pictures of a movie. This gives the appearance of an animated object.
  One way to get a list of images is to load an animated GIF (Graphics Interchange Format). Unfortunately, PyGame doesn’t offer a function to load the frames of an animated GIF. However, there are several Stack Overflow answers that address this issue:

• How can I load an animated GIF and get all of the individual frames in PyGame?
• How do I make a sprite as a gif in pygame?
• Pygame and Numpy Animations

One way is to use the popular Pillow library (pip install Pillow). The following function loads the frames of an animated GIF and generates a list of pygame.Surface objects:

from PIL import Image, ImageSequence

def loadGIF(filename):
    pilImage = Image.open(filename)
    frames = []
    for frame in ImageSequence.Iterator(pilImage):
        frame = frame.convert('RGBA')
        pygameImage = pygame.image.fromstring(
            frame.tobytes(), frame.size, frame.mode).convert_alpha()
        frames.append(pygameImage)
    return frames

Create a pygame.sprite.Sprite class that maintains a list of images. Implement an update method that selects a different image in each frame.
Pass the list of images to the class constructor. Add an index attribute that indicates the index of the current image in the list. Increase the index in the Update method. Reset the index if it is greater than or equal to the length of the image list (or use the modulo (%) operator). Get the current image from the list by subscription:

class AnimatedSpriteObject(pygame.sprite.Sprite):
    def __init__(self, x, bottom, images):
        pygame.sprite.Sprite.__init__(self)
        self.images = images
        self.image = self.images[0]
        self.rect = self.image.get_rect(midbottom = (x, bottom))
        self.image_index = 0
    def update(self):
        self.image_index += 1
        if self.image_index >= len(self.images):
            self.image_index = 0
        self.image = self.images[self.image_index]

📁 Minimal example - Animated sprites

repl.it/@Rabbid76/PyGame-SpriteAnimation

Rotate Sprite

Related Stack Overflow questions:

• How can you rotate an image around an off center pivot in PyGame
  

  📁 Minimal example - Rotate Sprite around off center pivot

  repl.it/@Rabbid76/PyGame-RotateSpriteAroundOffCenterPivot

Follow mouse

Related Stack Overflow questions:

• How do I rotate a sprite towards the mouse and move it?

  📁 Minimal example - Rotate Sprite to mouse

  repl.it/@Rabbid76/PyGame-SpriteRotateToMouse

  

  📁 Minimal example - Sprite follows mouse

  repl.it/@Rabbid76/PyGame-SpriteFollowMouse

  

Click Sprite

Related Stack Overflow questions:

• Pygame mouse clicking detection
  

  📁 minimal example - Detect click on sprite

  repl.it/@Rabbid76/PyGame-MouseClick

• How can I add an image or icon to a button rectangle in Pygame?
  

  📁 minimal example - Detect click on sprite 2

Use the rect attribute of the pygame.sprite.Sprite object and the collidepoint method to see if the Sprite was clicked. Pass the list of events to the update method of the pygame.sprite.Group so that you can process the events in the Sprite class:

class SpriteObject(pygame.sprite.Sprite):
    # [...]

    def update(self, event_list):

        for event in event_list:
            if event.type == pygame.MOUSEBUTTONDOWN:
                if self.rect.collidepoint(event.pos):
                    # [...]

my_sprite = SpriteObject()
group = pygame.sprite.Group(my_sprite)

# [...]

run = True
while run:
    event_list = pygame.event.get()
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            run = False

    group.update(event_list)

    # [...]

Sprite on mouse hover

Related Stack Overflow questions:

• Pygame mouse clicking detection
  

  📁 minimal example - Detect Sprite on hover

  repl.it/@Rabbid76/PyGame-MouseHover

• How do I add a border to a sprite when the mouse hovers over it, and delete it after the mouse stops?0
  

  📁 minimal example - Hover and delete

• How can I add an image or icon to a button rectangle in Pygame?
  

  📁 minimal exame_minample - Detect Sprite on hover 2_2

Detect evaluate the mouse states in the Update method of the pygame.sprite.Sprite object:

class SpriteObject(pygame.sprite.Sprite):
    # [...]

    def update(self, event_list):

        mouse_pos = pygame.mouse.get_pos()
        mouse_buttons = pygame.mouse.get_pressed()

        if  self.rect.collidepoint(mouse_pos) and any(mouse_buttons):
            # [...]

my_sprite = SpriteObject()
group = pygame.sprite.Group(my_sprite)

# [...]

run = True
while run:
    for event in pygame.event.get():
        if event.type == pygame.QUIT:
            run = False

    group.update(event_list)

    # [...]

Drag Sprite

Related Stack Overflow questions:

• Drag multiple sprites with different “update ()” methods from the same Sprite class in Pygame
  

  📁 Minimal example - Drag Sprite

  repl.it/@Rabbid76/PyGame-MouseDrag

• How to draw a chessboard with Pygame and move the pieces on the board??
  

  📁 Minimal example - Drag chess pieces

Circular sprite

Related Stack Overflow questions:

• how to create a circular sprite in pygame
• OOP Pygame Circle

Health Bar

Related Stack Overflow questions:

• How to put a health bar over the sprite in pygame
  

  📁 Minimal example - Drag Sprite

  repl.it/@Rabbid76/PyGame-HealthBar

Copy (duplicate) sprites

Related Stack Overflow questions:

• Duplicating a sprite

In general, you need to implement the duplicate method and construct a new instance of the Sprite object in the method.

Another solution is to use the Python copy module. deepcopy can create a deep copy of an object. Unfortunately this cannot be used for pygame.sprite.Sprite objects, as theimage attribute is a pygame.Surface, which cannot be copied deeply. Therefore, a deepcopy of a Sprite will cause an error.
Unless you have nor any other attribute that needs to be copied deeply, you can make a shallow copy of the Sprite. The rect attribute is a pygame.Rect object. The copy of the Sprite needs its own rectangle, so you have to generate a new rectangle instance. Fortunately a pygame.Rect object can be copied by pygame.Rect.copy:

import copy

new_d = copy.copy(d)
new_d.rect = d.rect.copy()

Text input

Related Stack Overflow questions:

• How to create a text input box with pygame?
  

  repl.it/@Rabbid76/PyGame-SpriteTextInput

  📁 minimal example - Text input box

Radio button

Related Stack Overflow questions:

• How do I implement option buttons and change the button color in PyGame?
  

📁 Minimal example - Radio button

repl.it/@Rabbid76/PyGame-RadioButton