Small improvements for human readability (#222)

* use enums for better readibility

* remove old comments

* use color and terrain type enums

* change comment

* delete wrong comment

* add known stats to phys enum

---------

Co-authored-by: penta3 <thedragopenta9@gmail.com>

Author: kkv0n

decompile/General/221/221_Full.c

@@ -30,6 +30,8 @@ void DECOMP_CC_EndEvent_DrawMenu()
 	int levelID;
 	int elapsedFrames;
 
+	unsigned char prize = 0x6f;
+	
 	gGT = sdata->gGT;
 	levelID = gGT->levelID;
 	driver = gGT->drivers[0];
@@ -38,15 +40,15 @@ void DECOMP_CC_EndEvent_DrawMenu()
 	// Dingo Canyon gives different item depending on 
 	// camera, Blizz Bluff gives Skull Rock token, and
 	// Dragon Mines gives purple gem
-	if(levelID == 0) bitIndex = gGT->pushBuffer[0].pos[2];
-	else if(levelID == 1) bitIndex = 0;
-	else if(levelID == 2) bitIndex = -1;
+	if(levelID == DINGO_CANYON) bitIndex = gGT->pushBuffer[0].pos[2];
+	else if(levelID == DRAGON_MINES) bitIndex = 0;
+	else if(levelID == BLIZZARD_BLUFF) bitIndex = -1;
 
 	// default logic
-	else bitIndex = hub[gGT->levelID-0x12];
+	else bitIndex = hub[gGT->levelID-TURBO_TRACK]; //0x12
 
 	// first purple token at 0x6f
-	bitIndex += 0x6f;
+	bitIndex += prize;
 
 	adv = &sdata->advProgress;
 	boolLose = driver->numCrystals < gGT->numCrystalsInLEV;

decompile/General/222/222_Full.c

@@ -40,6 +40,8 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 	u_int scaleDown;
 	u_int txtColor;
 	int bitIndex;
+	
+	unsigned char prize;
 
 	bitIndex = -1;
 	gGT = sdata->gGT;
@@ -92,9 +94,11 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 			lerpEndX = lerpStartX + 0x10;
 			lerpEndY = lerpStartY + 0x10;
 			lerpFrames = FPS_DOUBLE(8);
-
+            
+			prize = 0x4c;
+			
 			// If you have not unlocked this CTR Token
-			bitIndex = gGT->levelID + 0x4C;
+			bitIndex = gGT->levelID + prize;
 			*(int *)&letterPos[0] = *(int *)&hudCTR[0];
 			if (CHECK_ADV_BIT(adv->rewards, bitIndex) == 0)
 			{
@@ -438,8 +442,10 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 	// If you are in boss mode
 	if (gGT->gameMode1 < 0)
 	{
+		prize = 0x5e;
+		
 		// bitIndex of keys unlocked, and boss beaten
-		bitIndex = gGT->bossID + 0x5e;
+		bitIndex = gGT->bossID + prize;
 
 		// If the number of keys you have is less than 4
 		if (gGT->bossID < 4)
@@ -448,14 +454,14 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 			if (CHECK_ADV_BIT(adv->rewards, bitIndex) == 0)
 			{
 				// Go to Podium after returning to Adventure Hub
-				gGT->podiumRewardID = 99; // key
+				gGT->podiumRewardID = STATIC_KEY; // key
 
 				// hot air skyway
-				if (gGT->levelID == 7)
+				if (gGT->levelID == HOT_AIR_SKYWAY)
 				{
 					// If you just beat Pinstripe
 					// Load gemstone valley
-					levSpawn = 0x19;
+					levSpawn = GEM_STONE_VALLEY;
 				}
 			}
 		}
@@ -465,7 +471,7 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 		{
 			// Always go to podium after oxide,
 			// with no key (0x38 = empty)
-			gGT->podiumRewardID = 0x38;
+			gGT->podiumRewardID = STATIC_BIG1;
 
 			// assume oxide beaten 1st time
 			adv->rewards[3] |= 0x80004;
@@ -488,14 +494,15 @@ void DECOMP_AA_EndEvent_DrawMenu(void)
 
 	// if trophy is not won,
 	// Dingo Bingo needs to win trophy and token in the same race
-	bitIndex = gGT->levelID + 6;
+	prize = 6;
+	bitIndex = gGT->levelID + prize;
 	if (CHECK_ADV_BIT(adv->rewards, bitIndex) == 0)
 	{
 		// unlock tropy
 		UNLOCK_ADV_BIT(adv->rewards, bitIndex);
 
 		// go to podium with trophy
-		gGT->podiumRewardID = 0x62;
+		gGT->podiumRewardID = STATIC_TROPHY;
 	}
 
 	MainRaceTrack_RequestLoad(levSpawn);

decompile/General/223/223_Full.c

@@ -60,7 +60,7 @@ void DECOMP_RR_EndEvent_UnlockAward()
 		UNLOCK_ADV_BIT(adv->rewards, bitIndex);
 
 		// relic model
-		gGT->podiumRewardID = 0x61;
+		gGT->podiumRewardID = STATIC_RELIC;
 
 		// won relic
 		gGT->gameModeEnd |= NEW_RELIC;
@@ -130,7 +130,8 @@ void DECOMP_RR_EndEvent_DrawMenu(void)
 
 	// 0x3a is the bit index of where platinum
 	// relics start in adventure progress
-	bitIndex = gGT->levelID + 0x3a;
+	unsigned char prize = 0x3a;
+	bitIndex = gGT->levelID + prize;
 
 	// set color of relic in Instance
 	relic->colorRGBA =

decompile/General/230/230_56_MM_TrackSelect_MenuProc.c

@@ -134,11 +134,11 @@ void DECOMP_MM_TrackSelect_MenuProc(struct RectMenu* menu)
 
 	#ifdef USE_HIGHMP
 	numTracks = 23;
-	D230.battleTracks[0].levID = 0x19;
-	D230.battleTracks[1].levID = 0x1a;
-	D230.battleTracks[2].levID = 0x1b;
-	D230.battleTracks[3].levID = 0x1c;
-	D230.battleTracks[4].levID = 0x1d;
+	D230.battleTracks[0].levID = GEM_STONE_VALLEY;
+	D230.battleTracks[1].levID = N_SANITY_BEACH;
+	D230.battleTracks[2].levID = THE_LOST_RUINS;
+	D230.battleTracks[3].levID = GLACIER_PARK;
+	D230.battleTracks[4].levID = CITADEL_CITY;
 	#endif
 
 	// if you are in battle mode
@@ -148,11 +148,11 @@ void DECOMP_MM_TrackSelect_MenuProc(struct RectMenu* menu)
 		numTracks = 7;
 
 		#ifdef USE_HIGHMP
-		D230.battleTracks[0].levID = 18;
-		D230.battleTracks[1].levID = 19;
-		D230.battleTracks[2].levID = 20;
-		D230.battleTracks[3].levID = 21;
-		D230.battleTracks[4].levID = 22;
+		D230.battleTracks[0].levID = NITRO_COURT;
+		D230.battleTracks[1].levID = RAMPAGE_RUINS;
+		D230.battleTracks[2].levID = PARKING_LOT;
+		D230.battleTracks[3].levID = SKULL_ROCK;
+		D230.battleTracks[4].levID = THE_NORTH_BOWL;
 		#endif
 	}
 

decompile/General/231/231_007_RB_Hazard_CollideWithDrivers.c

@@ -48,7 +48,7 @@ struct Instance* DECOMP_RB_Hazard_CollideWithDrivers(
 
 		// to be more optimal, just do weaponInst->thread->funcThTick == GenericMine_ThTick
 		if (
-				((unsigned int)modelID - 0x46 < 2) ||	// red or green potion
+				((unsigned int)modelID - STATIC_BEAKER_RED < 2) ||	// red or green potion
 				(modelID == PU_EXPLOSIVE_CRATE) ||						// Nitro
 				(modelID == STATIC_CRATE_TNT) 						// TNT
 			)

decompile/General/231/231_010_RB_Hazard_ThCollide_Missile.c

@@ -10,7 +10,7 @@ void DECOMP_RB_Hazard_ThCollide_Missile(struct Thread* thread)
 	inst = thread->inst;
 
 	// could I also just do thread->modelID?
-	if (inst->model->id == 0x29)
+	if (inst->model->id == DYNAMIC_ROCKET)
 	{
 		#ifndef REBUILD_PS1
 		// play audio of explosion

decompile/General/231/231_011_RB_Hazard_ThCollide_Generic.c

@@ -36,7 +36,7 @@ void DECOMP_RB_Hazard_ThCollide_Generic(struct Thread* thread)
 	modelID = inst->model->id;
 
 	// if red beaker or green beaker
-	if ((unsigned int)(modelID - 0x46) < 2)
+	if ((unsigned int)(modelID - STATIC_BEAKER_RED) < 2)
 	{
 		#ifndef REBUILD_PS1
 		PlaySound3D(0x3f, inst);
@@ -57,7 +57,7 @@ void DECOMP_RB_Hazard_ThCollide_Generic(struct Thread* thread)
 		else
 		{
 			// if not TNT
-			if(modelID != 0x27)
+			if(modelID != STATIC_CRATE_TNT)
 			{
 				return;
 			}

decompile/General/231/231_012_RB_Potion_OnShatter_TeethCallback.c

@@ -11,7 +11,7 @@ int RB_Potion_OnShatter_TeethCallback(int unk, struct BSP* bspHitbox)
 	instDef = bspHitbox->data.hitbox.instDef;
 	if (instDef != NULL)
 		if (teethInst = instDef->ptrInstance, teethInst != NULL)
-			if (instDef->modelID == 0x70) //STATIC_TEETH
+			if (instDef->modelID == STATIC_TEETH) //tiger temple door
 				instDef = DECOMP_RB_Teeth_OpenDoor(teethInst);
 
 	return (int)instDef;

decompile/General/231/231_016_RB_GenericMine_ThTick.c

@@ -383,7 +383,7 @@ void DECOMP_RB_GenericMine_ThTick(struct Thread* t)
 	param = 0x3d;
 
 	// if model is Nitro
-	if (model == 6) 
+	if (model == PU_EXPLOSIVE_CRATE) 
 	{
 		// glass shatter
 		param = 0x3f;

decompile/General/231/231_024_RB_MovingExplosive_ThTick.c

@@ -239,7 +239,7 @@ LAB_800adc08:;
   inst->matrix.t[2] += (((int)tw->vel[2] * elapsedTime) >> 5);
 
   // If this is bomb
-  if (modelID == 0x3b)
+  if (modelID == DYNAMIC_BOMB)
   {
 	// if bomb is forwards
 	if ((tw->flags & 0x20) == 0)
@@ -321,7 +321,7 @@ LAB_800adc08:;
       int iVar8 = elapsedTime << 2;
 
 	  // if missile
-      if (modelID == 0x29)
+      if (modelID == DYNAMIC_ROCKET)
 	  {
         iVar8 = elapsedTime << 3;
       }
@@ -338,9 +338,9 @@ LAB_800adc08:;
     else
 	{
       tw->vel[1] = 0;
-
-	  // DYNAMIC_ROCKET
-      if (modelID == 0x29)
+	  
+	  //missile model
+      if (modelID == DYNAMIC_ROCKET)
 	  {
         VehPhysForce_RotAxisAngle(
 			&inst->matrix,
@@ -380,7 +380,7 @@ LAB_800adc08:;
 			(
 				(
 					(instDef->ptrInstance != 0) &&
-					(instDef->modelID == 0x70)
+					(instDef->modelID == STATIC_TEETH)
 				)
 			)
 		)
@@ -418,7 +418,7 @@ LAB_800adc08:;
 	if (hitInst == 0)
 	{
 	  // instance -> model -> modelID is not bomb
-	  if (modelID != 0x3b) {
+	  if (modelID != DYNAMIC_BOMB) {
 LAB_800ae440:
         if (tw->frameCount_DontHurtParent != 0)
 			tw->frameCount_DontHurtParent--;
@@ -445,7 +445,7 @@ LAB_800adc08:;
 	  else
 	  {
 		// not a missile
-        if (hitInst->model->id != 0x29)
+        if (hitInst->model->id != DYNAMIC_ROCKET)
 		{
 		  // quit, warpball collisions dont matter
           return;