Ticket #1580: customColorSupport.patch

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -43 +43 @@
 
 var g_ChatMessages = [];
 
+// List of supported player colors. There should be at least as many as the sum of the maximum number of players plus
+// one, so that players can always change color (you can only change to a color that no one else has).
+// That is: 8 + 1 = 9 minimum colors.
+//
+// Note: Player default colors are defined in <mod>/simulation/data/player_defaults.json. These are just colors that you
+// can select manually. It would be great to keep both lists in sync (have here all colors in player_defaults.json plus
+// some more), but it is not mandatory.
+var g_PlayerColors = [
+    { "r":  46, "g":  46, "b": 200, "displayName": "Blue" },
+    { "r": 150, "g":  20, "b":  20, "displayName": "Red" },
+    { "r":  50, "g": 165, "b":   5, "displayName": "Green" },
+    { "r": 230, "g": 230, "b":  75, "displayName": "Yellow" },
+    { "r":  50, "g": 170, "b": 170, "displayName": "Cyan" },
+    { "r": 160, "g":  80, "b": 200, "displayName": "Purple" },
+    { "r": 235, "g": 120, "b":  20, "displayName": "Orange" },
+    { "r":  64, "g":  64, "b":  64, "displayName": "Gray" },
+    { "r": 230, "g":  60, "b": 105, "displayName": "Fandango" }
+];
+var g_PlayerColorsSorted = [];
+var g_PlayerColorIdsSorted = [];
+var g_PlayerColorDisplayNamesSorted = [];
+
 // Data caches
 var g_MapData = {};
 var g_CivData = {};
@@ -301 +323 @@
                 updateGameAttributes();
         };
 
+        // Populate color drop-down lists.
+        var colorPicker = getGUIObjectByName("playerColorPicker["+i+"]");
+        colorPicker.list = getPlayerColorLabelsSorted();
+        colorPicker.list_data = getPlayerColorIdsSorted();
+        colorPicker.selected = -1;
+        colorPicker.onSelectionChange = function()
+        {       // Update color
+            if (this.selected !== -1)
+            {
+                var numPlayers = g_GameAttributes.settings.PlayerData.length;
+                var used = 0;
+                var playerColorsSorted = getPlayerColorsSorted();
+                for (var o = 0; o < numPlayers; o++)
+                {
+                    if (rgbValuesMatch(playerColorsSorted[this.list_data[this.selected]], g_GameAttributes.settings.PlayerData[o].Colour))
+                    {
+                        ++used;
+                        break;
+                    }
+                }
+                if (!used)
+                {
+                    copyRgbValuesFromColorIntoColor(playerColorsSorted[this.list_data[this.selected]], g_GameAttributes.settings.PlayerData[playerSlot].Colour);
+                }
+            }
+            if (!g_IsInGuiUpdate)
+            {
+                updateGameAttributes();
+            }
+        };
+
         // Set events
         var civ = getGUIObjectByName("playerCiv["+i+"]");
         civ.onSelectionChange = function()
@@ -386 +439 @@
     }
 }
 
