Merge pull request #33 from bszonye/feb-2018

Rise & Fall compatibility

Author: bszonye

README.md

@@ -1,4 +1,4 @@
-# Map Tacks 0.9.1 [<img align="right" src="maptacks.png" height="256" width="256">](https://steamcommunity.com/sharedfiles/filedetails/?id=1122081356)
+# Map Tacks 0.9.2 [<img align="right" src="maptacks.png" height="256" width="256">](https://steamcommunity.com/sharedfiles/filedetails/?id=1122081356)
 Enhances map pin list  
 Adds new icon options  
 Fixes base-game bugs  
@@ -17,13 +17,12 @@ for all builder and engineer actions, great people, and several common unit
 operations, plus a golden hexagon to mark wonder sites.
 
 ## Bug fixes and restyling
-The mod fixes a few base-game bugs and styling problems: Deleting and re-adding
-a pin no longer scrambles the pins. The pin list cannot grow past the top of
-the screen. Unnamed pins sort correctly when there are more than ten. Labels
-and controls have more consistent alignment and spacing.
+The mod fixes a few base-game bugs and styling problems: The pin list cannot
+grow past the top of the screen. Unnamed pins sort correctly when there are
+more than ten. Labels and controls have more consistent alignment and spacing.
 
 ## Compatibility
 The Map Tacks mod does not affect saved games. You can add it to a game in
 progress or disable it without breaking your game. Enabling or disabling the
 mod will not remove any pins that are already on your map, but some may change
-color. This mod layers on top of NQ/CQUI, replacing their map pin features.
+color. This mod layers on top of CQUI, replacing its map pin features.

mappinpopup.lua

@@ -14,7 +14,8 @@ include( "MapTacks" );
 local COLOR_YELLOW				:number = 0xFF2DFFF8;
 local COLOR_WHITE				:number = 0xFFFFFFFF;
 
-local g_editMapPinID :number = nil;
+local NO_EDIT_PIN_ID :number = -1;
+local g_editPinID :number = NO_EDIT_PIN_ID;
 local g_uniqueIconsPlayer :number = nil;  -- tailor UAs to the player
 local g_iconOptionEntries = {};
 local g_visibilityTargetEntries = {};
@@ -133,6 +134,8 @@ end
 
 -- ===========================================================================
 function PopulateIconOptions()
+	-- unique icons are specific to the current player
+	g_uniqueIconsPlayer = Game.GetLocalPlayer();
 	-- build icon table with default pins + extensions
 	g_iconPulldownOptions = MapTacksIconOptions(g_stockIcons);
 
@@ -191,14 +194,6 @@ function UpdateIconOptionColor(iconEntryIndex :number)
 	end
 end
 
--- ===========================================================================
-function GetMapPinID(id :number)
-	if id == nil then return nil; end
-	local activePlayerID = Game.GetLocalPlayer();
-	local pPlayerCfg = PlayerConfigurations[activePlayerID];
-	return pPlayerCfg:GetMapPinID(id);
-end
-
 -- ===========================================================================
 function RequestMapPin(hexX :number, hexY :number)
 	local activePlayerID = Game.GetLocalPlayer();
@@ -207,17 +202,14 @@ function RequestMapPin(hexX :number, hexY :number)
 	local pPlayerCfg = PlayerConfigurations[activePlayerID];
 	local pMapPin = pPlayerCfg:GetMapPin(hexX, hexY);
 	if(pMapPin ~= nil) then
-		g_editMapPinID = pMapPin:GetID()
-
+		g_editPinID = pMapPin:GetID();
 		g_desiredIconName = pMapPin:GetIconName();
 		if GameConfiguration.IsAnyMultiplayer() then
 			MapPinVisibilityToPlayerTarget(pMapPin:GetVisibility(), g_playerTarget);
 			UpdatePlayerTargetPulldown(Controls.VisibilityPull, g_playerTarget);
 			Controls.VisibilityContainer:SetHide(false);
 		else
 			Controls.VisibilityContainer:SetHide(true);
-			-- XXX debug
-			-- Controls.VisibilityContainer:SetHide(false);
 		end
 
 		Controls.PinName:SetText(pMapPin:GetName());
@@ -244,6 +236,20 @@ function RequestMapPin(hexX :number, hexY :number)
 	end
 end
 
