Merge pull request #3 from HDest-Community/feature/zforms-upgrade

Update ZForms

Author: UndeadZeratul

LANGUAGE

@@ -73,7 +73,7 @@ Payouts are as follows:
 
 Original Mod Credits are displayed below.
 - Cryomundus, for porting original mod to HDest Community Organization, updating as needed.
-- Undead Zeratul, adding all sorts of Shop Entries & filters.
+- Undead Zeratul, adding all sorts of Shop Entries & filters, updating ZForms, redesigning Shop Menu.
 
 Code:
 - Accensus

README.md

@@ -1,11 +1,20 @@
 version "4.10"
 
-// [Ace] For the menu.
 #include "zscript/MerchZForms/Include.zsc"
 
-#include "zscript/accensus/merchant/merchantMenu.zsc"
 #include "zscript/accensus/merchant/merchantSkins.zsc"
 
+#include "zscript/accensus/merchant/menu/merchantMenu.zsc"
+
+#include "zscript/accensus/merchant/menu/elements/merchantCategoryFrame.zsc"
+#include "zscript/accensus/merchant/menu/elements/merchantCategoryHeaderFrame.zsc"
+#include "zscript/accensus/merchant/menu/elements/merchantCategoryToggleButton.zsc"
+#include "zscript/accensus/merchant/menu/elements/merchantCurrencyFrame.zsc"
+#include "zscript/accensus/merchant/menu/elements/merchantItemFrame.zsc"
+#include "zscript/accensus/merchant/menu/elements/merchantItemBtn.zsc"
+
+#include "zscript/accensus/merchant/menu/handlers/merchantMenuHandler.zsc"
+
 #include "zscript/accensus/merchant/store/merchantStore.zsc"
 #include "zscript/accensus/merchant/store/storeItems.zsc"
 

ZSCRIPT.zsc