+// Returns the index of the specified color.
+function getIndexOfColor(color)
+{
+    for (var i = 0; i < g_PlayerColors.length; ++i)
+    {
+        var playerColorsSorted = getPlayerColorsSorted();
+        if (rgbValuesMatch(playerColorsSorted[i], color))
+        {
+            return i;
+        }
+    }
+    return -1;
+}
+
+// Get list of player colors sorted by color value.
+// See http://stackoverflow.com/a/11923973/939364
+function getPlayerColorsSorted()
+{
+    if (g_PlayerColorsSorted.length === 0)
+    {
+        function rgbToHsl(color){
+            var r = color.r/255, g = color.g/255, b = color.b/255;
+            var max = Math.max(r, g, b), min = Math.min(r, g, b);
+            var h, s, l = (max + min) / 2;
+            if (max === min)
+            {
+                h = s = 0; // achromatic
+            }
+            else
+            {
+                var d = max - min;
+                s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
+                switch(max)
+                {
+                    case r: h = (g - b) / d + (g < b ? 6 : 0); break;
+                    case g: h = (b - r) / d + 2; break;
+                    case b: h = (r - g) / d + 4; break;
+                }
+                h /= 6;
+            }
+            return new Array(h * 360, s * 100, l * 100);
+        }
+
+        var hslArray = new Array();
+        for (var i = 0; i < g_PlayerColors.length; ++i)
+        {
+            //Transforming rgb to hsl
+            //`hslArray[i][1]` (`i`) is a reference to the rgb color, in order to retrieve it later
+            hslArray[i] = [rgbToHsl(g_PlayerColors[i]),i];
+        }
+
+        var sortedHslArray = new Array();
+        outerloop:
+        for (var i = 0; i < hslArray.length; ++i)
+        {
+            for (var j = 0; j < sortedHslArray.length; ++j)
+            {
+                if (sortedHslArray[j][0][0] > hslArray[i][0][0])
+                {
+                    sortedHslArray.splice(j, 0, hslArray[i]);
+                    continue outerloop;
+                }
+            }
+            sortedHslArray.push(hslArray[i]);
+        }
+
+        for (var i = 0; i < sortedHslArray.length; ++i)
+        {
+            g_PlayerColorsSorted[i] = g_PlayerColors[sortedHslArray[i][1]];
+        }
+    }
+    return g_PlayerColorsSorted;
+}
+
+// Get a list of player color display names.
+function getPlayerColorLabelsSorted()
+{
+    if (g_PlayerColorDisplayNamesSorted.length === 0)
+    {
+        var playerColorsSorted = getPlayerColorsSorted();
+        for (var i = 0; i < playerColorsSorted.length; ++i)
+        {
+            g_PlayerColorDisplayNamesSorted[i] = "[color=\"" + playerColorsSorted[i].r + " " + playerColorsSorted[i].g + " " + playerColorsSorted[i].b + " 255\"]" + playerColorsSorted[i].displayName;
+        }
+    }
+    return g_PlayerColorDisplayNamesSorted;
+}
+
+// Get a simple list of color IDs, basically a list of indexes that has as many members as colors there are.
+function getPlayerColorIdsSorted()
+{
+    if (g_PlayerColorIdsSorted.length === 0)
+    {
+        var playerColorsSorted = getPlayerColorsSorted();
+        for (var i = 0; i < playerColorsSorted.length; ++i)
+        {
+            g_PlayerColorIdsSorted[i] = i;
+        }
+    }
+    return g_PlayerColorIdsSorted;
+}
+
+// Determine whether two specified variables contain the same RGB data.
+function rgbValuesMatch(color1, color2)
+{
+    return color1.r === color2.r && color1.g === color2.g && color1.b === color2.b;
+}
+
+// Copy the RGB data from the first color into the second color.
+function copyRgbValuesFromColorIntoColor(color1, color2)
+{
+    color2.r = color1.r;
+    color2.g = color1.g;
+    color2.b = color1.b;
+}
+
 // Get display name from map data
 function getMapDisplayName(map)
 {
@@ -1075 +1244 @@
         var pTeam = getGUIObjectByName("playerTeam["+i+"]");
         var pTeamText = getGUIObjectByName("playerTeamText["+i+"]");
         var pColor = getGUIObjectByName("playerColour["+i+"]");
+        var pColorPicker = getGUIObjectByName("playerColorPicker["+i+"]");
 
         // Player data / defaults
         var pData = mapSettings.PlayerData ? mapSettings.PlayerData[i] : {};
         var pDefs = g_DefaultPlayerData ? g_DefaultPlayerData[i] : {};
 
         // Common to all game types
-        var color = iColorToString(getSetting(pData, pDefs, "Colour"));
-        pColor.sprite = "colour:"+color+" 100";
+        var color = getSetting(pData, pDefs, "Colour");
+        pColor.sprite = "colour:" + iColorToString(color) + " 100";
         pName.caption = getSetting(pData, pDefs, "Name");
 
         var team = getSetting(pData, pDefs, "Team");
@@ -1095 +1265 @@
             pCiv.hidden = true;
             pTeamText.hidden = false;
             pTeam.hidden = true;
+            pColorPicker.hidden = true;
             // Set text values
             if (civ == "random")
                 pCivText.caption = "[color=\"orange\"]Random";
@@ -1108 +1279 @@
             pCiv.hidden = false;
             pTeamText.hidden = true;
             pTeam.hidden = false;
+            pColorPicker.hidden = false;
             // Set dropdown values
             pCiv.selected = (civ ? pCiv.list_data.indexOf(civ) : 0);
             pTeam.selected = (team !== undefined && team >= 0) ? team+1 : 0;
+            pColorPicker.selected = getIndexOfColor(color);
         }
     }
 

