Add Documentation for RandMap functions#240
Add Documentation for RandMap functions#240Drought-Causer wants to merge 6 commits intoprojectPiki:mainfrom
Conversation
HeartPiece44
left a comment
HeartPiece44
left a comment
There was a problem hiding this comment.
Nice! Looks great on the whole, really good to have more documentation in this part of the code. Few nitpick comments (open to being convinced on some of them though).
| * @size{0x4} | ||
| */ | ||
| struct RandMapDraw { | ||
| class RandMapDraw { |
There was a problem hiding this comment.
nit: would keep this consistent with the rest of the codebase and just use struct.
There was a problem hiding this comment.
fair enough, I think at some point once we're matching we should go in and make a lot of things classes (at least in JSystem)
| * @size{0x4} | ||
| */ | ||
| struct RandMapChecker { | ||
| class RandMapChecker { |
| void getStartPosition(Vector3f& position, int index); | ||
| void getItemDropPosition(Vector3f& position, f32 minDist, f32 maxDist); | ||
| void getItemDropPosition(Vector3f* positions, int positionCount, f32 lowerWeightBound, f32 upperWeightBound); | ||
| void getItemDropPosition(Vector3f positions[], int positionCount, f32 lowerWeightBound, f32 upperWeightBound); |
There was a problem hiding this comment.
nit: we don't use array notation for any parameters elsewhere in the codebase, so probably good to keep this in pointer notation - if we want to, we can do a pass through the codebase later and make any lists into array notation to make it clearer later.
There was a problem hiding this comment.
Yeah, I kinda wanted to start the motion towards using list notation, but for now that makes sense. We should definitely consider changing everything to a list in the future because I think it makes function parameters less confusing.
| MapNode* getLinkDoorNodeFirst(MapNode*, int, int, int, int&); | ||
| MapNode* getLoopEndMapUnit(); | ||
| u32 getLoopMapNode(MapNode**); | ||
| u32 getLoopMapNode(MapNode* nodes[]); |
2 participants
Added a bunch of documentation for functions and members under Cave::RandMap
Squash merge this please