+-- ===========================================================================
+-- Returns the map pin configuration for the pin we are currently editing.
+-- Do not cache the map pin configuration because it will get destroyed by other processes.  Use it and get out!
+function GetEditPinConfig()
+	if(g_editPinID ~= NO_EDIT_PIN_ID) then
+		local activePlayerID = Game.GetLocalPlayer();
+		local pPlayerCfg = PlayerConfigurations[activePlayerID];
+		local pMapPin = pPlayerCfg:GetMapPinID(g_editPinID);
+		return pMapPin;
+	end
+
+	return nil;
+end
+
 -- ===========================================================================
 function OnChatPanel_PlayerTargetChanged(playerTargetTable)
 	g_cachedChatPanelTarget = playerTargetTable;
@@ -254,16 +260,19 @@ end
 
 -- ===========================================================================
 function ShowHideSendToChatButton()
-	local pMapPin = GetMapPinID(g_editMapPinID);
-	local showSendButton = pMapPin ~= nil and not pMapPin:IsPrivate() and GameConfiguration.IsNetworkMultiplayer();
-	-- XXX debug
-	-- showSendButton = true;
+	local editPin = GetEditPinConfig();
+	if(editPin == nil) then
+		return;
+	end
+
+	local privatePin = editPin:IsPrivate();
+	local showSendButton = GameConfiguration.IsNetworkMultiplayer() and not privatePin;
 
 	Controls.SendToChatButton:SetHide(not showSendButton);
 
 	-- Send To Chat disables itself if the current chat panel target is not visible to the map pin.
 	if(showSendButton) then
-		local chatVisible = MapPinIsVisibleToChatTarget(pMapPin:GetVisibility(), g_cachedChatPanelTarget);
+		local chatVisible = MapPinIsVisibleToChatTarget(editPin:GetVisibility(), g_cachedChatPanelTarget);
 		Controls.SendToChatButton:SetDisabled(not chatVisible);
 		if(chatVisible) then
 			Controls.SendToChatButton:SetToolTipString(sendToChatTTStr);
@@ -286,13 +295,13 @@ end
 -- ===========================================================================
 function OnOk()
 	if( not ContextPtr:IsHidden() ) then
-		local pMapPin = GetMapPinID(g_editMapPinID);
-		if(pMapPin ~= nil) then
-			pMapPin:SetName(Controls.PinName:GetText());
-			pMapPin:SetIconName(g_desiredIconName);
+		local editPin = GetEditPinConfig();
+		if(editPin ~= nil) then
+			editPin:SetName(Controls.PinName:GetText());
+			editPin:SetIconName(g_desiredIconName);
 
 			local newMapPinVisibility = PlayerTargetToMapPinVisibility(g_playerTarget);
-			pMapPin:SetVisibility(newMapPinVisibility);
+			editPin:SetVisibility(newMapPinVisibility);
 
 			Network.BroadcastPlayerInfo();
 			UI.PlaySound("Map_Pin_Add");
@@ -305,19 +314,23 @@ end
 
 -- ===========================================================================
 function OnSendToChatButton()
-	local pMapPin = GetMapPinID(g_editMapPinID);
-	if(pMapPin ~= nil) then
-		pMapPin:SetName(Controls.PinName:GetText());
-		LuaEvents.MapPinPopup_SendPinToChat(pMapPin:GetPlayerID(), pMapPin:GetID());
+	local editPinCfg = GetEditPinConfig();
+	if(editPinCfg ~= nil) then
+		editPinCfg:SetName(Controls.PinName:GetText());
+		LuaEvents.MapPinPopup_SendPinToChat(editPinCfg:GetPlayerID(), editPinCfg:GetID());
 	end
 end
 
 -- ===========================================================================
 function OnDelete()
-	if(g_editMapPinID ~= nil) then
+	local editPinCfg = GetEditPinConfig();
+	if(editPinCfg ~= nil) then
 		local activePlayerID = Game.GetLocalPlayer();
 		local pPlayerCfg = PlayerConfigurations[activePlayerID];
-		pPlayerCfg:DeleteMapPin(g_editMapPinID);
+		local deletePinID = editPinCfg:GetID();
+
+		g_editPinID = NO_EDIT_PIN_ID;
+		pPlayerCfg:DeleteMapPin(deletePinID);
 		Network.BroadcastPlayerInfo();
 		UI.PlaySound("Map_Pin_Remove");
 	end
@@ -331,12 +344,12 @@ end
 -- Event Handlers
 ---------------------------------------------------------------- 
 function OnMapPinPlayerInfoChanged( playerID :number )
