Ticket #1719: AttackNotificationApr072013.patch

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

@@ -78 +78 @@
             "amounts": notification.amounts
         });
     }
+    else if (notification.type == "attack")
+    {
+        if (notification.player == Engine.GetPlayerID())
+        {
+            Engine.GuiInterfaceCall("PlaySound", { "name":"attacked", "entity": notification.message.target });
+        }
+    }
     else
     {
         // Only display notifications directed to this player
@@ -356 +363 @@
 
         formatted = "[color=\"" + playerColor + "\"]" + username + "[/color] has sent you " + amounts + ".";
         break;
+    case "attack":
+        if (msg.player != Engine.GetPlayerID()) 
+            return;
+
+        formatted = "We're under attack!";
+        break;
     case "message":
         // May have been hidden by the 'team' command.
         if (msg.hide)

binaries/data/mods/public/simulation/components/GuiInterface.js

@@ -620 +620 @@
     return cmpBattleDetection.GetState();
 };
 
+// Returns a list of ongoing attacks against the player.
+GuiInterface.prototype.GetIncomingAttacks = function(player)
+{
+    var cmpAttackDetection = QueryPlayerIDInterface(player, IID_AttackDetection);
+    return cmpAttackDetection.GetIncomingAttacks();
+};
+
 // Used to show a red square over GUI elements you can't yet afford.
 GuiInterface.prototype.GetNeededResources = function(player, amounts)
 {
@@ -1720 +1727 @@
     "CheckTechnologyRequirements": 1,
     "GetStartedResearch": 1,
     "GetBattleState": 1,
+    "GetIncomingAttacks": 1,
     "GetNeededResources": 1,
     "GetNextNotification": 1,
 

binaries/data/mods/public/simulation/components/interfaces/AttackDetection.js

@@ +1 @@
+Engine.RegisterInterface("AttackDetection");
+
+// Message of the form { "target": 123, "x": 123, "z": 456, "time": 1 }.
+// sent when an entity is attacked.
+//Engine.RegisterMessageType("EntityAttacked");
+
+// Message of the form { "player": 1, "event": { "target": 123 , "position": { "x": 123, "z": 456 }, "time": 1, }.
+// sent when a new attack is detected.
+Engine.RegisterMessageType("AttackDetected");

binaries/data/mods/public/simulation/templates/special/player.xml

@@ -12 +12 @@
   <Player/>
   <StatisticsTracker/>
   <TechnologyManager/>
+  <AttackDetection/>
   <BattleDetection>
     <TimerInterval>200</TimerInterval>
     <RecordLength>12</RecordLength>

binaries/data/mods/public/simulation/templates/template_structure.xml

@@ -85 +85 @@
       <select>interface/select/building/sel_universal.xml</select>
       <constructed>interface/complete/building/complete_universal.xml</constructed>
       <death>attack/destruction/building_collapse_large.xml</death>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>   
     </SoundGroups>
   </Sound>
   <StatusBars>

binaries/data/mods/public/simulation/templates/template_unit_cavalry.xml

@@ -79 +79 @@
       <walk>actor/mounted/movement/walk.xml</walk>
       <run>actor/mounted/movement/walk.xml</run>
       <attack>attack/weapon/sword.xml</attack>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
       <death>actor/fauna/death/death_horse.xml</death>
       <trained>interface/alarm/alarm_create_cav.xml</trained>
     </SoundGroups>

binaries/data/mods/public/simulation/templates/template_unit_champion.xml

@@ -14 +14 @@
     <stone>0</stone>
     <metal>20</metal>
   </Loot>
+  <Sound>
+    <SoundGroups>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
+    </SoundGroups>
+  </Sound>
 </Entity>

binaries/data/mods/public/simulation/templates/template_unit_hero.xml

@@ -60 +60 @@
   <Sound>
     <SoundGroups>
       <attack>attack/weapon/sword.xml</attack>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
       <death>actor/human/death/death.xml</death>
     </SoundGroups>
   </Sound>

binaries/data/mods/public/simulation/templates/template_unit_infantry.xml

@@ -92 +92 @@
   <Sound>
     <SoundGroups>
       <select>voice/hellenes/civ/civ_male_select.xml</select>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
       <order_walk>voice/hellenes/civ/civ_male_ack.xml</order_walk>
       <order_attack>voice/hellenes/civ/civ_male_attack.xml</order_attack>
       <order_gather>voice/hellenes/civ/civ_male_ack.xml</order_gather>

binaries/data/mods/public/simulation/templates/template_unit_mechanical.xml

@@ -21 +21 @@
     <stone>0</stone>
     <metal>25</metal>
   </Loot>
+  <Sound>
+    <SoundGroups>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
+    </SoundGroups>
+  </Sound>
 </Entity>

binaries/data/mods/public/simulation/templates/template_unit_support.xml

@@ -23 +23 @@
   <Sound>
     <SoundGroups>
       <trained>interface/alarm/alarm_create_worker.xml</trained>
+      <attacked>interface/alarm/alarm_attackplayer.xml</attacked>
     </SoundGroups>
   </Sound>
   <UnitAI>

source/gui/MiniMap.cpp

@@ -1 @@
-/* Copyright (C) 2012 Wildfire Games.
+/* Copyright (C) 2013 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -69 +69 @@
         m_ShallowPassageHeight = pathingSettings.GetChild("default").GetChild("MaxWaterDepth").ToFloat();
     else
         m_ShallowPassageHeight = 0.0f;
+
+    m_ChangePingColor = 0;
 }
 
 CMiniMap::~CMiniMap()
@@ -469 +471 @@
                 v.a = 255;
                 v.x = posX.ToFloat()*sx;
                 v.y = -posZ.ToFloat()*sy;
+
+                // Check minimap pinging to indicate something
+                if (cmpMinimap->IsEntityPinging()) {
+
+                    // Override the normal rendering of the entity with the ping color
+                    // Note: If the pinged entity's dot is rendered over by another entity's
+                    // dot then it will be invisible & the ping will be not be seen.
+                    // We can try to move the pinged dots towards the end in the vertexArray
+                    // Keep 2 pointers and insert pinged dots at end, unpinged at current position
+                    if (m_ChangePingColor > PING_DURATION/2) {
+                        v.r = 255; // bright red
+                        v.g = 1;
+                        v.b = 1;
+                    }
+
+                    // Must reduce ping count every frame
+                    u32 pingCount = cmpMinimap->GetRemainingPingCount();
+                    if (pingCount <= 0) {
+                        // Also turns off ping flag if 0 passed in
+                        cmpMinimap->SetRemainingPingCount(0);
+                    }
+                    else {
+                        cmpMinimap->SetRemainingPingCount(pingCount - 1);
+                    }
+                }
+
                 vertexArray.push_back(v);
             }
         }
     }
 
+    // Cycle the ping color counter as needed
+    m_ChangePingColor = (m_ChangePingColor + 1) > PING_DURATION ? 0 : (m_ChangePingColor + 1);
+
     if (!vertexArray.empty())
     {
         glEnableClientState(GL_VERTEX_ARRAY);
@@ -497 +528 @@
     }
 
     PROFILE_END("minimap units");
-    
+
     if (g_Renderer.GetRenderPath() == CRenderer::RP_SHADER)
     {
         tech->EndPass();

source/gui/MiniMap.h

@@ -1 @@
-/* Copyright (C) 2012 Wildfire Games.
+/* Copyright (C) 2013 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -18 +18 @@
 #ifndef INCLUDED_MINIMAP
 #define INCLUDED_MINIMAP
 
+// GUI
 #include "gui/GUI.h"
 
+// Types
+#include "lib/types.h"
+
 class CCamera;
 class CTerrain;
 
+// Pinging constants - Controls blink duration of the ping, smaller means higher
+// ping frequency
+const unsigned int PING_DURATION = 50;
+
 class CMiniMap : public IGUIObject
 {
     GUI_OBJECT(CMiniMap)
 public:
     CMiniMap();
     virtual ~CMiniMap();
+
 protected:
     virtual void Draw();
 
@@ -81 +90 @@
     // maximal water height to allow the passage of a unit (for underwater shallows).
     float m_ShallowPassageHeight;
 
+    // For tracking the ping color
+    u32 m_ChangePingColor;
+
     void DrawTexture(float coordMax, float angle, float x, float y, float x2, float y2, float z);
 
     void DrawViewRect();

source/simulation2/components/CCmpMinimap.cpp

@@ -1 @@
-/* Copyright (C) 2012 Wildfire Games.
+/* Copyright (C) 2013 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -25 +25 @@
 #include "simulation2/MessageTypes.h"
 
 #include "ps/Overlay.h"
+#include "ps/Game.h"
 
 class CCmpMinimap : public ICmpMinimap
 {
@@ -33 +34 @@
     {
         componentManager.SubscribeToMessageType(MT_PositionChanged);
         componentManager.SubscribeToMessageType(MT_OwnershipChanged);
+        componentManager.SubscribeToMessageType(MT_EntityAttacked);
     }
 
     DEFAULT_COMPONENT_ALLOCATOR(Minimap)
@@ -48 +50 @@
     bool m_Active;
     entity_pos_t m_X, m_Z; // cache the latest position for more efficient rendering; only valid when m_Active true
 
+
+    // Used by the minimap while pinging this entity to indicate something(currently an attack)
+    // Entity not pinged after MAX_PING_TURNS if it wasn't notified in between
+    static const u32 MAX_PING_FRAMES = 500;
+    bool m_PingEntity;
+    u32 m_PingCount;
+
+
+
     static std::string GetSchema()
     {
         return
@@ -82 +93 @@
     virtual void Init(const CParamNode& paramNode)
     {
         m_Active = true;
+        m_PingEntity = false;
 
         const CParamNode& colour = paramNode.GetChild("Colour");
         if (colour.IsOk())
@@ -183 +195 @@
 
             break;
         }
+        case MT_EntityAttacked:
+        {
+            const CMessageEntityAttacked& data = static_cast<const CMessageEntityAttacked&> (msg);
+
+            if (!g_Game)
+                break;
+
+            if(g_Game->GetPlayerID() != (int)data.player)
+                break;
+
+            m_Active = true;
+            m_PingEntity = true;
+            m_PingCount = MAX_PING_FRAMES;
+
+            break;
         }
+        }
     }
 
     virtual bool GetRenderData(u8& r, u8& g, u8& b, entity_pos_t& x, entity_pos_t& z)
@@ -198 +226 @@
         z = m_Z;
         return true;
     }
+
+    virtual bool IsEntityPinging(void)
+    {
+        if (!m_Active)
+            return false;
+
+        return m_PingEntity;
+    }
+
+    virtual u32 GetRemainingPingCount(void)
+    {
+        return m_PingCount;
+    }
+
+    virtual void SetRemainingPingCount(u32 pingCount)
+    {
+        m_PingCount = pingCount;
+
+        if (m_PingCount == 0)
+            m_PingEntity = false;
+    }
 };
 
 REGISTER_COMPONENT_TYPE(Minimap)

source/simulation2/components/ICmpMinimap.h

@@ -35 +35 @@
      */
     virtual bool GetRenderData(u8& r, u8& g, u8& b, entity_pos_t& x, entity_pos_t& z) = 0;
 
+    /**
+     * Returns true if the unit is pinging.
+     */
+    virtual bool IsEntityPinging(void) = 0;
+
+    /**
+     * Returns the current ping count.
+     */
+    virtual u32 GetRemainingPingCount(void) = 0;
+
+    /**
+     * Used by the minimap to set the ping count, controls pinging.
+     */
+    virtual void SetRemainingPingCount(u32 pingCount) = 0;
+
     DECLARE_INTERFACE_TYPE(Minimap)
 };
 