binaries/data/mods/public/gui/gamesetup/gamesetup.xml

@@ -59 +59 @@
             <!-- Player assignments -->
             <object size="24 59 100%-440 358" type="image" sprite="BackgroundIndentFillDark" name="playerAssignmentsPannel">
                 <object size="0 6 100% 30">
-                    <object name="playerNameHeading" type="text" style="CenteredLabelText" size="0 0 25% 100%">Player Name</object>
-                    <object name="playerPlacementHeading" type="text" style="CenteredLabelText" size="25%+5 0 55% 100%">Player Placement</object>
-                    <object name="playerCivHeading" type="text" style="CenteredLabelText" size="55%+65 0 85% 100%">Civilization</object>
+                    <object name="playerNameHeading" type="text" style="CenteredLabelText" size="0 0 20% 100%">Player Name</object>
+                    <object name="playerPlacementHeading" type="text" style="CenteredLabelText" size="35%+5 0 60% 100%">Player Placement</object>
+                    <object name="playerCivHeading" type="text" style="CenteredLabelText" size="60%+65 0 85% 100%">Civilization</object>
                     <object name="civInfoButton"
                         type="button"
                         sprite="iconInfoGold"
@@ -80 +80 @@
                     <repeat count="8">
                         <object name="playerBox[n]" size="0 0 100% 32" hidden="true">
                             <object name="playerColour[n]" type="image" size="0 0 100% 100%"/>
-                            <object name="playerName[n]" type="text" style="CenteredLabelText" size="0 2 25% 30"/>
-                            <object name="playerAssignment[n]" type="dropdown" style="StoneDropDown" size="25%+5 2 55% 30" tooltip_style="onscreenToolTip" tooltip="Select player."/>
-                            <object name="playerConfig[n]" type="button" style="StoneButton" size="55%+5 6 55%+60 26"
+                            <object name="playerName[n]" type="text" style="CenteredLabelText" size="0 2 20% 30"/>
+                            <object name="playerColorPicker[n]" type="dropdown" style="StoneDropDown" size="20%+5 2 35% 30" tooltip_style="onscreenToolTip" tooltip="Select color."/>
+                            <object name="playerAssignment[n]" type="dropdown" style="StoneDropDown" size="35%+5 2 60% 30" tooltip_style="onscreenToolTip" tooltip="Select player."/>
+                            <object name="playerConfig[n]" type="button" style="StoneButton" size="60%+5 6 60%+60 26"
                                 tooltip_style="onscreenToolTip"
                                 tooltip="Configure AI settings."
                                 font="serif-bold-stroke-12"
                             >Settings</object>
-                            <object name="playerCiv[n]" type="dropdown" style="StoneDropDown" size="55%+65 2 85% 30" tooltip_style="onscreenToolTip" tooltip="Select player's civilization."/>
-                            <object name="playerCivText[n]" type="text" style="CenteredLabelText" size="55%+65 0 85% 30"/>
+                            <object name="playerCiv[n]" type="dropdown" style="StoneDropDown" size="60%+65 2 85% 30" tooltip_style="onscreenToolTip" tooltip="Select player's civilization."/>
+                            <object name="playerCivText[n]" type="text" style="CenteredLabelText" size="60%+65 0 85% 30"/>
                             <object name="playerTeam[n]" type="dropdown" style="StoneDropDown" size="85%+5 2 100%-5 30" tooltip_style="onscreenToolTip" tooltip="Select player's team."/>
                             <object name="playerTeamText[n]" type="text" style="CenteredLabelText" size="85%+5 0 100%-5 100%"/>
                         </object>