v1.0.4 - custom buttons and more

Author: GDColon

README.md

@@ -98,6 +98,7 @@ Default keybind is HOME
 - `button` (string or Button) - Button 1, defaults to "OK"
 - `button2` (string or Button) - Button 2, if you want one
     - Button 2 is also the "cancel" button for "comment" and "mod" types
+- `customButtons` (array of Buttons) - Adds additional custom buttons. You probably want to provide x and y values for them
 - `width` (float) - Width of the popup, default is 350 (normal popup type only)
 - `background` (string, int, or [filename](#texture-files-can-be-read-from)) - Background color of the popup
     - Main ones are brown, blue, green, purple, grey, lightgrey, transparent (GJ_square0#.png)
@@ -114,6 +115,7 @@ Default keybind is HOME
 - `width` (float) - Custom width for the button
 - `height` (float) - Maybe you wanna change the height too idk
 - `x`, `y` (float) - Custom positioning for the button (0, 0 is the middle of the button row)
+- `z` (int) - Z order for the button. Buttons with a higher Z order will be placed in front of others
 - `scale` (float) - Scale factor for the whole button
 - `onClick` ([Callback](#callbacks)) - Spawns something when the button is clicked
 - `pulse` (object) - Enables size pulsing for the button
@@ -154,7 +156,6 @@ Extra properties exclusive to icon/shop type:
 
 **Extra properties exclusive to mod type:**
 - `platformer` (bool) - Use moons instead of stars
-- This popup actually DOES function but I hardcoded it to use Generation Retro
 
 Advanced example:
 ```json

changelog.md

@@ -1,3 +1,12 @@
+# 1.0.4
+- Added `customButtons` property for popups which allows you to add more buttons
+- Added `z` property for popup buttons which modify Z ordering
+- Added an option to spawn the queued textbox when you die in a level
+- Added options to rebind the Shift and Alt modifier keys
+- SHIFT+ESC keybind now also cancels queued textboxes
+- Changed "mod" popup's submit button to not actually go through
+- Fixed crash when button `texture` property is a nonexistent file (and also made it check more locations)
+
 # 1.0.3
 - `Sound` object now supports an array of sounds to randomly choose from
 - Improved error popup (now shows location of JSON errors)

mod.json

@@ -6,7 +6,7 @@
 	},
 	"id": "colon.customtextboxes",
 	"name": "Custom Textboxes",
-	"version": "v1.0.3",
+	"version": "v1.0.4",
 	"developer": "Colon",
 	"description": "Display custom popups, chests, and more",
 	"resources": {
@@ -24,13 +24,13 @@
 		"key_popup": {
 			"type": "custom:keybind",
 			"name": "Popup keybind",
-			"description": "Press this key to spawn the popup defined in <cy>custom_popups.json</c>\n\n<cg>Shift + this key</c> will queue the popup\n<cg>Alt + this key</c> will spawn the secondary one.",
+			"description": "Press this key to spawn the popup defined in <cy>custom_popups.json</c>\n\n<cg>Shift + this key</c> will queue the popup\n<cg>Alt + this key</c> will spawn the secondary one.\n<cl>(these modifier keys can be changed below)</c>",
 			"default": 36
 		},
 		"key_dialogue": {
 			"type": "custom:keybind",
 			"name": "Dialogue keybind",
-			"description": "Press this key to spawn the dialogue box defined in <cy>custom_dialogues.json</c>\n\n<cg>Shift + this key</c> will queue the dialogue\n<cg>Alt + this key</c> will spawn the secondary one.",
+			"description": "Press this key to spawn the dialogue box defined in <cy>custom_dialogues.json</c>\n\n<cg>Shift + this key</c> will queue the dialogue\n<cg>Alt + this key</c> will spawn the secondary one.\n<cl>(these modifier keys can be changed below)</c>",
 			"default": 33
 		},
 		"key_chest": {
@@ -52,6 +52,28 @@
             "description": "Plays a sound effect when a textbox is successfully queued up (by holding SHIFT)",
             "type": "bool",
 			"default": false
-        }
+        },
+		"onDeath": {
+            "name": "Spawn queued on death",
+            "description": "Also spawns the queued textbox when you die in-game. Why not.",
+            "type": "bool",
+			"default": false
+        },
+
+		"shiftRebind": {
+			"name": "Queue modifier key",
+			"description": "Spawning a textbox while holding this key will queue it up instead, making it appear the next time you click a menu button.",
+			"type": "string",
+			"one-of": ["Shift", "Alt", "Ctrl", "Command", "None"],
+			"default": "Shift"
+		},
+
+		"altRebind": {
+			"name": "Alt modifier key",
+			"description": "Spawning a textbox while holding this key will spawn the alt one instead, using the <cy>to-show-alt</c> JSON key.",
+			"type": "string",
+			"one-of": ["Shift", "Alt", "Ctrl", "Command", "None"],
+			"default": "Alt"
+		}
 	}
 }

src/CustomAlert.cpp

@@ -47,8 +47,7 @@ void CustomAlert::showPopup(std::string id)
         }
 
         if (hasButton) {
-            auto okContainer = iconLayer->getChildByType<CCMenu>(0);
-            auto okParent = okContainer->getChildByType<CCMenuItemSpriteExtra>(0);
+            auto okParent = popup->m_buttonMenu->getChildByType<CCMenuItemSpriteExtra>(0);
             customizeButton(okParent, popup, button1, "OK");
         }
 
@@ -58,6 +57,8 @@ void CustomAlert::showPopup(std::string id)
 
         setBorder(popup->m_mainLayer, data);
 
+        setupCustomButtons(popup, data);
+
         customizeIcon(iconLayer->getChildByType<GJItemIcon>(0)->m_player, data);
 
         popup->show();
@@ -92,14 +93,16 @@ void CustomAlert::showPopup(std::string id)
 
 
         // Buttons
-        CCMenu* buttonMenu = purchaseLayer->getChildByType<CCMenu>(0);
+        CCMenu* buttonMenu = popup->m_buttonMenu;
         if (hasButton) customizeButton(buttonMenu->getChildByType<CCMenuItemSpriteExtra>(1), popup, button1, "Buy");
         if (data.contains("button2")) customizeButton(buttonMenu->getChildByType<CCMenuItemSpriteExtra>(0), popup, data["button2"], "Cancel");
 
         if (data.contains("customTexture")) setupCustomTexture(purchaseLayer, data);
 
         createCloseButton(popup, data, {-124, 87});
 
+        setupCustomButtons(popup, data);
+
         customizeIcon(purchaseLayer->getChildByType<GJItemIcon>(0)->m_player, data);
 
         popup->show();
@@ -123,7 +126,11 @@ void CustomAlert::showPopup(std::string id)
         popup->setID("custom_modpopup"_spr);
         popup->show();
 
+        popup->m_submitButton->setTarget(popup, menu_selector(RateStarsLayer::onClose));
+
         if (hasButton) customizeButton(popup->m_submitButton, popup, button1, "Submit");
+
+        setupCustomButtons(popup, data);
     }
 
 
@@ -148,6 +155,8 @@ void CustomAlert::showPopup(std::string id)
 
         if (hasButton) customizeButton(comment->m_buttonMenu->getChildByType<CCMenuItemSpriteExtra>(-1), comment, button1, "");
         if (data.contains("button2")) customizeButton(comment->m_buttonMenu->getChildByType<CCMenuItemSpriteExtra>(-2), comment, data["button2"], "");
+
+        setupCustomButtons(comment, data);
     }
 
 
@@ -181,6 +190,8 @@ void CustomAlert::showPopup(std::string id)
 
         if (hasButton) customizeButton(popup->m_buttonMenu->getChildByType<CCMenuItemSpriteExtra>(0), popup, button1, "OK");
         if (data.contains("button2")) customizeButton(popup->m_buttonMenu->getChildByType<CCMenuItemSpriteExtra>(1), popup, data["button2"], "Cancel");
+
+        setupCustomButtons(popup, data);
     }
 }
 
@@ -247,6 +258,8 @@ void customizeButton(CCMenuItemSpriteExtra* buttonBase, CCObject* parent, matjso
     CCLabelBMFont* label = button->getChildByType<CCLabelBMFont>(0);
     if (!label) return;
 
+    CCScale9Sprite* slice = button->getChildByType<CCScale9Sprite>(0);
+
     if (fallback == "") fallback = label->m_sInitialStringUTF8;
     std::string str = getText(data, fallback);
 
@@ -255,8 +268,9 @@ void customizeButton(CCMenuItemSpriteExtra* buttonBase, CCObject* parent, matjso
 
     // ====== //
 
-    if (data.contains("texture")) {
-        button->updateBGImage(getStr(data, "texture").c_str());
+    if (slice && data.contains("texture")) {
+        auto customTexture = getCustomTexture(getStr(data, "texture").c_str(), "GJ_button_06.png", true);
+        set9SpriteFrame(slice, customTexture);  // button->updateBGImage() is very prone to crashes
     }
 
     else if (data.contains("background")) {
@@ -281,7 +295,6 @@ void customizeButton(CCMenuItemSpriteExtra* buttonBase, CCObject* parent, matjso
     float w = getNum(data, "width", std::clamp(label->getContentWidth() + 14.0f, size.width, 150.0f));
     float h = getNum(data, "height", size.height);
 
-    CCScale9Sprite* slice = button->getChildByType<CCScale9Sprite>(0);
     if (slice && (w != size.width || h != size.height)) {
         buttonBase->setContentSize({w, h});
         label->setPositionX(w / 2.0f);
@@ -296,6 +309,7 @@ void customizeButton(CCMenuItemSpriteExtra* buttonBase, CCObject* parent, matjso
 
     if (data.contains("x") && data["x"].isNumber()) buttonBase->setPositionX(getNum(data, "x", 0.0f));
     if (data.contains("y") && data["y"].isNumber()) buttonBase->setPositionY(getNum(data, "y", 0.0f));
+    if (data.contains("z") && data["z"].isNumber()) buttonBase->setZOrder(getInt(data, "z", 0));
 
     if (data.contains("pulse")) {
         auto pulseData = data["pulse"];
@@ -376,4 +390,33 @@ void setupCustomTexture(CCLayer* layer, matjson::Value data) {
     customSprite->setPosition(iconImg->getPosition());
     customSprite->setScale(scale);
     layer->addChild(customSprite);
+}
+
+void setupCustomButtons(FLAlertLayer* layer, matjson::Value data) {
+    if (!data.contains("extraButtons")) return;
+    auto dat = data["extraButtons"];
+
+    if (dat.isObject()) createExtraButton(layer, dat);
+
+    else if (dat.isArray()) {
+        auto arr = dat.asArray().unwrap();
+        for (auto b : arr) {
+            createExtraButton(layer, b);
+        }
+    }
+}
+
+void createExtraButton(FLAlertLayer* layer, matjson::Value data) {
+    // just create a default button sprite and change the properties in customizeButton()
+    // can probably improve on this later but it works for now
+
+    auto msg = getText(data, "OK");
+    auto bSprite = ButtonSprite::create(msg.c_str());
+    if (!bSprite) return;
+
+    auto bItem = CCMenuItemExt::createSpriteExtra(bSprite, [layer](auto) { layer->keyBackClicked(); });
+    bItem->setID("custom_button"_spr);
+
+    customizeButton(bItem, layer, data, msg);
+    layer->m_buttonMenu->addChild(bItem);
 }

src/CustomAlert.hpp

@@ -38,6 +38,9 @@ void createCloseButton(FLAlertLayer* parent, matjson::Value data, CCPoint positi
 void customizeButton(CCMenuItemSpriteExtra* button, CCObject* parent, matjson::Value data, std::string fallback);
 void customizeIcon(CCSprite* icon, matjson::Value data);
 
+void setupCustomButtons(FLAlertLayer* layer, matjson::Value data);
+void createExtraButton(FLAlertLayer* layer, matjson::Value data);
+
 void setupCustomTexture(CCLayer* layer, matjson::Value data);
 
 inline std::map<std::string, int> BUTTON_COLORS = {

src/main.cpp

@@ -2,6 +2,7 @@
 #include <Geode/modify/CCMenuItemSpriteExtra.hpp>
 #include <Geode/modify/CCKeyboardDispatcher.hpp>
 #include <Geode/modify/DialogLayer.hpp>
+#include <Geode/modify/PlayLayer.hpp>
 
 #include "utils.hpp"
 #include "CustomAlert.hpp"
@@ -38,9 +39,9 @@ void clearQueue() {
 	queuedChest = "";
 }
 
-void playQueueSound() {
+void playQueueSound(bool lower = false) {
 	if (!Mod::get()->getSettingValue<bool>("shiftSound")) return;
-	FMODAudioEngine::sharedEngine()->playEffect("counter003.ogg");
+	FMODAudioEngine::sharedEngine()->playEffect("counter003.ogg", lower ? 0.7f : 1.0f, 1, 0.8f);
 }
 
 std::string getTargetID(std::string path, bool alt) {
@@ -94,8 +95,17 @@ bool dontShowPopupHere() {
 	return CCScene::get() == nullptr || CCScene::get()->getChildByType<KeyPickerPopup>(0) != nullptr;
 }
 
-bool getShift() { return CCKeyboardDispatcher::get()->getShiftKeyPressed(); }
-bool getAlt() { return CCKeyboardDispatcher::get()->getAltKeyPressed(); }
+bool getModifier(std::string key) {
+	auto val = Mod::get()->getSettingValue<std::string>(key);
+	if (val == "Shift") return CCKeyboardDispatcher::get()->getShiftKeyPressed();
+	if (val == "Alt") return CCKeyboardDispatcher::get()->getAltKeyPressed();
+	if (val == "Ctrl") return CCKeyboardDispatcher::get()->getControlKeyPressed();
+	if (val == "Command") return CCKeyboardDispatcher::get()->getCommandKeyPressed();
+	return false;
+}
+
+bool getShift() { return getModifier("shiftRebind"); }
+bool getAlt() { return getModifier("altRebind"); }
 
 void prepPopup() {
 	if (dontShowPopupHere()) return;
@@ -143,32 +153,25 @@ bool killAllAlerts() {
 			killed = true;
 		}
 	} 
+
+	// Clear queue
+	
+	if (!killed && (!queuedChest.empty() || !queuedPopup.empty() || !queuedTextbox.empty())) {
+		killed = true;
+		playQueueSound(true);
+	}
+	clearQueue(); // to be safe
+	
 	return killed;
 }
 
-// Button queueing
-class $modify(CCMenuItemSpriteExtra) {
-	void activate() {
-		if (queuedPopup != "") {
-			runPopup(queuedPopup);
-		}
-		else if (queuedTextbox != "") {
-			runTextbox(queuedTextbox);
-		}
-		else if (queuedChest != "") {
-			runChest(queuedChest);
-		}
-		else {
-			CCMenuItemSpriteExtra::activate();
-		}
-	}
-};
 
+// Handle key presses
 class $modify(CCKeyboardDispatcher) {
 	bool dispatchKeyboardMSG(enumKeyCodes key, bool down, bool repeat) {
 		if (repeat || !down || key == KEY_None || key == KEY_Unknown) return CCKeyboardDispatcher::dispatchKeyboardMSG(key, down, repeat);
 
-		else if (key == KEY_Escape && getShift()) {
+		else if (key == KEY_Escape && CCKeyboardDispatcher::get()->getShiftKeyPressed()) {
 			if (killAllAlerts()) return false;
 		}
 
@@ -180,6 +183,37 @@ class $modify(CCKeyboardDispatcher) {
 	}
 };
 
+bool playQueue() {
+	if (queuedPopup != "") {
+		runPopup(queuedPopup);
+		return true;
+	}
+	else if (queuedTextbox != "") {
+		runTextbox(queuedTextbox);
+		return true;
+	}
+	else if (queuedChest != "") {
+		runChest(queuedChest);
+		return true;
+	}
+	return false;
+}
+
+// Button queueing
+class $modify(CCMenuItemSpriteExtra) {
+	void activate() {
+		if (!playQueue()) CCMenuItemSpriteExtra::activate();
+	}
+};
+
+// Run queued textbox on death (it's funny, why not)
+class $modify(PlayLayer) {
+	void destroyPlayer(PlayerObject* player, GameObject* obj) {
+		PlayLayer::destroyPlayer(player, obj);
+		if (obj != m_anticheatSpike && Mod::get()->getSettingValue<bool>("onDeath")) playQueue();
+	}
+};
+
 $on_mod(Loaded) {
 	checkMissingFiles();
-}
+}