@@ -1,64 +1,234 @@
-/// The base menu class for menus to inherit from.
-/// Contains a mainFrame to put items in.
-class MerchMenuGenericMenu : GenericMenu {
-	MerchMenuFrame mainFrame;
-	int mouseX;
-	int mouseY;
+/// Represents when in the element order the focus indicator element should be
+/// drawn.
+enum MerchZFFocusPriority {
+	/// The focus indicator will be drawn above every element, besides things drawn explicitly on
+	/// top.
+	MerchZFFocusPriority_AboveAll,
+	/// The focus indicator will be drawn immediately below the focused element.
+	MerchZFFocusPriority_JustBelowFocused,
+	/// The focus indicator will be drawn immediately above the focused element.
+	MerchZFFocusPriority_JustAboveFocused,
+}
+
+/// The class to inherit from for defining any menu that goes in the place that
+/// ZScript [`GenericMenu`]s normally go.
+class MerchZFGenericMenu : GenericMenu {
+	/// The top-level frame of the menu's element tree.
+	///
+	/// All top-level elements should be packed into this frame.
+	MerchZFFrame mainFrame;
+
+	/// The default elements that are focused when the user hasn't got anything
+	/// focused and presses a navigation button.
+	MerchZFElement focusDefaults[MerchZFNavEventType_FocusChangeCount];
+
+	private MerchZFElementTreeGlobal globalStore;
+
+	/// Returns where the mouse position currently is in the menu.
+	Vector2 getMousePos() { return globalStore.mousePos; }
+
+	/// Sets the currently focused element to be `elem`, as if it came from the
+	/// direction `type`.
+	void setFocus(MerchZFElement elem, MerchZFNavEventType type) {
+		let old = globalStore.focus;
+		globalStore.focus = elem;
+		elem.beenFocused(type);
+		changeFocusIndicator(old, globalStore.focus);
+		if (globalStore.focusIndicator != NULL) globalStore.focusIndicator.show();
+	}
+	/// Returns the element that is drawn as an indicator of what element is
+	/// focused.
+	MerchZFElement getFocusIndicator() { return globalStore.focusIndicator; }
+	/// Sets the element that is drawn as an indicator of what element is
+	/// focused.
+	void setFocusIndicator(MerchZFElement focusIndicator) { globalStore.focusIndicator = focusIndicator; }
+
+	/// Returns the focus indicator's priority.
+	///
+	/// See [`ZF_FocusPriority`].
+	MerchZFFocusPriority getFocusPriority() { return globalStore.focusPriority; }
+	/// Sets the focus indicator's priority.
+	///
+	/// See [`ZF_FocusPriority`].
+	void setFocusPriority(MerchZFFocusPriority focusPriority) { globalStore.focusPriority = focusPriority; }
 
 	override void init(Menu parent) {
 		Super.init(parent);
-		mainFrame = new("MerchMenuFrame");
-		mainFrame.init((0, 0), (320, 200));
+		mainFrame = MerchZFFrame.create((0, 0), (320, 200));
+		globalStore = new("MerchZFElementTreeGlobal");
+		mainFrame.setGlobalStore(globalStore);
 		mainFrame.setBaseResolution((320, 200));
+		globalStore.mainFrame = mainFrame;
+		globalStore.needsMouseUpdate = true;
+		setupFocusIndicator();
+		if (globalStore.focusIndicator != NULL) {
+			globalStore.focusIndicator.hide();
+		}
 	}
 
+	/// Sets the resolution of the virtual ZForms screen.
 	void setBaseResolution(Vector2 size) {
 		mainFrame.setBox((0, 0), size);
 		mainFrame.setBaseResolution(size);
 	}
 
-	override void ticker() {
-		// Trigger a mouse movement UI event to fix things "sticking" sometimes
-		let zfEv = new("MerchMenuUiEvent");
-		zfEv.type = UIEvent.Type_MouseMove;
-		zfEv.mouseX = mouseX;
-		zfEv.mouseY = mouseY;
-		mainFrame.onUIEvent(zfEv);
+	/// Called whenever the back button is pressed, so that its behaviour can
+	/// be overridden if needed.
+	///
+	/// Normally this gives all the elements in the tree a chance to override
+	/// it, and if none of them did, it closes this menu.
+	virtual void handleBack() {
+		if (!mainFrame.handleBack()) {
+			close();
+			let m = GetCurrentMenu();
+			MenuSound(m != null ? "menu/backup" : "menu/clear");
+			if (!m) menuDelegate.MenuDismissed();
+		}
+	}
 
+	override bool translateKeyboardEvents() {
+		if (globalStore == NULL) return true;
+		return !globalStore.blockMenuEvent;
+	}
+
+	override void ticker() {
 		Super.ticker();
 		mainFrame.ticker();
 	}
 
 	override void drawer() {
-		Super.drawer();
+		if (globalStore.focus != NULL) {
+			MerchZFAABB box;
+			globalStore.focus.getFocusAABB(box);
+			positionFocusIndicator(box.pos, box.size);
+		}
+
+		if (globalStore.needsMouseUpdate) {
+			let mouseBlock = mainFrame.handlePriorityMouseBlock(false, globalStore.mousePos);
+			mainFrame.handleMousePosition(mouseBlock, globalStore.mousePos);
+			globalStore.needsMouseUpdate = false;
+		}
 		mainFrame.drawer();
+		mainFrame.topDrawer();
+	}
+
+	/// Called when the menu wants a focus indicator to be set up.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// override void setupFocusIndicator() {
+	///     let focusBox = ZF_BoxTextures.CreateTexturePixels (
+	///         "Graphics/FocusIndicator.png",
+	///         (16, 16),
+	///         (16, 16),
+	///         true,
+	///         true
+	///     );
+	///
+	///     setFocusIndicator(ZF_BoxImage.create((0, 0), (0, 0), focusBox));
+	///     setFocusPriority(ZF_FocusPriority_JustAboveFocused);
+	/// }
+	/// ```
+	virtual void setupFocusIndicator() {}
+	/// Called when the menu wants the focus indicator to be moved to a new element.
+	/// 
+	/// This should not position the indicator - see [`positionFocusIndicator`].
+	virtual void changeFocusIndicator(MerchZFElement oldFocus, MerchZFElement newFocus) {}
+	/// Called when the focus indicator should change position or size.
+	///
+	/// # Examples
+	///
+	/// ```
+	/// override void positionFocusIndicator(Vector2 pos, Vector2 size) {
+	///     getFocusIndicator().setBox(pos, size);
+	/// }
+	/// ```
+	virtual void positionFocusIndicator(Vector2 pos, Vector2 size) {}
+
+	private void fireNavigationEvent(MerchZFNavEventType type, bool fromController) {
+		if (type == MerchZFNavEventType_Deny) {
+			handleBack();
+		}
+
+		if (mainFrame.onNavEvent(type, fromController)) return;
+
+		if (type < MerchZFNavEventType_FocusChangeCount) {
+			MerchZFElement newFocus;
+			if (globalStore.focus == NULL) {
+				newFocus = focusDefaults[type];
+			} else {
+				newFocus = globalStore.focus.getFocusNeighbor(type);
+			}
+			if (newFocus != NULL) {
+				let oldFocus = globalStore.focus;
+				setFocus(newFocus, type);
+			}
+		}
 	}
 
 	// "relay" all UI events down to the elements so they can handle them
 	override bool onUIEvent(UIEvent ev) {
+		if (ev.type == UIEvent.Type_KeyDown && (ev.keyChar == UIEvent.Key_Escape || ev.keyChar == UIEvent.Key_Back)) {
+			handleBack();
+		}
 		if (ev.type == UIEvent.Type_MouseMove) {
-			mouseX = ev.mouseX;
-			mouseY = ev.mouseY;
+			globalStore.mousePos.x = ev.mouseX;
+			globalStore.mousePos.y = ev.mouseY;
+			globalStore.needsMouseUpdate = true;
+			return true;
+		}
+		if (ev.type == UIEvent.Type_LButtonDown) {
+			let oldFocus = globalStore.focus;
+			globalStore.focus = NULL;
+			changeFocusIndicator(oldFocus, NULL);
+			if (globalStore.focusIndicator != NULL) globalStore.focusIndicator.hide();
+			SetCapture(true);
+		}
+		if (ev.type == UIEvent.Type_LButtonUp) {
+			SetCapture(false);
 		}
 
-		let zfEv = new("MerchMenuUiEvent");
+		MerchZFUiEvent zfEv;
 
-		MerchMenuUiEvent.fromGZDUiEvent(ev, zfEv);
-		mainFrame.onUIEvent(zfEv);
+		MerchZFUiEvent.fromGZDUiEvent(ev, zfEv);
+		if (mainFrame.onUIEventPriority(zfEv)) return true;
+		if (mainFrame.onUIEvent(zfEv)) return true;
+
+		return true;
+	}
+
+	override bool menuEvent(int mkey, bool fromcontroller) {
+		if (globalStore != NULL && globalStore.blockMenuEvent) return true;
 
-		return Super.onUIEvent(ev);
+		switch (mkey) {
+		case MKEY_Up:    fireNavigationEvent(MerchZFNavEventType_Up, fromcontroller); break;
+		case MKEY_Down:  fireNavigationEvent(MerchZFNavEventType_Down, fromcontroller); break;
+		case MKEY_Left:  fireNavigationEvent(MerchZFNavEventType_Left, fromcontroller); break;
+		case MKEY_Right: fireNavigationEvent(MerchZFNavEventType_Right, fromcontroller); break;
+
+		case MKEY_PageUp:   fireNavigationEvent(MerchZFNavEventType_PageUp, fromcontroller); break;
+		case MKEY_PageDown: fireNavigationEvent(MerchZFNavEventType_PageDown, fromcontroller); break;
+
+		case MKEY_Enter: fireNavigationEvent(MerchZFNavEventType_Confirm, fromcontroller); break;
+		case MKEY_Back:  fireNavigationEvent(MerchZFNavEventType_Deny, fromcontroller); break;
+		}
+		return true;
 	}
 }
 
-class MerchMenuEventHandlerMenu ui {
-	MerchMenuFrame mainFrame;
+//  this is temporarily undocumented as i haven't been updating it to the
+//  current ZForms API as much as i should have been so it doesn't work
+//  properly anyway
+/// ?doc: hidden
+class MerchZFEventHandlerMenu ui {
+	MerchZFFrame mainFrame;
 
 	protected bool useCustomCursor;
 	protected string customCursor;
 
 	virtual void init() {
-		mainFrame = new("MerchMenuFrame");
-		mainFrame.init((0, 0), (320, 200));
+		mainFrame = MerchZFFrame.create((0, 0), (320, 200));
 		mainFrame.setBaseResolution((320, 200));
 	}
 
@@ -71,9 +241,13 @@ class MerchMenuEventHandlerMenu ui {
 		ticker();
 	}
 
+	virtual void handleBack() {
+		mainFrame.handleBack();
+	}
+
 	protected virtual void ticker() {
 		// Trigger a mouse movement UI event to fix things "sticking" sometimes
-		let zfEv = new("MerchMenuUiEvent");
+		MerchZFUiEvent zfEv;
 		zfEv.type = UIEvent.Type_MouseMove;
 		zfEv.mouseX = inputProc_MouseX;
 		zfEv.mouseY = inputProc_MouseY;
@@ -92,16 +266,21 @@ class MerchMenuEventHandlerMenu ui {
 
 	protected virtual void drawer() {
 		mainFrame.drawer();
+		mainFrame.topDrawer();
 	}
 
 	// "relay" all UI events down to the elements so they can handle them
 	virtual bool onUIEvent(UIEvent ev) {
-		let zfEv = new("MerchMenuUiEvent");
+		if (ev.type == UIEvent.Type_KeyDown && (ev.keyChar == UIEvent.Key_Escape || ev.keyChar == UIEvent.Key_Back)) {
+			handleBack();
+		}
 
-		MerchMenuUiEvent.fromGZDUiEvent(ev, zfEv);
-		mainFrame.onUIEvent(zfEv);
+		MerchZFUiEvent zfEv;
 
-		return false;
+		MerchZFUiEvent.fromGZDUiEvent(ev, zfEv);
+		if (mainFrame.onUIEventPriority(zfEv)) return true;
+		mainFrame.onUIEvent(zfEv);
+		return true;
 	}
 
 	private bool inputProc_Alt;
@@ -119,13 +298,13 @@ class MerchMenuEventHandlerMenu ui {
 		inputProc_MouseY = posY;
 	}
 
-	void copyCustomMousePosition(MerchMenuEventHandlerMenu other) {
+	void copyCustomMousePosition(MerchZFEventHandlerMenu other) {
 		inputProc_MouseX = other.inputProc_MouseX;
 		inputProc_MouseY = other.inputProc_MouseY;
 	}
 
 	void onInputEvent(InputEvent gzdEv) {
-		let ev = new("MerchMenuUiEvent");
+		MerchZFUiEvent ev;
 
 		ev.KeyString = gzdEv.KeyString;
 		ev.KeyChar = gzdEv.KeyChar;
@@ -246,4 +425,4 @@ class MerchMenuEventHandlerMenu ui {
 
 		return -1;
 	}
-}
+}