map_header: Use camelCase

Also changes a couple things: * map_no -> mapId * .location_type -> .mapType
2026-05-15 15:40:13 -05:00 · 2024-12-15 21:27:58 -06:00 · 2024-12-15 21:27:58 -06:00 · 3c8686f2fd
commit 3c8686f2fd
parent 65ac5957cc
3 changed files with 11503 additions and 11503 deletions
--- a/include/map_header.h
+++ b/include/map_header.h
@ -10,72 +10,72 @@
 #define MAP_FOLLOWMODE_ALLOW           2

 typedef struct MapHeader {
-    u8 wild_encounter_bank;  // fielddata/encountdata/[gs]_enc_data.naix
-    u8 area_data_bank;       // fielddata/areadata/area_data.naix
-    u16 move_model_bank : 4; // fielddata/mm_list/move_model_list.naix
-    u16 world_map_x : 6;
-    u16 world_map_y : 6;
-    u16 matrix_id;          // fielddata/mapmatrix/map_matrix.naix
-    u16 scripts_bank;       // fielddata/script/scr_seq_release.naix
-    u16 script_header_bank; // fielddata/script/scr_seq_release.naix
-    u16 msg_bank;           // msgdata/msg.naix
-    u16 day_music_id;       // data/sound/gs_sound_data.sdat
-    u16 night_music_id;     // data/sound/gs_sound_data.sdat
-    u16 events_bank;        // fielddata/eventdata/zone_event_release.naix
+    u8 wildEncounterBank;  // fielddata/encountdata/[gs]_enc_data.naix
+    u8 areaDataBank;       // fielddata/areadata/area_data.naix
+    u16 moveModelBank : 4; // fielddata/mm_list/move_model_list.naix
+    u16 worldMapX : 6;
+    u16 worldMapY : 6;
+    u16 matrixId;         // fielddata/mapmatrix/map_matrix.naix
+    u16 scriptsBank;      // fielddata/script/scr_seq_release.naix
+    u16 scriptHeaderBank; // fielddata/script/scr_seq_release.naix
+    u16 msgBank;          // msgdata/msg.naix
+    u16 dayMusicId;       // data/sound/gs_sound_data.sdat
+    u16 nightMusicId;     // data/sound/gs_sound_data.sdat
+    u16 eventsBank;       // fielddata/eventdata/zone_event_release.naix
    u16 mapsec : 8;
-    u16 area_icon : 4;
+    u16 areaIcon : 4;
    u16 unk_12_C : 4;
-    u32 is_kanto : 1;
+    u32 isKanto : 1;
    u32 weather : 7;
-    u32 location_type : 4;
-    u32 camera_type : 6;
-    u32 follow_mode : 2;
-    u32 battle_bg : 5;
-    u32 bike_allowed : 1;
+    u32 mapType : 4;
+    u32 cameraType : 6;
+    u32 followMode : 2;
+    u32 battleBg : 5;
+    u32 bikeAllowed : 1;
    u32 unk_14_1A : 1; // unused running flag?
-    u32 escape_rope_allowed : 1;
-    u32 fly_allowed : 1;
+    u32 escapeRopeAllowed : 1;
+    u32 flyAllowed : 1;
    u32 unk_14_1D : 1;
    u32 unk_14_1E : 1;
    u32 unk_14_1F : 1;
 } MapHeader;

