Merge pull request #52 from bszonye/bradd/integration

Integrate official release

Author: bszonye

README.md

@@ -1,33 +1,11 @@
-# Map Tacks 2.0.1 [<img align="right" src="maptacks.png" height="256" width="256">](https://steamcommunity.com/sharedfiles/filedetails/?id=1122081356)
-Adds new map icons  
-Enhances list interface  
-Fixes bugs and styling  
+# Map Tacks 3.0.0 [<img align="right" src="maptacks.png" height="256" width="256">](https://steamcommunity.com/sharedfiles/filedetails/?id=1122081356)
+The Map Tacks mod is now
+[included in Civilization VI](https://civilization.com/news/entries/civilization-vi-gathering-storm-patch-update-april-2019/)!
 
-## New icons
-The map tack editor adds many new icons:
+This optional add-on makes a few small changes to the official interface:
 
-* districts
-* improvements
-* villages and barbarians
-* common unit actions
-* great people
-* wonders
-
-All new icons have tooltips, including game effects for districts,
-improvements, and wonders.
-
-## Scrollable map tack list
-The list dynamically resizes to show up to 15 map tacks, with a scrollbar to
-manage longer lists.  It groups all named locations at the top, followed by all
-unnamed locations in numerical order.
-
-## Bug fixes and restyling
-The mod fixes a few base-game bugs and styling problems.  It handles large
-numbers of map tacks without breaking the popup list or causing performance
-problems.  Unnamed markers now sort correctly when there are more than ten.
-Labels and controls have more consistent alignment and spacing.  The mod
-improves overlapping and stacked icons, so that closer tacks always look
-closer, and the current player always appears on top in multiplayer.
+* improve the editor layout for Gathering Storm districts
+* fix some in-game text that still refers to map pins instead of tacks
 
 ## Compatibility
 The Map Tacks mod does not affect saved games, so you can add it to a game in

mappinlistpanel.lua

@@ -122,9 +122,7 @@ function GetMapPinListEntry(iPlayerID :number, mapPinID :number)
 		end
 
 		UpdateMapPinListEntry(iPlayerID, mapPinID);
-
 		Controls.MapPinEntryStack:CalculateSize();
-		Controls.MapPinEntryStack:ReprocessAnchoring();
 	end
 	return mapPinEntry;
 end
@@ -155,16 +153,13 @@ function BuildMapPinList()
 
 	-- Recalc after sorting so the anchoring can account for hidden elements.
 	Controls.MapPinEntryStack:CalculateSize();
-	Controls.MapPinEntryStack:ReprocessAnchoring();
+
 	-- Dynamically resize scroll panel
 	local maxY = 15 * 25 - 1;  -- show up to 15 pins without a scrollbar
 	local stackY = Controls.MapPinEntryStack:GetSizeY();
 	local panelY = math.min(maxY, stackY);
 	Controls.MapPinScrollPanel:SetSizeY(panelY);
-	Controls.MapPinScrollPanel:ReprocessAnchoring();
 	Controls.MapPinStack:CalculateSize();
-	Controls.MapPinStack:ReprocessAnchoring();
-	Controls.MapPinPanel:ReprocessAnchoring();
 end
 
 
@@ -239,7 +234,6 @@ function ShowHideHandler( bIsHide, bIsInit )
 end
 ContextPtr:SetShowHideHandler( ShowHideHandler );
 
-
 -- ===========================================================================
 function Initialize()
 	Controls.AddPinButton:RegisterCallback( Mouse.eLClick, OnAddPinButton );

mappinmanager.lua

@@ -8,21 +8,22 @@ include( "SupportFunctions" );
 include( "Colors" );
 include( "MapTacks" );
 
+
 -- ===========================================================================
 --	CONSTANTS
 -- ===========================================================================
 
 local ALPHA_DIM					:number = 0.45;
-local COLOR_RED					:number = 0xFF0101F5;
-local COLOR_YELLOW				:number = 0xFF2DFFF8;
-local COLOR_GREEN				:number = 0xFF4CE710;
+local COLOR_RED					:number = UI.GetColorValueFromHexLiteral(0xFF0101F5);
+local COLOR_YELLOW				:number = UI.GetColorValueFromHexLiteral(0xFF2DFFF8);
+local COLOR_GREEN				:number = UI.GetColorValueFromHexLiteral(0xFF4CE710);
+local COLOR_WHITE				:number = UI.GetColorValueFromHexLiteral(0xFFFFFFFF);
 local FLAGSTATE_NORMAL			:number= 0;
 local FLAGSTATE_FORTIFIED		:number= 1;
 local FLAGSTATE_EMBARKED		:number= 2;
 local FLAGSTYLE_MILITARY		:number= 0;
 local FLAGSTYLE_CIVILIAN		:number= 1;
 local FLAGTYPE_UNIT				:number= 0;
-local ZOOM_MULT_DELTA			:number = .01;
 local TEXTURE_BASE				:string = "MapPinFlag";
 local TEXTURE_MASK_BASE			:string = "MapPinFlagMask";
 
@@ -37,9 +38,6 @@ local m_SelectedContainer			:table = ContextPtr:LookUpControl( "../SelectedMapPi
 
 local m_InstanceManager		:table = InstanceManager:new( "MapPinFlag",	"Anchor", Controls.MapPinFlags );
 
-local m_cameraFocusX				:number = -1;
-local m_cameraFocusY				:number = -1;
-local m_zoomMultiplier				:number = 1;
 local m_MapPinInstances				:table  = {};
 local m_MapPinStacks				:table  = {};
 
@@ -201,6 +199,7 @@ end
 
 ------------------------------------------------------------------
 function OnMapPinFlagRightClick( playerID : number, pinID : number )
+	-- TODO it might be nice to enable this if shift is down
 	--[[
 	-- If we are the owner of this pin, delete the pin.
 	if(playerID == Game.GetLocalPlayer()) then
@@ -232,10 +231,9 @@ end
 function MapPinFlag.SetColor( self : MapPinFlag )
 	local primaryColor, secondaryColor = UI.GetPlayerColors(self.m_Player:GetID());
 
-	local darkerFlagColor   :number = MapTacks.Tint(primaryColor, -85);
-	local brighterFlagColor :number = MapTacks.Tint(primaryColor, 90);
-	local brighterIconColor :number = MapTacks.Tint(secondaryColor, 20);
-	-- local darkerIconColor   :number = MapTacks.Tint(secondaryColor, -30);
+	local darkerFlagColor   :number = UI.DarkenLightenColor(primaryColor,  -85, 255);
+	local brighterFlagColor :number = UI.DarkenLightenColor(primaryColor,   90, 255);
+	local brighterIconColor :number = UI.DarkenLightenColor(secondaryColor, 20, 255);
 
 	local iconType = MapTacks.IconType(self:GetMapPin()) or MapTacks.STOCK;
 	-- set icon tint appropriate for the icon color
@@ -248,7 +246,7 @@ function MapPinFlag.SetColor( self : MapPinFlag )
 		self.m_Instance.UnitIcon:SetColor(tintedIconColor);
 	else
 		-- full color
-		self.m_Instance.UnitIcon:SetColor(-1);  -- pure white
+		self.m_Instance.UnitIcon:SetColor(COLOR_WHITE);
 	end
 	self.m_Instance.FlagBase:SetColor( primaryColor );
 	self.m_Instance.FlagBaseOutline:SetColor( primaryColor );
@@ -417,13 +415,14 @@ function MapPinFlag.SetPosition( self : MapPinFlag, worldX : number, worldY : nu
 		local pMapPin : table = self:GetMapPin();
 		if (pMapPin ~= nil) then
 			-- If there are multiple map pins sharing a hex, recenter them
-			local stack = GetPinStack(pMapPin);
-			local found = false;
-			local depth = 0;
-			for i, pin in ipairs(stack) do
+			local kStack : table = GetPinStack(pMapPin);
+			local found : boolean = false;
+			local depth : number = 0;
+			for i, pin in ipairs(kStack) do
 				if pin == pMapPin then
 					found = true;
-				elseif not found then
+					break;
+				else
 					depth = depth + 1;
 				end
 			end
@@ -466,23 +465,6 @@ end
 -- ===========================================================================
 --	Engine Event
 -- ===========================================================================
--------------------------------------------------
--- Zoom level calculation
--------------------------------------------------
-function OnCameraUpdate( vFocusX:number, vFocusY:number, fZoomLevel:number )
-	m_cameraFocusX	= vFocusX;
-	m_cameraFocusY	= vFocusY;
-
-	-- If no change in the zoom, no update necessary.
-	if( math.abs( (1-fZoomLevel) - m_zoomMultiplier ) < ZOOM_MULT_DELTA ) then
-		return;
-	end
-	m_zoomMultiplier= 1-fZoomLevel;
-
-	-- Map pins do not really use zoom, so skip the refresh.
-	-- Refresh();
-end
-
 ------------------------------------------------------------------
 function OnPlayerConnectChanged(iPlayerID)
 	-- When a human player connects/disconnects, their unit flag tooltips need to be updated.
@@ -702,7 +684,6 @@ function Initialize()
 	ContextPtr:SetShutdown( OnShutdown );
 
 	Events.BeginWonderReveal.Add( OnBeginWonderReveal );
-	Events.Camera_Updated.Add( OnCameraUpdate );
 	Events.CombatVisBegin.Add( OnCombatVisBegin );
 	Events.CombatVisEnd.Add( OnCombatVisEnd );
 	Events.EndWonderReveal.Add( OnEndWonderReveal );

mappinpopup.lua

@@ -8,11 +8,12 @@ include( "PlayerTargetLogic" );
 include( "ToolTipHelper" );
 include( "MapTacks" );
 
+
 ----------------------------------------------------------------
 -- Globals
 ----------------------------------------------------------------
-local COLOR_YELLOW				:number = 0xFF2DFFF8;
-local COLOR_WHITE				:number = 0xFFFFFFFF;
+local COLOR_YELLOW : number = UI.GetColorValue("COLOR_YELLOW");
+local COLOR_WHITE  : number = UI.GetColorValue("COLOR_WHITE");
 
 local NO_EDIT_PIN_ID :number = -1;
 local g_editPinID :number = NO_EDIT_PIN_ID;
@@ -126,24 +127,46 @@ function PopulateIconOptions()
 	g_iconOptionEntries = {};
 	Controls.IconOptionStack:DestroyAllChildren();
 
-	-- calculate column width
-	local columns = 7;
-	for j, section in ipairs(g_iconPulldownOptions) do
-		local width = #section;
-		if columns < width and width <= 21 and 1 < j then
-			columns = width;
+	-- Fit the icons within 1024x768
+	-- If a mod adds a ton of new improvements/districts we might need to add a scrollbar
+	local MIN_COLS = 8;
+	local MAX_COLS = 18;
+	local MAX_ROWS = 12;
+
+	-- find the dimensions that have the fewest blank spaces that fits the minimum resolution
+	local columns = MAX_COLS;
+	local nMinBlanks = MAX_COLS * MAX_ROWS;
+	for i=MIN_COLS,MAX_COLS do
+		local nBlanks = 0;
+		local nRows = 0;
+		for j, section in ipairs(g_iconPulldownOptions) do
+			nRows = nRows + math.ceil(#section / i);
+			local remainder = #section % i;
+			if remainder > 0 then
+				nBlanks = nBlanks + (i - remainder);
+			end
+		end
+		if nBlanks < nMinBlanks and nRows <= MAX_ROWS then
+			nMinBlanks = nBlanks;
+			columns = i;
 		end
 	end
-	local sectionTable = {};
+	print("Selected " .. columns .. " columns");
+
 	local controlTable = {};
 	local newIconEntry = {};
 	for j, section in ipairs(g_iconPulldownOptions) do
 		g_iconOptionEntries[j] = {};
+		local sectionTable = {};
 		ContextPtr:BuildInstanceForControl( "IconOptionRowInstance", sectionTable, Controls.IconOptionStack );
 		-- dynamically determine section spacing
 		local ht = math.floor((#section + columns - 1) / columns);
-		local wd = math.floor((#section + ht - 1) / ht);
-		sectionTable.IconOptionRowStack:SetWrapWidth(40 * ht);
+		local wd = columns;
+		-- rebalance sections with very short final rows
+		if (#section % wd) < MIN_COLS then
+			wd = math.floor((#section + ht - 1) / ht);
+		end
+		sectionTable.IconOptionRowStack:SetWrapWidth(44 * wd);
 		if j > 1 and (ht > 1 or columns < #g_iconPulldownOptions[j - 1]) then
 			-- leave a break around multi-row sections
 			sectionTable.IconOptionRowStack:SetOffsetY(8);
@@ -165,29 +188,26 @@ function PopulateIconOptions()
 			g_iconOptionEntries[j][i] = newIconEntry;
 
 			UpdateIconOptionColor(i, j);
-		end
-		for i=#section+1,ht*wd do
-			-- fill out section blocks with disabled boxes
-			controlTable = {};
-			ContextPtr:BuildInstanceForControl( "IconOptionInstance", controlTable, sectionTable.IconOptionRowStack );
-			controlTable.IconOptionButton:SetDisabled(true);
-			controlTable.Icon:SetHide(true);
+			
+			if (#section % wd) ~= 0 then
+				-- this section has a partially filled row, create a new stack at
+				-- the end of the final full row, so it can be centered properly
+				if (i % wd) == 0 and (i / wd) == (ht - 1) then
+					sectionTable = {};
+					ContextPtr:BuildInstanceForControl( "IconOptionRowInstance", sectionTable, Controls.IconOptionStack );
+					sectionTable.IconOptionRowStack:SetWrapWidth(44 * wd);
+				end
+			end
 		end
 	end
 
 	-- set width dynamically according to widest section
 	Controls.Window:SetSizeX(44 * columns + 30);
 	Controls.OptionsStack:SetWrapWidth(44 * columns + 8);
-	-- Controls.PinFrame:SetSizeX(44 * (columns - 4) + 2);
 	Controls.IconOptionStack:CalculateSize();
-	Controls.IconOptionStack:ReprocessAnchoring();
 	Controls.OptionsStack:CalculateSize();
-	Controls.OptionsStack:ReprocessAnchoring();
 	Controls.WindowContentsStack:CalculateSize();
-	Controls.WindowContentsStack:ReprocessAnchoring();
 	Controls.WindowStack:CalculateSize();
-	Controls.WindowStack:ReprocessAnchoring();
-	Controls.WindowContainer:ReprocessAnchoring();
 end
 
 -- ===========================================================================

mappinpopup.xml

@@ -2,7 +2,6 @@
 <Context xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\..\..\..\..\CivTech\Libs\ForgeUI\ForgeUI_Assets\Controls.xsd"
   ColorSet="Beige_Black" FontStyle="Shadow">
 
-
   <Box Color="0,0,0,150" Size="parent,parent" ConsumeMouse="1">
     <AlphaAnim        ID="PopupAlphaIn" AlphaBegin="0" AlphaEnd="1" Speed="3" Function="Root" Cycle="Once" Size="parent,parent">
       <SlideAnim      ID="PopupSlideIn" Start="0,-20" End="0,0" Speed="3" Function="Root" Cycle="Once" Size="parent,parent">
@@ -45,7 +44,7 @@
   </Box>
 
   <Instance Name="IconOptionRowInstance">
-    <Stack ID="IconOptionRowStack" Anchor="C,T" StackGrowth="Down" Padding="4" WrapWidth="40" WrapGrowth="Right"/>
+    <Stack ID="IconOptionRowStack" Anchor="C,T" StackGrowth="Right" Padding="4" WrapWidth="40" WrapGrowth="Down"/>
   </Instance>
 
   <Instance Name="IconOptionInstance">