Implement area mex terraform in the non-hacky way.

Anims/cursorterramex.txt

@@ -0,0 +1,5 @@
+hotspot topleft
+frame  anims/cursorterramex_0.png  0.2
+frame  anims/cursorterramex_1.png  0.2
+frame  anims/cursorterramex_0.png  0.2
+frame  anims/cursorterramex_2.png  0.2

Anims/zk_large/cursorterramex.txt

@@ -0,0 +1,5 @@
+hotspot topleft
+frame  anims/cursorterramex_0.png  0.2
+frame  anims/cursorterramex_1.png  0.2
+frame  anims/cursorterramex_0.png  0.2
+frame  anims/cursorterramex_2.png  0.2

LuaRules/Configs/customcmds.lua

@@ -42,6 +42,7 @@ local cmds = {
 	SELECT_MISSILES = 14001,
 
 	AREA_MEX = 30100,
+	AREA_TERRA_MEX = 30101,
 	STEALTH = 31100,
 	CLOAK_SHIELD = 31101,
 	RAW_MOVE = 31109, --cmd_raw_move.lua

LuaRules/Gadgets/mex_placement.lua

@@ -18,15 +18,26 @@ end
 include("LuaRules/Configs/customcmds.h.lua")
 
 local cmdMex = {
-	id	  = CMD_AREA_MEX,
-	type	= CMDTYPE.ICON_AREA,
+	id      = CMD_AREA_MEX,
+	type    = CMDTYPE.ICON_AREA,
 	tooltip = 'Area Mex: Click and drag to queue metal extractors in an area.',
-	name	= 'Mex',
+	name    = 'Mex',
 	cursor  = 'Mex',
 	action  = 'areamex',
 	params  = {},
 }
 
+local cmdTerraMex = {
+	id      = CMD_AREA_TERRA_MEX,
+	type    = CMDTYPE.ICON_AREA,
+	tooltip = 'Area Terra Mex: Click and drag to queue terraformed metal extractors in an area.',
+	name    = 'Terra Mex',
+	cursor  = 'Terramex',
+	action  = 'areaterramex',
+	params  = {},
+}
+
+
 ----------------------------------------------------------------------------------------------
 ----------------------------------------------------------------------------------------------
 -- SYNCED
@@ -134,6 +145,7 @@ function gadget:Initialize()
 	GG.GetClosestMetalSpot = GetClosestMetalSpot
 	-- register command
 	gadgetHandler:RegisterCMDID(CMD_AREA_MEX)
+	gadgetHandler:RegisterCMDID(CMD_AREA_TERRA_MEX)
 	-- load active units
 	for _, unitID in ipairs(Spring.GetAllUnits()) do
 		local unitDefID = Spring.GetUnitDefID(unitID)
@@ -163,6 +175,7 @@ local inlosTrueTable = {inlos = true}
 function gadget:UnitCreated(unitID, unitDefID, unitTeam)
 	if canMex[unitDefID] then
 		Spring.InsertUnitCmdDesc(unitID, cmdMex)
+		Spring.InsertUnitCmdDesc(unitID, cmdTerraMex)
 	end
 
 	if unitDefID == mexDefID then
@@ -214,6 +227,7 @@ function gadget:Initialize()
 	--gadgetHandler:RegisterCMDID(CMD_RAW_MOVE)
 	--Spring.SetCustomCommandDrawData(CMD_RAW_MOVE, "RawMove", {0.5, 1.0, 0.5, 0.7}) -- "" mean there's no MOVE cursor if the command is drawn.
 	Spring.AssignMouseCursor("Mex", "cursormex", true, true)
+	Spring.AssignMouseCursor("Terramex", "cursorterramex", true, true)
 end
 
 end

LuaUI/Configs/border_menu_commands.lua

@@ -217,6 +217,7 @@ local overrides = {
 	[CMD_BUMPY] = {texture = imageDir .. 'bumpy.png'},
 
 	[CMD_AREA_MEX] = {caption = '', texture = imageDir .. 'Bold/mex.png'},
+	[CMD_AREA_TERRA_MEX] = {caption = '', texture = imageDir .. 'Bold/mex.png'},
 
 	[CMD_JUMP] = {texture = imageDir .. 'Bold/jump.png'},
 
@@ -310,6 +311,7 @@ local custom_cmd_actions = {	-- states are 2, not states are 1
 	sethaven=1,
 	--build=1,
 	areamex=1,
+	areaterramex=1,
 	disembark=1,
 	mine=1,
 	build=1,

LuaUI/Configs/customCmdTypes.lua

@@ -51,6 +51,7 @@ local custom_cmd_actions = {
 	excludeairpad = {cmdType = 1, name = "Exclude an Airpad"},
 	--build = {cmdType = 1, name = "--build"},
 	areamex = {cmdType = 1, name = "Area Mex"},
+	areaterramex = {cmdType = 1, name = "Area Terra Mex"},
 	mine = {cmdType = 1, name = "Mine"},
 	build = {cmdType = 1, name = "Build"},
 	jump = {cmdType = 1, name = "Jump"},
@@ -154,6 +155,7 @@ local usedActions = {
 	["repair"] = true,
 	["reclaim"] = true,
 	["areamex"] = true,
+	["areaterramex"] = true,
 	["priority"] = true,
 	["rampground"] = true,
 	["levelground"] = true,

LuaUI/Configs/integral_menu_commands.lua

@@ -51,8 +51,9 @@ local cmdPosDef = {
 	[CMD.UNLOAD_UNITS]  = {pos = 7, priority = 8},
 	[CMD_RECALL_DRONES] = {pos = 7, priority = 10},
 
+	[CMD_AREA_TERRA_MEX]= {pos = 13, priority = 1},
 	[CMD_UNIT_SET_TARGET_CIRCLE] = {pos = 13, priority = 2},
-	[CMD_UNIT_CANCEL_TARGET]     = {pos = 13, priority = 2},
+	[CMD_UNIT_CANCEL_TARGET]     = {pos = 13, priority = 3},
 	[CMD_EMBARK]        = {pos = 13, priority = 5},
 	[CMD_DISEMBARK]     = {pos = 13, priority = 6},
 	[CMD_EXCLUDE_PAD]   = {pos = 13, priority = 7},

LuaUI/Configs/integral_menu_config.lua

@@ -74,6 +74,7 @@ local commandDisplayConfig = {
 	[CMD_AREA_GUARD] = { texture = imageDir .. 'Bold/guard.png', tooltip = "Guard: Protect the target and assist its production."},
 
 	[CMD_AREA_MEX] = {texture = imageDir .. 'Bold/mex.png'},
+	[CMD_AREA_TERRA_MEX] = {texture = imageDir .. 'Bold/mex.png'},
 
 	[CMD_JUMP] = {texture = imageDir .. 'Bold/jump.png'},
 

LuaUI/Configs/integral_menu_culling.lua

@@ -22,6 +22,7 @@ local configList = {
 
 	{label = "Advanced Commands (hidden by default)"},
 	{cmdID = CMD.AREA_ATTACK           , default = false, name = "Area Attack"},
+	{cmdID = CMD_AREA_TERRA_MEX        , default = false, name = "Area Terra Mex"},
 	{cmdID = CMD_UNIT_CANCEL_TARGET    , default = false, name = "Cancel Target"},
 	{cmdID = CMD_DISEMBARK             , default = false, name = "Disembark"},
 	{cmdID = CMD_EXCLUDE_PAD           , default = false, name = "Exclude Airpad"},
@@ -68,6 +69,7 @@ local defaultValues = {
 	[CMD.WAIT] = true,
 	[CMD_DISEMBARK] = true,
 	[CMD.AREA_ATTACK] = true,
+	[CMD_AREA_TERRA_MEX] = true,
 	[CMD_AREA_GUARD] = true,
 	[CMD_UNIT_SET_TARGET_CIRCLE] = true,
 	[CMD_UNIT_CANCEL_TARGET] = true,

LuaUI/Configs/zk_keys.lua

@@ -119,6 +119,7 @@ return {
 		{	"pastetext",	"Ctrl+v",},
 		{	"wait",	"ctrl+w",},
 		{	"areamex",	"w",},
+		{	"areaterramex",	"alt+w",},
 		{	"wantonoff",	"o",},
 		{	"pushpull",	"o",},
 		{	"buildspacing dec",	"Any+x",},

LuaUI/Widgets/cmd_commandinsert.lua

@@ -166,7 +166,7 @@ local function ProcessCommand(id, params, options, sequence_order)
 			coded = coded - CMD.OPT_META
 		end
 
-		if not (shift or id == CMD_AREA_MEX) then
+		if not (shift or id == CMD_AREA_MEX or id == CMD_AREA_TERRA_MEX) then
 			Spring.GiveOrder(CMD.INSERT, {sequence_order, id, coded, unpack(params)}, CMD.OPT_ALT)
 			return true
 		end

LuaUI/Widgets/cmd_keep_target.lua

@@ -74,6 +74,7 @@ local TargetKeepingCommand = {
 	[CMD.RECLAIM] = true,
 	[CMD.RESURRECT] = true,
 	[CMD_AREA_MEX] = true,
+	[CMD_AREA_TERRA_MEX] = true,
 	[CMD.LOAD_UNITS] = true,
 	[CMD.UNLOAD_UNITS] = true,
 	[CMD.LOAD_ONTO] = true,

LuaUI/Widgets/cmd_mex_placement.lua

@@ -125,7 +125,6 @@ local myPlayerID = Spring.GetMyPlayerID()
 local myOctant = 1
 local pregame = true
 
-local terraformModeEnabled = false
 local placedMexSinceShiftPressed = false
 
 ------------------------------------------------------------
@@ -179,20 +178,6 @@ options = {
 		value = true,
 		desc = "Clicking area mex without dragging is like constructing a mex.",
 	},
-	terraform_mex = {
-		name = "Area Mex with Terraform",
-		type = 'button',
-		action='areamexterra',
-		hotkey = {key='Q', mod='alt+'},
-		OnChange = function(self)
-			local index = Spring.GetCmdDescIndex(CMD_AREA_MEX)
-			if index then
-				Spring.SetActiveCommand(index)
-				terraformModeEnabled = true
-			end
-		end,
-		path = "Hotkeys/Construction"
-	},
 }
 
 local centerX
@@ -512,7 +497,7 @@ function widget:CommandNotify(cmdID, params, cmdOpts)
 		return false
 	end
 
-	if (cmdID == CMD_AREA_MEX) and ((params[4] or 0) > 1 or not options.area_point_command.value) then
+	if (cmdID == CMD_AREA_MEX or cmdID == CMD_AREA_TERRA_MEX) and ((params[4] or 0) > 1 or not options.area_point_command.value) then
 		local cx, cy, cz, cr = params[1], params[2], params[3], math.max((params[4] or 60),60)
 
 		local xmin = cx-cr
@@ -556,7 +541,7 @@ function widget:CommandNotify(cmdID, params, cmdOpts)
 			aveZ = uz/us
 		end
 
-		local terraMode = terraformModeEnabled
+		local terraMode = (cmdID == CMD_AREA_TERRA_MEX)
 		local makeMexEnergy = (not terraMode) and (cmdOpts.alt or cmdOpts.ctrl)
 		local wallHeight = 40
 		local burryMode = false
@@ -669,7 +654,7 @@ function widget:CommandNotify(cmdID, params, cmdOpts)
 		return true
 	end
 
-	if (-mexDefID == cmdID or cmdID == CMD_AREA_MEX) and params[3] then
+	if (-mexDefID == cmdID or cmdID == CMD_AREA_MEX or cmdID == CMD_AREA_TERRA_MEX) and params[3] then
 		local bx, bz = params[1], params[3]
 		return PlaceSingleMex(bx, bz, params[4], cmdOpts)
 	end
@@ -784,7 +769,6 @@ function widget:MouseRelease(x, y, button)
 	end
 	if button ~= 1 then
 		Spring.SetActiveCommand(-1)
-		terraformModeEnabled = false
 		return false
 	end
 	local mx, my = spGetMouseState()
@@ -794,7 +778,6 @@ function widget:MouseRelease(x, y, button)
 		placedMexSinceShiftPressed = true
 		if not retain then
 			Spring.SetActiveCommand(-1)
-			terraformModeEnabled = false
 		end
 	end
 	return true
@@ -942,13 +925,6 @@ function widget:Update(dt)
 		firstUpdate = false
 	end
 
-	if terraformModeEnabled then
-		local _, cmdID = Spring.GetActiveCommand()
-		if cmdID ~= CMD_AREA_MEX then
-			terraformModeEnabled = false
-		end
-	end
-
 	if CheckNeedsRecalculating() then
 		spotByID = {}
 		spotData = {}
@@ -1014,7 +990,6 @@ function widget:KeyRelease(key, modifier, isRepeat)
 		local _, cmdID = Spring.GetActiveCommand()
 		if cmdID == -mexDefID then
 			Spring.SetActiveCommand(-1)
-			terraformModeEnabled = false
 		end
 	end
 end
@@ -1199,7 +1174,7 @@ function widget:DrawWorldPreUnit()
 	local showecoMode = WG.showeco
 	local peruse = spGetGameFrame() < 1 or showecoMode or spGetMapDrawMode() == 'metal'
 
-	drawMexSpots = (-mexDefID == cmdID or CMD_AREA_MEX == cmdID or peruse)
+	drawMexSpots = (-mexDefID == cmdID or CMD_AREA_MEX == cmdID or CMD_AREA_TERRA_MEX == cmdID or peruse)
 
 	if WG.metalSpots and (drawMexSpots or WG.showeco_always_mexes) then
 		gl.DepthTest(true)
@@ -1229,7 +1204,7 @@ function widget:DrawWorld()
 	local pregame = (spGetGameFrame() < 1)
 
 	if WG.metalSpots and (pregame or WG.selectionEntirelyCons) and
-			(isMexCmd or (pregame or (WG.showeco or WG.showeco_always_mexes)) or CMD_AREA_MEX == cmdID) then
+			(isMexCmd or (pregame or (WG.showeco or WG.showeco_always_mexes)) or CMD_AREA_MEX == cmdID or CMD_AREA_TERRA_MEX == cmdID) then
 		local mx, my, leftPressed = spGetMouseState()
 		local _, pos = spTraceScreenRay(mx, my, true)
 
@@ -1241,7 +1216,7 @@ function widget:DrawWorld()
 		local bx, by, bz = Spring.Pos2BuildPos(mexDefID, pos[1], pos[2], pos[3])
 		local closestSpot, distance, index = GetClosestMetalSpot(bx, bz)
 		local wantShow = isMexCmd or distance <= 60
-		if (not wantShow) and (options.area_point_command.value and CMD_AREA_MEX == cmdID) then
+		if (not wantShow) and (options.area_point_command.value and (CMD_AREA_MEX == cmdID or CMD_AREA_TERRA_MEX == cmdID)) then
 			if leftPressed then
 				local pressX, pressY = Spring.GetMouseStartPosition(1)
 				if pressX then

LuaUI/Widgets/gui_hide_interface_action.lua

@@ -40,6 +40,8 @@ local cursorNames = {
 	'cursornumber',
 	'cursortime',
 	'cursorunload',
+	'cursormex',
+	'cursorterramex',
 	'cursorLevel',
 	'cursorRaise',
 	'cursorRamp',