-u8 MapHeader_GetAreaDataBank(u32 map_no);
-u16 MapHeader_GetMoveModelBank(u32 map_no);
-u16 MapHeader_GetMatrixId(u32 map_no);
-u16 MapHeader_GetMsgBank(u32 map_no);
-u16 MapHeader_GetScriptsBank(u32 map_no);
-u16 MapHeader_GetScriptHeaderBank(u32 map_no);
-u16 MapHeader_GetDayMusicId(u32 map_no);
-u16 MapHeader_GetNightMusicId(u32 map_no);
-BOOL MapHeader_HasWildEncounters(u32 map_no);
-u8 MapHeader_GetWildEncounterBank(u32 map_no);
-u16 MapHeader_GetEventsBank(u32 map_no);
-u16 MapHeader_GetMapSec(u32 map_no);
-u8 MapHeader_GetAreaIcon(u32 map_no);
-u8 MapHeader_GetMomCallIntroParam(u32 map_no);
-BOOL MapHeader_IsKanto(u32 map_no);
-u32 MapHeader_GetWeatherType(u32 map_no);
-u32 MapHeader_GetCameraType(u32 map_no);
-BattleBg MapHeader_GetBattleBg(u32 map_no);
-BOOL MapHeader_IsEscapeRopeAllowed(u32 map_no);
-BOOL MapHeader_IsFlyAllowed(u32 map_no);
-BOOL MapHeader_IsBikeAllowed(u32 map_no);
-BOOL MapHeader_GetField14_1D(u32 map_no);
-BOOL MapHeader_GetField14_1E(u32 map_no);
-BOOL MapHeader_GetField14_1F(u32 map_no);
-u32 MapHeader_GetMapType(u32 map_no);
-u8 MapHeader_GetFollowMode(u32 map_no);
-void MapHeader_GetWorldMapCoords(u32 map_no, s16 *x, s16 *y);
-BOOL MapHeader_IsOutdoors(u32 map_no);
-BOOL MapHeader_MapIsOnMainMatrix(u32 map_no);
-BOOL MapHeader_IsCave(u32 map_no);
-BOOL sub_0203B58C(u32 map_no);
-BOOL sub_0203B5AC(u32 map_no);
-BOOL MapHeader_MapIsUnionRoom(u32 map_no);
-BOOL MapHeader_MapIsAmitySquare(u32 map_no);
-BOOL MapHeader_MapIsPokemonCenter(u32 map_no);
-BOOL MapHeader_MapIsPokemonLeagueLobby(u32 map_no);
-u16 MapHeader_GetMapEvolutionMethod(u32 map_no);
+u8 MapHeader_GetAreaDataBank(u32 mapId);
+u16 MapHeader_GetMoveModelBank(u32 mapId);
+u16 MapHeader_GetMatrixId(u32 mapId);
+u16 MapHeader_GetMsgBank(u32 mapId);
+u16 MapHeader_GetScriptsBank(u32 mapId);
+u16 MapHeader_GetScriptHeaderBank(u32 mapId);
+u16 MapHeader_GetDayMusicId(u32 mapId);
+u16 MapHeader_GetNightMusicId(u32 mapId);
+BOOL MapHeader_HasWildEncounters(u32 mapId);
+u8 MapHeader_GetWildEncounterBank(u32 mapId);
+u16 MapHeader_GetEventsBank(u32 mapId);
+u16 MapHeader_GetMapSec(u32 mapId);
+u8 MapHeader_GetAreaIcon(u32 mapId);
+u8 MapHeader_GetMomCallIntroParam(u32 mapId);
+BOOL MapHeader_IsKanto(u32 mapId);
+u32 MapHeader_GetWeatherType(u32 mapId);
+u32 MapHeader_GetCameraType(u32 mapId);
+BattleBg MapHeader_GetBattleBg(u32 mapId);
+BOOL MapHeader_IsEscapeRopeAllowed(u32 mapId);
+BOOL MapHeader_IsFlyAllowed(u32 mapId);
+BOOL MapHeader_IsBikeAllowed(u32 mapId);
+BOOL MapHeader_GetField14_1D(u32 mapId);
+BOOL MapHeader_GetField14_1E(u32 mapId);
+BOOL MapHeader_GetField14_1F(u32 mapId);
+u32 MapHeader_GetMapType(u32 mapId);
+u8 MapHeader_GetFollowMode(u32 mapId);
+void MapHeader_GetWorldMapCoords(u32 mapId, s16 *x, s16 *y);
+BOOL MapHeader_IsOutdoors(u32 mapId);
+BOOL MapHeader_MapIsOnMainMatrix(u32 mapId);
+BOOL MapHeader_IsCave(u32 mapId);
+BOOL sub_0203B58C(u32 mapId);
+BOOL sub_0203B5AC(u32 mapId);
+BOOL MapHeader_MapIsUnionRoom(u32 mapId);
+BOOL MapHeader_MapIsAmitySquare(u32 mapId);
+BOOL MapHeader_MapIsPokemonCenter(u32 mapId);
+BOOL MapHeader_MapIsPokemonLeagueLobby(u32 mapId);
+u16 MapHeader_GetMapEvolutionMethod(u32 mapId);

 #endif // POKEHEARTGOLD_MAP_HEADER_H
