Ticket #3512: t3512_phaseNotif_WIP_v0.3.patch

binaries/data/config/default.cfg

@@ -54 +54 @@
 display = 0
 
 ; Emulate right-click with Ctrl+Click on Mac mice
 macmouse = false
 
+; Gameplay Settings
+
+; if true, receive automatic notifications from allies about their progress (currently only phasing notifications)
+teamNotification = true
+
 ; System settings:
 
 ; if false, actors won't be rendered but anything entity will be.
 renderactors = true
 

binaries/data/mods/public/gui/options/options.json

@@ -200 +200 @@
             "label": "UI Gain",
             "tooltip": "UI sound gain",
             "parameters": { "config": "sound.uigain", "function": "SetUIGain", "min": "0" }
         }
     ],
+    "gameplaySetting":
+    [
+        {
+            "type": "boolean",
+            "label": "Team Notifications",
+            "tooltip": "Receive automatically created messages from your allies about their progress (currently: only when they are phasing up)",
+            "parameters": { "config": "teamNotification" }
+        }
+    ],
     "lobbySetting":
     [
         {
             "type": "number",
             "label": "Chat Backlog", 

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

@@ -41 +41 @@
                     <object name="graphicsSettingInput[n]" size="70% 0 100%-8 100%" type="input" style="ModernInput" hidden="true"/>
                     <object name="graphicsSettingDropdown[n]" size="70% 0 100%-8 100%" type="dropdown" style="ModernDropDown" hidden="true"/>
                 </object>
             </repeat>
         </object>
-        <object name="SoundSettings" type="image" sprite="ModernDarkBoxGold" size="620 16 916 50%-4">
+        <object name="SoundSettings" type="image" sprite="ModernDarkBoxGold" size="620 16 916 40%-4">
             <object style="ModernLabelText" type="text" size="0 5 100% 25">
                 <translatableAttribute id="caption">Sound Settings</translatableAttribute>
             </object>
             <repeat count="10">
                 <object name="soundSetting[n]" size="0 25 100% 50" hidden="true">
@@ -54 +54 @@
                     <object name="soundSettingInput[n]" size="70% 0 100%-8 100%" type="input" style="ModernInput" hidden="true"/>
                     <object name="soundSettingDropdown[n]" size="70% 0 100%-8 100%" type="dropdown" style="ModernDropDown" hidden="true"/>
                 </object>
             </repeat>
         </object>
-        <object name="LobbySettings" type="image" sprite="ModernDarkBoxGold" size="620 50%+4 916 100%-52">
+        <object name="gameplaySetting" type="image" sprite="ModernDarkBoxGold" size="620 40%+4 916 70%-4">
+            <object style="ModernLabelText" type="text" size="0 5 100% 25">
+                <translatableAttribute id="caption">Gameplay Settings</translatableAttribute>
+            </object>
+            <repeat count="1">
+                <object name="gameplaySetting[n]" size="0 25 100% 50" hidden="true">
+                    <object name="gameplaySettingLabel[n]" size="0 0 65% 100%" type="text" style="ModernLabelText" text_align="left"/>
+                    <object name="gameplaySettingTickbox[n]" size="90% 5 100% 100%+5" type="checkbox" style="ModernTickBox" hidden="true"/>
+                    <object name="gameplaySettingInput[n]" size="70% 0 100%-8 100%" type="input" style="ModernInput" hidden="true"/>
+                    <object name="gameplaySettingDropdown[n]" size="70% 0 100%-8 100%" type="dropdown" style="ModernDropDown" hidden="true"/>
+                </object>
+            </repeat>
+        </object>
+        <object name="LobbySettings" type="image" sprite="ModernDarkBoxGold" size="620 70%+4 916 100%-52">
             <object style="ModernLabelText" type="text" size="0 5 100% 25">
                 <translatableAttribute id="caption">Lobby Settings</translatableAttribute>
             </object>
             <repeat count="10">
                 <object name="lobbySetting[n]" size="0 25 100% 50" hidden="true">

binaries/data/mods/public/gui/session/messages.js

@@ -181 +181 @@
             }
         }
 
         addChatMessage(message);
     },
+    "AutoTeamMsg": function(notification, player)
+    {
+        // do not inform user of his own progress or if the option is not enabled
+        if (Engine.ConfigDB_GetValue("user", "teamNotification") != "true" )//|| notification.players == Engine.GetPlayerID())
+            return;
+        
+        let notification_message = "";
+        if (notification.event == "advancing_phase_town")
+            notification_message = translate("I am advancing to the Town Phase.");
+        else if (notification.event == "advancing_phase_city")
+            mnotification_message = translate("I am advancing to the City Phase.");
+        // TODO: create messages for the events of phase reached, new civil center started, new market built, wonder
+        
+        let message = {
+            "guid": findGuidForPlayerID(player) || -1,
+            "type": "message",
+            "text": "/allies " + notification_message,
+            "translate": true
+        };
+        
+        if (message.guid == -1)
+            message.player = player;
+            
+        addChatMessage(message);
+    },
     "defeat": function(notification, player)
     {
         addChatMessage({
             "type": "defeat",
             "guid": findGuidForPlayerID(player),

binaries/data/mods/public/simulation/helpers/Commands.js

@@ -322 +322 @@
         }
 
         var queue = Engine.QueryInterface(cmd.entity, IID_ProductionQueue);
         if (queue)
             queue.AddBatch(cmd.template, "technology");
+            
+        // if the researched technology is phasing, send a notification to GUI
+        if (cmd.template == "phase_town" || cmd.template == "phase_city")
+        {
+            var cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+            cmpGuiInterface.PushNotification({
+                "type": "AutoTeamMsg",
+                "players": [player],
+                "event": "advancing_" + cmd.template
+            });
+        }
     },
 
     "stop-production": function(player, cmd, data)
     {
         if (!CanControlUnit(cmd.entity, player, data.controlAllUnits))