The Item class

The object classes will all be kept in a single file called game_classes.py. Each class will be added to the bottom of the file and tested / demonstrated in the "if name == 'main':" block.

The Item class is the simplest class to design and will be used for the coin, the picnic, and the key. This is the class diagram for the Item class.

Item class
name desc collectable = True
get_desc()

Here is the Python code for the item class.

class Item:  # Class names begin with upper case
    '''
    Class to define all simple objects within the game.
    Attributes:
        name: str
        desc: str
        collectable: bool (overloaded)
    Methods:
        get_desc(): Used to return description.  This may be a complicated process in some functions
    '''
    def __init__(self, name, desc):  # This is a constructor
        self.name = name
        self.desc = desc
        self.collectable = True

    def get_desc(self):  # This is a getter
        return self.desc

Note that another property, collectable, has been added. This can be used to stop the player from taking objects that are not meant to be collected. E.g. the vending machine.

To test the code we add this at the bottom of the file:

if __name__ == '__main__':
    coin = Item('coin', 'a gold coin with $1 stamped on one side and someone\'s head on the other.')

    print(coin.name)  # Note, accessing the attribute directly.
    # coin
    print(coin.get_desc())  # Note, using a getter to access the attribute.
    # a gold coin with $1 stamped on one side and someone's head on the other.
    print(f'You see {coin.get_desc()}')  
    # You see a gold coin with $1 stamped on one side and someone's head on the other.

Note that it is not un-Pythonic to access the class properties directly. This tutorial will only use class methods where necessary or to maintain consistency. For some classes the description will change depending on the state of the class instance. For example the Admin office and the Teacher's office have different descriptions if they are locked or unlocked so a get_desc() method will be required. To save trying to remember which classes have a get_desc() method and which do not, we will implement a get_desc() for all classes.

Last modified: 07 April 2024