--- a/src/data/map_headers.h
+++ b/src/data/map_headers.h
--- a/src/map_header.c
+++ b/src/map_header.c
@ -46,188 +46,188 @@ static const u16 sPokemonCenterMaps[] = {

 #include "data/map_headers.h"

-static u32 MapNumberBoundsCheck(u32 map_no) {
-    if (map_no >= NELEMS(sMapHeaders)) {
+static u32 MapNumberBoundsCheck(u32 mapId) {
+    if (mapId >= NELEMS(sMapHeaders)) {
        GF_ASSERT(FALSE);
-        map_no = MAP_NOTHING;
+        mapId = MAP_NOTHING;
    }

-    return map_no;
+    return mapId;
 }

-u8 MapHeader_GetAreaDataBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].area_data_bank;
+u8 MapHeader_GetAreaDataBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].areaDataBank;
 }

-u16 MapHeader_GetMoveModelBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].move_model_bank;
+u16 MapHeader_GetMoveModelBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].moveModelBank;
 }

-u16 MapHeader_GetMatrixId(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].matrix_id;
+u16 MapHeader_GetMatrixId(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].matrixId;
 }

-u16 MapHeader_GetMsgBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].msg_bank;
+u16 MapHeader_GetMsgBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].msgBank;
 }

-u16 MapHeader_GetScriptsBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].scripts_bank;
+u16 MapHeader_GetScriptsBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].scriptsBank;
 }

-u16 MapHeader_GetScriptHeaderBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].script_header_bank;
+u16 MapHeader_GetScriptHeaderBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].scriptHeaderBank;
 }

-u16 MapHeader_GetDayMusicId(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].day_music_id;
+u16 MapHeader_GetDayMusicId(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].dayMusicId;
 }

-u16 MapHeader_GetNightMusicId(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].night_music_id;
+u16 MapHeader_GetNightMusicId(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].nightMusicId;
 }

-BOOL MapHeader_HasWildEncounters(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].wild_encounter_bank != ENCDATA_NA;
+BOOL MapHeader_HasWildEncounters(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].wildEncounterBank != ENCDATA_NA;
 }

-u8 MapHeader_GetWildEncounterBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].wild_encounter_bank;
+u8 MapHeader_GetWildEncounterBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].wildEncounterBank;
 }

-u16 MapHeader_GetEventsBank(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].events_bank;
+u16 MapHeader_GetEventsBank(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].eventsBank;
 }

-u16 MapHeader_GetMapSec(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].mapsec;
+u16 MapHeader_GetMapSec(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].mapsec;
 }

-u8 MapHeader_GetAreaIcon(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].area_icon;
+u8 MapHeader_GetAreaIcon(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].areaIcon;
 }

-u8 MapHeader_GetMomCallIntroParam(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].unk_12_C;
+u8 MapHeader_GetMomCallIntroParam(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].unk_12_C;
 }

-BOOL MapHeader_IsKanto(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].is_kanto;
+BOOL MapHeader_IsKanto(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].isKanto;
 }

-u32 MapHeader_GetWeatherType(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].weather;
+u32 MapHeader_GetWeatherType(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].weather;
 }

-u32 MapHeader_GetCameraType(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].camera_type;
+u32 MapHeader_GetCameraType(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].cameraType;
 }

-BattleBg MapHeader_GetBattleBg(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return (BattleBg)sMapHeaders[map_no].battle_bg;
+BattleBg MapHeader_GetBattleBg(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return (BattleBg)sMapHeaders[mapId].battleBg;
 }

-BOOL MapHeader_IsEscapeRopeAllowed(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].escape_rope_allowed;
+BOOL MapHeader_IsEscapeRopeAllowed(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].escapeRopeAllowed;
 }

-BOOL MapHeader_IsFlyAllowed(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].fly_allowed;
+BOOL MapHeader_IsFlyAllowed(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].flyAllowed;
 }

-BOOL MapHeader_IsBikeAllowed(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].bike_allowed;
+BOOL MapHeader_IsBikeAllowed(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].bikeAllowed;
 }

-BOOL MapHeader_GetField14_1D(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].unk_14_1D;
+BOOL MapHeader_GetField14_1D(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].unk_14_1D;
 }

-BOOL MapHeader_GetField14_1E(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].unk_14_1E;
+BOOL MapHeader_GetField14_1E(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].unk_14_1E;
 }

-BOOL MapHeader_GetField14_1F(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].unk_14_1F;
+BOOL MapHeader_GetField14_1F(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].unk_14_1F;
 }

-u32 MapHeader_GetMapType(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].location_type;
+u32 MapHeader_GetMapType(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].mapType;
 }

