├── .github
    └── workflows
    │   └── main.yml
├── .gitignore
├── AggiEngine
    ├── __init__.py
    ├── application.py
    ├── contactlistener.py
    ├── gameobject.py
    ├── gameobjecthandler.py
    ├── gamescreen.py
    ├── mainwindow.py
    ├── particles.py
    ├── sound.py
    ├── state.py
    ├── statemanager.py
    ├── tileloader.py
    └── uimanager.py
├── LICENSE
├── README.md
├── docs
    ├── application.html
    ├── contactlistener.html
    ├── gameobject.html
    ├── gameobjecthandler.html
    ├── gamescreen.html
    ├── index.html
    ├── mainwindow.html
    ├── particles.html
    ├── sound.html
    ├── state.html
    ├── statemanager.html
    ├── tileloader.html
    └── uimanager.html
├── setup.cfg
└── setup.py


/.github/workflows/main.yml:
--------------------------------------------------------------------------------
 1 | # This is a basic workflow to help you get started with Actions
 2 | 
 3 | name: CI
 4 | 
 5 | # Controls when the action will run. 
 6 | on:
 7 |   # Triggers the workflow on push or pull request events but only for the master branch
 8 |   push:
 9 |     branches: [ master ]
10 |   pull_request:
11 |     branches: [ master ]
12 | 
13 |   # Allows you to run this workflow manually from the Actions tab
14 |   workflow_dispatch:
15 | 
16 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel
17 | jobs:
18 |   # This workflow contains a single job called "build"
19 |   build:
20 |     # The type of runner that the job will run on
21 |     runs-on: ubuntu-latest
22 | 
23 |     # Steps represent a sequence of tasks that will be executed as part of the job
24 |     steps:
25 |       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
26 |       - uses: actions/checkout@v2
27 | 
28 |       # Runs a set of commands using the runners shell
29 |       - name: Updates the documentation folder
30 |         run: |
31 |           rm -r ./docs/*
32 |           sudo apt-get install libasound2-dev
33 |           pip install PySide2
34 |           pip install PyOpenGL
35 |           pip install Box2D
36 |           pip install pytmx
37 |           pip install pillow
38 |           pip install numpy
39 |           pip install simpleaudio
40 |           pip install pdoc3
41 |           pdoc3 --html --output-dir ./docs ./AggiEngine
42 |           cd ./docs
43 |           mv AggiEngine/* .
44 |           rm -r ./AggiEngine
45 |           git config --local user.name "action"
46 |           git add .
47 |           git commit -m "Auto updating docs"
48 |       - name: Push changes # push the output folder to your repo
49 |         uses: ad-m/github-push-action@master
50 |         with:
51 |           github_token: ${{ secrets.GITHUB_TOKEN }}
52 |           force: true
53 |       # Deploy the site
54 |       - name: Deploy
55 |         uses: peaceiris/actions-gh-pages@v3
56 |         with:
57 |           github_token: ${{ secrets.GITHUB_TOKEN }}
58 |           publish_dir: ./docs
59 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | __pycache__/


--------------------------------------------------------------------------------
/AggiEngine/__init__.py:
--------------------------------------------------------------------------------
 1 | from AggiEngine.gamescreen import GameScreen
 2 | from AggiEngine.state import State
 3 | from AggiEngine.statemanager import StateManager
 4 | from AggiEngine.uimanager import UiManager
 5 | from AggiEngine.gameobject import GameObject
 6 | from AggiEngine.mainwindow import MainWindow
 7 | from AggiEngine.particles import Particles
 8 | from AggiEngine.application import Application
 9 | from AggiEngine.sound import Sound
10 | from AggiEngine.tileloader import TileMap
11 | 


--------------------------------------------------------------------------------
/AggiEngine/application.py:
--------------------------------------------------------------------------------
 1 | from typing import Optional
 2 | 
 3 | from PySide2.QtWidgets import QApplication
 4 | 
 5 | from . import State
 6 | from .mainwindow import MainWindow
 7 | 
 8 | 
 9 | class Application(QApplication):
10 |     """
11 |     This is the core class of an AggiEngine application.
12 |     """
13 | 
14 |     def __init__(self, state: State, screenFps: Optional[float] = 120, fixedFps: Optional[float] = 60,
15 |                  args: Optional[list] = None) -> None:
16 |         """
17 |         Creates and initializes QWidgets for the application to start.
18 |         ``state:`` The initial state to launch the Application with    
19 |         ``args:`` System arguments passed in    
20 |         ``config:`` Set application parameters    
21 |         """
22 |         if args:
23 |             super(Application, self).__init__(args)
24 |         else:
25 |             super(Application, self).__init__()
26 | 
27 |         self.window = MainWindow(self, state, screenFps, fixedFps)
28 | 
29 |     def run(self) -> None:
30 |         """
31 |         Execute the application, this will start the passed State
32 |         """
33 |         self.window.start()
34 |         self.window.show()
35 |         self.exec_()
36 | 


--------------------------------------------------------------------------------
/AggiEngine/contactlistener.py:
--------------------------------------------------------------------------------
 1 | from Box2D import b2ContactListener, b2Contact, b2Manifold, b2Vec2
 2 | 
 3 | 
 4 | class ContactListener(b2ContactListener):
 5 |     """
 6 |     Receives contact information from Box2D and passes it along to the GameObjects in the collision.
 7 |     """
 8 | 
 9 |     def __init__(self):
10 |         b2ContactListener.__init__(self)
11 | 
12 |     def BeginContact(self, contact: b2Contact) -> None:
13 |         """
14 |         Called when two Box2D bodies collide and calls their beginContact(otherBody) methods
15 |         ``contact:`` The contact event
16 |         """
17 |         bodyA = contact.fixtureA.body
18 |         bodyB = contact.fixtureB.body
19 |         bodyA.userData.beginContact(bodyB)
20 |         bodyB.userData.beginContact(bodyA)
21 | 
22 |     def EndContact(self, contact: b2Contact) -> None:
23 |         """
24 |         Called when two Box2D bodies collide and calls their endContact(otherBody) methods
25 |         ``contact:`` The contact event
26 |         """
27 |         bodyA = contact.fixtureA.body
28 |         bodyB = contact.fixtureB.body
29 |         bodyA.userData.endContact(bodyB)
30 |         bodyB.userData.endContact(bodyA)
31 | 
32 |     def PreSolve(self, contact: b2Contact, manifold: b2Manifold) -> None:
33 |         """
34 |         Called before Box2D handles a contact while the bodies are still overlapping
35 |         """
36 |         bodyA = contact.fixtureA.body
37 |         bodyB = contact.fixtureB.body
38 |         bodyA.userData.preSolve(bodyB, manifold)
39 |         bodyB.userData.preSolve(bodyA, manifold)
40 | 
41 |     def PostSolve(self, contact: b2Contact, impulse: b2Vec2) -> None:
42 |         """
43 |         Called after Box2D handles a contact while the bodies are no longer overlapping
44 |         """
45 |         bodyA = contact.fixtureA.body
46 |         bodyB = contact.fixtureB.body
47 |         bodyA.userData.postSolve(bodyB, impulse)
48 |         bodyB.userData.postSolve(bodyA, impulse)
49 | 


--------------------------------------------------------------------------------
/AggiEngine/gameobject.py:
--------------------------------------------------------------------------------
  1 | from typing import Optional
  2 | import PySide2
  3 | from Box2D import b2Contact, b2Vec2, b2Manifold
  4 | 
  5 | 
  6 | class GameObject:
  7 | 
  8 |     def __init__(self, gameObjectHandler: Optional[object] = None):
  9 |         self.body = None
 10 |         self.active = True
 11 |         self.window = None
 12 |         self.vertices = [[0, 0], [0.1, 0], [0.1, 0.1], [0, 0.1]]
 13 |         self.color = [1, 1, 1, 1]
 14 |         self.position = [0, 0]
 15 |         self.rotation = 0
 16 |         self.gameObjectHandler = gameObjectHandler
 17 |         self.textureID = -1
 18 |         self.height = 1
 19 |         self.width = 1
 20 | 
 21 |     def getWidth(self) -> int:
 22 |         '''
 23 |         Returns the width of the GameObject.
 24 |         '''
 25 |         return self.width * 2
 26 | 
 27 |     def getHeight(self) -> int:
 28 |         '''
 29 |         Returns the height.
 30 |         '''
 31 |         return self.height * 2
 32 | 
 33 |     def setWidth(self, width: int) -> None:
 34 |         '''
 35 |         Sets the GameObject's width.
 36 |         '''
 37 |         self.width = width / 2
 38 | 
 39 |     def setHeight(self, height: int) -> None:
 40 |         '''
 41 |         Sets the GameObject's height.
 42 |         '''
 43 |         self.height = height / 2
 44 | 
 45 |     def start(self) -> None:
 46 |         '''
 47 |         Called when the GameObject is created.
 48 |         '''
 49 |         pass
 50 | 
 51 |     def update(self) -> None:
 52 |         '''
 53 |         Called everytime the screen is rendered.
 54 |         '''
 55 |         pass
 56 | 
 57 |     def fixedUpdate(self) -> None:
 58 |         '''
 59 |         Called everytime Box2D finishes a physics update.
 60 |         '''
 61 |         pass
 62 | 
 63 |     def exit(self) -> None:
 64 |         '''
 65 |         Called when the GameObject is destroyed.
 66 |         '''
 67 |         pass
 68 | 
 69 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
 70 |         '''
 71 |         Called when a key is pushed down.
 72 |         '''
 73 |         pass
 74 | 
 75 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
 76 |         '''
 77 |         Called when a key is released.
 78 |         '''
 79 |         pass
 80 | 
 81 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
 82 |         '''
 83 |         Called when the cursor moves.
 84 |         '''
 85 |         pass
 86 | 
 87 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
 88 |         '''
 89 |         Called when a mouse button is pressed.
 90 |         '''
 91 |         pass
 92 | 
 93 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
 94 |         '''
 95 |         Called when a mouse button is released.
 96 |         '''
 97 |         pass
 98 | 
 99 |     def beginContact(self, body: object) -> None:
100 |         '''
101 |         Called whenever a GameObject's object first makes contact with another body.
102 |         '''
103 |         pass
104 | 
105 |     def endContact(self, body: object) -> None:
106 |         '''
107 |         Called whenever a GameObject's object stops making contact with another.
108 |         '''
109 |         pass
110 |     
111 |     def preSolve(self, contact: b2Contact, manifold: b2Manifold) -> None:
112 |         '''
113 |         Called whenever a GameObject's body's shape is overlapping another.
114 |         Gravity and other forces will trigger this even if the body hasn't stopped making contact.
115 |         '''
116 |         pass
117 | 
118 |     def postSolve(self, contact: b2Contact, impulse: b2Vec2) -> None:
119 |         '''
120 |         Called whenever a GameObject's body's shape is not longer overlapping another.
121 |         Gravity and other forces will trigger this even if the body hasn't stopped making contact.
122 |         '''
123 |         pass
124 | 


--------------------------------------------------------------------------------
/AggiEngine/gameobjecthandler.py:
--------------------------------------------------------------------------------
  1 | from typing import Optional
  2 | 
  3 | import PySide2
  4 | from AggiEngine.contactlistener import ContactListener
  5 | import math
  6 | 
  7 | from Box2D import *
  8 | 
  9 | 
 10 | class GameObjectHandler:
 11 | 
 12 |     def __init__(self, window, scale: Optional[float] = 16):
 13 |         self.timing = 1 / window.targetFixedFPS
 14 |         self.window = window
 15 |         
 16 |         self.world = Box2D.b2World(gravity=(0, -9.8))  # create instance of box 2d world
 17 |         self.world.contactListener = ContactListener()
 18 |         
 19 |         self.scale = scale  # scaling parameter, is equal to pixels to meter
 20 |         self.gameObjects = []  # game object list
 21 |         self.removeList = []
 22 | 
 23 |     def setScale(self, scale: float) -> None:
 24 |         '''
 25 |         Set the pixels per meter scale for TMX, OpenGL, and Box2D calculations
 26 |         '''
 27 |         self.scale = scale
 28 | 
 29 |     def update(self) -> None:
 30 |         '''
 31 |         Calls update on all game objects, variable timing rate. Triggered back screen draws.
 32 |         '''
 33 |         for gameObject in self.gameObjects:
 34 |             if gameObject.active:
 35 |                 gameObject.update()
 36 | 
 37 |     def fixedUpdate(self) -> None:
 38 |         '''
 39 |         Updates the Box2D world then game objects on a fixed time interval.
 40 |         '''
 41 |         self.world.Step(self.timing, 6, 2)
 42 |         self.world.ClearForces()
 43 | 
 44 |         newRenderInfoList = []
 45 |         for gameObject in self.gameObjects:
 46 |             info = [gameObject.textureID]
 47 | 
 48 |             if gameObject.textureID == -1:
 49 |                 if len(gameObject.color) < 4:
 50 |                     gameObject.color.append(1)
 51 |                 info += [gameObject.vertices, gameObject.color]
 52 |             else:
 53 |                 info += [gameObject.width, gameObject.height]
 54 | 
 55 |             if gameObject.active:
 56 |                 gameObject.fixedUpdate()
 57 |                 if gameObject.body is not None:
 58 |                     gameObject.position = gameObject.body.position / self.scale
 59 |                     gameObject.rotation = gameObject.body.angle
 60 |                 info += [gameObject.position, math.degrees(gameObject.rotation)]
 61 |             newRenderInfoList.append(info)
 62 |         if self.window.gameScreen is not None:
 63 |             self.window.gameScreen.renderInfoList = newRenderInfoList
 64 | 
 65 |         for gameObject in self.removeList:
 66 |             self.gameObjects.remove(gameObject)
 67 |             self.world.DestroyBody(gameObject.body)
 68 |         self.removeList = []
 69 | 
 70 |     def add(self, gameObject: object, bodyDef: Optional[b2BodyDef] = None,
 71 |             bodyFixtureDef: Optional[b2FixtureDef] = None,
 72 |             color: list = None) -> None:
 73 |         '''
 74 |         Creates a game object.
 75 |         '''
 76 |         self.gameObjects.append(gameObject)  # adds game object to list of game objects
 77 |         gameObject.gameObjectHandler = self
 78 | 
 79 |         if bodyDef:
 80 |             body = self.world.CreateBody(bodyDef)
 81 |             body.CreateFixture(bodyFixtureDef)
 82 |             gameObject.body = body
 83 |             gameObject.body.userData = gameObject
 84 | 
 85 |             gameObject.body.userData = gameObject
 86 | 
 87 |             if type(bodyFixtureDef.shape) is b2PolygonShape:
 88 |                 gameObject.vertices.clear()
 89 |                 for vertex in bodyFixtureDef.shape.vertices:
 90 |                     gameObject.vertices.append([vertex[0] / self.scale, vertex[1] / self.scale])
 91 |             elif type(bodyFixtureDef.shape) is b2CircleShape:
 92 |                 vertices = []
 93 |                 for i in range(0, 30):
 94 |                     rad = (2 * math.pi * i) / 30
 95 |                     r = bodyFixtureDef.shape.radius / self.scale
 96 |                     vertices.append([(r * math.cos(rad) - (bodyFixtureDef.shape.pos[0] / self.scale)),
 97 |                                      (r * math.sin(rad) - (bodyFixtureDef.shape.pos[1] / self.scale))])
 98 |                 gameObject.vertices = vertices
 99 | 
100 |             if color is None:
101 |                 gameObject.color = [1, 1, 1, 1]
102 |             else:
103 |                 gameObject.color = color
104 |             gameObject.position = body.position / self.scale
105 | 
106 |         gameObject.window = self.window
107 |         gameObject.start()
108 | 
109 |     def getGameObject(self, typeOf: type):
110 |         '''
111 |         Returns the first instance of the game object with the type passed
112 |         '''
113 |         for gameObject in self.gameObjects:
114 |             if isinstance(gameObject, typeOf):
115 |                 return gameObject
116 | 
117 |     def getGameObjects(self, typeOf: type) -> object:
118 |         '''
119 |         Returns all instances of game objects with the type passed
120 |         '''
121 |         gameObjects = []
122 |         for gameObject in self.gameObjects:
123 |             if isinstance(gameObject, typeOf):
124 |                 gameObjects.append(gameObject)
125 |         return gameObjects
126 | 
127 |     def removeGameObject(self, toRemove: object) -> None:
128 |         '''
129 |         Removes the gameObject passed
130 |         '''
131 |         self.removeList.append(toRemove)
132 | 
133 |     def removeGameObjects(self, typeOf: type) -> None:
134 |         '''
135 |         Removes all game objects with the type passed
136 |         '''
137 |         for gameObject in self.gameObjects:
138 |             if isinstance(gameObject, typeOf):
139 |                 self.removeList.append(gameObject)
140 | 
141 |     def exit(self) -> None:
142 |         '''
143 |         Trigger exit on all game objects, called when state exits
144 |         '''
145 |         for gameObject in self.gameObjects:
146 |             gameObject.exit()
147 | 
148 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
149 |         '''
150 |         Trigger keyPressed on all game objects, called when a key is pressed
151 |         '''
152 |         for gameObject in self.gameObjects:
153 |             gameObject.keyPressed(event)
154 | 
155 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
156 |         '''
157 |         Trigger keyReleased on all game objects, called when a key is released
158 |         '''
159 |         for gameObject in self.gameObjects:
160 |             gameObject.keyReleased(event)
161 | 
162 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
163 |         '''
164 |         Trigger mouseMoved on all game objects, called when the mouse is moved
165 |         '''    
166 |         for gameObject in self.gameObjects:
167 |             gameObject.mouseMoved(event)
168 | 
169 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
170 |         '''
171 |         Trigger mousePressed on all game objects, called when a mouse key is pressed
172 |         '''
173 |         for gameObject in self.gameObjects:
174 |             gameObject.mousePressed(event)
175 | 
176 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
177 |         '''
178 |         Trigger mouseReleased on all game objects, called when a mouse key is released
179 |         '''
180 |         for gameObject in self.gameObjects:
181 |             gameObject.mouseReleased(event)
182 | 


--------------------------------------------------------------------------------
/AggiEngine/gamescreen.py:
--------------------------------------------------------------------------------
  1 | from typing import Optional, Callable
  2 | 
  3 | from OpenGL.GL import *
  4 | import numpy
  5 | from PIL import Image
  6 | from PIL import ImageOps
  7 | from PySide2.QtWidgets import QWidget
  8 | from PySide2.QtWidgets import QOpenGLWidget
  9 | 
 10 | 
 11 | class GameScreen(QOpenGLWidget):
 12 | 
 13 |     def __init__(self, parent: QWidget):
 14 |         '''
 15 |         Subclass of the QOpenGLWidget, this is promoted in Qt Designer so that
 16 |         we can draw to the widget.
 17 |         ``parent:`` The widget that the this held under usually MainWindow  
 18 |         '''
 19 |         super(GameScreen, self).__init__(parent=parent)
 20 | 
 21 |         self.cameraPosition = [0, 0]
 22 |         self.cameraScale = 1
 23 |         self.renderInfoList = []
 24 |         self.bgColor = [0, 0, 0]
 25 | 
 26 |     def initializeGL(self) -> None:
 27 |         '''
 28 |         Sets up OpenGL for rendering
 29 |         '''
 30 |         glEnable(GL_BLEND)
 31 |         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA)
 32 |         glClearColor(self.bgColor[0], self.bgColor[1], self.bgColor[2], 1)
 33 |         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
 34 |         glEnable(GL_TEXTURE_2D)
 35 | 
 36 |     def paintGL(self) -> None:
 37 |         '''
 38 |         Draws all game objects rect and texture id given by game object handler
 39 |         '''
 40 | 
 41 |         glClearColor(self.bgColor[0], self.bgColor[1], self.bgColor[2], 1)
 42 |         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
 43 |         glColor3f(1, 1, 1)
 44 |         glLoadIdentity()
 45 |         glScalef(self.cameraScale, self.cameraScale, 0)
 46 |         glTranslatef(-self.cameraPosition[0], -self.cameraPosition[1], 0)
 47 |         for renderInfo in self.renderInfoList:
 48 | 
 49 |             if renderInfo[0] == -1:
 50 |                 glPushMatrix()
 51 |                 glTranslatef(renderInfo[3][0], renderInfo[3][1], 0)
 52 |                 glRotatef(renderInfo[4], 0, 0, 1)
 53 |                 glColor4f(renderInfo[2][0], renderInfo[2][1], renderInfo[2][2], renderInfo[2][3])
 54 |                 glPolygonMode(GL_FRONT, GL_FILL)
 55 |                 glBegin(GL_POLYGON)
 56 |                 for vertex in renderInfo[1]:
 57 |                     glVertex2f(vertex[0], vertex[1])
 58 |                 glEnd()
 59 |                 glPopMatrix()
 60 |             else:
 61 |                 glPushMatrix()
 62 |                 glTranslatef(renderInfo[3][0], renderInfo[3][1], 0)
 63 |                 glRotatef(renderInfo[4], 0, 0, 1)
 64 |                 glBindTexture(GL_TEXTURE_2D, renderInfo[0])
 65 |                 glBegin(GL_QUADS)
 66 |                 glTexCoord2f(0, 0)
 67 |                 glVertex2f(renderInfo[1], renderInfo[2])
 68 |                 glTexCoord2f(1, 0)
 69 |                 glVertex2f(-renderInfo[1], renderInfo[2])
 70 |                 glTexCoord2f(1, 1)
 71 |                 glVertex2f(-renderInfo[1], -renderInfo[2])
 72 |                 glTexCoord2f(0, 1)
 73 |                 glVertex2f(renderInfo[1], -renderInfo[2])
 74 |                 glEnd()
 75 |                 glBindTexture(GL_TEXTURE_2D, 0)
 76 |                 glPopMatrix()
 77 | 
 78 |     def resizeGL(self, w, h) -> None:
 79 |         '''
 80 |         Resize event recalculates values to maintain the same image.
 81 |         '''
 82 |         glViewport(0, 0, w, h)
 83 |         glMatrixMode(GL_PROJECTION)
 84 |         glLoadIdentity()
 85 |         aspect = w / h
 86 |         glOrtho(aspect, -aspect, -1.0, 1.0, 1.0, -1.0)
 87 |         glMatrixMode(GL_MODELVIEW)
 88 |         glLoadIdentity()
 89 | 
 90 |     def loadTexture(self, imageData: [int], width: int, height: int) -> int:
 91 |         '''
 92 |         Loads the texture to the render device.
 93 |         Returns it's texture id.
 94 |         '''
 95 |         textureID = glGenTextures(1)
 96 |         glPixelStorei(GL_UNPACK_ALIGNMENT, 4)
 97 |         glBindTexture(GL_TEXTURE_2D, textureID)
 98 |         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT)
 99 |         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT)
100 |         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST)
101 |         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST)
102 |         glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, imageData)
103 |         return textureID
104 | 
105 |     def loadImageTexture(self, fileName: str) -> int:
106 |         '''
107 |         Loads an image from a path and loads it to the render device.
108 |         Returns the texture id of the image.
109 |         '''
110 |         image = Image.open(fileName)
111 | 
112 |         # Add alpha if the base image doesn't have one
113 |         if not (fileName.split(".")[-1] == "png"):
114 |             image.putalpha(256)
115 | 
116 |         # Making image data for OpenGL
117 |         imageData = numpy.array(list(image.getdata()), numpy.uint8)
118 |         return self.loadTexture(imageData, image.width, image.height)
119 | 
120 |     def image_loader(self, filename: str, colorkey, **kwargs) -> Callable:
121 |         '''
122 |         The image loader used by pytmx so that all images are sent to the render devices memory for quick drawing.
123 |         '''
124 |         image = Image.open(filename)
125 |         transparent = filename.split(".")[-1] == "png"
126 | 
127 |         def extract_image(rect: Optional[list] = None, flags=None) -> int:
128 |             # Cropping the image to the necessary size
129 |             if rect:
130 |                 crop = image.crop((rect[0], rect[1], rect[0] + rect[2], rect[1] + rect[3]))
131 |             else:
132 |                 crop = image
133 | 
134 |             if flags:
135 |                 # Handling the flags
136 |                 if flags.flipped_horizontally:
137 |                     crop = ImageOps.mirror(crop)
138 |                 if flags.flipped_vertically:
139 |                     crop = ImageOps.flip(crop)
140 |             
141 |             # Add alpha if the base image doesn't have one
142 |             if not transparent:
143 |                 crop.putalpha(256)
144 |             # Making image data for OpenGL
145 |             imageData = numpy.array(list(crop.getdata()), numpy.uint8)
146 |             return self.loadTexture(imageData, crop.width, crop.height), crop.width, crop.height
147 | 
148 |         return extract_image
149 | 
150 | 


--------------------------------------------------------------------------------
/AggiEngine/mainwindow.py:
--------------------------------------------------------------------------------
  1 | import time
  2 | from typing import Optional
  3 | 
  4 | import PySide2
  5 | from PySide2.QtCore import QTimer, Qt
  6 | from PySide2.QtWidgets import QMainWindow, QWidget
  7 | 
  8 | from .uimanager import UiManager
  9 | from .statemanager import StateManager
 10 | from .state import State
 11 | from .gamescreen import GameScreen
 12 | 
 13 | 
 14 | class MainWindow(QMainWindow):
 15 | 
 16 |     def __init__(self, app, state: State, screenFPS: int, fixedFPS: int, parent: Optional[QWidget] = None):
 17 |         '''
 18 |         The MainWindow is created by the application, here we handle ui/scenes and send out updates.
 19 |         ``state:`` The current state we want to start with.  
 20 |         ``parent:`` The widget this held under, None by default because this is top widget  
 21 |         '''
 22 |         QMainWindow.__init__(self, parent)
 23 |         self.app = app  # the application created
 24 |         self.gameScreen = None  # where all graphics are drawn
 25 |         self.uiManager = UiManager(self, customWidgets=[GameScreen])  # Loads widgets into window from a file
 26 |         self.stateManager = StateManager(self, state)  # Manages state updates and transitions
 27 | 
 28 |         self.updateFPSTimer = QTimer(self)  # Used to manage frame timings
 29 |         self.updateFPSTimer.timeout.connect(self.__calculateFPS)
 30 | 
 31 |         self.fixedFps = 0  # Calculated FPS
 32 |         self.screenFps = 0
 33 | 
 34 |         self.fixedFrames = 0  # Accumulated Frames
 35 |         self.screenFrames = 0
 36 | 
 37 |         self.targetFixedFPS = fixedFPS
 38 |         self.targetUpdateFPS = screenFPS
 39 |         self.fixedTiming = 1 / self.targetFixedFPS
 40 |         self.screenTiming = 1 / self.targetUpdateFPS
 41 |         self.fixedNeeded = fixedFPS
 42 |         self.screenNeeded = screenFPS
 43 |         self.lastTime = 0
 44 |         self.setMouseTracking(True)
 45 | 
 46 |         self.uiManager.keepWidgets = self.children()
 47 | 
 48 |     def start(self) -> None:
 49 |         '''
 50 |         Called when application.run() is executed. Starts the actual engine.
 51 |         '''
 52 |         self.stateManager.initializeState()  # start the state
 53 |         self.updateFPSTimer.start(100)
 54 | 
 55 |     def closeEvent(self, event: PySide2.QtGui.QCloseEvent) -> None:
 56 |         '''
 57 |         Called when the window is closed
 58 |         '''
 59 |         print("Window closed.")
 60 |         self.updateFPSTimer.stop()
 61 |         self.stateManager.exit()
 62 | 
 63 |     def __calculateFPS(self) -> None:
 64 |         '''
 65 |         Averages FPS and adjust frame timings to meet the targets
 66 |         '''
 67 | 
 68 |         self.fixedFps = self.fixedFrames / (time.perf_counter() - self.lastTime)
 69 |         self.fixedFrames = 0
 70 | 
 71 |         self.screenFps = self.screenFrames / (time.perf_counter() - self.lastTime)
 72 |         self.screenFrames = 0
 73 | 
 74 |         if -0.5 < (self.targetFixedFPS - self.fixedFps) / self.targetFixedFPS < 0.5 and self.fixedNeeded > 30:
 75 |             self.fixedNeeded += (self.targetFixedFPS - self.fixedFps) * 0.25
 76 |             self.fixedTiming = 1 / self.fixedNeeded
 77 | 
 78 |         if -0.5 < (self.screenNeeded - self.screenFps) / self.targetUpdateFPS < 0.5 and self.screenNeeded > 30:
 79 |             self.screenNeeded += (self.targetUpdateFPS - self.screenFps) * 0.15
 80 |             self.screenTiming = 1 / self.screenNeeded
 81 | 
 82 |         self.lastTime = time.perf_counter()
 83 | 
 84 |     def resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -> None:
 85 |         '''
 86 |         Triggered when the screen is resized and passes down the event.
 87 |         '''
 88 |         if self.gameScreen:
 89 |             self.gameScreen.setGeometry(0, 0, self.width(), self.height())
 90 | 
 91 |     def keyPressEvent(self, event: PySide2.QtGui.QKeyEvent) -> None:
 92 |         '''
 93 |         Triggered when a key is pressed and passes down the event.
 94 |         '''
 95 |         self.stateManager.keyPressed(event)
 96 | 
 97 |     def keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) -> None:
 98 |         '''
 99 |         Triggered when a key is released and passes down the event.
100 |         '''
101 |         self.stateManager.keyReleased(event)
102 | 
103 |     def mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) -> None:
104 |         '''
105 |         Triggered when the mouse is moved and passes down the event.
106 |         '''
107 |         self.stateManager.mouseMoved(event)
108 | 
109 |     def mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) -> None:
110 |         '''
111 |         Triggered when a mouse key is pressed and passes down the event.
112 |         '''
113 |         self.stateManager.mousePressed(event)
114 | 
115 |     def mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) -> None:
116 |         '''
117 |         Triggered when a mouse key is released and passes down the event.
118 |         '''
119 |         self.stateManager.mouseReleased(event)
120 | 
121 |     def waitForLoad(self) -> None:
122 |         '''
123 |         Makes state manager wait until the current state finishes loading widgets.
124 |         '''
125 |         QTimer(self).singleShot(0, self.stateManager.start)
126 | 


--------------------------------------------------------------------------------
/AggiEngine/particles.py:
--------------------------------------------------------------------------------
 1 | from typing import Optional
 2 | 
 3 | import numpy as np
 4 | 
 5 | from AggiEngine import GameScreen
 6 | 
 7 | 
 8 | class Particles:
 9 | 
10 |     def __init__(self, gameScreen: GameScreen, startColor: Optional[list] = None,
11 |                  endColor: Optional[list] = None, shape: Optional[list] = None, rate=0.5,
12 |                  count=100, endSize=0.01, sizeDecrease=0.95, colorFade=0.05):
13 |         if not endColor:
14 |             self.endColor = [1, 1, 1, 1]
15 |         else:
16 |             self.endColor = endColor
17 | 
18 |         if not startColor:
19 |             self.startColor = [1, 1, 1, 1]
20 |         else:
21 |             self.startColor = startColor
22 | 
23 |         if not shape:
24 |             self.shape = [[0, 0], [0.05, 0], [0.05, -0.05], [0, -0.05]]
25 |         else:
26 |             self.shape = shape
27 | 
28 |         self.gameScreen = gameScreen
29 |         self.particles = []
30 |         self.rate = rate
31 |         self.count = count
32 |         self.endSize = endSize
33 |         self.sizeDecrease = sizeDecrease
34 |         self.colorFade = colorFade
35 |         self.time = 0
36 | 
37 |     def update(self) -> None:
38 |         '''
39 |         Updates the particles, color, size and  deletes old particles.
40 |         '''
41 |         toRemove = []
42 |         for particle in self.particles:
43 |             if abs(particle[1][0][0] - particle[1][1][0]) < self.endSize:
44 |                 toRemove.append(particle)
45 | 
46 |             shape = []
47 |             for vert in particle[1]:
48 |                 shape.append([vert[0] * self.sizeDecrease, vert[1] * self.sizeDecrease])
49 |             particle[1] = shape
50 |             particle[2] = self.getColor(particle[-1])
51 |             particle[-1] -= self.colorFade
52 |             self.gameScreen.renderInfoList.append(particle)
53 | 
54 |         for particle in toRemove:
55 |             self.particles.remove(particle)
56 | 
57 |         self.time += self.rate
58 | 
59 |     def emit(self, position: list) -> None:
60 |         '''
61 |         Appends are new particle to the particle list.
62 |         '''
63 |         
64 |         if self.time > 1:
65 |             if len(self.particles) < self.count:
66 |                 self.particles.append([-1, self.shape, self.getColor(0), position, 0, 0])
67 |             self.time = 0
68 | 
69 |     def getColor(self, amount: float) -> list:
70 |         '''
71 |         Interpolates the start and end color values and returns the value.
72 |         '''
73 |         
74 |         r = abs(self.startColor[0] - self.endColor[0]) * amount + self.startColor[0]
75 |         g = abs(self.startColor[1] - self.endColor[1]) * amount + self.startColor[1]
76 |         b = abs(self.startColor[2] - self.endColor[2]) * amount + self.startColor[2]
77 |         a = abs(self.startColor[3] - self.endColor[3]) * amount + self.startColor[3]
78 |         
79 |         return [max(r, self.endColor[0]), max(g, self.endColor[1]), max(b, self.endColor[2]), max(a, self.endColor[3])]
80 | 


--------------------------------------------------------------------------------
/AggiEngine/sound.py:
--------------------------------------------------------------------------------
 1 | import simpleaudio as sa
 2 | from typing import Any
 3 | 
 4 | 
 5 | class Sound:
 6 | 
 7 |     def __init__(self) -> None:
 8 |         self.sounds = dict()
 9 |     
10 |     def load(self, key: Any, filestr: str) -> None:
11 |         """
12 |         loads a wav file for future playback  
13 |         ``key:`` A key you will use to access the audio playback  
14 |         ``filestr:`` The file path for a wav file to play  
15 |         """
16 |         self.sounds[key] = sa.WaveObject.from_wave_file(filestr)
17 |     
18 |     def play(self, key: Any) -> sa.PlayObject:
19 |         """
20 |         Plays your sound
21 |         ``key:`` The key used when loading the sound  
22 |         """
23 |         return self.sounds[key].play()
24 |     
25 |     def stop_all(self) -> None:
26 |         """
27 |         Stops all sounds from playing
28 |         """
29 |         sa.stop_all()
30 | 


--------------------------------------------------------------------------------
/AggiEngine/state.py:
--------------------------------------------------------------------------------
  1 | from typing import Optional
  2 | 
  3 | import PySide2
  4 | from .gameobjecthandler import GameObjectHandler
  5 | from .tileloader import TileMap
  6 | 
  7 | 
  8 | class State:
  9 | 
 10 |     def __init__(self, ui_path: Optional[str] = None, window: Optional[object] = None):
 11 |         '''
 12 |         Initialized class variables.
 13 |         ``ui_path:`` The path to the .ui file for the State to display
 14 |         ``window:`` The main window class for the whole application
 15 |         '''
 16 |         self.ui_path = ui_path
 17 |         self.window = window
 18 |         self.gameObjectHandler = None
 19 |         self.active = True
 20 | 
 21 |     def loadMap(self, filePath: str) -> None:
 22 |         '''
 23 |         Loads the TMX file and creates the contained game objects
 24 |         ``filePath:`` The path to the .tmx file to load game objects
 25 |         '''
 26 |         TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)
 27 | 
 28 |     def loadUi(self) -> None:
 29 |         '''
 30 |         Loads the widgets in the .ui file
 31 |         '''
 32 |         if self.ui_path is not None:
 33 |             self.window.uiManager.loadWidgets(self.ui_path, True)
 34 | 
 35 |     def startGOH(self) -> None:
 36 |         '''
 37 |         Starts the game object handler
 38 |         '''
 39 |         self.gameObjectHandler = GameObjectHandler(self.window)
 40 | 
 41 |     def updateGOH(self) -> None:
 42 |         '''
 43 |         Updates the game object handler after a screen draw
 44 |         '''
 45 |         self.gameObjectHandler.update()
 46 | 
 47 |     def fixedUpdateGOH(self) -> None:
 48 |         '''
 49 |         Updates the game object handler after a physics update
 50 |         '''
 51 |         self.gameObjectHandler.fixedUpdate()
 52 | 
 53 |     def exitGOH(self) -> None:
 54 |         '''
 55 |         Stops the game object handler
 56 |         '''
 57 |         self.gameObjectHandler.exit()
 58 | 
 59 |     def start(self) -> None:
 60 |         '''
 61 |         Triggered when the State is first activated
 62 |         '''
 63 |         pass
 64 | 
 65 |     def update(self) -> None:
 66 |         '''
 67 |         Triggered after a screen draw
 68 |         '''
 69 |         pass
 70 | 
 71 |     def fixedUpdate(self) -> None:
 72 |         '''
 73 |         Triggered after a physics update
 74 |         '''
 75 |         pass
 76 | 
 77 |     def exit(self) -> None:
 78 |         '''
 79 |         Triggered when the State stops
 80 |         '''
 81 |         pass
 82 | 
 83 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
 84 |         '''
 85 |         Triggered when a key is pressed down
 86 |         ``event:`` The key event contains the key(s) pressed
 87 |         '''
 88 |         pass
 89 | 
 90 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
 91 |         '''
 92 |         Triggered when a key is released
 93 |         ``event:`` The key event contains the key(s) released
 94 |         '''
 95 |         pass
 96 | 
 97 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
 98 |         '''
 99 |         Triggered when the mouse is moved
100 |         ``event:`` The mouse event contains the new mouse positions
101 |         '''
102 |         pass
103 | 
104 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
105 |         '''
106 |         Triggered when mouse buttons are pressed
107 |         ``event:`` The mouse event contains the mouse buttons pressed
108 |         '''
109 |         pass
110 | 
111 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
112 |         '''
113 |         Triggered when mouse buttons are released
114 |         ``event:`` The mouse event contains the mouse buttons released
115 |         '''
116 |         pass
117 | 


--------------------------------------------------------------------------------
/AggiEngine/statemanager.py:
--------------------------------------------------------------------------------
  1 | from typing import Callable
  2 | 
  3 | from PySide2.QtCore import QRunnable, Slot, QThreadPool
  4 | import PySide2
  5 | from .state import State
  6 | from .gamescreen import GameScreen
  7 | 
  8 | import time
  9 | 
 10 | 
 11 | class Physics(QRunnable):
 12 | 
 13 |     def __init__(self, fixedUpdate: Callable, state: State):
 14 |         '''
 15 |         Runs all physics related events on a separate loop and thread.
 16 |         ``fixedUpdate:`` State Managers fixedUpdate function
 17 |         ``state:`` The current state loaded
 18 |         '''
 19 |         QRunnable.__init__(self)
 20 |         self.fixedUpdate = fixedUpdate
 21 |         self.window = state.window
 22 |         self.state = state
 23 |         self.setAutoDelete(False)
 24 | 
 25 |     @Slot()  # QtCore.Slot
 26 |     def run(self) -> None:
 27 |         '''
 28 |         Starts the physics loop
 29 |         '''
 30 |         while self.state.active:
 31 |             start = time.perf_counter()
 32 |             self.fixedUpdate()
 33 |             self.window.fixedFrames += 1
 34 |             wait = self.window.fixedTiming - (time.perf_counter() - start)
 35 |             time.sleep(wait if wait > 0 else 0)
 36 | 
 37 | 
 38 | class Rendering(QRunnable):
 39 | 
 40 |     def __init__(self, update: Callable, state: State):
 41 |         '''
 42 |         Runs all rendering related events on a separate loop and thread.
 43 |         ``update:`` State Managers update function
 44 |         ``state:`` The current state loaded
 45 |         '''
 46 |         QRunnable.__init__(self)
 47 |         self.update = update
 48 |         self.window = state.window
 49 |         self.state = state
 50 |         self.setAutoDelete(False)
 51 | 
 52 |     @Slot()  # QtCore.Slot
 53 |     def run(self) -> None:
 54 |         '''
 55 |         Starts the rendering loop
 56 |         '''
 57 |         while self.state.active:
 58 |             start = time.perf_counter()
 59 |             self.update()
 60 |             if self.window.gameScreen:
 61 |                 self.window.gameScreen.update()
 62 |             self.window.screenFrames += 1
 63 |             wait = self.window.screenTiming - (time.perf_counter() - start)
 64 |             time.sleep(wait if wait > 0 else 0)
 65 | 
 66 | 
 67 | class StateManager:
 68 | 
 69 |     def __init__(self, window: object, state: State):
 70 |         '''
 71 |         ``window:`` The main window class on the application
 72 |         ``state:`` The initial state to be displayed
 73 |         '''
 74 |         self.window = window
 75 |         self.currentState = state
 76 |         self.threadPool = QThreadPool()
 77 | 
 78 |     def changeState(self, state: State) -> None:
 79 |         '''
 80 |         Switch states
 81 |         ``state:`` The next state to show  
 82 |         '''
 83 |         self.currentState.active = False
 84 |         self.currentState.exitGOH()
 85 |         self.currentState.exit()
 86 |         self.currentState = state
 87 |         self.initializeState()
 88 | 
 89 |     def update(self) -> None:
 90 |         '''
 91 |         Triggered after a frame draw
 92 |         '''
 93 |         self.currentState.updateGOH()
 94 |         self.currentState.update()
 95 | 
 96 |     def fixedUpdate(self) -> None:
 97 |         '''
 98 |         Triggered after a physics update
 99 |         '''
100 |         self.currentState.fixedUpdateGOH()
101 |         self.currentState.fixedUpdate()
102 | 
103 |     def initializeState(self) -> None:
104 |         '''
105 |         Prepares State for execution
106 |         '''
107 |         self.currentState.window = self.window  # Give the state a reference to the window
108 |         self.currentState.loadUi()  # Load the states UI
109 |         self.window.waitForLoad()
110 | 
111 |     def start(self) -> None:
112 |         '''
113 |         Starts game loops and starts the State
114 |         '''
115 |         self.window.gameScreen = self.window.findChild(GameScreen)
116 |         self.currentState.startGOH()
117 |         self.currentState.start()  # Start the state
118 |         self.threadPool.start(Physics(self.fixedUpdate, self.currentState))
119 |         self.threadPool.start(Rendering(self.update, self.currentState))
120 | 
121 |     def exit(self) -> None:
122 |         '''
123 |         Stops the State
124 |         '''
125 |         self.currentState.active = False
126 |         self.currentState.exitGOH()
127 |         self.currentState.exit()
128 | 
129 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -> None:
130 |         '''
131 |         Triggered when a key is pressed down
132 |         ``event:`` The key event contains the key(s) pressed
133 |         '''
134 |         self.currentState.keyPressed(event)
135 |         self.currentState.gameObjectHandler.keyPressed(event)
136 | 
137 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -> None:
138 |         '''
139 |         Triggered when a key is released
140 |         ``event:`` The key event contains the key(s) released
141 |         '''
142 |         self.currentState.keyReleased(event)
143 |         self.currentState.gameObjectHandler.keyReleased(event)
144 | 
145 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -> None:
146 |         '''
147 |         Triggered when the mouse is moved
148 |         ``event:`` The mouse event contains the new mouse positions
149 |         '''
150 |         self.currentState.mouseMoved(event)
151 |         self.currentState.gameObjectHandler.mouseMoved(event)
152 | 
153 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -> None:
154 |         '''
155 |         Triggered when mouse buttons are pressed
156 |         ``event:`` The mouse event contains the mouse buttons pressed
157 |         '''
158 |         self.currentState.mousePressed(event)
159 |         self.currentState.gameObjectHandler.mousePressed(event)
160 | 
161 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -> None:
162 |         '''
163 |         Triggered when mouse buttons are released
164 |         ``event:`` The mouse event contains the mouse buttons released
165 |         '''
166 |         self.currentState.mouseReleased(event)
167 |         self.currentState.gameObjectHandler.mouseReleased(event)
168 | 


--------------------------------------------------------------------------------
/AggiEngine/tileloader.py:
--------------------------------------------------------------------------------
  1 | import pytmx
  2 | import Box2D
  3 | import importlib
  4 | from PIL import ImageColor
  5 | from .gameobject import GameObject
  6 | 
  7 | 
  8 | class TileMap:
  9 | 
 10 |     def __init__(self, tmxFile, gameObjectHandler, gameScreen):
 11 |         tiled_map = pytmx.TiledMap(tmxFile, image_loader=gameScreen.image_loader)
 12 |         if tiled_map.background_color:
 13 |             color = ImageColor.getcolor(tiled_map.background_color, 'RGB')
 14 |             gameScreen.bgColor = [color[0] / 255, color[1] / 255, color[2] / 255]
 15 | 
 16 |         hitboxes = {}
 17 |         objects = tiled_map.objects
 18 | 
 19 |         # Looks for objects and gets its vertices
 20 |         for obj in objects:
 21 |             pairPoints = []
 22 |             for pair in obj.points:
 23 |                 pairPoints.append(
 24 |                     (-(pair[0] - obj.x) / gameObjectHandler.scale, -(pair[1] - obj.y) / gameObjectHandler.scale))
 25 |             hitboxes[obj.name] = pairPoints
 26 | 
 27 |         for layer in tiled_map:
 28 |             # Checks for layers with tiles
 29 |             if isinstance(layer, pytmx.TiledTileLayer):
 30 |                 for x, y, image in layer.tiles():
 31 |                     # Gets class name and gets class name definition
 32 |                     className = layer.properties.get('class', 'GameObject')
 33 | 
 34 |                     if className != 'GameObject':
 35 |                         className = getattr(importlib.import_module('__main__'), className)
 36 |                     else:
 37 |                         className = GameObject
 38 |                     # Sets up Texture
 39 |                     gm = className()
 40 |                     gm.textureID = image[0]
 41 | 
 42 |                     gm.setWidth(image[1] / gameObjectHandler.scale ** 2)
 43 |                     gm.setHeight(image[2] / gameObjectHandler.scale ** 2)
 44 | 
 45 |                     # Sets up Color
 46 |                     color = layer.properties.get('color', None)
 47 |                     if color:
 48 |                         color = ImageColor.getcolor(color, 'RGBA')
 49 |                         color = [color[2] / 255, color[1] / 255, color[0] / 255, color[3] / 255]
 50 |                         print(color)
 51 | 
 52 |                     # Sets up Hitbox
 53 |                     verticesName = layer.properties.get('hitboxName', None)
 54 | 
 55 |                     # Sets up Body Type
 56 |                     bodyType = layer.properties.get('bodyType', 'none')
 57 |                     if bodyType != 'none':
 58 |                         bodyDef = Box2D.b2BodyDef()
 59 |                         if bodyType == 'dynamic':
 60 |                             bodyDef.type = Box2D.b2_dynamicBody
 61 |                         elif bodyType == 'static':
 62 |                             bodyDef.type = Box2D.b2_staticBody
 63 |                         else:
 64 |                             bodyDef.type = Box2D.b2_kinematicBody
 65 |                         bodyDef.linearDamping = layer.properties.get('linearDamping', 0)
 66 |                         bodyDef.angularDamping = layer.properties.get('angularDamping', 0)
 67 |                         bodyDef.fixedRotation = layer.properties.get('fixedRotation', False)
 68 | 
 69 |                         # Linear Vel (Broken)
 70 |                         linearVel = layer.properties.get('linearVel', None)
 71 |                         if linearVel:
 72 |                             linearVel = [float(x) for x in linearVel.split(',')]
 73 |                             bodyDef.linearVelocity = (linearVel[0], linearVel[1])
 74 | 
 75 |                         # Sets up body Fixture
 76 |                         if verticesName:
 77 |                             bodyFixtureDef = Box2D.b2FixtureDef(
 78 |                                 shape=Box2D.b2PolygonShape(vertices=hitboxes[verticesName]))
 79 |                         else:
 80 |                             bodyFixtureDef = Box2D.b2FixtureDef(shape=Box2D.b2PolygonShape(
 81 |                                 box=((image[1] / gameObjectHandler.scale) / 2,
 82 |                                      (image[2] / gameObjectHandler.scale) / 2)))
 83 |                         bodyFixtureDef.density = layer.properties.get('density', 1)
 84 |                         bodyFixtureDef.friction = layer.properties.get('friction', 0)
 85 |                         bodyFixtureDef.restitution = layer.properties.get('restitution', 0)
 86 |                         # Sets up Position
 87 |                         bodyDef.position = (
 88 |                             -(x * tiled_map.tilewidth) / gameObjectHandler.scale,
 89 |                             -(y * tiled_map.tileheight) / gameObjectHandler.scale)
 90 |                         # adds box
 91 |                         if color:
 92 |                             gm.textureID = -1
 93 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef, color)
 94 |                         else:
 95 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef)
 96 |                     else:
 97 |                         gm.position = (-x / gameObjectHandler.scale, -y / gameObjectHandler.scale)
 98 |                         if color:
 99 |                             gm.textureID = -1
100 |                             vertices = hitboxes[verticesName]
101 |                             gm.vertices = [
102 |                                 (v[0] / gameObjectHandler.scale, v[1] / gameObjectHandler.scale) for v in vertices]
103 |                             gameObjectHandler.add(gm, color=color)
104 |                         else:
105 |                             gameObjectHandler.add(gm)
106 | 


--------------------------------------------------------------------------------
/AggiEngine/uimanager.py:
--------------------------------------------------------------------------------
 1 | from PySide2.QtCore import QMetaObject
 2 | from PySide2.QtUiTools import QUiLoader
 3 | from PySide2.QtWidgets import QMainWindow
 4 | 
 5 | 
 6 | class UiManager(QUiLoader):
 7 | 
 8 |     def __init__(self, window, customWidgets=None):
 9 |         QUiLoader.__init__(self)
10 |         self.window = window
11 | 
12 |         # Register all the custom widgets so that they can be created later
13 |         self.customWidgets = customWidgets
14 |         if customWidgets is not None:
15 |             for wid in customWidgets:
16 |                 self.registerCustomWidget(wid)
17 | 
18 |         self.keepWidgets = []
19 | 
20 |     def createWidget(self, class_name, parent=None, name=''):
21 |         """
22 |         Overrides QUiLoader to createWidget in current window rather than a new one
23 |         ``class_name:`` The class we want to create  
24 |         ``parent:`` The parent widget  
25 |         ``name:`` The name of the widget we'll create  
26 |         """
27 | 
28 |         if class_name is QMainWindow.__name__:
29 |             return self.window
30 | 
31 |         if parent is None and self.window:
32 |             return self.window
33 |         else:
34 |             if class_name in self.availableWidgets():
35 |                 widget = QUiLoader.createWidget(self, class_name, parent, name)
36 |                 widget.show()
37 |             else:
38 |                 try:
39 |                     widget = self.customWidgets[class_name](parent)
40 |                 except (TypeError, KeyError) as e:
41 |                     raise Exception(class_name, 'was not found are you sure it was promoted?')
42 | 
43 |             if self.window:
44 |                 setattr(self.window, name, widget)
45 | 
46 |             return widget
47 | 
48 |     def loadWidgets(self, ui_file, deleteCurrent=False):
49 |         """
50 |         Loads the current ui_file and if wanted deleted old widgets
51 |         ``ui_file:`` The file path to load  
52 |         ``deleteCurrent:`` Remove old widgets  
53 |         """
54 | 
55 |         if len(self.window.children()) > 0 and deleteCurrent:
56 |             for i in range(0, len(self.window.children())):
57 |                 if not(self.window.children()[i] in self.keepWidgets):
58 |                     self.window.children()[i].deleteLater()
59 | 
60 |         widgets = self.load(ui_file)  # load widgets
61 |         QMetaObject.connectSlotsByName(widgets)
62 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2020 bradylangdale
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Build Status](https://img.shields.io/github/actions/workflow/status/aggie-coding-club/AggiEngine/.github/workflows/main.yml?branch=master)](https://github.com/aggie-coding-club/AggiEngine/actions)
 2 | [![AggiEngine on PyPI](https://img.shields.io/pypi/v/AggiEngine.svg?color=blue&style=for-the-badge)](https://pypi.org/project/AggiEngine)
 3 | [![package downloads](https://img.shields.io/pypi/dm/AggiEngine.svg?color=skyblue&style=for-the-badge)](https://pypi.org/project/AggiEngine)
 4 | 
 5 | # AggiEngine
 6 | AggiEngine is a 2D game engine, designed for making game development easier. AggiEngine provides GUI, physics, state management and more...
 7 | 
 8 | ## Documentation
 9 | [Check out the docs here.](https://aggie-coding-club.github.io/AggiEngine/index.html)
10 | 
11 | ## Easy Installation
12 | 
13 | ```bash
14 | $ pip install AggiEngine
15 | ```
16 | 
17 | ## Manual Installation
18 | ```bash
19 | $ pip install PySide2
20 | $ pip install PyOpenGL
21 | $ pip install Box2D
22 | $ pip install pytmx
23 | $ pip install pillow
24 | $ pip install numpy
25 | $ pip install simpleaudio
26 | ```
27 | 
28 | ## Usage
29 | 
30 | ```python
31 | import AggiEngine as ag
32 | 
33 | 
34 | class ExampleState(ag.State):
35 | 
36 |     def __init__(self, ui_path):
37 |         ag.State.__init__(self, ui_path)
38 |         
39 |     def start(self):
40 |         self.loadMap('example_map.tmx')
41 |     
42 |     def update(self):
43 |         print("Updated!")
44 | 
45 | state = ExampleState("example.ui")
46 | app = ag.Application(state)
47 | app.run()
48 | ```
49 | 
50 | ## Issues
51 | Feel free to report any [issues](https://github.com/aggie-coding-club/AggiEngine/issues) you may find.
52 | Also if there is a feature you would like to add feel free to make a pull request!
53 | 


--------------------------------------------------------------------------------
/docs/application.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.application API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.application</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from typing import Optional
 30 | 
 31 | from PySide2.QtWidgets import QApplication
 32 | 
 33 | from . import State
 34 | from .mainwindow import MainWindow
 35 | 
 36 | 
 37 | class Application(QApplication):
 38 |     &#34;&#34;&#34;
 39 |     This is the core class of an AggiEngine application.
 40 |     &#34;&#34;&#34;
 41 | 
 42 |     def __init__(self, state: State, screenFps: Optional[float] = 120, fixedFps: Optional[float] = 60,
 43 |                  args: Optional[list] = None) -&gt; None:
 44 |         &#34;&#34;&#34;
 45 |         Creates and initializes QWidgets for the application to start.
 46 |         ``state:`` The initial state to launch the Application with    
 47 |         ``args:`` System arguments passed in    
 48 |         ``config:`` Set application parameters    
 49 |         &#34;&#34;&#34;
 50 |         if args:
 51 |             super(Application, self).__init__(args)
 52 |         else:
 53 |             super(Application, self).__init__()
 54 | 
 55 |         self.window = MainWindow(self, state, screenFps, fixedFps)
 56 | 
 57 |     def run(self) -&gt; None:
 58 |         &#34;&#34;&#34;
 59 |         Execute the application, this will start the passed State
 60 |         &#34;&#34;&#34;
 61 |         self.window.start()
 62 |         self.window.show()
 63 |         self.exec_()</code></pre>
 64 | </details>
 65 | </section>
 66 | <section>
 67 | </section>
 68 | <section>
 69 | </section>
 70 | <section>
 71 | </section>
 72 | <section>
 73 | <h2 class="section-title" id="header-classes">Classes</h2>
 74 | <dl>
 75 | <dt id="AggiEngine.application.Application"><code class="flex name class">
 76 | <span>class <span class="ident">Application</span></span>
 77 | <span>(</span><span>state: <a title="AggiEngine.state.State" href="state.html#AggiEngine.state.State">State</a>, screenFps: typing.Union[float, NoneType] = 120, fixedFps: typing.Union[float, NoneType] = 60, args: typing.Union[list, NoneType] = None)</span>
 78 | </code></dt>
 79 | <dd>
 80 | <div class="desc"><p>This is the core class of an AggiEngine application.</p>
 81 | <p>Creates and initializes QWidgets for the application to start.
 82 | <code>state:</code> The initial state to launch the Application with
 83 | <br>
 84 | <code>args:</code> System arguments passed in
 85 | <br>
 86 | <code>config:</code> Set application parameters</p></div>
 87 | <details class="source">
 88 | <summary>
 89 | <span>Expand source code</span>
 90 | </summary>
 91 | <pre><code class="python">class Application(QApplication):
 92 |     &#34;&#34;&#34;
 93 |     This is the core class of an AggiEngine application.
 94 |     &#34;&#34;&#34;
 95 | 
 96 |     def __init__(self, state: State, screenFps: Optional[float] = 120, fixedFps: Optional[float] = 60,
 97 |                  args: Optional[list] = None) -&gt; None:
 98 |         &#34;&#34;&#34;
 99 |         Creates and initializes QWidgets for the application to start.
100 |         ``state:`` The initial state to launch the Application with    
101 |         ``args:`` System arguments passed in    
102 |         ``config:`` Set application parameters    
103 |         &#34;&#34;&#34;
104 |         if args:
105 |             super(Application, self).__init__(args)
106 |         else:
107 |             super(Application, self).__init__()
108 | 
109 |         self.window = MainWindow(self, state, screenFps, fixedFps)
110 | 
111 |     def run(self) -&gt; None:
112 |         &#34;&#34;&#34;
113 |         Execute the application, this will start the passed State
114 |         &#34;&#34;&#34;
115 |         self.window.start()
116 |         self.window.show()
117 |         self.exec_()</code></pre>
118 | </details>
119 | <h3>Ancestors</h3>
120 | <ul class="hlist">
121 | <li>PySide2.QtWidgets.QApplication</li>
122 | <li>PySide2.QtGui.QGuiApplication</li>
123 | <li>PySide2.QtCore.QCoreApplication</li>
124 | <li>PySide2.QtCore.QObject</li>
125 | <li>Shiboken.Object</li>
126 | </ul>
127 | <h3>Class variables</h3>
128 | <dl>
129 | <dt id="AggiEngine.application.Application.staticMetaObject"><code class="name">var <span class="ident">staticMetaObject</span></code></dt>
130 | <dd>
131 | <div class="desc"></div>
132 | </dd>
133 | </dl>
134 | <h3>Methods</h3>
135 | <dl>
136 | <dt id="AggiEngine.application.Application.run"><code class="name flex">
137 | <span>def <span class="ident">run</span></span>(<span>self) ‑> NoneType</span>
138 | </code></dt>
139 | <dd>
140 | <div class="desc"><p>Execute the application, this will start the passed State</p></div>
141 | <details class="source">
142 | <summary>
143 | <span>Expand source code</span>
144 | </summary>
145 | <pre><code class="python">def run(self) -&gt; None:
146 |     &#34;&#34;&#34;
147 |     Execute the application, this will start the passed State
148 |     &#34;&#34;&#34;
149 |     self.window.start()
150 |     self.window.show()
151 |     self.exec_()</code></pre>
152 | </details>
153 | </dd>
154 | </dl>
155 | </dd>
156 | </dl>
157 | </section>
158 | </article>
159 | <nav id="sidebar">
160 | <h1>Index</h1>
161 | <div class="toc">
162 | <ul></ul>
163 | </div>
164 | <ul id="index">
165 | <li><h3>Super-module</h3>
166 | <ul>
167 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
168 | </ul>
169 | </li>
170 | <li><h3><a href="#header-classes">Classes</a></h3>
171 | <ul>
172 | <li>
173 | <h4><code><a title="AggiEngine.application.Application" href="#AggiEngine.application.Application">Application</a></code></h4>
174 | <ul class="">
175 | <li><code><a title="AggiEngine.application.Application.run" href="#AggiEngine.application.Application.run">run</a></code></li>
176 | <li><code><a title="AggiEngine.application.Application.staticMetaObject" href="#AggiEngine.application.Application.staticMetaObject">staticMetaObject</a></code></li>
177 | </ul>
178 | </li>
179 | </ul>
180 | </li>
181 | </ul>
182 | </nav>
183 | </main>
184 | <footer id="footer">
185 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
186 | </footer>
187 | </body>
188 | </html>


--------------------------------------------------------------------------------
/docs/contactlistener.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.contactlistener API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.contactlistener</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from Box2D import b2ContactListener, b2Contact, b2Manifold, b2Vec2
 30 | 
 31 | 
 32 | class ContactListener(b2ContactListener):
 33 |     &#34;&#34;&#34;
 34 |     Receives contact information from Box2D and passes it along to the GameObjects in the collision.
 35 |     &#34;&#34;&#34;
 36 | 
 37 |     def __init__(self):
 38 |         b2ContactListener.__init__(self)
 39 | 
 40 |     def BeginContact(self, contact: b2Contact) -&gt; None:
 41 |         &#34;&#34;&#34;
 42 |         Called when two Box2D bodies collide and calls their beginContact(otherBody) methods
 43 |         ``contact:`` The contact event
 44 |         &#34;&#34;&#34;
 45 |         bodyA = contact.fixtureA.body
 46 |         bodyB = contact.fixtureB.body
 47 |         bodyA.userData.beginContact(bodyB)
 48 |         bodyB.userData.beginContact(bodyA)
 49 | 
 50 |     def EndContact(self, contact: b2Contact) -&gt; None:
 51 |         &#34;&#34;&#34;
 52 |         Called when two Box2D bodies collide and calls their endContact(otherBody) methods
 53 |         ``contact:`` The contact event
 54 |         &#34;&#34;&#34;
 55 |         bodyA = contact.fixtureA.body
 56 |         bodyB = contact.fixtureB.body
 57 |         bodyA.userData.endContact(bodyB)
 58 |         bodyB.userData.endContact(bodyA)
 59 | 
 60 |     def PreSolve(self, contact: b2Contact, manifold: b2Manifold) -&gt; None:
 61 |         &#34;&#34;&#34;
 62 |         Called before Box2D handles a contact while the bodies are still overlapping
 63 |         &#34;&#34;&#34;
 64 |         bodyA = contact.fixtureA.body
 65 |         bodyB = contact.fixtureB.body
 66 |         bodyA.userData.preSolve(bodyB, manifold)
 67 |         bodyB.userData.preSolve(bodyA, manifold)
 68 | 
 69 |     def PostSolve(self, contact: b2Contact, impulse: b2Vec2) -&gt; None:
 70 |         &#34;&#34;&#34;
 71 |         Called after Box2D handles a contact while the bodies are no longer overlapping
 72 |         &#34;&#34;&#34;
 73 |         bodyA = contact.fixtureA.body
 74 |         bodyB = contact.fixtureB.body
 75 |         bodyA.userData.postSolve(bodyB, impulse)
 76 |         bodyB.userData.postSolve(bodyA, impulse)</code></pre>
 77 | </details>
 78 | </section>
 79 | <section>
 80 | </section>
 81 | <section>
 82 | </section>
 83 | <section>
 84 | </section>
 85 | <section>
 86 | <h2 class="section-title" id="header-classes">Classes</h2>
 87 | <dl>
 88 | <dt id="AggiEngine.contactlistener.ContactListener"><code class="flex name class">
 89 | <span>class <span class="ident">ContactListener</span></span>
 90 | </code></dt>
 91 | <dd>
 92 | <div class="desc"><p>Receives contact information from Box2D and passes it along to the GameObjects in the collision.</p></div>
 93 | <details class="source">
 94 | <summary>
 95 | <span>Expand source code</span>
 96 | </summary>
 97 | <pre><code class="python">class ContactListener(b2ContactListener):
 98 |     &#34;&#34;&#34;
 99 |     Receives contact information from Box2D and passes it along to the GameObjects in the collision.
100 |     &#34;&#34;&#34;
101 | 
102 |     def __init__(self):
103 |         b2ContactListener.__init__(self)
104 | 
105 |     def BeginContact(self, contact: b2Contact) -&gt; None:
106 |         &#34;&#34;&#34;
107 |         Called when two Box2D bodies collide and calls their beginContact(otherBody) methods
108 |         ``contact:`` The contact event
109 |         &#34;&#34;&#34;
110 |         bodyA = contact.fixtureA.body
111 |         bodyB = contact.fixtureB.body
112 |         bodyA.userData.beginContact(bodyB)
113 |         bodyB.userData.beginContact(bodyA)
114 | 
115 |     def EndContact(self, contact: b2Contact) -&gt; None:
116 |         &#34;&#34;&#34;
117 |         Called when two Box2D bodies collide and calls their endContact(otherBody) methods
118 |         ``contact:`` The contact event
119 |         &#34;&#34;&#34;
120 |         bodyA = contact.fixtureA.body
121 |         bodyB = contact.fixtureB.body
122 |         bodyA.userData.endContact(bodyB)
123 |         bodyB.userData.endContact(bodyA)
124 | 
125 |     def PreSolve(self, contact: b2Contact, manifold: b2Manifold) -&gt; None:
126 |         &#34;&#34;&#34;
127 |         Called before Box2D handles a contact while the bodies are still overlapping
128 |         &#34;&#34;&#34;
129 |         bodyA = contact.fixtureA.body
130 |         bodyB = contact.fixtureB.body
131 |         bodyA.userData.preSolve(bodyB, manifold)
132 |         bodyB.userData.preSolve(bodyA, manifold)
133 | 
134 |     def PostSolve(self, contact: b2Contact, impulse: b2Vec2) -&gt; None:
135 |         &#34;&#34;&#34;
136 |         Called after Box2D handles a contact while the bodies are no longer overlapping
137 |         &#34;&#34;&#34;
138 |         bodyA = contact.fixtureA.body
139 |         bodyB = contact.fixtureB.body
140 |         bodyA.userData.postSolve(bodyB, impulse)
141 |         bodyB.userData.postSolve(bodyA, impulse)</code></pre>
142 | </details>
143 | <h3>Ancestors</h3>
144 | <ul class="hlist">
145 | <li>Box2D.Box2D.b2ContactListener</li>
146 | </ul>
147 | <h3>Methods</h3>
148 | <dl>
149 | <dt id="AggiEngine.contactlistener.ContactListener.BeginContact"><code class="name flex">
150 | <span>def <span class="ident">BeginContact</span></span>(<span>self, contact: Box2D.Box2D.b2Contact) ‑> NoneType</span>
151 | </code></dt>
152 | <dd>
153 | <div class="desc"><p>Called when two Box2D bodies collide and calls their beginContact(otherBody) methods
154 | <code>contact:</code> The contact event</p></div>
155 | <details class="source">
156 | <summary>
157 | <span>Expand source code</span>
158 | </summary>
159 | <pre><code class="python">def BeginContact(self, contact: b2Contact) -&gt; None:
160 |     &#34;&#34;&#34;
161 |     Called when two Box2D bodies collide and calls their beginContact(otherBody) methods
162 |     ``contact:`` The contact event
163 |     &#34;&#34;&#34;
164 |     bodyA = contact.fixtureA.body
165 |     bodyB = contact.fixtureB.body
166 |     bodyA.userData.beginContact(bodyB)
167 |     bodyB.userData.beginContact(bodyA)</code></pre>
168 | </details>
169 | </dd>
170 | <dt id="AggiEngine.contactlistener.ContactListener.EndContact"><code class="name flex">
171 | <span>def <span class="ident">EndContact</span></span>(<span>self, contact: Box2D.Box2D.b2Contact) ‑> NoneType</span>
172 | </code></dt>
173 | <dd>
174 | <div class="desc"><p>Called when two Box2D bodies collide and calls their endContact(otherBody) methods
175 | <code>contact:</code> The contact event</p></div>
176 | <details class="source">
177 | <summary>
178 | <span>Expand source code</span>
179 | </summary>
180 | <pre><code class="python">def EndContact(self, contact: b2Contact) -&gt; None:
181 |     &#34;&#34;&#34;
182 |     Called when two Box2D bodies collide and calls their endContact(otherBody) methods
183 |     ``contact:`` The contact event
184 |     &#34;&#34;&#34;
185 |     bodyA = contact.fixtureA.body
186 |     bodyB = contact.fixtureB.body
187 |     bodyA.userData.endContact(bodyB)
188 |     bodyB.userData.endContact(bodyA)</code></pre>
189 | </details>
190 | </dd>
191 | <dt id="AggiEngine.contactlistener.ContactListener.PostSolve"><code class="name flex">
192 | <span>def <span class="ident">PostSolve</span></span>(<span>self, contact: Box2D.Box2D.b2Contact, impulse: Box2D.Box2D.b2Vec2) ‑> NoneType</span>
193 | </code></dt>
194 | <dd>
195 | <div class="desc"><p>Called after Box2D handles a contact while the bodies are no longer overlapping</p></div>
196 | <details class="source">
197 | <summary>
198 | <span>Expand source code</span>
199 | </summary>
200 | <pre><code class="python">def PostSolve(self, contact: b2Contact, impulse: b2Vec2) -&gt; None:
201 |     &#34;&#34;&#34;
202 |     Called after Box2D handles a contact while the bodies are no longer overlapping
203 |     &#34;&#34;&#34;
204 |     bodyA = contact.fixtureA.body
205 |     bodyB = contact.fixtureB.body
206 |     bodyA.userData.postSolve(bodyB, impulse)
207 |     bodyB.userData.postSolve(bodyA, impulse)</code></pre>
208 | </details>
209 | </dd>
210 | <dt id="AggiEngine.contactlistener.ContactListener.PreSolve"><code class="name flex">
211 | <span>def <span class="ident">PreSolve</span></span>(<span>self, contact: Box2D.Box2D.b2Contact, manifold: Box2D.Box2D.b2Manifold) ‑> NoneType</span>
212 | </code></dt>
213 | <dd>
214 | <div class="desc"><p>Called before Box2D handles a contact while the bodies are still overlapping</p></div>
215 | <details class="source">
216 | <summary>
217 | <span>Expand source code</span>
218 | </summary>
219 | <pre><code class="python">def PreSolve(self, contact: b2Contact, manifold: b2Manifold) -&gt; None:
220 |     &#34;&#34;&#34;
221 |     Called before Box2D handles a contact while the bodies are still overlapping
222 |     &#34;&#34;&#34;
223 |     bodyA = contact.fixtureA.body
224 |     bodyB = contact.fixtureB.body
225 |     bodyA.userData.preSolve(bodyB, manifold)
226 |     bodyB.userData.preSolve(bodyA, manifold)</code></pre>
227 | </details>
228 | </dd>
229 | </dl>
230 | </dd>
231 | </dl>
232 | </section>
233 | </article>
234 | <nav id="sidebar">
235 | <h1>Index</h1>
236 | <div class="toc">
237 | <ul></ul>
238 | </div>
239 | <ul id="index">
240 | <li><h3>Super-module</h3>
241 | <ul>
242 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
243 | </ul>
244 | </li>
245 | <li><h3><a href="#header-classes">Classes</a></h3>
246 | <ul>
247 | <li>
248 | <h4><code><a title="AggiEngine.contactlistener.ContactListener" href="#AggiEngine.contactlistener.ContactListener">ContactListener</a></code></h4>
249 | <ul class="">
250 | <li><code><a title="AggiEngine.contactlistener.ContactListener.BeginContact" href="#AggiEngine.contactlistener.ContactListener.BeginContact">BeginContact</a></code></li>
251 | <li><code><a title="AggiEngine.contactlistener.ContactListener.EndContact" href="#AggiEngine.contactlistener.ContactListener.EndContact">EndContact</a></code></li>
252 | <li><code><a title="AggiEngine.contactlistener.ContactListener.PostSolve" href="#AggiEngine.contactlistener.ContactListener.PostSolve">PostSolve</a></code></li>
253 | <li><code><a title="AggiEngine.contactlistener.ContactListener.PreSolve" href="#AggiEngine.contactlistener.ContactListener.PreSolve">PreSolve</a></code></li>
254 | </ul>
255 | </li>
256 | </ul>
257 | </li>
258 | </ul>
259 | </nav>
260 | </main>
261 | <footer id="footer">
262 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
263 | </footer>
264 | </body>
265 | </html>


--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Package <code>AggiEngine</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from AggiEngine.gamescreen import GameScreen
 30 | from AggiEngine.state import State
 31 | from AggiEngine.statemanager import StateManager
 32 | from AggiEngine.uimanager import UiManager
 33 | from AggiEngine.gameobject import GameObject
 34 | from AggiEngine.mainwindow import MainWindow
 35 | from AggiEngine.particles import Particles
 36 | from AggiEngine.application import Application
 37 | from AggiEngine.sound import Sound
 38 | from AggiEngine.tileloader import TileMap</code></pre>
 39 | </details>
 40 | </section>
 41 | <section>
 42 | <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 43 | <dl>
 44 | <dt><code class="name"><a title="AggiEngine.application" href="application.html">AggiEngine.application</a></code></dt>
 45 | <dd>
 46 | <div class="desc"></div>
 47 | </dd>
 48 | <dt><code class="name"><a title="AggiEngine.contactlistener" href="contactlistener.html">AggiEngine.contactlistener</a></code></dt>
 49 | <dd>
 50 | <div class="desc"></div>
 51 | </dd>
 52 | <dt><code class="name"><a title="AggiEngine.gameobject" href="gameobject.html">AggiEngine.gameobject</a></code></dt>
 53 | <dd>
 54 | <div class="desc"></div>
 55 | </dd>
 56 | <dt><code class="name"><a title="AggiEngine.gameobjecthandler" href="gameobjecthandler.html">AggiEngine.gameobjecthandler</a></code></dt>
 57 | <dd>
 58 | <div class="desc"></div>
 59 | </dd>
 60 | <dt><code class="name"><a title="AggiEngine.gamescreen" href="gamescreen.html">AggiEngine.gamescreen</a></code></dt>
 61 | <dd>
 62 | <div class="desc"></div>
 63 | </dd>
 64 | <dt><code class="name"><a title="AggiEngine.mainwindow" href="mainwindow.html">AggiEngine.mainwindow</a></code></dt>
 65 | <dd>
 66 | <div class="desc"></div>
 67 | </dd>
 68 | <dt><code class="name"><a title="AggiEngine.particles" href="particles.html">AggiEngine.particles</a></code></dt>
 69 | <dd>
 70 | <div class="desc"></div>
 71 | </dd>
 72 | <dt><code class="name"><a title="AggiEngine.sound" href="sound.html">AggiEngine.sound</a></code></dt>
 73 | <dd>
 74 | <div class="desc"></div>
 75 | </dd>
 76 | <dt><code class="name"><a title="AggiEngine.state" href="state.html">AggiEngine.state</a></code></dt>
 77 | <dd>
 78 | <div class="desc"></div>
 79 | </dd>
 80 | <dt><code class="name"><a title="AggiEngine.statemanager" href="statemanager.html">AggiEngine.statemanager</a></code></dt>
 81 | <dd>
 82 | <div class="desc"></div>
 83 | </dd>
 84 | <dt><code class="name"><a title="AggiEngine.tileloader" href="tileloader.html">AggiEngine.tileloader</a></code></dt>
 85 | <dd>
 86 | <div class="desc"></div>
 87 | </dd>
 88 | <dt><code class="name"><a title="AggiEngine.uimanager" href="uimanager.html">AggiEngine.uimanager</a></code></dt>
 89 | <dd>
 90 | <div class="desc"></div>
 91 | </dd>
 92 | </dl>
 93 | </section>
 94 | <section>
 95 | </section>
 96 | <section>
 97 | </section>
 98 | <section>
 99 | </section>
100 | </article>
101 | <nav id="sidebar">
102 | <h1>Index</h1>
103 | <div class="toc">
104 | <ul></ul>
105 | </div>
106 | <ul id="index">
107 | <li><h3><a href="#header-submodules">Sub-modules</a></h3>
108 | <ul>
109 | <li><code><a title="AggiEngine.application" href="application.html">AggiEngine.application</a></code></li>
110 | <li><code><a title="AggiEngine.contactlistener" href="contactlistener.html">AggiEngine.contactlistener</a></code></li>
111 | <li><code><a title="AggiEngine.gameobject" href="gameobject.html">AggiEngine.gameobject</a></code></li>
112 | <li><code><a title="AggiEngine.gameobjecthandler" href="gameobjecthandler.html">AggiEngine.gameobjecthandler</a></code></li>
113 | <li><code><a title="AggiEngine.gamescreen" href="gamescreen.html">AggiEngine.gamescreen</a></code></li>
114 | <li><code><a title="AggiEngine.mainwindow" href="mainwindow.html">AggiEngine.mainwindow</a></code></li>
115 | <li><code><a title="AggiEngine.particles" href="particles.html">AggiEngine.particles</a></code></li>
116 | <li><code><a title="AggiEngine.sound" href="sound.html">AggiEngine.sound</a></code></li>
117 | <li><code><a title="AggiEngine.state" href="state.html">AggiEngine.state</a></code></li>
118 | <li><code><a title="AggiEngine.statemanager" href="statemanager.html">AggiEngine.statemanager</a></code></li>
119 | <li><code><a title="AggiEngine.tileloader" href="tileloader.html">AggiEngine.tileloader</a></code></li>
120 | <li><code><a title="AggiEngine.uimanager" href="uimanager.html">AggiEngine.uimanager</a></code></li>
121 | </ul>
122 | </li>
123 | </ul>
124 | </nav>
125 | </main>
126 | <footer id="footer">
127 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
128 | </footer>
129 | </body>
130 | </html>


--------------------------------------------------------------------------------
/docs/mainwindow.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.mainwindow API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.mainwindow</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">import time
 30 | from typing import Optional
 31 | 
 32 | import PySide2
 33 | from PySide2.QtCore import QTimer, Qt
 34 | from PySide2.QtWidgets import QMainWindow, QWidget
 35 | 
 36 | from .uimanager import UiManager
 37 | from .statemanager import StateManager
 38 | from .state import State
 39 | from .gamescreen import GameScreen
 40 | 
 41 | 
 42 | class MainWindow(QMainWindow):
 43 | 
 44 |     def __init__(self, app, state: State, screenFPS: int, fixedFPS: int, parent: Optional[QWidget] = None):
 45 |         &#39;&#39;&#39;
 46 |         The MainWindow is created by the application, here we handle ui/scenes and send out updates.
 47 |         ``state:`` The current state we want to start with.  
 48 |         ``parent:`` The widget this held under, None by default because this is top widget  
 49 |         &#39;&#39;&#39;
 50 |         QMainWindow.__init__(self, parent)
 51 |         self.app = app  # the application created
 52 |         self.gameScreen = None  # where all graphics are drawn
 53 |         self.uiManager = UiManager(self, customWidgets=[GameScreen])  # Loads widgets into window from a file
 54 |         self.stateManager = StateManager(self, state)  # Manages state updates and transitions
 55 | 
 56 |         self.updateFPSTimer = QTimer(self)  # Used to manage frame timings
 57 |         self.updateFPSTimer.timeout.connect(self.__calculateFPS)
 58 | 
 59 |         self.fixedFps = 0  # Calculated FPS
 60 |         self.screenFps = 0
 61 | 
 62 |         self.fixedFrames = 0  # Accumulated Frames
 63 |         self.screenFrames = 0
 64 | 
 65 |         self.targetFixedFPS = fixedFPS
 66 |         self.targetUpdateFPS = screenFPS
 67 |         self.fixedTiming = 1 / self.targetFixedFPS
 68 |         self.screenTiming = 1 / self.targetUpdateFPS
 69 |         self.fixedNeeded = fixedFPS
 70 |         self.screenNeeded = screenFPS
 71 |         self.lastTime = 0
 72 |         self.setMouseTracking(True)
 73 | 
 74 |         self.uiManager.keepWidgets = self.children()
 75 | 
 76 |     def start(self) -&gt; None:
 77 |         &#39;&#39;&#39;
 78 |         Called when application.run() is executed. Starts the actual engine.
 79 |         &#39;&#39;&#39;
 80 |         self.stateManager.initializeState()  # start the state
 81 |         self.updateFPSTimer.start(100)
 82 | 
 83 |     def closeEvent(self, event: PySide2.QtGui.QCloseEvent) -&gt; None:
 84 |         &#39;&#39;&#39;
 85 |         Called when the window is closed
 86 |         &#39;&#39;&#39;
 87 |         print(&#34;Window closed.&#34;)
 88 |         self.updateFPSTimer.stop()
 89 |         self.stateManager.exit()
 90 | 
 91 |     def __calculateFPS(self) -&gt; None:
 92 |         &#39;&#39;&#39;
 93 |         Averages FPS and adjust frame timings to meet the targets
 94 |         &#39;&#39;&#39;
 95 | 
 96 |         self.fixedFps = self.fixedFrames / (time.perf_counter() - self.lastTime)
 97 |         self.fixedFrames = 0
 98 | 
 99 |         self.screenFps = self.screenFrames / (time.perf_counter() - self.lastTime)
100 |         self.screenFrames = 0
101 | 
102 |         if -0.5 &lt; (self.targetFixedFPS - self.fixedFps) / self.targetFixedFPS &lt; 0.5 and self.fixedNeeded &gt; 30:
103 |             self.fixedNeeded += (self.targetFixedFPS - self.fixedFps) * 0.25
104 |             self.fixedTiming = 1 / self.fixedNeeded
105 | 
106 |         if -0.5 &lt; (self.screenNeeded - self.screenFps) / self.targetUpdateFPS &lt; 0.5 and self.screenNeeded &gt; 30:
107 |             self.screenNeeded += (self.targetUpdateFPS - self.screenFps) * 0.15
108 |             self.screenTiming = 1 / self.screenNeeded
109 | 
110 |         self.lastTime = time.perf_counter()
111 | 
112 |     def resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -&gt; None:
113 |         &#39;&#39;&#39;
114 |         Triggered when the screen is resized and passes down the event.
115 |         &#39;&#39;&#39;
116 |         if self.gameScreen:
117 |             self.gameScreen.setGeometry(0, 0, self.width(), self.height())
118 | 
119 |     def keyPressEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
120 |         &#39;&#39;&#39;
121 |         Triggered when a key is pressed and passes down the event.
122 |         &#39;&#39;&#39;
123 |         self.stateManager.keyPressed(event)
124 | 
125 |     def keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
126 |         &#39;&#39;&#39;
127 |         Triggered when a key is released and passes down the event.
128 |         &#39;&#39;&#39;
129 |         self.stateManager.keyReleased(event)
130 | 
131 |     def mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
132 |         &#39;&#39;&#39;
133 |         Triggered when the mouse is moved and passes down the event.
134 |         &#39;&#39;&#39;
135 |         self.stateManager.mouseMoved(event)
136 | 
137 |     def mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
138 |         &#39;&#39;&#39;
139 |         Triggered when a mouse key is pressed and passes down the event.
140 |         &#39;&#39;&#39;
141 |         self.stateManager.mousePressed(event)
142 | 
143 |     def mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
144 |         &#39;&#39;&#39;
145 |         Triggered when a mouse key is released and passes down the event.
146 |         &#39;&#39;&#39;
147 |         self.stateManager.mouseReleased(event)
148 | 
149 |     def waitForLoad(self) -&gt; None:
150 |         &#39;&#39;&#39;
151 |         Makes state manager wait until the current state finishes loading widgets.
152 |         &#39;&#39;&#39;
153 |         QTimer(self).singleShot(0, self.stateManager.start)</code></pre>
154 | </details>
155 | </section>
156 | <section>
157 | </section>
158 | <section>
159 | </section>
160 | <section>
161 | </section>
162 | <section>
163 | <h2 class="section-title" id="header-classes">Classes</h2>
164 | <dl>
165 | <dt id="AggiEngine.mainwindow.MainWindow"><code class="flex name class">
166 | <span>class <span class="ident">MainWindow</span></span>
167 | <span>(</span><span>app, state: <a title="AggiEngine.state.State" href="state.html#AggiEngine.state.State">State</a>, screenFPS: int, fixedFPS: int, parent: typing.Union[PySide2.QtWidgets.QWidget, NoneType] = None)</span>
168 | </code></dt>
169 | <dd>
170 | <div class="desc"><p>QMainWindow(self, parent: typing.Union[PySide2.QtWidgets.QWidget, NoneType] = None, flags: PySide2.QtCore.Qt.WindowFlags = Default(Qt.WindowFlags)) -&gt; None</p>
171 | <p>The MainWindow is created by the application, here we handle ui/scenes and send out updates.
172 | <code>state:</code> The current state we want to start with.<br>
173 | <code>parent:</code> The widget this held under, None by default because this is top widget</p></div>
174 | <details class="source">
175 | <summary>
176 | <span>Expand source code</span>
177 | </summary>
178 | <pre><code class="python">class MainWindow(QMainWindow):
179 | 
180 |     def __init__(self, app, state: State, screenFPS: int, fixedFPS: int, parent: Optional[QWidget] = None):
181 |         &#39;&#39;&#39;
182 |         The MainWindow is created by the application, here we handle ui/scenes and send out updates.
183 |         ``state:`` The current state we want to start with.  
184 |         ``parent:`` The widget this held under, None by default because this is top widget  
185 |         &#39;&#39;&#39;
186 |         QMainWindow.__init__(self, parent)
187 |         self.app = app  # the application created
188 |         self.gameScreen = None  # where all graphics are drawn
189 |         self.uiManager = UiManager(self, customWidgets=[GameScreen])  # Loads widgets into window from a file
190 |         self.stateManager = StateManager(self, state)  # Manages state updates and transitions
191 | 
192 |         self.updateFPSTimer = QTimer(self)  # Used to manage frame timings
193 |         self.updateFPSTimer.timeout.connect(self.__calculateFPS)
194 | 
195 |         self.fixedFps = 0  # Calculated FPS
196 |         self.screenFps = 0
197 | 
198 |         self.fixedFrames = 0  # Accumulated Frames
199 |         self.screenFrames = 0
200 | 
201 |         self.targetFixedFPS = fixedFPS
202 |         self.targetUpdateFPS = screenFPS
203 |         self.fixedTiming = 1 / self.targetFixedFPS
204 |         self.screenTiming = 1 / self.targetUpdateFPS
205 |         self.fixedNeeded = fixedFPS
206 |         self.screenNeeded = screenFPS
207 |         self.lastTime = 0
208 |         self.setMouseTracking(True)
209 | 
210 |         self.uiManager.keepWidgets = self.children()
211 | 
212 |     def start(self) -&gt; None:
213 |         &#39;&#39;&#39;
214 |         Called when application.run() is executed. Starts the actual engine.
215 |         &#39;&#39;&#39;
216 |         self.stateManager.initializeState()  # start the state
217 |         self.updateFPSTimer.start(100)
218 | 
219 |     def closeEvent(self, event: PySide2.QtGui.QCloseEvent) -&gt; None:
220 |         &#39;&#39;&#39;
221 |         Called when the window is closed
222 |         &#39;&#39;&#39;
223 |         print(&#34;Window closed.&#34;)
224 |         self.updateFPSTimer.stop()
225 |         self.stateManager.exit()
226 | 
227 |     def __calculateFPS(self) -&gt; None:
228 |         &#39;&#39;&#39;
229 |         Averages FPS and adjust frame timings to meet the targets
230 |         &#39;&#39;&#39;
231 | 
232 |         self.fixedFps = self.fixedFrames / (time.perf_counter() - self.lastTime)
233 |         self.fixedFrames = 0
234 | 
235 |         self.screenFps = self.screenFrames / (time.perf_counter() - self.lastTime)
236 |         self.screenFrames = 0
237 | 
238 |         if -0.5 &lt; (self.targetFixedFPS - self.fixedFps) / self.targetFixedFPS &lt; 0.5 and self.fixedNeeded &gt; 30:
239 |             self.fixedNeeded += (self.targetFixedFPS - self.fixedFps) * 0.25
240 |             self.fixedTiming = 1 / self.fixedNeeded
241 | 
242 |         if -0.5 &lt; (self.screenNeeded - self.screenFps) / self.targetUpdateFPS &lt; 0.5 and self.screenNeeded &gt; 30:
243 |             self.screenNeeded += (self.targetUpdateFPS - self.screenFps) * 0.15
244 |             self.screenTiming = 1 / self.screenNeeded
245 | 
246 |         self.lastTime = time.perf_counter()
247 | 
248 |     def resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -&gt; None:
249 |         &#39;&#39;&#39;
250 |         Triggered when the screen is resized and passes down the event.
251 |         &#39;&#39;&#39;
252 |         if self.gameScreen:
253 |             self.gameScreen.setGeometry(0, 0, self.width(), self.height())
254 | 
255 |     def keyPressEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
256 |         &#39;&#39;&#39;
257 |         Triggered when a key is pressed and passes down the event.
258 |         &#39;&#39;&#39;
259 |         self.stateManager.keyPressed(event)
260 | 
261 |     def keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
262 |         &#39;&#39;&#39;
263 |         Triggered when a key is released and passes down the event.
264 |         &#39;&#39;&#39;
265 |         self.stateManager.keyReleased(event)
266 | 
267 |     def mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
268 |         &#39;&#39;&#39;
269 |         Triggered when the mouse is moved and passes down the event.
270 |         &#39;&#39;&#39;
271 |         self.stateManager.mouseMoved(event)
272 | 
273 |     def mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
274 |         &#39;&#39;&#39;
275 |         Triggered when a mouse key is pressed and passes down the event.
276 |         &#39;&#39;&#39;
277 |         self.stateManager.mousePressed(event)
278 | 
279 |     def mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
280 |         &#39;&#39;&#39;
281 |         Triggered when a mouse key is released and passes down the event.
282 |         &#39;&#39;&#39;
283 |         self.stateManager.mouseReleased(event)
284 | 
285 |     def waitForLoad(self) -&gt; None:
286 |         &#39;&#39;&#39;
287 |         Makes state manager wait until the current state finishes loading widgets.
288 |         &#39;&#39;&#39;
289 |         QTimer(self).singleShot(0, self.stateManager.start)</code></pre>
290 | </details>
291 | <h3>Ancestors</h3>
292 | <ul class="hlist">
293 | <li>PySide2.QtWidgets.QMainWindow</li>
294 | <li>PySide2.QtWidgets.QWidget</li>
295 | <li>PySide2.QtCore.QObject</li>
296 | <li>PySide2.QtGui.QPaintDevice</li>
297 | <li>Shiboken.Object</li>
298 | </ul>
299 | <h3>Class variables</h3>
300 | <dl>
301 | <dt id="AggiEngine.mainwindow.MainWindow.staticMetaObject"><code class="name">var <span class="ident">staticMetaObject</span></code></dt>
302 | <dd>
303 | <div class="desc"></div>
304 | </dd>
305 | </dl>
306 | <h3>Methods</h3>
307 | <dl>
308 | <dt id="AggiEngine.mainwindow.MainWindow.closeEvent"><code class="name flex">
309 | <span>def <span class="ident">closeEvent</span></span>(<span>self, event: PySide2.QtGui.QCloseEvent) ‑> NoneType</span>
310 | </code></dt>
311 | <dd>
312 | <div class="desc"><p>Called when the window is closed</p></div>
313 | <details class="source">
314 | <summary>
315 | <span>Expand source code</span>
316 | </summary>
317 | <pre><code class="python">def closeEvent(self, event: PySide2.QtGui.QCloseEvent) -&gt; None:
318 |     &#39;&#39;&#39;
319 |     Called when the window is closed
320 |     &#39;&#39;&#39;
321 |     print(&#34;Window closed.&#34;)
322 |     self.updateFPSTimer.stop()
323 |     self.stateManager.exit()</code></pre>
324 | </details>
325 | </dd>
326 | <dt id="AggiEngine.mainwindow.MainWindow.keyPressEvent"><code class="name flex">
327 | <span>def <span class="ident">keyPressEvent</span></span>(<span>self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType</span>
328 | </code></dt>
329 | <dd>
330 | <div class="desc"><p>Triggered when a key is pressed and passes down the event.</p></div>
331 | <details class="source">
332 | <summary>
333 | <span>Expand source code</span>
334 | </summary>
335 | <pre><code class="python">def keyPressEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
336 |     &#39;&#39;&#39;
337 |     Triggered when a key is pressed and passes down the event.
338 |     &#39;&#39;&#39;
339 |     self.stateManager.keyPressed(event)</code></pre>
340 | </details>
341 | </dd>
342 | <dt id="AggiEngine.mainwindow.MainWindow.keyReleaseEvent"><code class="name flex">
343 | <span>def <span class="ident">keyReleaseEvent</span></span>(<span>self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType</span>
344 | </code></dt>
345 | <dd>
346 | <div class="desc"><p>Triggered when a key is released and passes down the event.</p></div>
347 | <details class="source">
348 | <summary>
349 | <span>Expand source code</span>
350 | </summary>
351 | <pre><code class="python">def keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
352 |     &#39;&#39;&#39;
353 |     Triggered when a key is released and passes down the event.
354 |     &#39;&#39;&#39;
355 |     self.stateManager.keyReleased(event)</code></pre>
356 | </details>
357 | </dd>
358 | <dt id="AggiEngine.mainwindow.MainWindow.mouseMoveEvent"><code class="name flex">
359 | <span>def <span class="ident">mouseMoveEvent</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
360 | </code></dt>
361 | <dd>
362 | <div class="desc"><p>Triggered when the mouse is moved and passes down the event.</p></div>
363 | <details class="source">
364 | <summary>
365 | <span>Expand source code</span>
366 | </summary>
367 | <pre><code class="python">def mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
368 |     &#39;&#39;&#39;
369 |     Triggered when the mouse is moved and passes down the event.
370 |     &#39;&#39;&#39;
371 |     self.stateManager.mouseMoved(event)</code></pre>
372 | </details>
373 | </dd>
374 | <dt id="AggiEngine.mainwindow.MainWindow.mousePressEvent"><code class="name flex">
375 | <span>def <span class="ident">mousePressEvent</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
376 | </code></dt>
377 | <dd>
378 | <div class="desc"><p>Triggered when a mouse key is pressed and passes down the event.</p></div>
379 | <details class="source">
380 | <summary>
381 | <span>Expand source code</span>
382 | </summary>
383 | <pre><code class="python">def mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
384 |     &#39;&#39;&#39;
385 |     Triggered when a mouse key is pressed and passes down the event.
386 |     &#39;&#39;&#39;
387 |     self.stateManager.mousePressed(event)</code></pre>
388 | </details>
389 | </dd>
390 | <dt id="AggiEngine.mainwindow.MainWindow.mouseReleaseEvent"><code class="name flex">
391 | <span>def <span class="ident">mouseReleaseEvent</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
392 | </code></dt>
393 | <dd>
394 | <div class="desc"><p>Triggered when a mouse key is released and passes down the event.</p></div>
395 | <details class="source">
396 | <summary>
397 | <span>Expand source code</span>
398 | </summary>
399 | <pre><code class="python">def mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
400 |     &#39;&#39;&#39;
401 |     Triggered when a mouse key is released and passes down the event.
402 |     &#39;&#39;&#39;
403 |     self.stateManager.mouseReleased(event)</code></pre>
404 | </details>
405 | </dd>
406 | <dt id="AggiEngine.mainwindow.MainWindow.resizeEvent"><code class="name flex">
407 | <span>def <span class="ident">resizeEvent</span></span>(<span>self, event: PySide2.QtGui.QResizeEvent) ‑> NoneType</span>
408 | </code></dt>
409 | <dd>
410 | <div class="desc"><p>Triggered when the screen is resized and passes down the event.</p></div>
411 | <details class="source">
412 | <summary>
413 | <span>Expand source code</span>
414 | </summary>
415 | <pre><code class="python">def resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -&gt; None:
416 |     &#39;&#39;&#39;
417 |     Triggered when the screen is resized and passes down the event.
418 |     &#39;&#39;&#39;
419 |     if self.gameScreen:
420 |         self.gameScreen.setGeometry(0, 0, self.width(), self.height())</code></pre>
421 | </details>
422 | </dd>
423 | <dt id="AggiEngine.mainwindow.MainWindow.start"><code class="name flex">
424 | <span>def <span class="ident">start</span></span>(<span>self) ‑> NoneType</span>
425 | </code></dt>
426 | <dd>
427 | <div class="desc"><p>Called when application.run() is executed. Starts the actual engine.</p></div>
428 | <details class="source">
429 | <summary>
430 | <span>Expand source code</span>
431 | </summary>
432 | <pre><code class="python">def start(self) -&gt; None:
433 |     &#39;&#39;&#39;
434 |     Called when application.run() is executed. Starts the actual engine.
435 |     &#39;&#39;&#39;
436 |     self.stateManager.initializeState()  # start the state
437 |     self.updateFPSTimer.start(100)</code></pre>
438 | </details>
439 | </dd>
440 | <dt id="AggiEngine.mainwindow.MainWindow.waitForLoad"><code class="name flex">
441 | <span>def <span class="ident">waitForLoad</span></span>(<span>self) ‑> NoneType</span>
442 | </code></dt>
443 | <dd>
444 | <div class="desc"><p>Makes state manager wait until the current state finishes loading widgets.</p></div>
445 | <details class="source">
446 | <summary>
447 | <span>Expand source code</span>
448 | </summary>
449 | <pre><code class="python">def waitForLoad(self) -&gt; None:
450 |     &#39;&#39;&#39;
451 |     Makes state manager wait until the current state finishes loading widgets.
452 |     &#39;&#39;&#39;
453 |     QTimer(self).singleShot(0, self.stateManager.start)</code></pre>
454 | </details>
455 | </dd>
456 | </dl>
457 | </dd>
458 | </dl>
459 | </section>
460 | </article>
461 | <nav id="sidebar">
462 | <h1>Index</h1>
463 | <div class="toc">
464 | <ul></ul>
465 | </div>
466 | <ul id="index">
467 | <li><h3>Super-module</h3>
468 | <ul>
469 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
470 | </ul>
471 | </li>
472 | <li><h3><a href="#header-classes">Classes</a></h3>
473 | <ul>
474 | <li>
475 | <h4><code><a title="AggiEngine.mainwindow.MainWindow" href="#AggiEngine.mainwindow.MainWindow">MainWindow</a></code></h4>
476 | <ul class="two-column">
477 | <li><code><a title="AggiEngine.mainwindow.MainWindow.closeEvent" href="#AggiEngine.mainwindow.MainWindow.closeEvent">closeEvent</a></code></li>
478 | <li><code><a title="AggiEngine.mainwindow.MainWindow.keyPressEvent" href="#AggiEngine.mainwindow.MainWindow.keyPressEvent">keyPressEvent</a></code></li>
479 | <li><code><a title="AggiEngine.mainwindow.MainWindow.keyReleaseEvent" href="#AggiEngine.mainwindow.MainWindow.keyReleaseEvent">keyReleaseEvent</a></code></li>
480 | <li><code><a title="AggiEngine.mainwindow.MainWindow.mouseMoveEvent" href="#AggiEngine.mainwindow.MainWindow.mouseMoveEvent">mouseMoveEvent</a></code></li>
481 | <li><code><a title="AggiEngine.mainwindow.MainWindow.mousePressEvent" href="#AggiEngine.mainwindow.MainWindow.mousePressEvent">mousePressEvent</a></code></li>
482 | <li><code><a title="AggiEngine.mainwindow.MainWindow.mouseReleaseEvent" href="#AggiEngine.mainwindow.MainWindow.mouseReleaseEvent">mouseReleaseEvent</a></code></li>
483 | <li><code><a title="AggiEngine.mainwindow.MainWindow.resizeEvent" href="#AggiEngine.mainwindow.MainWindow.resizeEvent">resizeEvent</a></code></li>
484 | <li><code><a title="AggiEngine.mainwindow.MainWindow.start" href="#AggiEngine.mainwindow.MainWindow.start">start</a></code></li>
485 | <li><code><a title="AggiEngine.mainwindow.MainWindow.staticMetaObject" href="#AggiEngine.mainwindow.MainWindow.staticMetaObject">staticMetaObject</a></code></li>
486 | <li><code><a title="AggiEngine.mainwindow.MainWindow.waitForLoad" href="#AggiEngine.mainwindow.MainWindow.waitForLoad">waitForLoad</a></code></li>
487 | </ul>
488 | </li>
489 | </ul>
490 | </li>
491 | </ul>
492 | </nav>
493 | </main>
494 | <footer id="footer">
495 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
496 | </footer>
497 | </body>
498 | </html>


--------------------------------------------------------------------------------
/docs/particles.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.particles API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.particles</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from typing import Optional
 30 | 
 31 | import numpy as np
 32 | 
 33 | from AggiEngine import GameScreen
 34 | 
 35 | 
 36 | class Particles:
 37 | 
 38 |     def __init__(self, gameScreen: GameScreen, startColor: Optional[list] = None,
 39 |                  endColor: Optional[list] = None, shape: Optional[list] = None, rate=0.5,
 40 |                  count=100, endSize=0.01, sizeDecrease=0.95, colorFade=0.05):
 41 |         if not endColor:
 42 |             self.endColor = [1, 1, 1, 1]
 43 |         else:
 44 |             self.endColor = endColor
 45 | 
 46 |         if not startColor:
 47 |             self.startColor = [1, 1, 1, 1]
 48 |         else:
 49 |             self.startColor = startColor
 50 | 
 51 |         if not shape:
 52 |             self.shape = [[0, 0], [0.05, 0], [0.05, -0.05], [0, -0.05]]
 53 |         else:
 54 |             self.shape = shape
 55 | 
 56 |         self.gameScreen = gameScreen
 57 |         self.particles = []
 58 |         self.rate = rate
 59 |         self.count = count
 60 |         self.endSize = endSize
 61 |         self.sizeDecrease = sizeDecrease
 62 |         self.colorFade = colorFade
 63 |         self.time = 0
 64 | 
 65 |     def update(self) -&gt; None:
 66 |         &#39;&#39;&#39;
 67 |         Updates the particles, color, size and  deletes old particles.
 68 |         &#39;&#39;&#39;
 69 |         toRemove = []
 70 |         for particle in self.particles:
 71 |             if abs(particle[1][0][0] - particle[1][1][0]) &lt; self.endSize:
 72 |                 toRemove.append(particle)
 73 | 
 74 |             shape = []
 75 |             for vert in particle[1]:
 76 |                 shape.append([vert[0] * self.sizeDecrease, vert[1] * self.sizeDecrease])
 77 |             particle[1] = shape
 78 |             particle[2] = self.getColor(particle[-1])
 79 |             particle[-1] -= self.colorFade
 80 |             self.gameScreen.renderInfoList.append(particle)
 81 | 
 82 |         for particle in toRemove:
 83 |             self.particles.remove(particle)
 84 | 
 85 |         self.time += self.rate
 86 | 
 87 |     def emit(self, position: list) -&gt; None:
 88 |         &#39;&#39;&#39;
 89 |         Appends are new particle to the particle list.
 90 |         &#39;&#39;&#39;
 91 |         
 92 |         if self.time &gt; 1:
 93 |             if len(self.particles) &lt; self.count:
 94 |                 self.particles.append([-1, self.shape, self.getColor(0), position, 0, 0])
 95 |             self.time = 0
 96 | 
 97 |     def getColor(self, amount: float) -&gt; list:
 98 |         &#39;&#39;&#39;
 99 |         Interpolates the start and end color values and returns the value.
100 |         &#39;&#39;&#39;
101 |         
102 |         r = abs(self.startColor[0] - self.endColor[0]) * amount + self.startColor[0]
103 |         g = abs(self.startColor[1] - self.endColor[1]) * amount + self.startColor[1]
104 |         b = abs(self.startColor[2] - self.endColor[2]) * amount + self.startColor[2]
105 |         a = abs(self.startColor[3] - self.endColor[3]) * amount + self.startColor[3]
106 |         
107 |         return [max(r, self.endColor[0]), max(g, self.endColor[1]), max(b, self.endColor[2]), max(a, self.endColor[3])]</code></pre>
108 | </details>
109 | </section>
110 | <section>
111 | </section>
112 | <section>
113 | </section>
114 | <section>
115 | </section>
116 | <section>
117 | <h2 class="section-title" id="header-classes">Classes</h2>
118 | <dl>
119 | <dt id="AggiEngine.particles.Particles"><code class="flex name class">
120 | <span>class <span class="ident">Particles</span></span>
121 | <span>(</span><span>gameScreen: <a title="AggiEngine.gamescreen.GameScreen" href="gamescreen.html#AggiEngine.gamescreen.GameScreen">GameScreen</a>, startColor: typing.Union[list, NoneType] = None, endColor: typing.Union[list, NoneType] = None, shape: typing.Union[list, NoneType] = None, rate=0.5, count=100, endSize=0.01, sizeDecrease=0.95, colorFade=0.05)</span>
122 | </code></dt>
123 | <dd>
124 | <div class="desc"></div>
125 | <details class="source">
126 | <summary>
127 | <span>Expand source code</span>
128 | </summary>
129 | <pre><code class="python">class Particles:
130 | 
131 |     def __init__(self, gameScreen: GameScreen, startColor: Optional[list] = None,
132 |                  endColor: Optional[list] = None, shape: Optional[list] = None, rate=0.5,
133 |                  count=100, endSize=0.01, sizeDecrease=0.95, colorFade=0.05):
134 |         if not endColor:
135 |             self.endColor = [1, 1, 1, 1]
136 |         else:
137 |             self.endColor = endColor
138 | 
139 |         if not startColor:
140 |             self.startColor = [1, 1, 1, 1]
141 |         else:
142 |             self.startColor = startColor
143 | 
144 |         if not shape:
145 |             self.shape = [[0, 0], [0.05, 0], [0.05, -0.05], [0, -0.05]]
146 |         else:
147 |             self.shape = shape
148 | 
149 |         self.gameScreen = gameScreen
150 |         self.particles = []
151 |         self.rate = rate
152 |         self.count = count
153 |         self.endSize = endSize
154 |         self.sizeDecrease = sizeDecrease
155 |         self.colorFade = colorFade
156 |         self.time = 0
157 | 
158 |     def update(self) -&gt; None:
159 |         &#39;&#39;&#39;
160 |         Updates the particles, color, size and  deletes old particles.
161 |         &#39;&#39;&#39;
162 |         toRemove = []
163 |         for particle in self.particles:
164 |             if abs(particle[1][0][0] - particle[1][1][0]) &lt; self.endSize:
165 |                 toRemove.append(particle)
166 | 
167 |             shape = []
168 |             for vert in particle[1]:
169 |                 shape.append([vert[0] * self.sizeDecrease, vert[1] * self.sizeDecrease])
170 |             particle[1] = shape
171 |             particle[2] = self.getColor(particle[-1])
172 |             particle[-1] -= self.colorFade
173 |             self.gameScreen.renderInfoList.append(particle)
174 | 
175 |         for particle in toRemove:
176 |             self.particles.remove(particle)
177 | 
178 |         self.time += self.rate
179 | 
180 |     def emit(self, position: list) -&gt; None:
181 |         &#39;&#39;&#39;
182 |         Appends are new particle to the particle list.
183 |         &#39;&#39;&#39;
184 |         
185 |         if self.time &gt; 1:
186 |             if len(self.particles) &lt; self.count:
187 |                 self.particles.append([-1, self.shape, self.getColor(0), position, 0, 0])
188 |             self.time = 0
189 | 
190 |     def getColor(self, amount: float) -&gt; list:
191 |         &#39;&#39;&#39;
192 |         Interpolates the start and end color values and returns the value.
193 |         &#39;&#39;&#39;
194 |         
195 |         r = abs(self.startColor[0] - self.endColor[0]) * amount + self.startColor[0]
196 |         g = abs(self.startColor[1] - self.endColor[1]) * amount + self.startColor[1]
197 |         b = abs(self.startColor[2] - self.endColor[2]) * amount + self.startColor[2]
198 |         a = abs(self.startColor[3] - self.endColor[3]) * amount + self.startColor[3]
199 |         
200 |         return [max(r, self.endColor[0]), max(g, self.endColor[1]), max(b, self.endColor[2]), max(a, self.endColor[3])]</code></pre>
201 | </details>
202 | <h3>Methods</h3>
203 | <dl>
204 | <dt id="AggiEngine.particles.Particles.emit"><code class="name flex">
205 | <span>def <span class="ident">emit</span></span>(<span>self, position: list) ‑> NoneType</span>
206 | </code></dt>
207 | <dd>
208 | <div class="desc"><p>Appends are new particle to the particle list.</p></div>
209 | <details class="source">
210 | <summary>
211 | <span>Expand source code</span>
212 | </summary>
213 | <pre><code class="python">def emit(self, position: list) -&gt; None:
214 |     &#39;&#39;&#39;
215 |     Appends are new particle to the particle list.
216 |     &#39;&#39;&#39;
217 |     
218 |     if self.time &gt; 1:
219 |         if len(self.particles) &lt; self.count:
220 |             self.particles.append([-1, self.shape, self.getColor(0), position, 0, 0])
221 |         self.time = 0</code></pre>
222 | </details>
223 | </dd>
224 | <dt id="AggiEngine.particles.Particles.getColor"><code class="name flex">
225 | <span>def <span class="ident">getColor</span></span>(<span>self, amount: float) ‑> list</span>
226 | </code></dt>
227 | <dd>
228 | <div class="desc"><p>Interpolates the start and end color values and returns the value.</p></div>
229 | <details class="source">
230 | <summary>
231 | <span>Expand source code</span>
232 | </summary>
233 | <pre><code class="python">def getColor(self, amount: float) -&gt; list:
234 |     &#39;&#39;&#39;
235 |     Interpolates the start and end color values and returns the value.
236 |     &#39;&#39;&#39;
237 |     
238 |     r = abs(self.startColor[0] - self.endColor[0]) * amount + self.startColor[0]
239 |     g = abs(self.startColor[1] - self.endColor[1]) * amount + self.startColor[1]
240 |     b = abs(self.startColor[2] - self.endColor[2]) * amount + self.startColor[2]
241 |     a = abs(self.startColor[3] - self.endColor[3]) * amount + self.startColor[3]
242 |     
243 |     return [max(r, self.endColor[0]), max(g, self.endColor[1]), max(b, self.endColor[2]), max(a, self.endColor[3])]</code></pre>
244 | </details>
245 | </dd>
246 | <dt id="AggiEngine.particles.Particles.update"><code class="name flex">
247 | <span>def <span class="ident">update</span></span>(<span>self) ‑> NoneType</span>
248 | </code></dt>
249 | <dd>
250 | <div class="desc"><p>Updates the particles, color, size and
251 | deletes old particles.</p></div>
252 | <details class="source">
253 | <summary>
254 | <span>Expand source code</span>
255 | </summary>
256 | <pre><code class="python">def update(self) -&gt; None:
257 |     &#39;&#39;&#39;
258 |     Updates the particles, color, size and  deletes old particles.
259 |     &#39;&#39;&#39;
260 |     toRemove = []
261 |     for particle in self.particles:
262 |         if abs(particle[1][0][0] - particle[1][1][0]) &lt; self.endSize:
263 |             toRemove.append(particle)
264 | 
265 |         shape = []
266 |         for vert in particle[1]:
267 |             shape.append([vert[0] * self.sizeDecrease, vert[1] * self.sizeDecrease])
268 |         particle[1] = shape
269 |         particle[2] = self.getColor(particle[-1])
270 |         particle[-1] -= self.colorFade
271 |         self.gameScreen.renderInfoList.append(particle)
272 | 
273 |     for particle in toRemove:
274 |         self.particles.remove(particle)
275 | 
276 |     self.time += self.rate</code></pre>
277 | </details>
278 | </dd>
279 | </dl>
280 | </dd>
281 | </dl>
282 | </section>
283 | </article>
284 | <nav id="sidebar">
285 | <h1>Index</h1>
286 | <div class="toc">
287 | <ul></ul>
288 | </div>
289 | <ul id="index">
290 | <li><h3>Super-module</h3>
291 | <ul>
292 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
293 | </ul>
294 | </li>
295 | <li><h3><a href="#header-classes">Classes</a></h3>
296 | <ul>
297 | <li>
298 | <h4><code><a title="AggiEngine.particles.Particles" href="#AggiEngine.particles.Particles">Particles</a></code></h4>
299 | <ul class="">
300 | <li><code><a title="AggiEngine.particles.Particles.emit" href="#AggiEngine.particles.Particles.emit">emit</a></code></li>
301 | <li><code><a title="AggiEngine.particles.Particles.getColor" href="#AggiEngine.particles.Particles.getColor">getColor</a></code></li>
302 | <li><code><a title="AggiEngine.particles.Particles.update" href="#AggiEngine.particles.Particles.update">update</a></code></li>
303 | </ul>
304 | </li>
305 | </ul>
306 | </li>
307 | </ul>
308 | </nav>
309 | </main>
310 | <footer id="footer">
311 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
312 | </footer>
313 | </body>
314 | </html>


--------------------------------------------------------------------------------
/docs/sound.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.sound API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.sound</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">import simpleaudio as sa
 30 | from typing import Any
 31 | 
 32 | 
 33 | class Sound:
 34 | 
 35 |     def __init__(self) -&gt; None:
 36 |         self.sounds = dict()
 37 |     
 38 |     def load(self, key: Any, filestr: str) -&gt; None:
 39 |         &#34;&#34;&#34;
 40 |         loads a wav file for future playback  
 41 |         ``key:`` A key you will use to access the audio playback  
 42 |         ``filestr:`` The file path for a wav file to play  
 43 |         &#34;&#34;&#34;
 44 |         self.sounds[key] = sa.WaveObject.from_wave_file(filestr)
 45 |     
 46 |     def play(self, key: Any) -&gt; sa.PlayObject:
 47 |         &#34;&#34;&#34;
 48 |         Plays your sound
 49 |         ``key:`` The key used when loading the sound  
 50 |         &#34;&#34;&#34;
 51 |         return self.sounds[key].play()
 52 |     
 53 |     def stop_all(self) -&gt; None:
 54 |         &#34;&#34;&#34;
 55 |         Stops all sounds from playing
 56 |         &#34;&#34;&#34;
 57 |         sa.stop_all()</code></pre>
 58 | </details>
 59 | </section>
 60 | <section>
 61 | </section>
 62 | <section>
 63 | </section>
 64 | <section>
 65 | </section>
 66 | <section>
 67 | <h2 class="section-title" id="header-classes">Classes</h2>
 68 | <dl>
 69 | <dt id="AggiEngine.sound.Sound"><code class="flex name class">
 70 | <span>class <span class="ident">Sound</span></span>
 71 | </code></dt>
 72 | <dd>
 73 | <div class="desc"></div>
 74 | <details class="source">
 75 | <summary>
 76 | <span>Expand source code</span>
 77 | </summary>
 78 | <pre><code class="python">class Sound:
 79 | 
 80 |     def __init__(self) -&gt; None:
 81 |         self.sounds = dict()
 82 |     
 83 |     def load(self, key: Any, filestr: str) -&gt; None:
 84 |         &#34;&#34;&#34;
 85 |         loads a wav file for future playback  
 86 |         ``key:`` A key you will use to access the audio playback  
 87 |         ``filestr:`` The file path for a wav file to play  
 88 |         &#34;&#34;&#34;
 89 |         self.sounds[key] = sa.WaveObject.from_wave_file(filestr)
 90 |     
 91 |     def play(self, key: Any) -&gt; sa.PlayObject:
 92 |         &#34;&#34;&#34;
 93 |         Plays your sound
 94 |         ``key:`` The key used when loading the sound  
 95 |         &#34;&#34;&#34;
 96 |         return self.sounds[key].play()
 97 |     
 98 |     def stop_all(self) -&gt; None:
 99 |         &#34;&#34;&#34;
100 |         Stops all sounds from playing
101 |         &#34;&#34;&#34;
102 |         sa.stop_all()</code></pre>
103 | </details>
104 | <h3>Methods</h3>
105 | <dl>
106 | <dt id="AggiEngine.sound.Sound.load"><code class="name flex">
107 | <span>def <span class="ident">load</span></span>(<span>self, key: typing.Any, filestr: str) ‑> NoneType</span>
108 | </code></dt>
109 | <dd>
110 | <div class="desc"><p>loads a wav file for future playback<br>
111 | <code>key:</code> A key you will use to access the audio playback<br>
112 | <code>filestr:</code> The file path for a wav file to play</p></div>
113 | <details class="source">
114 | <summary>
115 | <span>Expand source code</span>
116 | </summary>
117 | <pre><code class="python">def load(self, key: Any, filestr: str) -&gt; None:
118 |     &#34;&#34;&#34;
119 |     loads a wav file for future playback  
120 |     ``key:`` A key you will use to access the audio playback  
121 |     ``filestr:`` The file path for a wav file to play  
122 |     &#34;&#34;&#34;
123 |     self.sounds[key] = sa.WaveObject.from_wave_file(filestr)</code></pre>
124 | </details>
125 | </dd>
126 | <dt id="AggiEngine.sound.Sound.play"><code class="name flex">
127 | <span>def <span class="ident">play</span></span>(<span>self, key: typing.Any) ‑> simpleaudio.shiny.PlayObject</span>
128 | </code></dt>
129 | <dd>
130 | <div class="desc"><p>Plays your sound
131 | <code>key:</code> The key used when loading the sound</p></div>
132 | <details class="source">
133 | <summary>
134 | <span>Expand source code</span>
135 | </summary>
136 | <pre><code class="python">def play(self, key: Any) -&gt; sa.PlayObject:
137 |     &#34;&#34;&#34;
138 |     Plays your sound
139 |     ``key:`` The key used when loading the sound  
140 |     &#34;&#34;&#34;
141 |     return self.sounds[key].play()</code></pre>
142 | </details>
143 | </dd>
144 | <dt id="AggiEngine.sound.Sound.stop_all"><code class="name flex">
145 | <span>def <span class="ident">stop_all</span></span>(<span>self) ‑> NoneType</span>
146 | </code></dt>
147 | <dd>
148 | <div class="desc"><p>Stops all sounds from playing</p></div>
149 | <details class="source">
150 | <summary>
151 | <span>Expand source code</span>
152 | </summary>
153 | <pre><code class="python">def stop_all(self) -&gt; None:
154 |     &#34;&#34;&#34;
155 |     Stops all sounds from playing
156 |     &#34;&#34;&#34;
157 |     sa.stop_all()</code></pre>
158 | </details>
159 | </dd>
160 | </dl>
161 | </dd>
162 | </dl>
163 | </section>
164 | </article>
165 | <nav id="sidebar">
166 | <h1>Index</h1>
167 | <div class="toc">
168 | <ul></ul>
169 | </div>
170 | <ul id="index">
171 | <li><h3>Super-module</h3>
172 | <ul>
173 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
174 | </ul>
175 | </li>
176 | <li><h3><a href="#header-classes">Classes</a></h3>
177 | <ul>
178 | <li>
179 | <h4><code><a title="AggiEngine.sound.Sound" href="#AggiEngine.sound.Sound">Sound</a></code></h4>
180 | <ul class="">
181 | <li><code><a title="AggiEngine.sound.Sound.load" href="#AggiEngine.sound.Sound.load">load</a></code></li>
182 | <li><code><a title="AggiEngine.sound.Sound.play" href="#AggiEngine.sound.Sound.play">play</a></code></li>
183 | <li><code><a title="AggiEngine.sound.Sound.stop_all" href="#AggiEngine.sound.Sound.stop_all">stop_all</a></code></li>
184 | </ul>
185 | </li>
186 | </ul>
187 | </li>
188 | </ul>
189 | </nav>
190 | </main>
191 | <footer id="footer">
192 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
193 | </footer>
194 | </body>
195 | </html>


--------------------------------------------------------------------------------
/docs/state.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.state API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.state</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from typing import Optional
 30 | 
 31 | import PySide2
 32 | from .gameobjecthandler import GameObjectHandler
 33 | from .tileloader import TileMap
 34 | 
 35 | 
 36 | class State:
 37 | 
 38 |     def __init__(self, ui_path: Optional[str] = None, window: Optional[object] = None):
 39 |         &#39;&#39;&#39;
 40 |         Initialized class variables.
 41 |         ``ui_path:`` The path to the .ui file for the State to display
 42 |         ``window:`` The main window class for the whole application
 43 |         &#39;&#39;&#39;
 44 |         self.ui_path = ui_path
 45 |         self.window = window
 46 |         self.gameObjectHandler = None
 47 |         self.active = True
 48 | 
 49 |     def loadMap(self, filePath: str) -&gt; None:
 50 |         &#39;&#39;&#39;
 51 |         Loads the TMX file and creates the contained game objects
 52 |         ``filePath:`` The path to the .tmx file to load game objects
 53 |         &#39;&#39;&#39;
 54 |         TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)
 55 | 
 56 |     def loadUi(self) -&gt; None:
 57 |         &#39;&#39;&#39;
 58 |         Loads the widgets in the .ui file
 59 |         &#39;&#39;&#39;
 60 |         if self.ui_path is not None:
 61 |             self.window.uiManager.loadWidgets(self.ui_path, True)
 62 | 
 63 |     def startGOH(self) -&gt; None:
 64 |         &#39;&#39;&#39;
 65 |         Starts the game object handler
 66 |         &#39;&#39;&#39;
 67 |         self.gameObjectHandler = GameObjectHandler(self.window)
 68 | 
 69 |     def updateGOH(self) -&gt; None:
 70 |         &#39;&#39;&#39;
 71 |         Updates the game object handler after a screen draw
 72 |         &#39;&#39;&#39;
 73 |         self.gameObjectHandler.update()
 74 | 
 75 |     def fixedUpdateGOH(self) -&gt; None:
 76 |         &#39;&#39;&#39;
 77 |         Updates the game object handler after a physics update
 78 |         &#39;&#39;&#39;
 79 |         self.gameObjectHandler.fixedUpdate()
 80 | 
 81 |     def exitGOH(self) -&gt; None:
 82 |         &#39;&#39;&#39;
 83 |         Stops the game object handler
 84 |         &#39;&#39;&#39;
 85 |         self.gameObjectHandler.exit()
 86 | 
 87 |     def start(self) -&gt; None:
 88 |         &#39;&#39;&#39;
 89 |         Triggered when the State is first activated
 90 |         &#39;&#39;&#39;
 91 |         pass
 92 | 
 93 |     def update(self) -&gt; None:
 94 |         &#39;&#39;&#39;
 95 |         Triggered after a screen draw
 96 |         &#39;&#39;&#39;
 97 |         pass
 98 | 
 99 |     def fixedUpdate(self) -&gt; None:
100 |         &#39;&#39;&#39;
101 |         Triggered after a physics update
102 |         &#39;&#39;&#39;
103 |         pass
104 | 
105 |     def exit(self) -&gt; None:
106 |         &#39;&#39;&#39;
107 |         Triggered when the State stops
108 |         &#39;&#39;&#39;
109 |         pass
110 | 
111 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
112 |         &#39;&#39;&#39;
113 |         Triggered when a key is pressed down
114 |         ``event:`` The key event contains the key(s) pressed
115 |         &#39;&#39;&#39;
116 |         pass
117 | 
118 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
119 |         &#39;&#39;&#39;
120 |         Triggered when a key is released
121 |         ``event:`` The key event contains the key(s) released
122 |         &#39;&#39;&#39;
123 |         pass
124 | 
125 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
126 |         &#39;&#39;&#39;
127 |         Triggered when the mouse is moved
128 |         ``event:`` The mouse event contains the new mouse positions
129 |         &#39;&#39;&#39;
130 |         pass
131 | 
132 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
133 |         &#39;&#39;&#39;
134 |         Triggered when mouse buttons are pressed
135 |         ``event:`` The mouse event contains the mouse buttons pressed
136 |         &#39;&#39;&#39;
137 |         pass
138 | 
139 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
140 |         &#39;&#39;&#39;
141 |         Triggered when mouse buttons are released
142 |         ``event:`` The mouse event contains the mouse buttons released
143 |         &#39;&#39;&#39;
144 |         pass</code></pre>
145 | </details>
146 | </section>
147 | <section>
148 | </section>
149 | <section>
150 | </section>
151 | <section>
152 | </section>
153 | <section>
154 | <h2 class="section-title" id="header-classes">Classes</h2>
155 | <dl>
156 | <dt id="AggiEngine.state.State"><code class="flex name class">
157 | <span>class <span class="ident">State</span></span>
158 | <span>(</span><span>ui_path: typing.Union[str, NoneType] = None, window: typing.Union[object, NoneType] = None)</span>
159 | </code></dt>
160 | <dd>
161 | <div class="desc"><p>Initialized class variables.
162 | <code>ui_path:</code> The path to the .ui file for the State to display
163 | <code>window:</code> The main window class for the whole application</p></div>
164 | <details class="source">
165 | <summary>
166 | <span>Expand source code</span>
167 | </summary>
168 | <pre><code class="python">class State:
169 | 
170 |     def __init__(self, ui_path: Optional[str] = None, window: Optional[object] = None):
171 |         &#39;&#39;&#39;
172 |         Initialized class variables.
173 |         ``ui_path:`` The path to the .ui file for the State to display
174 |         ``window:`` The main window class for the whole application
175 |         &#39;&#39;&#39;
176 |         self.ui_path = ui_path
177 |         self.window = window
178 |         self.gameObjectHandler = None
179 |         self.active = True
180 | 
181 |     def loadMap(self, filePath: str) -&gt; None:
182 |         &#39;&#39;&#39;
183 |         Loads the TMX file and creates the contained game objects
184 |         ``filePath:`` The path to the .tmx file to load game objects
185 |         &#39;&#39;&#39;
186 |         TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)
187 | 
188 |     def loadUi(self) -&gt; None:
189 |         &#39;&#39;&#39;
190 |         Loads the widgets in the .ui file
191 |         &#39;&#39;&#39;
192 |         if self.ui_path is not None:
193 |             self.window.uiManager.loadWidgets(self.ui_path, True)
194 | 
195 |     def startGOH(self) -&gt; None:
196 |         &#39;&#39;&#39;
197 |         Starts the game object handler
198 |         &#39;&#39;&#39;
199 |         self.gameObjectHandler = GameObjectHandler(self.window)
200 | 
201 |     def updateGOH(self) -&gt; None:
202 |         &#39;&#39;&#39;
203 |         Updates the game object handler after a screen draw
204 |         &#39;&#39;&#39;
205 |         self.gameObjectHandler.update()
206 | 
207 |     def fixedUpdateGOH(self) -&gt; None:
208 |         &#39;&#39;&#39;
209 |         Updates the game object handler after a physics update
210 |         &#39;&#39;&#39;
211 |         self.gameObjectHandler.fixedUpdate()
212 | 
213 |     def exitGOH(self) -&gt; None:
214 |         &#39;&#39;&#39;
215 |         Stops the game object handler
216 |         &#39;&#39;&#39;
217 |         self.gameObjectHandler.exit()
218 | 
219 |     def start(self) -&gt; None:
220 |         &#39;&#39;&#39;
221 |         Triggered when the State is first activated
222 |         &#39;&#39;&#39;
223 |         pass
224 | 
225 |     def update(self) -&gt; None:
226 |         &#39;&#39;&#39;
227 |         Triggered after a screen draw
228 |         &#39;&#39;&#39;
229 |         pass
230 | 
231 |     def fixedUpdate(self) -&gt; None:
232 |         &#39;&#39;&#39;
233 |         Triggered after a physics update
234 |         &#39;&#39;&#39;
235 |         pass
236 | 
237 |     def exit(self) -&gt; None:
238 |         &#39;&#39;&#39;
239 |         Triggered when the State stops
240 |         &#39;&#39;&#39;
241 |         pass
242 | 
243 |     def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
244 |         &#39;&#39;&#39;
245 |         Triggered when a key is pressed down
246 |         ``event:`` The key event contains the key(s) pressed
247 |         &#39;&#39;&#39;
248 |         pass
249 | 
250 |     def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
251 |         &#39;&#39;&#39;
252 |         Triggered when a key is released
253 |         ``event:`` The key event contains the key(s) released
254 |         &#39;&#39;&#39;
255 |         pass
256 | 
257 |     def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
258 |         &#39;&#39;&#39;
259 |         Triggered when the mouse is moved
260 |         ``event:`` The mouse event contains the new mouse positions
261 |         &#39;&#39;&#39;
262 |         pass
263 | 
264 |     def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
265 |         &#39;&#39;&#39;
266 |         Triggered when mouse buttons are pressed
267 |         ``event:`` The mouse event contains the mouse buttons pressed
268 |         &#39;&#39;&#39;
269 |         pass
270 | 
271 |     def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
272 |         &#39;&#39;&#39;
273 |         Triggered when mouse buttons are released
274 |         ``event:`` The mouse event contains the mouse buttons released
275 |         &#39;&#39;&#39;
276 |         pass</code></pre>
277 | </details>
278 | <h3>Methods</h3>
279 | <dl>
280 | <dt id="AggiEngine.state.State.exit"><code class="name flex">
281 | <span>def <span class="ident">exit</span></span>(<span>self) ‑> NoneType</span>
282 | </code></dt>
283 | <dd>
284 | <div class="desc"><p>Triggered when the State stops</p></div>
285 | <details class="source">
286 | <summary>
287 | <span>Expand source code</span>
288 | </summary>
289 | <pre><code class="python">def exit(self) -&gt; None:
290 |     &#39;&#39;&#39;
291 |     Triggered when the State stops
292 |     &#39;&#39;&#39;
293 |     pass</code></pre>
294 | </details>
295 | </dd>
296 | <dt id="AggiEngine.state.State.exitGOH"><code class="name flex">
297 | <span>def <span class="ident">exitGOH</span></span>(<span>self) ‑> NoneType</span>
298 | </code></dt>
299 | <dd>
300 | <div class="desc"><p>Stops the game object handler</p></div>
301 | <details class="source">
302 | <summary>
303 | <span>Expand source code</span>
304 | </summary>
305 | <pre><code class="python">def exitGOH(self) -&gt; None:
306 |     &#39;&#39;&#39;
307 |     Stops the game object handler
308 |     &#39;&#39;&#39;
309 |     self.gameObjectHandler.exit()</code></pre>
310 | </details>
311 | </dd>
312 | <dt id="AggiEngine.state.State.fixedUpdate"><code class="name flex">
313 | <span>def <span class="ident">fixedUpdate</span></span>(<span>self) ‑> NoneType</span>
314 | </code></dt>
315 | <dd>
316 | <div class="desc"><p>Triggered after a physics update</p></div>
317 | <details class="source">
318 | <summary>
319 | <span>Expand source code</span>
320 | </summary>
321 | <pre><code class="python">def fixedUpdate(self) -&gt; None:
322 |     &#39;&#39;&#39;
323 |     Triggered after a physics update
324 |     &#39;&#39;&#39;
325 |     pass</code></pre>
326 | </details>
327 | </dd>
328 | <dt id="AggiEngine.state.State.fixedUpdateGOH"><code class="name flex">
329 | <span>def <span class="ident">fixedUpdateGOH</span></span>(<span>self) ‑> NoneType</span>
330 | </code></dt>
331 | <dd>
332 | <div class="desc"><p>Updates the game object handler after a physics update</p></div>
333 | <details class="source">
334 | <summary>
335 | <span>Expand source code</span>
336 | </summary>
337 | <pre><code class="python">def fixedUpdateGOH(self) -&gt; None:
338 |     &#39;&#39;&#39;
339 |     Updates the game object handler after a physics update
340 |     &#39;&#39;&#39;
341 |     self.gameObjectHandler.fixedUpdate()</code></pre>
342 | </details>
343 | </dd>
344 | <dt id="AggiEngine.state.State.keyPressed"><code class="name flex">
345 | <span>def <span class="ident">keyPressed</span></span>(<span>self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType</span>
346 | </code></dt>
347 | <dd>
348 | <div class="desc"><p>Triggered when a key is pressed down
349 | <code>event:</code> The key event contains the key(s) pressed</p></div>
350 | <details class="source">
351 | <summary>
352 | <span>Expand source code</span>
353 | </summary>
354 | <pre><code class="python">def keyPressed(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
355 |     &#39;&#39;&#39;
356 |     Triggered when a key is pressed down
357 |     ``event:`` The key event contains the key(s) pressed
358 |     &#39;&#39;&#39;
359 |     pass</code></pre>
360 | </details>
361 | </dd>
362 | <dt id="AggiEngine.state.State.keyReleased"><code class="name flex">
363 | <span>def <span class="ident">keyReleased</span></span>(<span>self, event: PySide2.QtGui.QKeyEvent) ‑> NoneType</span>
364 | </code></dt>
365 | <dd>
366 | <div class="desc"><p>Triggered when a key is released
367 | <code>event:</code> The key event contains the key(s) released</p></div>
368 | <details class="source">
369 | <summary>
370 | <span>Expand source code</span>
371 | </summary>
372 | <pre><code class="python">def keyReleased(self, event: PySide2.QtGui.QKeyEvent) -&gt; None:
373 |     &#39;&#39;&#39;
374 |     Triggered when a key is released
375 |     ``event:`` The key event contains the key(s) released
376 |     &#39;&#39;&#39;
377 |     pass</code></pre>
378 | </details>
379 | </dd>
380 | <dt id="AggiEngine.state.State.loadMap"><code class="name flex">
381 | <span>def <span class="ident">loadMap</span></span>(<span>self, filePath: str) ‑> NoneType</span>
382 | </code></dt>
383 | <dd>
384 | <div class="desc"><p>Loads the TMX file and creates the contained game objects
385 | <code>filePath:</code> The path to the .tmx file to load game objects</p></div>
386 | <details class="source">
387 | <summary>
388 | <span>Expand source code</span>
389 | </summary>
390 | <pre><code class="python">def loadMap(self, filePath: str) -&gt; None:
391 |     &#39;&#39;&#39;
392 |     Loads the TMX file and creates the contained game objects
393 |     ``filePath:`` The path to the .tmx file to load game objects
394 |     &#39;&#39;&#39;
395 |     TileMap(filePath, self.gameObjectHandler, self.window.gameScreen)</code></pre>
396 | </details>
397 | </dd>
398 | <dt id="AggiEngine.state.State.loadUi"><code class="name flex">
399 | <span>def <span class="ident">loadUi</span></span>(<span>self) ‑> NoneType</span>
400 | </code></dt>
401 | <dd>
402 | <div class="desc"><p>Loads the widgets in the .ui file</p></div>
403 | <details class="source">
404 | <summary>
405 | <span>Expand source code</span>
406 | </summary>
407 | <pre><code class="python">def loadUi(self) -&gt; None:
408 |     &#39;&#39;&#39;
409 |     Loads the widgets in the .ui file
410 |     &#39;&#39;&#39;
411 |     if self.ui_path is not None:
412 |         self.window.uiManager.loadWidgets(self.ui_path, True)</code></pre>
413 | </details>
414 | </dd>
415 | <dt id="AggiEngine.state.State.mouseMoved"><code class="name flex">
416 | <span>def <span class="ident">mouseMoved</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
417 | </code></dt>
418 | <dd>
419 | <div class="desc"><p>Triggered when the mouse is moved
420 | <code>event:</code> The mouse event contains the new mouse positions</p></div>
421 | <details class="source">
422 | <summary>
423 | <span>Expand source code</span>
424 | </summary>
425 | <pre><code class="python">def mouseMoved(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
426 |     &#39;&#39;&#39;
427 |     Triggered when the mouse is moved
428 |     ``event:`` The mouse event contains the new mouse positions
429 |     &#39;&#39;&#39;
430 |     pass</code></pre>
431 | </details>
432 | </dd>
433 | <dt id="AggiEngine.state.State.mousePressed"><code class="name flex">
434 | <span>def <span class="ident">mousePressed</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
435 | </code></dt>
436 | <dd>
437 | <div class="desc"><p>Triggered when mouse buttons are pressed
438 | <code>event:</code> The mouse event contains the mouse buttons pressed</p></div>
439 | <details class="source">
440 | <summary>
441 | <span>Expand source code</span>
442 | </summary>
443 | <pre><code class="python">def mousePressed(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
444 |     &#39;&#39;&#39;
445 |     Triggered when mouse buttons are pressed
446 |     ``event:`` The mouse event contains the mouse buttons pressed
447 |     &#39;&#39;&#39;
448 |     pass</code></pre>
449 | </details>
450 | </dd>
451 | <dt id="AggiEngine.state.State.mouseReleased"><code class="name flex">
452 | <span>def <span class="ident">mouseReleased</span></span>(<span>self, event: PySide2.QtGui.QMouseEvent) ‑> NoneType</span>
453 | </code></dt>
454 | <dd>
455 | <div class="desc"><p>Triggered when mouse buttons are released
456 | <code>event:</code> The mouse event contains the mouse buttons released</p></div>
457 | <details class="source">
458 | <summary>
459 | <span>Expand source code</span>
460 | </summary>
461 | <pre><code class="python">def mouseReleased(self, event: PySide2.QtGui.QMouseEvent) -&gt; None:
462 |     &#39;&#39;&#39;
463 |     Triggered when mouse buttons are released
464 |     ``event:`` The mouse event contains the mouse buttons released
465 |     &#39;&#39;&#39;
466 |     pass</code></pre>
467 | </details>
468 | </dd>
469 | <dt id="AggiEngine.state.State.start"><code class="name flex">
470 | <span>def <span class="ident">start</span></span>(<span>self) ‑> NoneType</span>
471 | </code></dt>
472 | <dd>
473 | <div class="desc"><p>Triggered when the State is first activated</p></div>
474 | <details class="source">
475 | <summary>
476 | <span>Expand source code</span>
477 | </summary>
478 | <pre><code class="python">def start(self) -&gt; None:
479 |     &#39;&#39;&#39;
480 |     Triggered when the State is first activated
481 |     &#39;&#39;&#39;
482 |     pass</code></pre>
483 | </details>
484 | </dd>
485 | <dt id="AggiEngine.state.State.startGOH"><code class="name flex">
486 | <span>def <span class="ident">startGOH</span></span>(<span>self) ‑> NoneType</span>
487 | </code></dt>
488 | <dd>
489 | <div class="desc"><p>Starts the game object handler</p></div>
490 | <details class="source">
491 | <summary>
492 | <span>Expand source code</span>
493 | </summary>
494 | <pre><code class="python">def startGOH(self) -&gt; None:
495 |     &#39;&#39;&#39;
496 |     Starts the game object handler
497 |     &#39;&#39;&#39;
498 |     self.gameObjectHandler = GameObjectHandler(self.window)</code></pre>
499 | </details>
500 | </dd>
501 | <dt id="AggiEngine.state.State.update"><code class="name flex">
502 | <span>def <span class="ident">update</span></span>(<span>self) ‑> NoneType</span>
503 | </code></dt>
504 | <dd>
505 | <div class="desc"><p>Triggered after a screen draw</p></div>
506 | <details class="source">
507 | <summary>
508 | <span>Expand source code</span>
509 | </summary>
510 | <pre><code class="python">def update(self) -&gt; None:
511 |     &#39;&#39;&#39;
512 |     Triggered after a screen draw
513 |     &#39;&#39;&#39;
514 |     pass</code></pre>
515 | </details>
516 | </dd>
517 | <dt id="AggiEngine.state.State.updateGOH"><code class="name flex">
518 | <span>def <span class="ident">updateGOH</span></span>(<span>self) ‑> NoneType</span>
519 | </code></dt>
520 | <dd>
521 | <div class="desc"><p>Updates the game object handler after a screen draw</p></div>
522 | <details class="source">
523 | <summary>
524 | <span>Expand source code</span>
525 | </summary>
526 | <pre><code class="python">def updateGOH(self) -&gt; None:
527 |     &#39;&#39;&#39;
528 |     Updates the game object handler after a screen draw
529 |     &#39;&#39;&#39;
530 |     self.gameObjectHandler.update()</code></pre>
531 | </details>
532 | </dd>
533 | </dl>
534 | </dd>
535 | </dl>
536 | </section>
537 | </article>
538 | <nav id="sidebar">
539 | <h1>Index</h1>
540 | <div class="toc">
541 | <ul></ul>
542 | </div>
543 | <ul id="index">
544 | <li><h3>Super-module</h3>
545 | <ul>
546 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
547 | </ul>
548 | </li>
549 | <li><h3><a href="#header-classes">Classes</a></h3>
550 | <ul>
551 | <li>
552 | <h4><code><a title="AggiEngine.state.State" href="#AggiEngine.state.State">State</a></code></h4>
553 | <ul class="two-column">
554 | <li><code><a title="AggiEngine.state.State.exit" href="#AggiEngine.state.State.exit">exit</a></code></li>
555 | <li><code><a title="AggiEngine.state.State.exitGOH" href="#AggiEngine.state.State.exitGOH">exitGOH</a></code></li>
556 | <li><code><a title="AggiEngine.state.State.fixedUpdate" href="#AggiEngine.state.State.fixedUpdate">fixedUpdate</a></code></li>
557 | <li><code><a title="AggiEngine.state.State.fixedUpdateGOH" href="#AggiEngine.state.State.fixedUpdateGOH">fixedUpdateGOH</a></code></li>
558 | <li><code><a title="AggiEngine.state.State.keyPressed" href="#AggiEngine.state.State.keyPressed">keyPressed</a></code></li>
559 | <li><code><a title="AggiEngine.state.State.keyReleased" href="#AggiEngine.state.State.keyReleased">keyReleased</a></code></li>
560 | <li><code><a title="AggiEngine.state.State.loadMap" href="#AggiEngine.state.State.loadMap">loadMap</a></code></li>
561 | <li><code><a title="AggiEngine.state.State.loadUi" href="#AggiEngine.state.State.loadUi">loadUi</a></code></li>
562 | <li><code><a title="AggiEngine.state.State.mouseMoved" href="#AggiEngine.state.State.mouseMoved">mouseMoved</a></code></li>
563 | <li><code><a title="AggiEngine.state.State.mousePressed" href="#AggiEngine.state.State.mousePressed">mousePressed</a></code></li>
564 | <li><code><a title="AggiEngine.state.State.mouseReleased" href="#AggiEngine.state.State.mouseReleased">mouseReleased</a></code></li>
565 | <li><code><a title="AggiEngine.state.State.start" href="#AggiEngine.state.State.start">start</a></code></li>
566 | <li><code><a title="AggiEngine.state.State.startGOH" href="#AggiEngine.state.State.startGOH">startGOH</a></code></li>
567 | <li><code><a title="AggiEngine.state.State.update" href="#AggiEngine.state.State.update">update</a></code></li>
568 | <li><code><a title="AggiEngine.state.State.updateGOH" href="#AggiEngine.state.State.updateGOH">updateGOH</a></code></li>
569 | </ul>
570 | </li>
571 | </ul>
572 | </li>
573 | </ul>
574 | </nav>
575 | </main>
576 | <footer id="footer">
577 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
578 | </footer>
579 | </body>
580 | </html>


--------------------------------------------------------------------------------
/docs/tileloader.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.tileloader API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.tileloader</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">import pytmx
 30 | import Box2D
 31 | import importlib
 32 | from PIL import ImageColor
 33 | from .gameobject import GameObject
 34 | 
 35 | 
 36 | class TileMap:
 37 | 
 38 |     def __init__(self, tmxFile, gameObjectHandler, gameScreen):
 39 |         tiled_map = pytmx.TiledMap(tmxFile, image_loader=gameScreen.image_loader)
 40 |         if tiled_map.background_color:
 41 |             color = ImageColor.getcolor(tiled_map.background_color, &#39;RGB&#39;)
 42 |             gameScreen.bgColor = [color[0] / 255, color[1] / 255, color[2] / 255]
 43 | 
 44 |         hitboxes = {}
 45 |         objects = tiled_map.objects
 46 | 
 47 |         # Looks for objects and gets its vertices
 48 |         for obj in objects:
 49 |             pairPoints = []
 50 |             for pair in obj.points:
 51 |                 pairPoints.append(
 52 |                     (-(pair[0] - obj.x) / gameObjectHandler.scale, -(pair[1] - obj.y) / gameObjectHandler.scale))
 53 |             hitboxes[obj.name] = pairPoints
 54 | 
 55 |         for layer in tiled_map:
 56 |             # Checks for layers with tiles
 57 |             if isinstance(layer, pytmx.TiledTileLayer):
 58 |                 for x, y, image in layer.tiles():
 59 |                     # Gets class name and gets class name definition
 60 |                     className = layer.properties.get(&#39;class&#39;, &#39;GameObject&#39;)
 61 | 
 62 |                     if className != &#39;GameObject&#39;:
 63 |                         className = getattr(importlib.import_module(&#39;__main__&#39;), className)
 64 |                     else:
 65 |                         className = GameObject
 66 |                     # Sets up Texture
 67 |                     gm = className()
 68 |                     gm.textureID = image[0]
 69 | 
 70 |                     gm.setWidth(image[1] / gameObjectHandler.scale ** 2)
 71 |                     gm.setHeight(image[2] / gameObjectHandler.scale ** 2)
 72 | 
 73 |                     # Sets up Color
 74 |                     color = layer.properties.get(&#39;color&#39;, None)
 75 |                     if color:
 76 |                         color = ImageColor.getcolor(color, &#39;RGBA&#39;)
 77 |                         color = [color[2] / 255, color[1] / 255, color[0] / 255, color[3] / 255]
 78 |                         print(color)
 79 | 
 80 |                     # Sets up Hitbox
 81 |                     verticesName = layer.properties.get(&#39;hitboxName&#39;, None)
 82 | 
 83 |                     # Sets up Body Type
 84 |                     bodyType = layer.properties.get(&#39;bodyType&#39;, &#39;none&#39;)
 85 |                     if bodyType != &#39;none&#39;:
 86 |                         bodyDef = Box2D.b2BodyDef()
 87 |                         if bodyType == &#39;dynamic&#39;:
 88 |                             bodyDef.type = Box2D.b2_dynamicBody
 89 |                         elif bodyType == &#39;static&#39;:
 90 |                             bodyDef.type = Box2D.b2_staticBody
 91 |                         else:
 92 |                             bodyDef.type = Box2D.b2_kinematicBody
 93 |                         bodyDef.linearDamping = layer.properties.get(&#39;linearDamping&#39;, 0)
 94 |                         bodyDef.angularDamping = layer.properties.get(&#39;angularDamping&#39;, 0)
 95 |                         bodyDef.fixedRotation = layer.properties.get(&#39;fixedRotation&#39;, False)
 96 | 
 97 |                         # Linear Vel (Broken)
 98 |                         linearVel = layer.properties.get(&#39;linearVel&#39;, None)
 99 |                         if linearVel:
100 |                             linearVel = [float(x) for x in linearVel.split(&#39;,&#39;)]
101 |                             bodyDef.linearVelocity = (linearVel[0], linearVel[1])
102 | 
103 |                         # Sets up body Fixture
104 |                         if verticesName:
105 |                             bodyFixtureDef = Box2D.b2FixtureDef(
106 |                                 shape=Box2D.b2PolygonShape(vertices=hitboxes[verticesName]))
107 |                         else:
108 |                             bodyFixtureDef = Box2D.b2FixtureDef(shape=Box2D.b2PolygonShape(
109 |                                 box=((image[1] / gameObjectHandler.scale) / 2,
110 |                                      (image[2] / gameObjectHandler.scale) / 2)))
111 |                         bodyFixtureDef.density = layer.properties.get(&#39;density&#39;, 1)
112 |                         bodyFixtureDef.friction = layer.properties.get(&#39;friction&#39;, 0)
113 |                         bodyFixtureDef.restitution = layer.properties.get(&#39;restitution&#39;, 0)
114 |                         # Sets up Position
115 |                         bodyDef.position = (
116 |                             -(x * tiled_map.tilewidth) / gameObjectHandler.scale,
117 |                             -(y * tiled_map.tileheight) / gameObjectHandler.scale)
118 |                         # adds box
119 |                         if color:
120 |                             gm.textureID = -1
121 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef, color)
122 |                         else:
123 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef)
124 |                     else:
125 |                         gm.position = (-x / gameObjectHandler.scale, -y / gameObjectHandler.scale)
126 |                         if color:
127 |                             gm.textureID = -1
128 |                             vertices = hitboxes[verticesName]
129 |                             gm.vertices = [
130 |                                 (v[0] / gameObjectHandler.scale, v[1] / gameObjectHandler.scale) for v in vertices]
131 |                             gameObjectHandler.add(gm, color=color)
132 |                         else:
133 |                             gameObjectHandler.add(gm)</code></pre>
134 | </details>
135 | </section>
136 | <section>
137 | </section>
138 | <section>
139 | </section>
140 | <section>
141 | </section>
142 | <section>
143 | <h2 class="section-title" id="header-classes">Classes</h2>
144 | <dl>
145 | <dt id="AggiEngine.tileloader.TileMap"><code class="flex name class">
146 | <span>class <span class="ident">TileMap</span></span>
147 | <span>(</span><span>tmxFile, gameObjectHandler, gameScreen)</span>
148 | </code></dt>
149 | <dd>
150 | <div class="desc"></div>
151 | <details class="source">
152 | <summary>
153 | <span>Expand source code</span>
154 | </summary>
155 | <pre><code class="python">class TileMap:
156 | 
157 |     def __init__(self, tmxFile, gameObjectHandler, gameScreen):
158 |         tiled_map = pytmx.TiledMap(tmxFile, image_loader=gameScreen.image_loader)
159 |         if tiled_map.background_color:
160 |             color = ImageColor.getcolor(tiled_map.background_color, &#39;RGB&#39;)
161 |             gameScreen.bgColor = [color[0] / 255, color[1] / 255, color[2] / 255]
162 | 
163 |         hitboxes = {}
164 |         objects = tiled_map.objects
165 | 
166 |         # Looks for objects and gets its vertices
167 |         for obj in objects:
168 |             pairPoints = []
169 |             for pair in obj.points:
170 |                 pairPoints.append(
171 |                     (-(pair[0] - obj.x) / gameObjectHandler.scale, -(pair[1] - obj.y) / gameObjectHandler.scale))
172 |             hitboxes[obj.name] = pairPoints
173 | 
174 |         for layer in tiled_map:
175 |             # Checks for layers with tiles
176 |             if isinstance(layer, pytmx.TiledTileLayer):
177 |                 for x, y, image in layer.tiles():
178 |                     # Gets class name and gets class name definition
179 |                     className = layer.properties.get(&#39;class&#39;, &#39;GameObject&#39;)
180 | 
181 |                     if className != &#39;GameObject&#39;:
182 |                         className = getattr(importlib.import_module(&#39;__main__&#39;), className)
183 |                     else:
184 |                         className = GameObject
185 |                     # Sets up Texture
186 |                     gm = className()
187 |                     gm.textureID = image[0]
188 | 
189 |                     gm.setWidth(image[1] / gameObjectHandler.scale ** 2)
190 |                     gm.setHeight(image[2] / gameObjectHandler.scale ** 2)
191 | 
192 |                     # Sets up Color
193 |                     color = layer.properties.get(&#39;color&#39;, None)
194 |                     if color:
195 |                         color = ImageColor.getcolor(color, &#39;RGBA&#39;)
196 |                         color = [color[2] / 255, color[1] / 255, color[0] / 255, color[3] / 255]
197 |                         print(color)
198 | 
199 |                     # Sets up Hitbox
200 |                     verticesName = layer.properties.get(&#39;hitboxName&#39;, None)
201 | 
202 |                     # Sets up Body Type
203 |                     bodyType = layer.properties.get(&#39;bodyType&#39;, &#39;none&#39;)
204 |                     if bodyType != &#39;none&#39;:
205 |                         bodyDef = Box2D.b2BodyDef()
206 |                         if bodyType == &#39;dynamic&#39;:
207 |                             bodyDef.type = Box2D.b2_dynamicBody
208 |                         elif bodyType == &#39;static&#39;:
209 |                             bodyDef.type = Box2D.b2_staticBody
210 |                         else:
211 |                             bodyDef.type = Box2D.b2_kinematicBody
212 |                         bodyDef.linearDamping = layer.properties.get(&#39;linearDamping&#39;, 0)
213 |                         bodyDef.angularDamping = layer.properties.get(&#39;angularDamping&#39;, 0)
214 |                         bodyDef.fixedRotation = layer.properties.get(&#39;fixedRotation&#39;, False)
215 | 
216 |                         # Linear Vel (Broken)
217 |                         linearVel = layer.properties.get(&#39;linearVel&#39;, None)
218 |                         if linearVel:
219 |                             linearVel = [float(x) for x in linearVel.split(&#39;,&#39;)]
220 |                             bodyDef.linearVelocity = (linearVel[0], linearVel[1])
221 | 
222 |                         # Sets up body Fixture
223 |                         if verticesName:
224 |                             bodyFixtureDef = Box2D.b2FixtureDef(
225 |                                 shape=Box2D.b2PolygonShape(vertices=hitboxes[verticesName]))
226 |                         else:
227 |                             bodyFixtureDef = Box2D.b2FixtureDef(shape=Box2D.b2PolygonShape(
228 |                                 box=((image[1] / gameObjectHandler.scale) / 2,
229 |                                      (image[2] / gameObjectHandler.scale) / 2)))
230 |                         bodyFixtureDef.density = layer.properties.get(&#39;density&#39;, 1)
231 |                         bodyFixtureDef.friction = layer.properties.get(&#39;friction&#39;, 0)
232 |                         bodyFixtureDef.restitution = layer.properties.get(&#39;restitution&#39;, 0)
233 |                         # Sets up Position
234 |                         bodyDef.position = (
235 |                             -(x * tiled_map.tilewidth) / gameObjectHandler.scale,
236 |                             -(y * tiled_map.tileheight) / gameObjectHandler.scale)
237 |                         # adds box
238 |                         if color:
239 |                             gm.textureID = -1
240 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef, color)
241 |                         else:
242 |                             gameObjectHandler.add(gm, bodyDef, bodyFixtureDef)
243 |                     else:
244 |                         gm.position = (-x / gameObjectHandler.scale, -y / gameObjectHandler.scale)
245 |                         if color:
246 |                             gm.textureID = -1
247 |                             vertices = hitboxes[verticesName]
248 |                             gm.vertices = [
249 |                                 (v[0] / gameObjectHandler.scale, v[1] / gameObjectHandler.scale) for v in vertices]
250 |                             gameObjectHandler.add(gm, color=color)
251 |                         else:
252 |                             gameObjectHandler.add(gm)</code></pre>
253 | </details>
254 | </dd>
255 | </dl>
256 | </section>
257 | </article>
258 | <nav id="sidebar">
259 | <h1>Index</h1>
260 | <div class="toc">
261 | <ul></ul>
262 | </div>
263 | <ul id="index">
264 | <li><h3>Super-module</h3>
265 | <ul>
266 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
267 | </ul>
268 | </li>
269 | <li><h3><a href="#header-classes">Classes</a></h3>
270 | <ul>
271 | <li>
272 | <h4><code><a title="AggiEngine.tileloader.TileMap" href="#AggiEngine.tileloader.TileMap">TileMap</a></code></h4>
273 | </li>
274 | </ul>
275 | </li>
276 | </ul>
277 | </nav>
278 | </main>
279 | <footer id="footer">
280 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
281 | </footer>
282 | </body>
283 | </html>


--------------------------------------------------------------------------------
/docs/uimanager.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="utf-8">
  5 | <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6 | <meta name="generator" content="pdoc 0.9.2" />
  7 | <title>AggiEngine.uimanager API documentation</title>
  8 | <meta name="description" content="" />
  9 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 10 | <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 11 | <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
 12 | <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
 13 | <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
 14 | <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
 15 | <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
 16 | <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
 17 | </head>
 18 | <body>
 19 | <main>
 20 | <article id="content">
 21 | <header>
 22 | <h1 class="title">Module <code>AggiEngine.uimanager</code></h1>
 23 | </header>
 24 | <section id="section-intro">
 25 | <details class="source">
 26 | <summary>
 27 | <span>Expand source code</span>
 28 | </summary>
 29 | <pre><code class="python">from PySide2.QtCore import QMetaObject
 30 | from PySide2.QtUiTools import QUiLoader
 31 | from PySide2.QtWidgets import QMainWindow
 32 | 
 33 | 
 34 | class UiManager(QUiLoader):
 35 | 
 36 |     def __init__(self, window, customWidgets=None):
 37 |         QUiLoader.__init__(self)
 38 |         self.window = window
 39 | 
 40 |         # Register all the custom widgets so that they can be created later
 41 |         self.customWidgets = customWidgets
 42 |         if customWidgets is not None:
 43 |             for wid in customWidgets:
 44 |                 self.registerCustomWidget(wid)
 45 | 
 46 |         self.keepWidgets = []
 47 | 
 48 |     def createWidget(self, class_name, parent=None, name=&#39;&#39;):
 49 |         &#34;&#34;&#34;
 50 |         Overrides QUiLoader to createWidget in current window rather than a new one
 51 |         ``class_name:`` The class we want to create  
 52 |         ``parent:`` The parent widget  
 53 |         ``name:`` The name of the widget we&#39;ll create  
 54 |         &#34;&#34;&#34;
 55 | 
 56 |         if class_name is QMainWindow.__name__:
 57 |             return self.window
 58 | 
 59 |         if parent is None and self.window:
 60 |             return self.window
 61 |         else:
 62 |             if class_name in self.availableWidgets():
 63 |                 widget = QUiLoader.createWidget(self, class_name, parent, name)
 64 |                 widget.show()
 65 |             else:
 66 |                 try:
 67 |                     widget = self.customWidgets[class_name](parent)
 68 |                 except (TypeError, KeyError) as e:
 69 |                     raise Exception(class_name, &#39;was not found are you sure it was promoted?&#39;)
 70 | 
 71 |             if self.window:
 72 |                 setattr(self.window, name, widget)
 73 | 
 74 |             return widget
 75 | 
 76 |     def loadWidgets(self, ui_file, deleteCurrent=False):
 77 |         &#34;&#34;&#34;
 78 |         Loads the current ui_file and if wanted deleted old widgets
 79 |         ``ui_file:`` The file path to load  
 80 |         ``deleteCurrent:`` Remove old widgets  
 81 |         &#34;&#34;&#34;
 82 | 
 83 |         if len(self.window.children()) &gt; 0 and deleteCurrent:
 84 |             for i in range(0, len(self.window.children())):
 85 |                 if not(self.window.children()[i] in self.keepWidgets):
 86 |                     self.window.children()[i].deleteLater()
 87 | 
 88 |         widgets = self.load(ui_file)  # load widgets
 89 |         QMetaObject.connectSlotsByName(widgets)</code></pre>
 90 | </details>
 91 | </section>
 92 | <section>
 93 | </section>
 94 | <section>
 95 | </section>
 96 | <section>
 97 | </section>
 98 | <section>
 99 | <h2 class="section-title" id="header-classes">Classes</h2>
100 | <dl>
101 | <dt id="AggiEngine.uimanager.UiManager"><code class="flex name class">
102 | <span>class <span class="ident">UiManager</span></span>
103 | <span>(</span><span>window, customWidgets=None)</span>
104 | </code></dt>
105 | <dd>
106 | <div class="desc"><p>QUiLoader(self, parent: typing.Union[PySide2.QtCore.QObject, NoneType] = None) -&gt; None</p></div>
107 | <details class="source">
108 | <summary>
109 | <span>Expand source code</span>
110 | </summary>
111 | <pre><code class="python">class UiManager(QUiLoader):
112 | 
113 |     def __init__(self, window, customWidgets=None):
114 |         QUiLoader.__init__(self)
115 |         self.window = window
116 | 
117 |         # Register all the custom widgets so that they can be created later
118 |         self.customWidgets = customWidgets
119 |         if customWidgets is not None:
120 |             for wid in customWidgets:
121 |                 self.registerCustomWidget(wid)
122 | 
123 |         self.keepWidgets = []
124 | 
125 |     def createWidget(self, class_name, parent=None, name=&#39;&#39;):
126 |         &#34;&#34;&#34;
127 |         Overrides QUiLoader to createWidget in current window rather than a new one
128 |         ``class_name:`` The class we want to create  
129 |         ``parent:`` The parent widget  
130 |         ``name:`` The name of the widget we&#39;ll create  
131 |         &#34;&#34;&#34;
132 | 
133 |         if class_name is QMainWindow.__name__:
134 |             return self.window
135 | 
136 |         if parent is None and self.window:
137 |             return self.window
138 |         else:
139 |             if class_name in self.availableWidgets():
140 |                 widget = QUiLoader.createWidget(self, class_name, parent, name)
141 |                 widget.show()
142 |             else:
143 |                 try:
144 |                     widget = self.customWidgets[class_name](parent)
145 |                 except (TypeError, KeyError) as e:
146 |                     raise Exception(class_name, &#39;was not found are you sure it was promoted?&#39;)
147 | 
148 |             if self.window:
149 |                 setattr(self.window, name, widget)
150 | 
151 |             return widget
152 | 
153 |     def loadWidgets(self, ui_file, deleteCurrent=False):
154 |         &#34;&#34;&#34;
155 |         Loads the current ui_file and if wanted deleted old widgets
156 |         ``ui_file:`` The file path to load  
157 |         ``deleteCurrent:`` Remove old widgets  
158 |         &#34;&#34;&#34;
159 | 
160 |         if len(self.window.children()) &gt; 0 and deleteCurrent:
161 |             for i in range(0, len(self.window.children())):
162 |                 if not(self.window.children()[i] in self.keepWidgets):
163 |                     self.window.children()[i].deleteLater()
164 | 
165 |         widgets = self.load(ui_file)  # load widgets
166 |         QMetaObject.connectSlotsByName(widgets)</code></pre>
167 | </details>
168 | <h3>Ancestors</h3>
169 | <ul class="hlist">
170 | <li>PySide2.QtUiTools.QUiLoader</li>
171 | <li>PySide2.QtCore.QObject</li>
172 | <li>Shiboken.Object</li>
173 | </ul>
174 | <h3>Class variables</h3>
175 | <dl>
176 | <dt id="AggiEngine.uimanager.UiManager.staticMetaObject"><code class="name">var <span class="ident">staticMetaObject</span></code></dt>
177 | <dd>
178 | <div class="desc"></div>
179 | </dd>
180 | </dl>
181 | <h3>Methods</h3>
182 | <dl>
183 | <dt id="AggiEngine.uimanager.UiManager.createWidget"><code class="name flex">
184 | <span>def <span class="ident">createWidget</span></span>(<span>self, class_name, parent=None, name='')</span>
185 | </code></dt>
186 | <dd>
187 | <div class="desc"><p>Overrides QUiLoader to createWidget in current window rather than a new one
188 | <code>class_name:</code> The class we want to create<br>
189 | <code>parent:</code> The parent widget<br>
190 | <code>name:</code> The name of the widget we'll create</p></div>
191 | <details class="source">
192 | <summary>
193 | <span>Expand source code</span>
194 | </summary>
195 | <pre><code class="python">def createWidget(self, class_name, parent=None, name=&#39;&#39;):
196 |     &#34;&#34;&#34;
197 |     Overrides QUiLoader to createWidget in current window rather than a new one
198 |     ``class_name:`` The class we want to create  
199 |     ``parent:`` The parent widget  
200 |     ``name:`` The name of the widget we&#39;ll create  
201 |     &#34;&#34;&#34;
202 | 
203 |     if class_name is QMainWindow.__name__:
204 |         return self.window
205 | 
206 |     if parent is None and self.window:
207 |         return self.window
208 |     else:
209 |         if class_name in self.availableWidgets():
210 |             widget = QUiLoader.createWidget(self, class_name, parent, name)
211 |             widget.show()
212 |         else:
213 |             try:
214 |                 widget = self.customWidgets[class_name](parent)
215 |             except (TypeError, KeyError) as e:
216 |                 raise Exception(class_name, &#39;was not found are you sure it was promoted?&#39;)
217 | 
218 |         if self.window:
219 |             setattr(self.window, name, widget)
220 | 
221 |         return widget</code></pre>
222 | </details>
223 | </dd>
224 | <dt id="AggiEngine.uimanager.UiManager.loadWidgets"><code class="name flex">
225 | <span>def <span class="ident">loadWidgets</span></span>(<span>self, ui_file, deleteCurrent=False)</span>
226 | </code></dt>
227 | <dd>
228 | <div class="desc"><p>Loads the current ui_file and if wanted deleted old widgets
229 | <code>ui_file:</code> The file path to load<br>
230 | <code>deleteCurrent:</code> Remove old widgets</p></div>
231 | <details class="source">
232 | <summary>
233 | <span>Expand source code</span>
234 | </summary>
235 | <pre><code class="python">def loadWidgets(self, ui_file, deleteCurrent=False):
236 |     &#34;&#34;&#34;
237 |     Loads the current ui_file and if wanted deleted old widgets
238 |     ``ui_file:`` The file path to load  
239 |     ``deleteCurrent:`` Remove old widgets  
240 |     &#34;&#34;&#34;
241 | 
242 |     if len(self.window.children()) &gt; 0 and deleteCurrent:
243 |         for i in range(0, len(self.window.children())):
244 |             if not(self.window.children()[i] in self.keepWidgets):
245 |                 self.window.children()[i].deleteLater()
246 | 
247 |     widgets = self.load(ui_file)  # load widgets
248 |     QMetaObject.connectSlotsByName(widgets)</code></pre>
249 | </details>
250 | </dd>
251 | </dl>
252 | </dd>
253 | </dl>
254 | </section>
255 | </article>
256 | <nav id="sidebar">
257 | <h1>Index</h1>
258 | <div class="toc">
259 | <ul></ul>
260 | </div>
261 | <ul id="index">
262 | <li><h3>Super-module</h3>
263 | <ul>
264 | <li><code><a title="AggiEngine" href="index.html">AggiEngine</a></code></li>
265 | </ul>
266 | </li>
267 | <li><h3><a href="#header-classes">Classes</a></h3>
268 | <ul>
269 | <li>
270 | <h4><code><a title="AggiEngine.uimanager.UiManager" href="#AggiEngine.uimanager.UiManager">UiManager</a></code></h4>
271 | <ul class="">
272 | <li><code><a title="AggiEngine.uimanager.UiManager.createWidget" href="#AggiEngine.uimanager.UiManager.createWidget">createWidget</a></code></li>
273 | <li><code><a title="AggiEngine.uimanager.UiManager.loadWidgets" href="#AggiEngine.uimanager.UiManager.loadWidgets">loadWidgets</a></code></li>
274 | <li><code><a title="AggiEngine.uimanager.UiManager.staticMetaObject" href="#AggiEngine.uimanager.UiManager.staticMetaObject">staticMetaObject</a></code></li>
275 | </ul>
276 | </li>
277 | </ul>
278 | </li>
279 | </ul>
280 | </nav>
281 | </main>
282 | <footer id="footer">
283 | <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
284 | </footer>
285 | </body>
286 | </html>


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | # Inside of setup.cfg
2 | [metadata]
3 | description-file = README.md


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | from distutils.core import setup
 2 | setup(
 3 |   name = 'AggiEngine',
 4 |   packages = ['AggiEngine'],
 5 |   version = '0.1',
 6 |   license='MIT',
 7 |   description = 'A game engine written in python',
 8 |   author = 'Brady Langdale, Nurivan Gomez',
 9 |   author_email = 'bradylangdale@tamu.edu, nurivan@tamu.edu',
10 |   url = 'https://github.com/aggie-coding-club/AggiEngine/',
11 |   download_url = 'https://github.com/aggie-coding-club/AggiEngine/archive/refs/tags/0.1.tar.gz',
12 |   keywords = ['Python', 'Game Engine'],
13 |   install_requires=[
14 |         'PySide2',
15 |         'PyOpenGL',
16 |         'Box2D',
17 |         'pytmx',
18 |         'pillow',
19 |         'numpy',
20 |         'simpleaudio'
21 |     ],
22 |   classifiers=[
23 |         'Development Status :: 3 - Alpha',
24 |         'Intended Audience :: Developers',
25 |         'Topic :: Software Development :: Build Tools',
26 |         'License :: OSI Approved :: MIT License',
27 |         'Programming Language :: Python :: 3',
28 |         'Programming Language :: Python :: 3.4',
29 |         'Programming Language :: Python :: 3.5',
30 |         'Programming Language :: Python :: 3.6',
31 |         'Programming Language :: Python :: 3.7',
32 |         'Programming Language :: Python :: 3.8',
33 |     ],
34 | )


--------------------------------------------------------------------------------