Achievement Fix-ups (#1)

* Add `BossDefeated` event to final bowser

* Add new hooks

* actual achievement work; clang

* fix star counts for getting total stars when determining achievements

* implemented racing achievement

* clang

* implemented metal cap achievement; added save support for metal cap (+ coins); (mostly) stick with event Mario state instead of `gMarioState`; added color support for achievement histograms; clang

Author: stratomaster64

src/engine/level_script.c

@@ -705,6 +705,7 @@ static void level_cmd_set_music(void) {
         gAreas[sCurrAreaIndex].musicParam = CMD_GET(s16, 2);
         gAreas[sCurrAreaIndex].musicParam2 = CMD_GET(s16, 4);
     }
+    CALL_EVENT(MusicChanged, gAreas[sCurrAreaIndex].musicParam2);
     sCurrentCmd = CMD_NEXT;
 }
 

src/game/behaviors/bowser.inc.c

@@ -1322,20 +1322,22 @@ s32 bowser_dead_final_stage_ending(void) {
         } else {
             dialogID = DIALOG_163;
         }
-        // Lower music volume
-        if (o->oBowserTimer == 0) {
-            seq_player_lower_volume(SEQ_PLAYER_LEVEL, 60, 40);
-            o->oBowserTimer++;
-        }
-        // Play Bowser defeated dialog
-        if (cur_obj_update_dialog(MARIO_DIALOG_LOOK_UP,
-            (DIALOG_FLAG_TEXT_DEFAULT | DIALOG_FLAG_TIME_STOP_ENABLED), dialogID, 0)) {
-            // Dialog is done, fade out music and spawn grand star
-            cur_obj_set_model(MODEL_BOWSER_NO_SHADOW);
-            seq_player_unlower_volume(SEQ_PLAYER_LEVEL, 60);
-            seq_player_fade_out(SEQ_PLAYER_LEVEL, 1);
-            bowser_spawn_collectable();
-            o->oBowserTimer++;
+        CALL_CANCELLABLE_EVENT(BossDefeated, o, BOSS_TYPE_BOWSER_BITS) {
+            // Lower music volume
+            if (o->oBowserTimer == 0) {
+                seq_player_lower_volume(SEQ_PLAYER_LEVEL, 60, 40);
+                o->oBowserTimer++;
+            }
+            // Play Bowser defeated dialog
+            if (cur_obj_update_dialog(MARIO_DIALOG_LOOK_UP,
+                (DIALOG_FLAG_TEXT_DEFAULT | DIALOG_FLAG_TIME_STOP_ENABLED), dialogID, 0)) {
+                // Dialog is done, fade out music and spawn grand star
+                cur_obj_set_model(MODEL_BOWSER_NO_SHADOW);
+                seq_player_unlower_volume(SEQ_PLAYER_LEVEL, 60);
+                seq_player_fade_out(SEQ_PLAYER_LEVEL, 1);
+                bowser_spawn_collectable();
+                o->oBowserTimer++;
+            }
         }
     // Slowly fade him out
     } else if (o->oOpacity > 4) {

src/game/level_update.c

@@ -1330,5 +1330,6 @@ s32 lvl_set_current_level(UNUSED s16 arg0, s32 levelNum) {
  */
 s32 lvl_play_the_end_screen_sound(UNUSED s16 arg0, UNUSED s32 arg1) {
     play_sound(SOUND_MENU_THANK_YOU_PLAYING_MY_GAME, gGlobalSoundSource);
+    CALL_EVENT(GameEnded);
     return 1;
 }

src/port/Engine.cpp

@@ -918,7 +918,7 @@ void GameEngine::AudioInit() {
     }
 
     for (auto& sequence : *sequences_files) {
-        if(sequence.find(".m64") != std::string::npos) {
+        if (sequence.find(".m64") != std::string::npos) {
             continue;
         }
         auto path = "__OTR__" + sequence;

src/port/data/SaveConversion.h

@@ -61,6 +61,8 @@ inline void to_json(json& j, const AchievementSaveEntry& entry) {
 
 inline void from_json(const json& j, AchievementSaveData& data) {
     data.cheated = j.at("cheated").get<bool>();
+    data.capStars = j.at("capStars").get<int>();
+    data.coins = j.at("coins").get<int>();
 
     auto entriesJson = j.at("entries");
     for (size_t i = 0; i < entriesJson.size(); i++) {
@@ -76,6 +78,8 @@ inline void to_json(json& j, const AchievementSaveData& data) {
 
     j = json{
         { "cheated", data.cheated },
+        { "capStars",data.capStars },
+        { "coins", data.coins },
         { "entries", entriesJson }
     };
 }

src/port/hooks/list/GameEvent.h

@@ -59,4 +59,10 @@ DEFINE_EVENT(SpawnCollectible,
 DEFINE_EVENT(BossBattleStarted, 
     BossBattleType type;
 );
-DEFINE_EVENT(BossBattleEnded);
+DEFINE_EVENT(BossBattleEnded);
+
+DEFINE_EVENT(MusicChanged,
+    s16 seqId;
+);
+
+DEFINE_EVENT(GameEnded);

src/port/importer/AudioSequenceFactory.cpp

@@ -35,19 +35,18 @@ SM64::AudioSequenceFactoryV0::ReadResource(std::shared_ptr<Ship::File> file,
     return bank;
 }
 
-
 std::shared_ptr<Ship::IResource>
 SM64::AudioSequenceXMLFactoryV0::ReadResource(std::shared_ptr<Ship::File> file,
-                                           std::shared_ptr<Ship::ResourceInitData> initData) {
+                                              std::shared_ptr<Ship::ResourceInitData> initData) {
     if (!FileHasValidFormatAndReader(file, initData)) {
         return nullptr;
     }
 
     std::shared_ptr<AudioSequence> seq = std::make_shared<AudioSequence>(initData);
-    auto child =
-        std::get<std::shared_ptr<tinyxml2::XMLDocument>>(file->Reader)->FirstChildElement();
+    auto child = std::get<std::shared_ptr<tinyxml2::XMLDocument>>(file->Reader)->FirstChildElement();
 
-    auto m64File = Ship::Context::GetInstance()->GetResourceManager()->GetArchiveManager()->LoadFile(child->Attribute("Path"));
+    auto m64File =
+        Ship::Context::GetInstance()->GetResourceManager()->GetArchiveManager()->LoadFile(child->Attribute("Path"));
 
     tinyxml2::XMLElement* banksRoot = child->FirstChildElement("Banks");
     tinyxml2::XMLElement* banks = banksRoot->FirstChildElement();
@@ -58,8 +57,8 @@ SM64::AudioSequenceXMLFactoryV0::ReadResource(std::shared_ptr<Ship::File> file,
     }
 
     // Copy m64 to sampleData
-    for(size_t i = 0; i < m64File->Buffer->size(); i++) {
-        seq->sampleData.push_back((uint8_t) m64File->Buffer->at(i));
+    for (size_t i = 0; i < m64File->Buffer->size(); i++) {
+        seq->sampleData.push_back((uint8_t)m64File->Buffer->at(i));
     }
 
     seq->mData.id = child->IntAttribute("ID");

src/port/mods/PortEnhancements.cpp

@@ -137,6 +137,8 @@ void PortEnhancements_Register() {
     REGISTER_EVENT(SpawnCollectible);
     REGISTER_EVENT(BossBattleStarted);
     REGISTER_EVENT(BossBattleEnded);
+    REGISTER_EVENT(MusicChanged);
+    REGISTER_EVENT(GameEnded);
 
     Rando::Init();
     LoadGuiTextures();