Pokeradar Documentation #137
Conversation
| @@ -1,6 +1,6 @@ | |||
| #ifndef POKEPLATINUM_STRUCT_0206942C_DECL_H | |||
| #define POKEPLATINUM_STRUCT_0206942C_DECL_H | |||
|
|
|||
| typedef struct UnkStruct_0206942C_t UnkStruct_0206942C; | |||
| typedef struct RadarChain_t RadarChain; | |||
There was a problem hiding this comment.
Repo style is to omit _t suffixes on struct types wherever possible; it's safe to declare this as typedef struct RadarChain RadarChain;
Additionally, is it possible to merge this and its definition into the pokeradar.h header? We're using transparent structs. Alternatively, merge the typedef and the definition into the same header within include/struct_defs.
src/pokeradar.c
Outdated
| static BOOL CheckPatchShiny(const int param0); | ||
| static void IncWithCap(int * param0); | ||
|
|
||
| RadarChain * CreateRadarChain (const int param0) { |
There was a problem hiding this comment.
RadarChain_Init?param0looks like aheapIDto me.- function definition should look like:
RadarChain* RadarChain_Init(const int heapID)
{
// code
}
src/pokeradar.c
Outdated
| RadarChain * chain; | ||
|
|
||
| chain = Heap_AllocFromHeap(param0, sizeof(RadarChain)); |
There was a problem hiding this comment.
We use C99; prefer declare + define on the same line wherever possible, so long as it matches.
| RadarChain * chain; | |
| chain = Heap_AllocFromHeap(param0, sizeof(RadarChain)); | |
| RadarChain *chain = Heap_AllocFromHeap(param0, sizeof(RadarChain)); |
src/pokeradar.c
Outdated
| return chain; | ||
| } | ||
|
|
||
| void FreeRadarChain (RadarChain * chain) { |
There was a problem hiding this comment.
RadarChain_Free?RadarChain *chain(in general, align the pointer-star to immediately prefix the variable name)
src/pokeradar.c
Outdated
| Heap_FreeToHeap(chain); | ||
| } | ||
|
|
||
| void ClearRadarChain (RadarChain * chain) { |
There was a problem hiding this comment.
RadarChain_Clear?RadarChain_Zero?RadarChain *chain
src/pokeradar.c
Outdated
| static BOOL sub_020698AC (const RadarChain * chain, const int param1, const int param2, u8 * param3) | ||
| { | ||
| u8 patchRing; | ||
|
|
||
| for (patchRing = 0; patchRing < NUM_GRASS_PATCHES; patchRing++) { | ||
| if (chain->patch[patchRing].active) { | ||
| if ((chain->patch[patchRing].unk_00 == param1) && (chain->patch[patchRing].unk_04 == param2)) { | ||
| *param3 = patchRing; | ||
| return 1; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return 0; | ||
| } |
There was a problem hiding this comment.
Prefer returning TRUE or FALSE in functions that return a BOOL.
src/pokeradar.c
Outdated
| } | ||
| } | ||
|
|
||
| GF_ASSERT(0); |
There was a problem hiding this comment.
Prefer using a BOOL-evaluating expression inside GF_ASSERT, e.g. GF_ASSERT(FALSE) vs GF_ASSERT(0).
src/pokeradar.c
Outdated
| if (battleResult == 0x1) { // If the battle resulted in fainting the mon, use the regular rates | ||
| rates = ratesNormal; | ||
| } else if (battleResult == 0x4) { // If the battle resulted in a capture, use the boosted rates | ||
| rates = ratesBoosted; | ||
| } |
There was a problem hiding this comment.
Can you pull these from constants/battle.h?
src/pokeradar.c
Outdated
| } | ||
| break; | ||
| case 1: | ||
| Sound_PlayBGM(1150); |
There was a problem hiding this comment.
Can you create an enum definition for this in constants/sdat.h?
There was a problem hiding this comment.
Remind me some time, and I'll fill out the other songs in sdat.h
src/pokeradar.c
Outdated
| return 0; | ||
| } | ||
|
|
||
| static BOOL CheckPatchShiny (const int chianCount) { |
Started documenting the pokeradar. Still more to do