Bodyprog: trim suffixes

Author: Sezzary

configs/JAP0/sym.bodyprog.txt

@@ -380,9 +380,9 @@ Fs_CharaAnimBoneInfoUpdate                   = 0x8003536C; // type:func
 //--- PA: 0x0108F0   VA: 0x80035450   subsegment: c, game_boot/background_sound_init
 //----------------------------------------------------------------------------------
 Bgm_Init                                     = 0x80035450; // type:func
-Bgm_IsCurrentBgmTargetCheck                  = 0x80035578; // type:func
+Bgm_ActiveBgmTrackCheck                  = 0x80035578; // type:func
 Bgm_TrackSet                                 = 0x800355AC; // type:func
-Bgm_BgmChannelSet                            = 0x800355F4; // type:func
+Bgm_ChannelSet                            = 0x800355F4; // type:func
 func_8003596C                                = 0x8003563C; // type:func
 Sd_AmbientSfxInit                            = 0x8003566C; // type:func
 Sd_IsCurrentAmbientTargetCheck               = 0x80035780; // type:func

configs/JAP1/sym.bodyprog.txt

@@ -438,9 +438,9 @@ Fs_CharaAnimBoneInfoUpdate                   = 0x80035410; // type:func
 //--- PA: 0x010994   VA: 0x800354F4   subsegment: c, game_boot/background_sound_init
 //----------------------------------------------------------------------------------
 Bgm_Init                                     = 0x800354F4; // type:func
-Bgm_IsCurrentBgmTargetCheck                  = 0x8003561C; // type:func
+Bgm_ActiveBgmTrackCheck                  = 0x8003561C; // type:func
 Bgm_TrackSet                                 = 0x80035650; // type:func
-Bgm_BgmChannelSet                            = 0x80035698; // type:func
+Bgm_ChannelSet                            = 0x80035698; // type:func
 func_8003596C                                = 0x800356E0; // type:func
 Sd_AmbientSfxInit                            = 0x80035710; // type:func
 Sd_IsCurrentAmbientTargetCheck               = 0x80035824; // type:func

configs/USA/sym.bodyprog.txt

@@ -256,9 +256,9 @@ Fs_CharaAnimBoneInfoUpdate                   = 0x8003569C; // type:func
 //--- PA: 0x010C20   VA: 0x80035780   subsegment: c, game_boot/background_sound_init
 //----------------------------------------------------------------------------------
 Bgm_Init                                     = 0x80035780; // type:func
-Bgm_IsCurrentBgmTargetCheck                  = 0x800358A8; // type:func
+Bgm_ActiveBgmTrackCheck                  = 0x800358A8; // type:func
 Bgm_TrackSet                                 = 0x800358DC; // type:func
-Bgm_BgmChannelSet                            = 0x80035924; // type:func
+Bgm_ChannelSet                            = 0x80035924; // type:func
 func_8003596C                                = 0x8003596C; // type:func
 Sd_AmbientSfxInit                            = 0x8003599C; // type:func
 Sd_IsCurrentAmbientTargetCheck               = 0x80035AB0; // type:func

include/bodyprog/bodyprog.h