-u8 MapHeader_GetFollowMode(u32 map_no) {
-    map_no = MapNumberBoundsCheck(map_no);
-    return sMapHeaders[map_no].follow_mode;
+u8 MapHeader_GetFollowMode(u32 mapId) {
+    mapId = MapNumberBoundsCheck(mapId);
+    return sMapHeaders[mapId].followMode;
 }

-void MapHeader_GetWorldMapCoords(u32 map_no, s16 *x, s16 *y) {
-    map_no = MapNumberBoundsCheck(map_no);
+void MapHeader_GetWorldMapCoords(u32 mapId, s16 *x, s16 *y) {
+    mapId = MapNumberBoundsCheck(mapId);

-    *x = sMapHeaders[map_no].world_map_x;
-    *y = sMapHeaders[map_no].world_map_y;
+    *x = sMapHeaders[mapId].worldMapX;
+    *y = sMapHeaders[mapId].worldMapY;
 }

-BOOL MapHeader_IsOutdoors(u32 map_no) {
-    if (MapHeader_IsFlyAllowed(map_no) == FALSE) {
+BOOL MapHeader_IsOutdoors(u32 mapId) {
+    if (MapHeader_IsFlyAllowed(mapId) == FALSE) {
        return FALSE;
    }

-    return MapHeader_GetMapType(map_no) != 1;
+    return MapHeader_GetMapType(mapId) != 1;
 }

-BOOL MapHeader_MapIsOnMainMatrix(u32 map_no) {
-    return MapHeader_GetMatrixId(map_no) == NARC_map_matrix_map_matrix_0000_EVERYWHERE_bin;
+BOOL MapHeader_MapIsOnMainMatrix(u32 mapId) {
+    return MapHeader_GetMatrixId(mapId) == NARC_map_matrix_map_matrix_0000_EVERYWHERE_bin;
 }

-BOOL MapHeader_IsCave(u32 map_no) {
-    return MapHeader_GetMapType(map_no) == 3;
+BOOL MapHeader_IsCave(u32 mapId) {
+    return MapHeader_GetMapType(mapId) == 3;
 }

-BOOL sub_0203B58C(u32 map_no) {
-    return MapHeader_GetMapType(map_no) == 4 || MapHeader_GetMapType(map_no) == 5;
+BOOL sub_0203B58C(u32 mapId) {
+    return MapHeader_GetMapType(mapId) == 4 || MapHeader_GetMapType(mapId) == 5;
 }

-BOOL sub_0203B5AC(u32 map_no) {
-    return MapHeader_GetMapType(map_no) == 1 || MapHeader_GetMapType(map_no) == 2;
+BOOL sub_0203B5AC(u32 mapId) {
+    return MapHeader_GetMapType(mapId) == 1 || MapHeader_GetMapType(mapId) == 2;
 }

-BOOL MapHeader_MapIsUnionRoom(u32 map_no) {
-    return map_no == MAP_UNION;
+BOOL MapHeader_MapIsUnionRoom(u32 mapId) {
+    return mapId == MAP_UNION;
 }

-BOOL MapHeader_MapIsAmitySquare(u32 map_no) {
+BOOL MapHeader_MapIsAmitySquare(u32 mapId) {
    // Leftover from D/P/Pl.
    return FALSE;
 }

-BOOL MapHeader_MapIsPokemonCenter(u32 map_no) {
+BOOL MapHeader_MapIsPokemonCenter(u32 mapId) {
    for (s32 i = 0; i < (s32)NELEMS(sPokemonCenterMaps); i++) {
-        if (map_no == sPokemonCenterMaps[i]) {
+        if (mapId == sPokemonCenterMaps[i]) {
            return TRUE;
        }
    }
@ -235,11 +235,11 @@ BOOL MapHeader_MapIsPokemonCenter(u32 map_no) {
    return FALSE;
 }

-BOOL MapHeader_MapIsPokemonLeagueLobby(u32 map_no) {
-    return map_no == MAP_T10R0101;
+BOOL MapHeader_MapIsPokemonLeagueLobby(u32 mapId) {
+    return mapId == MAP_T10R0101;
 }

-u16 MapHeader_GetMapEvolutionMethod(u32 map_no) {
+u16 MapHeader_GetMapEvolutionMethod(u32 mapId) {
    // Leftover from D/P/Pl.
    return 0;
 }