source/simulation2/MessageTypes.h

@@ -398 +398 @@
     entity_pos_t newRange;
 };
 
+/**
+ * Sent when an entity is attacked
+ */
+class CMessageEntityAttacked : public CMessage
+{
+public:
+    DEFAULT_MESSAGE_IMPL(EntityAttacked)
+
+    CMessageEntityAttacked(entity_id_t entity, entity_id_t player) :
+    entity(entity), player(player)
+    {
+    }
+
+    entity_id_t entity;
+    entity_id_t player;
+};
+
 #endif // INCLUDED_MESSAGETYPES

source/simulation2/scripting/MessageTypeConversions.cpp

@@ -336 +336 @@
     return new CMessageVisionRangeChanged(entity, oldRange, newRange);
 }
 
+////////////////////////////////
+
+jsval CMessageEntityAttacked::ToJSVal(ScriptInterface& scriptInterface) const
+{
+    TOJSVAL_SETUP();
+    SET_MSG_PROPERTY(entity);
+    SET_MSG_PROPERTY(player);
+    return OBJECT_TO_JSVAL(obj);
+}
+
+CMessage* CMessageEntityAttacked::FromJSVal(ScriptInterface& scriptInterface, jsval val)
+{
+    FROMJSVAL_SETUP();
+    GET_MSG_PROPERTY(entity_id_t, entity);
+    GET_MSG_PROPERTY(entity_id_t, player);
+    return new CMessageEntityAttacked(entity, player);
+}
+
 ////////////////////////////////////////////////////////////////
 
 CMessage* CMessageFromJSVal(int mtid, ScriptInterface& scriptingInterface, jsval val)

source/simulation2/TypeList.h

@@ -49 +49 @@
 MESSAGE(PathResult)
 MESSAGE(TechnologyModification)
 MESSAGE(VisionRangeChanged)
+MESSAGE(EntityAttacked)
 
 // TemplateManager must come before all other (non-test) components,
 // so that it is the first to be (de)serialized