api & team badge

Author: BlueWitherer

CMakeLists.txt

@@ -12,7 +12,9 @@ project(AvalancheIndex VERSION 1.2.2)
 
 file(GLOB_RECURSE SOURCES CONFIGURE_DEPENDS src/*.cpp incl/*.cpp)
 add_library(${PROJECT_NAME} SHARED ${SOURCES})
-target_include_directories(AvalancheIndex PRIVATE ${CMAKE_SOURCE_DIR})
+
+target_include_directories(AvalancheIndex PUBLIC ${CMAKE_SOURCE_DIR}/incl)
+target_include_directories(AvalancheIndex PRIVATE ${CMAKE_SOURCE_DIR}/src)
 
 if(NOT DEFINED ENV{GEODE_SDK})
     message(FATAL_ERROR "Unable to find Geode SDK! Please define GEODE_SDK environment variable to point to Geode")

changelog.md

@@ -4,7 +4,7 @@
 #### Changes
 - **Added** team member name in Badge information pop-up
 - **Fixed** team data cache handling from API requests
-- Minor code cleanup
+- Major code cleanup
 
 #### Developers
 - **Tweaked** constructors for `Profile` and `Project` classes

incl/Avalanche.hpp

@@ -12,7 +12,6 @@
 #include <Geode/Geode.hpp>
 
 #include <Geode/utils/web.hpp>
-#include <Geode/utils/terminate.hpp>
 
 using namespace geode::prelude;
 using namespace matjson;
@@ -50,7 +49,7 @@ namespace avalanche { // Avalanche Index mod namespace
 
             // Node IDs for badges
             namespace Nodes {
-                inline constexpr auto None = "";
+                inline constexpr auto None = "none"_spr;
                 inline constexpr auto Cubic = "cubic-studios-badge"_spr;
                 inline constexpr auto Director = "director-badge"_spr;
                 inline constexpr auto Manager = "team-manager-badge"_spr;
@@ -60,7 +59,7 @@ namespace avalanche { // Avalanche Index mod namespace
 
             // Sprite IDs for badges
             namespace Sprites {
-                inline constexpr auto None = "";
+                inline constexpr auto None = "no-badge"_spr;
                 inline constexpr auto Cubic = "cubic-studios.png"_spr;
                 inline constexpr auto Director = "director.png"_spr;
                 inline constexpr auto Manager = "team-manager.png"_spr;
@@ -84,6 +83,7 @@ namespace avalanche { // Avalanche Index mod namespace
 
     // Avalanche member profile class
     struct Profile {
+        // The type of Avalanche badge
         enum class Badge {
             NONE, // No badge
             CUBIC, // Staff of Cubic Studios
@@ -106,6 +106,7 @@ namespace avalanche { // Avalanche Index mod namespace
 
     // Avalanche project level class
     struct Project {
+        // The type of Avalanche project
         enum class Type {
             NONE, // Not a project
             SOLO, // A project that a member worked on by themself
@@ -184,98 +185,42 @@ namespace avalanche { // Avalanche Index mod namespace
             static constexpr const char* toString(Project::Type type);
         };
 
-        // Fetch all remote data on badges and levels, automatically checks "Fetch Data Once" setting
+        /**
+         * Fetch all remote data on badges and levels, automatically checks "Fetch Data Once" setting
+         */
         static void scanAll();
 
-        // Get profile data on a player
-        static Profile GetProfile(
-            int id // The player's account ID
-        );
-        // Get project data on a level
-        static Project GetProject(
-            int id // The level's ID
-        );
-
-        // Check if the profile belongs to a team member
+        /**
+         * Get profile data on a player
+         *
+         * @param id The player's account ID
+         *
+         * @returns The player's team profile data
+         */
+        static Profile GetProfile(int id);
+
+        /**
+         * Get project data on a level
+         *
+         * @param id The level's ID
+         *
+         * @returns The level's team project data
+         */
+        static Project GetProject(int id);
+
+        /**
+         * Check if the profile belongs to a team member
+         *
+         * @param badge The team member's badge type
+         *
+         * @returns Whether this member is actually a part of Avalanche
+         */
         static bool isTeamMember(Profile::Badge badge);
 
         // Get the comment text color for a certain badge type
         static ccColor3B getCommentColor(Profile::Badge badge);
 
-        static void getBadgeInfo(Profile::Badge badge, CCString* name);
-        void onInfoBadge(CCObject* sender);
-
-        // Create badge and format comment for a player
-        template <typename T>
-        void createBadge(
-            T pointer, // Parent class
-            Profile profile, // Member's profile object
-            CCMenu* cell_menu, // Username menu to add the badge to
-            TextArea* cmntText = nullptr, // Comment text node
-            CCLabelBMFont* cmntFont = nullptr, // Comment font node
-            float size = 0.625f // Scale of the badge sprite
-        ) {
-            log::debug("Creating badge for {}...", profile.name);
-            auto idString = Handler::Badges::getBadgeID(profile.badge); // gets the string equivalent
-
-            if (idString) {
-                // get the badge item
-                auto badge = Handler::Badges::fromBadgeID(std::string(idString));
-
-                if (cell_menu == nullptr) {
-                    log::debug("No username menu provided");
-                } else {
-                    log::debug("Found username menu for {}...", profile.name);
-
-                    try {
-                        // prevent dupes
-                        if (auto alreadyBadge = cell_menu->getChildByID(idString)) alreadyBadge->removeMeAndCleanup();
-
-                        auto newBadge = Handler::Badges::getSpriteName(badge); // gets sprite filename
-
-                        CCSprite* badgeBtnSprite = CCSprite::createWithSpriteFrameName(newBadge);
-                        badgeBtnSprite->setScale(size);
-
-                        CCMenuItemSpriteExtra* badgeBtn = CCMenuItemSpriteExtra::create(
-                            badgeBtnSprite,
-                            pointer,
-                            menu_selector(Handler::onInfoBadge));
-                        badgeBtn->setID(idString);
-                        badgeBtn->setZOrder(1);
-
-                        badgeBtn->setUserObject("profile"_spr, CCString::create(profile.name));
-
-                        cell_menu->addChild(badgeBtn);
-                        cell_menu->updateLayout();
-                    } catch (std::exception& e) {
-                        log::error("Failed to create badge for {}...", profile.name);
-                    };
-
-                    log::info("Finished creating badge for {}", profile.name);
-                };
-
-                if (cmntText == nullptr && cmntFont == nullptr) {
-                    log::debug("No comment text node provided");
-                } else {
-                    log::debug("Found comment text node for {}...", profile.name);
-                    auto col = Handler::Badges::getBadgeColor(badge);
-
-                    if (cmntText) {
-                        cmntText->colorAllCharactersTo(col);
-                        cmntText->setOpacity(255);
-                    } else if (cmntFont) {
-                        cmntFont->setColor(col);
-                        cmntFont->setOpacity(255);
-                    } else {
-                        log::error("No comment text node found");
-                    };
-
-                    log::info("Finished changing comment text color for {}", profile.name);
-                };
-            } else {
-                log::error("Badge is invalid.");
-            };
-        };
+        static void getBadgeInfo(Profile::Badge badge, std::string name);
     };
 };
 

