Module AggiEngine.state

Classes

class State (ui_path: typing.Union[str, NoneType] = None, window: typing.Union[object, NoneType] = None)

Initialized class variables. ui_path: The path to the .ui file for the State to display window: The main window class for the whole application

Expand source code

class State:

    def __init__(self, ui_path: Optional[str] = None, window: Optional[object] = None):
        '''
        Initialized class variables.
        ``ui_path:`` The path to the .ui file for the State to display
        ``window:`` The main window class for the whole application
        '''
        self.ui_path = ui_path
        self.window = window
        self.gameObjectHandler = None
        self.active = True

    def loadMap(self, filePath: str) -> None:
        '''
        Loads the TMX file and creates the contained game objects
        ``filePath:`` The path to the .tmx file to load game objects
        '''
        TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)

    def loadUi(self) -> None:
        '''
        Loads the widgets in the .ui file
        '''
        if self.ui_path is not None:
            self.window.uiManager.loadWidgets(self.ui_path, True)

    def startGOH(self) -> None:
        '''
        Starts the game object handler
        '''
        self.gameObjectHandler = GameObjectHandler(self.window)

    def updateGOH(self) -> None:
        '''
        Updates the game object handler after a screen draw
        '''
        self.gameObjectHandler.update()

    def fixedUpdateGOH(self) -> None:
        '''
        Updates the game object handler after a physics update
        '''
        self.gameObjectHandler.fixedUpdate()

    def exitGOH(self) -> None:
        '''
        Stops the game object handler
        '''
        self.gameObjectHandler.exit()

    def start(self) -> None:
        '''
        Triggered when the State is first activated
        '''
        pass

    def update(self) -> None:
        '''
        Triggered after a screen draw
        '''
        pass

    def fixedUpdate(self) -> None:
        '''
        Triggered after a physics update
        '''
        pass

    def exit(self) -> None:
        '''
        Triggered when the State stops
        '''
        pass

    def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
        '''
        Triggered when a key is pressed down
        ``event:`` The key event contains the key(s) pressed
        '''
        pass

    def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
        '''
        Triggered when a key is released
        ``event:`` The key event contains the key(s) released
        '''
        pass

    def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
        '''
        Triggered when the mouse is moved
        ``event:`` The mouse event contains the new mouse positions
        '''
        pass

    def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
        '''
        Triggered when mouse buttons are pressed
        ``event:`` The mouse event contains the mouse buttons pressed
        '''
        pass

    def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
        '''
        Triggered when mouse buttons are released
        ``event:`` The mouse event contains the mouse buttons released
        '''
        pass

Methods

def exit(self) ‑> NoneType

Triggered when the State stops

Expand source code

def exit(self) -> None:
    '''
    Triggered when the State stops
    '''
    pass

def exitGOH(self) ‑> NoneType

Stops the game object handler

Expand source code

def exitGOH(self) -> None:
    '''
    Stops the game object handler
    '''
    self.gameObjectHandler.exit()

def fixedUpdate(self) ‑> NoneType

Triggered after a physics update

Expand source code

def fixedUpdate(self) -> None:
    '''
    Triggered after a physics update
    '''
    pass

def fixedUpdateGOH(self) ‑> NoneType

Updates the game object handler after a physics update

Expand source code

def fixedUpdateGOH(self) -> None:
    '''
    Updates the game object handler after a physics update
    '''
    self.gameObjectHandler.fixedUpdate()

def keyPressed(self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType

Triggered when a key is pressed down event: The key event contains the key(s) pressed

Expand source code

def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
    '''
    Triggered when a key is pressed down
    ``event:`` The key event contains the key(s) pressed
    '''
    pass

def keyReleased(self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType

Triggered when a key is released event: The key event contains the key(s) released

Expand source code

def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
    '''
    Triggered when a key is released
    ``event:`` The key event contains the key(s) released
    '''
    pass

def loadMap(self, filePath: str) ‑> NoneType

Loads the TMX file and creates the contained game objects filePath: The path to the .tmx file to load game objects

Expand source code

def loadMap(self, filePath: str) -> None:
    '''
    Loads the TMX file and creates the contained game objects
    ``filePath:`` The path to the .tmx file to load game objects
    '''
    TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)

def loadUi(self) ‑> NoneType

Loads the widgets in the .ui file

Expand source code

def loadUi(self) -> None:
    '''
    Loads the widgets in the .ui file
    '''
    if self.ui_path is not None:
        self.window.uiManager.loadWidgets(self.ui_path, True)

def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType

Triggered when the mouse is moved event: The mouse event contains the new mouse positions

Expand source code

def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
    '''
    Triggered when the mouse is moved
    ``event:`` The mouse event contains the new mouse positions
    '''
    pass

def mousePressed(self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType

Triggered when mouse buttons are pressed event: The mouse event contains the mouse buttons pressed

Expand source code

def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
    '''
    Triggered when mouse buttons are pressed
    ``event:`` The mouse event contains the mouse buttons pressed
    '''
    pass

def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType

Triggered when mouse buttons are released event: The mouse event contains the mouse buttons released

Expand source code

def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
    '''
    Triggered when mouse buttons are released
    ``event:`` The mouse event contains the mouse buttons released
    '''
    pass

def start(self) ‑> NoneType

Triggered when the State is first activated

Expand source code

def start(self) -> None:
    '''
    Triggered when the State is first activated
    '''
    pass

def startGOH(self) ‑> NoneType

Starts the game object handler

Expand source code

def startGOH(self) -> None:
    '''
    Starts the game object handler
    '''
    self.gameObjectHandler = GameObjectHandler(self.window)

def update(self) ‑> NoneType

Triggered after a screen draw

Expand source code

def update(self) -> None:
    '''
    Triggered after a screen draw
    '''
    pass

def updateGOH(self) ‑> NoneType

Updates the game object handler after a screen draw

Expand source code

def updateGOH(self) -> None:
    '''
    Updates the game object handler after a screen draw
    '''
    self.gameObjectHandler.update()