Merge branch 'document/sandcastle' into 'master'

Document the rest of TTC

See merge request banjo.decomp/banjo-kazooie!99

src/core2/ch/bottlesbonus.c

@@ -19,7 +19,7 @@ extern void func_803458E4(f32[4], f32[4], f32[4], f32);
 #define CH_BOTTLES_BONUS_PUZZLE_PIECE_COUNT (CH_BOTTLES_BONUS_PUZZLE_HEIGHT * CH_BOTTLES_BONUS_PUZZLE_WIDTH)
 
 /* .extern symbols??? */
-extern u8 D_8037DCC0[7];
+extern u8 gCompletedBottleBonusGames[7];
 extern u8 D_8037DCC7;
 extern u8 D_8037DCC8;
 extern u8 D_8037DCC9;
@@ -422,7 +422,7 @@ void chBottlesBonus_completedPuzzle(void) {
     Actor *actor;
 
     actor = marker_getActor(chBottlesBonusMarker);
-    D_8037DCC0[chBottleBonusPuzzleIndex] = TRUE;
+    gCompletedBottleBonusGames[chBottleBonusPuzzleIndex] = TRUE;
     func_80311714(0);
     gcdialog_showText(D_803681A0[chBottleBonusPuzzleIndex + 1].text_id, 0x86, actor->position, chBottlesBonusMarker, chBottlesBonus_IncrementPuzzle, NULL);
     func_80311714(1);
@@ -600,7 +600,7 @@ Actor *chBottlesBonus_new(s32 position[3], s32 yaw, ActorInfo *actor_info, u32 f
 void chBottlesBonus_func_802DEB80(void) {
     int i;
     for(i = 0; i < 7; i++){
-        D_8037DCC0[i] = 0;
+        gCompletedBottleBonusGames[i] = 0;
     }
     D_8037DCC7 = 0;
     D_8037DCC8 = 0;

src/core2/ch/crab.c

@@ -39,7 +39,7 @@ void __chCrab_802CB040(Actor *this) {
 void __chCrab_802CB078(Actor *this) {
     u32 temp_t9;
 
-    if ((this->modelCacheIndex != ACTOR_F2_BLACK_SNIPPET) || func_8038B550()) {
+    if ((this->modelCacheIndex != ACTOR_F2_BLACK_SNIPPET) || code3E30_hasBanjoKazooieCodeBeenEntered()) {
         temp_t9 = (u32) this->unk38_31 >> 0x16;
         if (this->unk38_31 != 0) {
             this->unk38_31--;
@@ -159,7 +159,7 @@ bool __chCrab_802CB76C(ActorMarker *marker, ActorMarker *other) {
     Actor *this;
 
     this = marker_getActor(marker);
-    if ((this->modelCacheIndex == ACTOR_F2_BLACK_SNIPPET) && !func_8038B550()) {
+    if ((this->modelCacheIndex == ACTOR_F2_BLACK_SNIPPET) && !code3E30_hasBanjoKazooieCodeBeenEntered()) {
         return FALSE;
     }
     return TRUE;

src/core2/ch/gameSelect.c

@@ -83,7 +83,7 @@ s32 mm_hut_smash_count;
 u32 CH_TREASUREHUNT_PUZZLE_CURRENT_STEP;
 struct FF_StorageStruct* D_8037DCB8;
 s32 D_8037DCBC;
-u8 D_8037DCC0[7];
+u8 gCompletedBottleBonusGames[7]; // bottle bonus puzzle?
 u8 D_8037DCC7;
 u8 D_8037DCC8;
 u8 D_8037DCC9;

src/core2/code_4C020.c

@@ -361,6 +361,7 @@ void func_802D3CC8(ActorMarker *marker){
     func_802D31AC(marker, NULL);
 }
 
+// used as init function
 void func_802D3CE8(Actor *this){
     if(!this->initialized){
         marker_setCollisionScripts(this->marker, NULL, func_802D3138, func_802D31AC);
@@ -373,6 +374,7 @@ void func_802D3D54(Actor *this){
     func_802D3CE8(this);
 }
 
+// used as init function
 void func_802D3D74(Actor *this){
     this->marker->propPtr->unk8_3 = TRUE;
     actor_collisionOff(this);

src/core2/code_73640.c

@@ -89,7 +89,7 @@ ItemPrint D_803692F8[0x2C] = {
 /* .bss */
 s32 D_803810B0;
 f32 itemPrintValues[0x2C]; //item_print_value
-s32 D_80381168[0x2C]; //comusic_e
+s32 D_80381168[0x2C]; // item_e => comusic_e
 f32 D_80381218[0x2C]; //item_sfx_volume???
 s32 D_803812C8[0x2C]; //comusic_e
 s32 D_80381378[0x2C]; //sfx_e

src/core2/code_956B0.c

@@ -231,8 +231,9 @@ void func_8031CE70(f32 *arg0, enum map_e arg1, s32 arg2) {
     }
 }
 
-void func_8031D04C(enum map_e arg0, s32 arg1) {
-    func_8031CB50(arg0, arg1, 0);
+// set map and exit id?
+void func_8031D04C(enum map_e arg0, s32 exit_id) {
+    func_8031CB50(arg0, exit_id, 0);
 }
 
 void func_8031D06C(enum map_e arg0, s32 arg1) {

src/core2/code_9B990.c

@@ -208,15 +208,15 @@ void func_80322B3C(s32 arg0, s32 arg1){ return; }
 void __overlay_ttc_draw(Gfx **gfx, Mtx **mtx, Vtx **vtx){ return; }
 
 void __overlay_ttc_release(void){
-    func_8038B04C();
+    code3E30_overlayRelease();
 }
 
 void overlay_ttc_init(void){
-    func_8038B094();
+    code3E30_overlayInit();
 }
 
 void __overlay_ttc_update(void){
-    func_8038B2F0();
+    code3E30_overlayUpdate();
 }
 
 void func_80322BB8(s32 arg0, s32 arg1){ return; }

src/core2/code_AD5B0.c

@@ -321,7 +321,7 @@ s32 func_80334ECC(void) {
             phi_v1 = 0x1F;
         }
         if (((phi_v1 & phi_v0) == 3) && (overlayManagergetLoadedId() == OVERLAY_5_BEACH)) {
-            if ((ttc_func_8038BF8C() == 0) || (D_80370250 != 0)) {
+            if ((code_3E30_isSecretCheatCodeRelatedValueEqualToScrambledAddressValue() == FALSE) || (D_80370250 != 0)) {
                 D_80370250 = (u8)1;
                 for (phi_v0 = 0; phi_v0 != 0x8F0D180; phi_v0++){
                 }

src/core2/code_CF3E0.c

@@ -128,7 +128,7 @@ void volatileFlag_setAndTriggerDialog_4(enum volatile_flags_e arg0) {
     volatileFlag_setAndTriggerDialog(arg0, 4);
 }
 
-// called for WISHYWASHYBANJO dialog
+// called for WISHYWASHYBANJO dialog, mumbo jumbo speaking?
 void volatileFlag_setAndTriggerDialog_E(enum volatile_flags_e arg0) {
     volatileFlag_setAndTriggerDialog(arg0, 0xE);
 }

src/core2/spawnqueue.c

@@ -374,7 +374,7 @@ void spawnQueue_reset(void){
             GV_func_8038F154();
             break;
         case OVERLAY_5_BEACH:
-            TTC_resetSpawnableActors();
+            code26D0_resetSpawnableActorsForTTC();
             break;
         case OVERLAY_6_JUNGLE:
             MM_func_803888B0();