incl/src/Avalanche.cpp

@@ -209,7 +209,7 @@ namespace avalanche {
         if (id > 0) {
             log::info("Fetching profile of ID {}", id);
 
-            auto cacheKey = fmt::format("cache-badge-p{}", (int)id); // format the save key string
+            auto cacheKey = fmt::format("cache-badge-p{}", id); // format the save key string
             Value cacheStd = AVAL_MOD->getSavedValue<Value>(cacheKey, Value()); // gets locally saved badge json
 
             if (AVAL_MOD->getSettingValue<bool>("web-once")) { // only fetch from cached web data if this setting is on
@@ -228,7 +228,7 @@ namespace avalanche {
             };
 
             if (cacheStd.isNull()) {
-                log::error("Player {} is no longer associated with Avalanche", (int)id);
+                log::error("Player {} is no longer associated with Avalanche", id);
                 return Profile();
             } else {
                 log::debug("Processing cache for player {}", id);
@@ -243,7 +243,7 @@ namespace avalanche {
                 return res;
             };
         } else {
-            log::error("Profile ID {} is invalid", (int)id);
+            log::error("Profile ID {} is invalid", id);
             return Profile();
         };
     };
@@ -252,7 +252,7 @@ namespace avalanche {
         if (id > 0) {
             log::info("Fetching project of ID {}", id);
 
-            auto cacheKey = fmt::format("cache-level-p{}", (int)id); // format the save key string
+            auto cacheKey = fmt::format("cache-level-p{}", id); // format the save key string
             Value cacheStd = AVAL_MOD->getSavedValue<Value>(cacheKey, Value()); // gets locally saved level json
 
             if (AVAL_MOD->getSettingValue<bool>("web-once")) { // only fetch from cached web data if this setting is on
@@ -324,7 +324,7 @@ namespace avalanche {
         return Handler::Badges::getBadgeColor(badge);
     };
 
-    void Handler::getBadgeInfo(Profile::Badge badge, CCString* name) {
+    void Handler::getBadgeInfo(Profile::Badge badge, std::string name) {
         auto title = "Oops!";
         auto description = "This badge has <cr>no available information</c>. This is likely unintentional, please report it as an issue in the mod's repository.";
         auto button = "Learn More";
@@ -333,27 +333,27 @@ namespace avalanche {
         switch (badge) {
         case Profile::Badge::CUBIC:
             title = "Cubic Studios";
-            description = fmt::format("<cg>{}</c> is a <cy>staff member</c> of <cj>Cubic Studios</c>. They partake in the activities of a department of Cubic, and may supervise or join projects such as <cl>Avalanche</c>.", name->getCString()).c_str();
+            description = fmt::format("<cg>{}</c> is a <cy>staff member</c> of <cj>Cubic Studios</c>. They partake in the activities of a department of Cubic, and may supervise or join projects such as <cl>Avalanche</c>.", name).c_str();
             break;
 
         case Profile::Badge::DIRECTOR:
             title = "Avalanche Director";
-            description = fmt::format("<cg>{}</c> is the <co>director</c> of <cl>Avalanche</c>. They run the whole team.", name->getCString()).c_str();
+            description = fmt::format("<cg>{}</c> is the <co>director</c> of <cl>Avalanche</c>. They run the whole team.", name).c_str();
             break;
 
         case Profile::Badge::MANAGER:
             title = "Avalanche Manager";
-            description = fmt::format("<cg>{}</c> is a <cy>manager</c> of <cl>Avalanche</c>. They manage team projects and collaborations.", name->getCString()).c_str();
+            description = fmt::format("<cg>{}</c> is a <cy>manager</c> of <cl>Avalanche</c>. They manage team projects and collaborations.", name).c_str();
             break;
 
         case Profile::Badge::MEMBER:
             title = "Avalanche Team Member";
-            description = fmt::format("<cg>{}</c> is a <cg>member</c> of <cl>Avalanche</c>. They partake in team projects and collaborations.", name->getCString()).c_str();
+            description = fmt::format("<cg>{}</c> is a <cg>member</c> of <cl>Avalanche</c>. They partake in team projects and collaborations.", name).c_str();
             break;
 
         case Profile::Badge::COLLABORATOR:
             title = "Team Collaborator";
-            description = fmt::format("<cg>{}</c> is a <cg>collaborator</c> of <cl>Avalanche</c>. They've directly worked on the crew's or team's projects as an outsider.", name->getCString()).c_str();
+            description = fmt::format("<cg>{}</c> is a <cg>collaborator</c> of <cl>Avalanche</c>. They've directly worked on the crew's or team's projects as an outsider.", name).c_str();
             break;
 
         default:
@@ -370,15 +370,4 @@ namespace avalanche {
                 if (btn2) web::openLinkInBrowser(url);
             }, true);
     };
-
-    // badge button event
-    void Handler::onInfoBadge(CCObject* sender) {
-        // gets the node that triggered the function
-        auto ptr = static_cast<CCMenuItemSpriteExtra*>(sender);
-
-        auto badge = Handler::Badges::fromBadgeID(ptr->getID());
-        auto name = static_cast<CCString*>(ptr->getUserObject("profile"_spr));
-
-        Handler::getBadgeInfo(badge, name);
-    };
 };

mod.json

@@ -23,7 +23,7 @@
 		"community": "https://www.dsc.gg/cubic"
 	},
 	"issues": {
-		"info": "You may report any significant issues you experience with this mod in the AvalancheIndex repository.",
+		"info": "You may report any significant issues you experience with this mod to us at the AvalancheIndex repository.",
 		"url": "https://www.github.com/CubicCommunity/AvalancheIndex/issues/"
 	},
 	"dependencies": {

src/BadgeHelper.hpp

@@ -0,0 +1,90 @@
+#include <Debugger.hpp>
+
+#include <Avalanche.hpp>
+
+#include "./headers/TeamBadgeItem.hpp"
+
+#include <Geode/Geode.hpp>
+
+using namespace geode::prelude;
+using namespace avalanche;
+
+class BadgeHelper {
+public:
+    // Get the BadgeHelper functions
+    static BadgeHelper* get() {
+        static BadgeHelper ptr;
+        return &ptr;
+    };
+
+    /**
+         * Create badge and format comment for a player
+         *
+         * @param profile Member's profile object
+         * @param cell_menu Username menu to add the badge to
+         * @param cmntText Comment text node
+         * @param cmntFont Comment font node
+         * @param size Scale of the badge sprite
+         */
+    void createBadge(
+        Profile profile,
+        CCMenu* cell_menu,
+        TextArea* cmntText = nullptr,
+        CCLabelBMFont* cmntFont = nullptr,
+        float size = 0.625f
+    ) {
+        AVAL_LOG_DEBUG("Creating badge for {}...", profile.name);
+        auto idString = Handler::Badges::getBadgeID(profile.badge); // gets the string equivalent
+
+        if (idString) {
+            // get the badge item
+            auto badge = Handler::Badges::fromBadgeID(std::string(idString));
+
+            if (cell_menu == nullptr) {
+                AVAL_LOG_DEBUG("No username menu provided");
+            } else {
+                AVAL_LOG_DEBUG("Found username menu for {}...", profile.name);
+
+                try {
+                    // prevent dupes
+                    if (auto alreadyBadge = cell_menu->getChildByID(idString)) alreadyBadge->removeMeAndCleanup();
+
+                    auto newBadge = Handler::Badges::getSpriteName(badge); // gets sprite filename
+
+                    CCSprite* badgeBtnSprite = CCSprite::createWithSpriteFrameName(newBadge);
+                    badgeBtnSprite->setScale(size);
+
+                    CCMenuItemSpriteExtra* badgeBtn = TeamBadgeItem::create(profile, size);
+
+                    cell_menu->addChild(badgeBtn);
+                    cell_menu->updateLayout();
+                } catch (std::exception& e) {
+                    AVAL_LOG_ERROR("Failed to create badge for {}...", profile.name);
+                };
+
+                AVAL_LOG_INFO("Finished creating badge for {}", profile.name);
+            };
+
+            if (cmntText == nullptr && cmntFont == nullptr) {
+                AVAL_LOG_DEBUG("No comment text node provided");
+            } else {
+                AVAL_LOG_DEBUG("Found comment text node for {}...", profile.name);
+                auto col = Handler::Badges::getBadgeColor(badge);
+
+                if (cmntText) {
+                    cmntText->colorAllCharactersTo(col);
+                    cmntText->setOpacity(255);
+                } else if (cmntFont) {
+                    cmntFont->setColor(col);
+                    cmntFont->setOpacity(255);
+                } else {
+                    AVAL_LOG_ERROR("No comment text node found");
+                };
+
+                AVAL_LOG_INFO("Finished changing comment text color for {}", profile.name);
+            };
+        } else {
+            AVAL_LOG_ERROR("Badge is invalid.");
+        };
+    };
+};

src/Debugger.hpp

@@ -1,5 +1,5 @@
 #pragma once
-#include <incl/Avalanche.hpp>
+#include <Avalanche.hpp>
 
 using namespace avalanche;