button

 1import pygame
 2
 3"""
 4Python file for button objects
 5
 6Button.py is creates a button object out of an image, position, and the images scale.
 7All of the features aren't fully implemented as plan, main.py currently handles the button logic
 8while the Button class creates the rectangle and its dimensions, and draws the image on screen.
 9
10Typical usage example:
11
12    pause_button = Button(100, 200, pause_button.pdf, .5)
13    pause_button.draw
14"""
15
16class Button():
17    """button objects
18    
19    Attributes:
20        width: an int representing the original images width
21        height: an int representing the original images height
22        image: an image file that is passed through the constructor
23        rect: a rect object for the image
24        rect.topleft: an int representing the top left coordinate for the image
25        clicked: a boolean representing whether the button has been clicked
26        """
27
28    
29    def __init__(self, x, y, image, scale):
30        """initializes an instance based on the image, it's position and scale
31        
32        Args:
33            x: defines x coordinate for instance
34            y: defines y coordinate for instance
35            image: the image file for instance
36            scale: scale for the new image relative to the original
37            """
38        width = image.get_width()
39        height = image.get_height()
40        self.image = pygame.transform.scale(image, (int(width * scale), int(height * scale)))
41        self.rect = self.image.get_rect()
42        self.rect.topleft = (x, y)
43        self.clicked = False
44
45    def draw(self, surface):
46        """draws the button and returns true if it is clicked
47        
48        Args:
49            surface: the screen/surface that the button will be drawn on (window).
50             
51        Returns:
52            Action - a boolean that is true when the button is clicked
53        """
54        action = False
55
56        # get mouse position
57        pos = pygame.mouse.get_pos()
58
59        # Check if mouse is clicked
60        if self.rect.collidepoint(pos):
61            if pygame.mouse.get_pressed()[0] == 1 and self.clicked == False:
62                self.clicked = True
63                action = True
64
65        if pygame.mouse.get_pressed()[0] == 0:
66            self.cliciked = False
67
68        surface.blit(self.image, (self.rect.x, self.rect.y))
69
70        return action