Code Flowchart
Below you'll see a flowchart that lays out the structure of this mod's code. More specifically, this chart will allow you to easily visualize how the various functions interconnect and when they run.
A simple guide to this chart is as follows:
-
White boxes represent functions, and are labeled with their name.
- Red-tinted boxes are also functions, but are functions which do not call other mod functions -- they are the "simplest" functions.
-
A solid arrow pointing from function A to B means that function A CAN (not WILL!) call function B.
- A dashed arrow means the same, except function A remote executes function B rather than calling it locally.
- If a function connects to multiple other functions, it is merely because that function CAN call any of those functions. It does NOT imply that the function calls them in parallel or even calls any of them consistently.
-
Green parallelograms represent event handlers.
- An arrow pointing from a function to an event handler means that the function creates the event handler.
- An arrow pointing from an event handler to a function means that event handler calls/remoteExecutes the function when triggered.
- The white cylinders are "databases" (just hashmaps in the code). These are fairly simple and just map IDs to some sort of data.
- Arrows pointing into a cylinder represent writing to the "database", and arrows pointing away represent reading from it or resulting from it.