-	PlayerTarget_OnPlayerInfoChanged( playerID, Controls.VisibilityPull, nil, g_visibilityTargetEntries, g_playerTarget, true);
+	PlayerTarget_OnPlayerInfoChanged( playerID, Controls.VisibilityPull, nil, nil, g_visibilityTargetEntries, g_playerTarget, true);
 end
 
 function OnLocalPlayerChanged()
 	g_playerTarget.targetID = Game.GetLocalPlayer();
-	PopulateTargetPull(Controls.VisibilityPull, nil, g_visibilityTargetEntries, g_playerTarget, true, OnVisibilityPull);
+	PopulateTargetPull(Controls.VisibilityPull, nil, nil, g_visibilityTargetEntries, g_playerTarget, true, OnVisibilityPull);
 
 	if( not ContextPtr:IsHidden() ) then
 		UIManager:DequeuePopup( ContextPtr );
@@ -365,7 +378,7 @@ function Initialize()
 	ContextPtr:SetInputHandler( OnInputHandler, true );
 
 	PopulateIconOptions();
-	PopulateTargetPull(Controls.VisibilityPull, nil, g_visibilityTargetEntries, g_playerTarget, true, OnVisibilityPull);
+	PopulateTargetPull(Controls.VisibilityPull, nil, nil, g_visibilityTargetEntries, g_playerTarget, true, OnVisibilityPull);
 	Controls.DeleteButton:RegisterCallback(Mouse.eLClick, OnDelete);
 	Controls.DeleteButton:RegisterCallback( Mouse.eMouseEnter, function() UI.PlaySound("Main_Menu_Mouse_Over"); end);
 	Controls.SendToChatButton:RegisterCallback(Mouse.eLClick, OnSendToChatButton);
@@ -385,6 +398,12 @@ function Initialize()
 	-- We have to do this because the map pin's context is loaded after the chat panel's 
 	-- and the chat panel's show/hide handler is not triggered as expected.
 	LuaEvents.MapPinPopup_RequestChatPlayerTarget();
+
+	local canChangeName = GameCapabilities.HasCapability("CAPABILITY_RENAME");
+	if(not canChangeName) then
+		Controls.PinFrame:SetHide(true);
+	end
+
 end
 Initialize();
 

mappinpopup.xml

@@ -8,19 +8,19 @@
       <SlideAnim      ID="PopupSlideIn" Start="0,-20" End="0,0" Speed="3" Function="Root" Cycle="Once" Size="parent,parent">
 
         <Grid           ID="WindowContainer" Size="auto,auto" Anchor="C,C" Offset="0,0" Style="DropShadow2"     Color="255,255,255,200" AutoSizePadding="25,25" ConsumeMouse="1">
-          <Grid         ID="Window"      Size="650,auto" Anchor="C,C" Offset="0,0" Style="WindowFrameTitle" AutoSizePadding="0,12">
+          <Grid         ID="Window"      Size="690,auto" Anchor="C,C" Offset="0,0" Style="WindowFrameTitle" AutoSizePadding="0,12">
             <Stack      ID="WindowStack" StackGrowth="Down" Padding="10" Anchor="C,T">
               <Container                 Size="330,42" Anchor="C,T">
                 <Label  ID="TitleText"   Style="WindowHeader"        Anchor="C,C" String="{LOC_MAP_PIN_POPUP_TITLE:upper}" />
               </Container>
               <Container Size="auto,auto" Anchor="C,T">
                 <Stack		ID="WindowContentsStack"  Anchor="L,T" StackGrowth="Bottom" Padding="12">
                   <!-- Name -->
-                  <Grid Style="EditTextButton" Anchor="C,T" Size="310,26">
+                  <Grid ID="PinFrame" Style="EditTextButton" Anchor="C,T" Size="310,26">
                     <EditBox ID="PinName" Style="EditTextArea" Size="parent-34,22" Anchor="R,C" Offset="4,0" MaxLength="20" EditMode="0" KeepFocus="1"/>
                   </Grid>
                   <!-- Icons -->
-                  <Stack ID="IconOptionStack" Anchor="C,T" StackGrowth="Right" Padding="4" WrapWidth="616" WrapGrowth="Down"/>
+                  <Stack ID="IconOptionStack" Anchor="C,T" StackGrowth="Right" Padding="4" WrapWidth="660" WrapGrowth="Down"/>
                   <!-- Visible to.. -->
 									<Container ID="VisibilityContainer" Anchor="C,T" Size="1,26" Hidden="1">
 										<PullDown ID="VisibilityPull" Anchor="C,T" Size="150,26" Style="WBPullDown"/>

