Use a queue for menus

Author: BalaM314

build/scripts/menus.js

@@ -6,24 +6,24 @@ This file contains the menu system.
 import { CommandError, fail } from "./commands";
 import { FishPlayer } from "./players";
 import { outputFail } from "./utils";
-import { crash, parseError } from './funcs';
+import { parseError } from './funcs';
 import { to2DArray } from './funcs';
 import { Promise } from "./promise";
 
+/** Used to change the behavior of adding another menu when being run in a menu callback. */
+let isInMenuCallback = false;
 /** Stores a mapping from name to the numeric id of a listener that has been registered. */
 const registeredListeners: Record<string, number> = {};
 /** Stores all listeners in use by fish-commands. */
 const listeners = {
 	generic(player, option){
 		const fishSender = FishPlayer.get(player);
 
-		//TODO replace with queue
-		const prevCallback = fishSender.activeMenu.callback;
-		fishSender.activeMenu.callback?.(fishSender, option);
-		//if the callback wasn't modified, then clear it
-		if(fishSender.activeMenu.callback === prevCallback)
-			fishSender.activeMenu.callback = undefined;
-		//otherwise, the menu spawned another menu that needs to be handled
+		const prevCallback = fishSender.activeMenus.shift();
+		if(!prevCallback) return; //No menu to process, do nothing
+		isInMenuCallback = true;
+		prevCallback.callback(option);
+		isInMenuCallback = false;
 	},
 	none(player, option){
 		//do nothing
@@ -82,15 +82,17 @@ export const Menu = {
 		}
 
 		//The target fishPlayer has a property called activeMenu, which stores information about the last menu triggered.
-		target.activeMenu.callback = (fishSender, option) => {
+		//If menu() is being called from a menu calback, add it to the front of the queue so it is processed before any other menus.
+		//Otherwise, two multi-step menus queued together would alternate, which would confuse the player.
+		target.activeMenus[isInMenuCallback ? "unshift" : "push"]({ callback(option){
 			//Additional permission validation could be done here, but the only way that callback() can be called is if the above statement executed,
 			//and on sensitive menus such as the stop menu, the only way to reach that is if menu() was called by the /stop command,
 			//which already checks permissions.
 			//Additionally, the callback is cleared by the generic menu listener after it is executed.
 
 			try {
 				//We do need to validate option though, as it can be any number.
-				if(option === -1 || option === fishSender.activeMenu.cancelOptionId || !(option in options)){
+				if(option === -1 || option === cancelOptionId || !(option in options)){
 					//Consider any invalid option to be a cancellation
 					if(onCancel == "null") resolve(null as never);
 					else if(onCancel == "reject") reject("cancel" as never);
@@ -109,7 +111,7 @@ export const Menu = {
 					Log.err(err as Error);
 				}
 			}
-		};
+		}});
 
 		Call.menu(target.con, registeredListeners.generic, title, description, arrangedOptions);
 		return promise;

build/scripts/players.js

@@ -53,10 +53,10 @@ export class FishPlayer {
 	player:mindustryPlayer | null = null;
 	pet:string = "";
 	watch:boolean = false;
-	activeMenu: {
-		cancelOptionId: number;
-		callback?: (sender:FishPlayer, option:number) => void;
-	} = {cancelOptionId: -1};
+	/** Front-to-back queue of menus to show. */
+	activeMenus: {
+		callback: (option:number) => void;
+	}[] = [];
 	tileId = false;
 	tilelog:null | "once" | "persist" = null;
 	trail: {
@@ -382,7 +382,7 @@ export class FishPlayer {
 			}
 		}
 		//Clear temporary states such as menu and taphandler
-		fishP.activeMenu.callback = undefined;
+		fishP.activeMenus = [];
 		fishP.tapInfo.commandName = null;
 		fishP.stats.timeInGame += (Date.now() - fishP.lastJoined); //Time between joining and leaving
 		fishP.lastJoined = Date.now();
@@ -454,7 +454,7 @@ export class FishPlayer {
 	static onGameOver(winningTeam:Team){
 		this.forEachPlayer((fishPlayer) => {
 			//Clear temporary states such as menu and taphandler
-			fishPlayer.activeMenu.callback = undefined;
+			fishPlayer.activeMenus = [];
 			fishPlayer.tapInfo.commandName = null;
 			//Update stats
 			if(!this.ignoreGameOver && fishPlayer.team() != Team.derelict && winningTeam != Team.derelict){