@@ -1197,7 +1197,7 @@ typedef struct _WaterZone
 
 typedef struct
 {
-    u8            charaId_0;  /** `e_CharacterId` */
+    u8            charaId;  /** `e_CharacterId` */
     u8            isLoaded_1; /** `bool` */
     // 2 bytes of padding.
     s32           queueIdx_4;

include/bodyprog/demo.h

@@ -25,7 +25,7 @@ typedef enum _DemoState
 /** @brief Initial demo game state data, stored inside `MISC/DEMO****.DAT` files. */
 typedef struct _DemoWork
 {
-    s_SaveUserConfig config_0;
+    s_SaveUserConfig config;
     u8               unk_38[200];
     s_Savegame       savegame_100;
     u8               unk_37C[1148];
@@ -38,7 +38,7 @@ STATIC_ASSERT_SIZEOF(s_DemoWork, 2048);
 typedef struct _DemoFrameData
 {
     s_AnalogController analogController_0;
-    s8                 gameStateExpected_8; /** Expected value of `g_GameWork.gameState_594` before `analogController_0` is processed, if it doesn't match `Demo_Update` will display `STEP ERROR` and stop reading demo. */
+    s8                 gameStateExpected_8; /** Expected value of `g_GameWork.gameState` before `analogController_0` is processed, if it doesn't match `Demo_Update` will display `STEP ERROR` and stop reading demo. */
     u8                 videoPresentInterval_9;
     s8                 unk_A[2];
     u32                randSeed_C;

include/bodyprog/game_boot/background_sound_init.h

@@ -1,21 +1,25 @@
-#ifndef _BODYPROG_GAMEBOOT_BACKGROUND_SOUND_INIT_H
-#define _BODYPROG_GAMEBOOT_BACKGROUND_SOUND_INIT_H
+#ifndef _BODYPROG_GAMEBOOT_BACKGROUNDSOUNDINIT_H
+#define _BODYPROG_GAMEBOOT_BACKGROUNDSOUNDINIT_H
 
 s32 Bgm_Init(void);
 
-/** @brief Checks if currently assigned song is the same as target. */
-bool Bgm_IsCurrentBgmTargetCheck(s32 bgmIdx);
+/** @brief Checks if a given background music track is not currently playing.
+ *
+ * @param bgmIdx Index of the background music track to check.
+ * @return `true` if the given track is not currently playing, `false` otherwise.
+ */
+bool Bgm_ActiveBgmTrackCheck(s32 bgmIdx);
 
 void Bgm_TrackSet(s32 bgmIdx);
 
 /** Executes sound command. */
-void Bgm_BgmChannelSet(void);
+void Bgm_ChannelSet(void);
 
 void func_8003596C(void);
 
 bool Sd_AmbientSfxInit(void);
 
-bool Sd_IsCurrentAmbientTargetCheck(s32 ambIdx);
+bool Sd_IsCurrentAmbientTargetCheck(s32 ambientIdx);
 
 void Sd_AmbientSfxSet(s32 idx);
 

include/bodyprog/game_boot/game_load.h

@@ -5,7 +5,7 @@
 
 void Anim_CharaTypeAnimInfoClear(void);
 
-/** Handles `g_GameWork.gameStateStep_598[0]`.
+/** Handles `g_GameWork.gameStateSteps[0]`.
  * Used to handle map loading and room changes.
  */
 void GameBoot_GameStartup(void);

include/bodyprog/memcard.h

@@ -290,7 +290,7 @@ STATIC_ASSERT_SIZEOF(s_Savegame_Container, 640);
 /** @brief Contains `s_SaveUserConfig` data padded to 128 bytes with a footer at the end containing checksum + magic. */
 typedef struct _SaveUserConfigContainer
 {
-    s_SaveUserConfig config_0;
+    s_SaveUserConfig config;
     u8                pad_38[68];
     s_Savegame_Footer footer_7C;
 } s_Savegame_UserConfigs;

include/game.h

@@ -487,15 +487,15 @@ typedef enum _PaperMapIdx
 // Temp name. Related to music.
 typedef enum _SysFlags
 {
-    SysFlag_None   = 0,
-    SysFlag_Freeze = 1 << 0,
-    SysFlag_1      = 1 << 1,
-    SysFlag_2      = 1 << 2,
-    SysFlag_3      = 1 << 3,
-    SysFlag_4      = 1 << 4,
-    SysFlag_5      = 1 << 5,
-    SysFlag_6      = 1 << 6,
-    SysFlag_Mute   = 1 << 7
+    SysFlag_None  = 0,
+    SysFlag_Pause = 1 << 0,
+    SysFlag_1     = 1 << 1,
+    SysFlag_2     = 1 << 2,
+    SysFlag_3     = 1 << 3,
+    SysFlag_4     = 1 << 4,
+    SysFlag_5     = 1 << 5,
+    SysFlag_6     = 1 << 6,
+    SysFlag_Mute  = 1 << 7
 } e_SysFlags;
 
 // Temp name.
@@ -1141,7 +1141,7 @@ STATIC_ASSERT_SIZEOF(s_EventData, 12);
 
 typedef struct _SaveUserConfig
 {
-    s_ControllerConfig controllerConfig_0;
+    s_ControllerConfig controllerConfig;
     s8                 optScreenPosX_1C;          /** Range: [-11, 11], default: 0. */
     s8                 optScreenPosY_1D;          /** Range: [-8, 8], default: 0. */
     u8                 optSoundType_1E;           /** `bool` | Stereo: `false`, Monaural: `true`, default: Stereo. */
@@ -1152,7 +1152,7 @@ typedef struct _SaveUserConfig
     u8                 optExtraWeaponCtrl_23;     /** `bool` | Switch: `false`, Press: `true`, default: Press. */
     u8                 optExtraBloodColor_24;     /** `e_BloodColor` | Default: Normal. */
     s8                 optAutoLoad_25;            /** `bool` | Off: `false`, On: `true`, default: Off. */
-    u8                 unk_26;
+    u8                 unk_26; // Padding.
     u8                 optExtraOptionsEnabled_27; /** Holds unlocked option flags. */
     s8                 optExtraViewCtrl_28;       /** `bool` | Normal: `false`, Reverse: `true`, default: Normal. */
     s8                 optExtraViewMode_29;       /** `bool` | Normal: `false`, Self View: `true`, default: Normal. */
@@ -1166,36 +1166,35 @@ typedef struct _SaveUserConfig
 } s_SaveUserConfig;
 STATIC_ASSERT_SIZEOF(s_SaveUserConfig, 56);
 
-/** @brief Game workspace. Stores miscellaneous gameplay-related data.
- */
+/** @brief Game workspace. Stores miscellaneous gameplay-related data. */
 typedef struct _GameWork
 {
-    s_SaveUserConfig   config_0;
-    s_ControllerData   controllers_38[CONTROLLER_COUNT_MAX];
-    s_Savegame         autosave_90;
-    s_Savegame         savegame_30C;
-    u16                gsScreenWidth_588;
-    u16                gsScreenHeight_58A;
-    s_PrimColor        background2dColor_58C;
-    e_GameState        gameStatePrev_590;
-    e_GameState        gameState_594;
-    s32                gameStateStep_598[3]; /** Temp data used by current `gameState`. Can be another state ID or other data.
-                                              * This states could be sub-states for specific events of individual screens
-                                              * because of the way it's normally used in menus. For example: in the settings
-                                              * screen, [0] is used to define what option the player has selected, and [1] is used
-                                              * during specific settings screens, such as the position screen or the brightness screen.
-                                              *
-                                              * [2] is likely rarely used or maybe only used during maps.
-                                              */
-    s8                 unk_5A4[4];
-    s32                field_5A8;
-    s32                field_5AC;
-    s8                 unk_5B0;
-    s8                 mapAnimIdx_5B1;
-    s8                 bgmTrackIdx_5B2; /** `BgmTrackIdx` | Currently player background music track. */
-    s8                 ambientIdx_5B4;  // Index of `g_AmbientVabTaskLoadCmds`.
-    s_AnalogController rawController_5B4;
-    s8                 unused_5BC[28];  // @unused Debug data?
+    /* 0x0   */ s_SaveUserConfig   config;
+    /* 0x38  */ s_ControllerData   controllers[CONTROLLER_COUNT_MAX];
+    /* 0x90  */ s_Savegame         autosave;
+    /* 0x30C */ s_Savegame         savegame;
+    /* 0x588 */ u16                gsScreenWidth;
+    /* 0x58A */ u16                gsScreenHeight;
+    /* 0x58C */ s_PrimColor        background2dColor;
+    /* 0x590 */ e_GameState        gameStatePrev;
+    /* 0x594 */ e_GameState        gameState;
+    /* 0x598 */ s32                gameStateSteps[3]; /** Sub-state steps used by the current `gameState`. Can other state IDs or data.
+                                                       * This states could be sub-states for specific events of individual screens
+                                                       * because of the way it's normally used in menus. For example: in the settings
+                                                       * screen, [0] is used to define what option the player has selected, and [1] is used
+                                                       * during specific settings screens, such as the position screen or the brightness screen.
+                                                       *
+                                                       * [2] is likely rarely used or maybe only used during maps.
+                                                       */
+    /* 0x5A4 */ s8                 unk_5A4[4];        // Padding?
+    /* 0x5A8 */ s32                field_5A8;
+    /* 0x5AC */ s32                field_5AC;
+    /* 0x5B0 */ s8                 unk_5B0;           // Padding?
+    /* 0x5B1 */ s8                 mapAnimIdx;
+    /* 0x5B2 */ s8                 bgmIdx;            /** `BgmTrackIdx` | Currently player background music track. */
+    /* 0x5B4 */ s8                 ambientIdx;        /** Index of `g_AmbientVabTaskLoadCmds`. */
+    /* 0x5B4 */ s_AnalogController rawController;
+    /* 0x5BC */ s8                 unused_5BC[28];    // @unused Debug data?
 } s_GameWork;
 STATIC_ASSERT_SIZEOF(s_GameWork, 1496);
 
@@ -1236,7 +1235,7 @@ STATIC_ASSERT_SIZEOF(s_ModelAnim, 20);
 /** @brief Character model. */
 typedef struct _Model
 {
-    /* 0x0 */ s8          charaId_0;      /** `e_CharacterId` TODO: Trim suffix. Not yet as another struct has the same field. */
+    /* 0x0 */ s8          charaId;      /** `e_CharacterId` */
     /* 0x1 */ u8          paletteIdx;   /** Changes the texture palette index for this model. */
     /* 0x2 */ u8          controlState; /** Active character control state. */
     /* 0x3 */ u8          stateStep;    // Step number or temp data for the current `controlState`? In `s_PlayerExtra` always 1, set to 0 for 1 tick when anim state appears to change.
@@ -2103,21 +2102,21 @@ static inline void Game_StateSetNext_ClearStateSteps(e_GameState gameState)
 {
     e_GameState prevState;
 
-    prevState = g_GameWork.gameState_594;
+    prevState = g_GameWork.gameState;
 
-    g_GameWork.gameState_594        = gameState;
+    g_GameWork.gameState        = gameState;
     g_SysWork.counters_1C[0]              = 0;
     g_SysWork.counters_1C[1]              = 0;
-    g_GameWork.gameStateStep_598[1] = 0;
-    g_GameWork.gameStateStep_598[2] = 0;
+    g_GameWork.gameStateSteps[1] = 0;
+    g_GameWork.gameStateSteps[2] = 0;
 
     SysWork_StateSetNext(SysState_Gameplay);
 
-    g_GameWork.gameStateStep_598[1] = 0;
-    g_GameWork.gameStateStep_598[2] = 0;
-    g_GameWork.gameStateStep_598[0] = prevState;
-    g_GameWork.gameStatePrev_590    = prevState;
-    g_GameWork.gameStateStep_598[0] = 0;
+    g_GameWork.gameStateSteps[1] = 0;
+    g_GameWork.gameStateSteps[2] = 0;
+    g_GameWork.gameStateSteps[0] = prevState;
+    g_GameWork.gameStatePrev    = prevState;
+    g_GameWork.gameStateSteps[0] = 0;
 }
 
 /** @brief Sets the GameState to be used in the next game update.
@@ -2127,19 +2126,19 @@ static inline void Game_StateSetNext(e_GameState gameState)
 {
     e_GameState prevState;
 
-    prevState = g_GameWork.gameState_594;
+    prevState = g_GameWork.gameState;
 
-    g_GameWork.gameState_594        = gameState;
+    g_GameWork.gameState        = gameState;
     g_SysWork.counters_1C[0]              = 0;
     g_SysWork.counters_1C[1]              = 0;
-    g_GameWork.gameStateStep_598[1] = 0;
-    g_GameWork.gameStateStep_598[2] = 0;
+    g_GameWork.gameStateSteps[1] = 0;
+    g_GameWork.gameStateSteps[2] = 0;
 
     SysWork_StateSetNext(SysState_Gameplay);
 
-    g_GameWork.gameStateStep_598[0] = prevState;
-    g_GameWork.gameStatePrev_590    = prevState;
-    g_GameWork.gameStateStep_598[0] = 0;
+    g_GameWork.gameStateSteps[0] = prevState;
+    g_GameWork.gameStatePrev    = prevState;
+    g_GameWork.gameStateSteps[0] = 0;
 }
 
 /** @brief Returns the GameState to the previously used state.
@@ -2149,19 +2148,19 @@ static inline void Game_StateSetPrevious()
 {
     e_GameState prevState;
 
-    prevState = g_GameWork.gameState_594;
+    prevState = g_GameWork.gameState;
 
     g_SysWork.counters_1C[0]              = 0;
     g_SysWork.counters_1C[1]              = 0;
-    g_GameWork.gameStateStep_598[1] = 0;
-    g_GameWork.gameStateStep_598[2] = 0;
+    g_GameWork.gameStateSteps[1] = 0;
+    g_GameWork.gameStateSteps[2] = 0;
 
     SysWork_StateSetNext(SysState_Gameplay);
 
-    g_GameWork.gameStateStep_598[0] = prevState;
-    g_GameWork.gameState_594        = g_GameWork.gameStatePrev_590;
-    g_GameWork.gameStatePrev_590    = prevState;
-    g_GameWork.gameStateStep_598[0] = 0;
+    g_GameWork.gameStateSteps[0] = prevState;
+    g_GameWork.gameState        = g_GameWork.gameStatePrev;
+    g_GameWork.gameStatePrev    = prevState;
+    g_GameWork.gameStateSteps[0] = 0;
 }
 
 /** @brief Gets an event flag state from the savegame event flags array.

include/maps/shared/Map_RoomBgmInit_0_s02_CondFalse.h

@@ -60,7 +60,7 @@ void Map_RoomBgmInit_CondFalse(void)
             break;
 
         case 18:
-            layerLimits = g_GameWork.bgmTrackIdx_5B2 == 7 ? sharedData_800CFB34_0_s02 : sharedData_800CFB3C_0_s02;
+            layerLimits = g_GameWork.bgmIdx == 7 ? sharedData_800CFB34_0_s02 : sharedData_800CFB3C_0_s02;
 
             if (Savegame_EventFlagGet(EventFlag_379))
             {
@@ -92,7 +92,7 @@ void Map_RoomBgmInit_CondFalse(void)
         case 7:
         case 8:
         case 9:
-            if (g_GameWork.bgmTrackIdx_5B2 == 34)
+            if (g_GameWork.bgmIdx == 34)
             {
                 if (Savegame_EventFlagGet(EventFlag_391))
                 {
@@ -122,7 +122,7 @@ void Map_RoomBgmInit_CondFalse(void)
 
         case 19:
         case 20:
-            if (g_GameWork.bgmTrackIdx_5B2 == 23)
+            if (g_GameWork.bgmIdx == 23)
             {
                 layerLimits = sharedData_800CFB4C_0_s02;
                 fadeSpeed   = Q12(0.25f);