maptacks.lua

@@ -60,23 +60,19 @@ local g_miscOps = {
 	GameInfo.UnitOperations.UNITOPERATION_DESIGNATE_PARK,
 	GameInfo.UnitOperations.UNITOPERATION_EXCAVATE,
 	GameInfo.UnitOperations.UNITOPERATION_MAKE_TRADE_ROUTE,
-	GameInfo.Units.UNIT_SPY,
-	GameInfo.UnitCommands.UNITCOMMAND_ACTIVATE_GREAT_PERSON,
-};
-local g_attackOps = {
-	GameInfo.UnitCommands.UNITCOMMAND_FORM_ARMY,
---	GameInfo.UnitOperations.UNITOPERATION_AIR_ATTACK,
 	GameInfo.UnitOperations.UNITOPERATION_WMD_STRIKE,
 	GameInfo.UnitOperations.UNITOPERATION_PILLAGE,
 	GameInfo.UnitCommands.UNITCOMMAND_PLUNDER_TRADE_ROUTE,
+	GameInfo.UnitCommands.UNITCOMMAND_FORM_ARMY,
+	GameInfo.Units.UNIT_SPY,
+	GameInfo.UnitCommands.UNITCOMMAND_ACTIVATE_GREAT_PERSON,
 };
 
 -- ===========================================================================
 -- Build the grid of map pin icon options
 function MapTacksIconOptions(stockIcons : table)
 	local icons = {};
 	local activePlayerID = Game.GetLocalPlayer();
-	g_uniqueIconsPlayer = activePlayerID;
 	local pPlayerCfg = PlayerConfigurations[activePlayerID];
 
 	local leader = GameInfo.Leaders[pPlayerCfg:GetLeaderTypeID()];
@@ -112,14 +108,15 @@ function MapTacksIconOptions(stockIcons : table)
 	end
 
 	-- Districts
+	table.insert(icons, MapTacksIcon(GameInfo.Districts.DISTRICT_WONDER, "DistrictType"));
 	for item in GameInfo.Districts() do
 		local itype = item.DistrictType;
 		if districts[itype] then
 			-- unique district replacements for this civ
 			table.insert(icons, MapTacksIcon(districts[itype], "DistrictType"));
 		elseif item.TraitType then
 			-- skip other unique districts
-		else
+		elseif itype ~= "DISTRICT_WONDER" then
 			table.insert(icons, MapTacksIcon(item, "DistrictType"));
 		end
 	end
@@ -153,13 +150,13 @@ function MapTacksIconOptions(stockIcons : table)
 		end
 	end
 
-	for i,v in ipairs(builderIcons) do table.insert(icons, v); end
-	for i,v in ipairs(g_buildOps) do table.insert(icons, MapTacksIcon(v)); end
 	if #uniqueIcons==0 then
 		table.insert(icons, MapTacksIcon(
 			GameInfo.UnitOperations.UNITOPERATION_BUILD_IMPROVEMENT))
 	end
 	for i,v in ipairs(uniqueIcons) do table.insert(icons, v); end
+	for i,v in ipairs(builderIcons) do table.insert(icons, v); end
+	for i,v in ipairs(g_buildOps) do table.insert(icons, MapTacksIcon(v)); end
 	for i,v in ipairs(minorCivIcons) do table.insert(icons, v); end
 	for i,v in ipairs(g_repairOps) do table.insert(icons, MapTacksIcon(v)); end
 	for i,v in ipairs(miscIcons) do table.insert(icons, v); end
@@ -170,9 +167,6 @@ function MapTacksIconOptions(stockIcons : table)
 		table.insert(icons, MapTacksIcon(item));
 	end
 
-	-- Unit actions
-	for i,v in ipairs(g_attackOps) do table.insert(icons, MapTacksIcon(v)); end
-
 	return icons;
 end
 

maptacks.modinfo

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Mod id="0a1c826c-0f43-4876-b096-23e1292eee3c" version="0.9.1">
+<Mod id="0a1c826c-0f43-4876-b096-23e1292eee3c" version="0.9.2">
   <Properties>
     <Name>Map Tacks</Name>
     <Description>Map pin improvements</Description>