Revamp class file structure

TASLabz / mkw-scripts

Python Scripts for use with Dolphin Emulator. Scripts cover various utilities for creating Mario Kart Wii TASes .

7 stars 6 forks source link

Revamp class file structure #41

Closed malleoz closed 11 months ago

malleoz commented 12 months ago

Classes are now organized in a mkw_classes folder. Classes can be individually imported by doing mkw_classes.ClassName. Each class allows construction based off an address, or (in cases where there is only one way to determine the class instance's reference) by a player index for example.

This should allow for more readable navigation of class hierarchies and easier debugging for future script work.

I've tested all existing scripts in this repository to assure no behavior is altered, however an additional thorough review for InfoDisplay would be appreciated.

vabold commented 12 months ago

Known issues out of scope of this PR:

Full EGG parity with vec2/vec3/mat34/quatf
Proper WheelCount documentation
Broadening TTK support by factoring in current gamemode

As well as this, we may want to introduce broader documentation for the player indices (and possibly the input system), as this will be helpful to other developers.

malleoz commented 11 months ago

Applied all of the above suggestions.