Ticket #2461: ShipSinkingRefinements.patch

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

@@ -17 +17 @@
   </Cost>
   <Decay>
     <Inactive/>
-    <SinkingAnim/>
+    <SinkingAnim>
+    <ShipSlowRate>0.01</ShipSlowRate>
+    <ShipSlowAccel>0.0</ShipSlowAccel>
+  </SinkingAnim>
     <DelayTime>0.0</DelayTime>
     <SinkRate>0.5</SinkRate>
     <SinkAccel>7.0</SinkAccel>

source/simulation2/components/CCmpDecay.cpp

@@ -24 +24 @@
 
 #include "ICmpPosition.h"
 #include "ICmpTerrain.h"
+#include "ICmpWaterManager.h"
 #include "ICmpVisual.h"
 
 /**
@@ -42 +43 @@
  *
  * Must not be used on network-synchronised entities, unless \<Inactive\> is present.
  */
+
 class CCmpDecay : public ICmpDecay
 {
 public:
@@ -53 +55 @@
 
     bool m_Active;
     bool m_ShipSink;
+    float m_ShipSlowRate;
+    float m_ShipSlowAccel;
+    fixed m_ShipSinkDepth;
     float m_DelayTime;
     float m_SinkRate;
     float m_SinkAccel;
@@ -86 +91 @@
             "</optional>"
             "<optional>"
                 "<element name='SinkingAnim' a:help='If this element is present, the entity will decay in a ship-like manner'>"
-                    "<empty/>"
+                    "<interleave>"
+                        "<element name='ShipSlowRate'><ref name='nonNegativeDecimal'/></element>"
+                        "<element name='ShipSlowAccel'><ref name='nonNegativeDecimal'/></element>"
+                    "</interleave>"
                 "</element>"
             "</optional>";
     }
@@ -95 +103 @@
     {
         m_Active = !paramNode.GetChild("Inactive").IsOk();
         m_ShipSink = paramNode.GetChild("SinkingAnim").IsOk();
+        if (m_ShipSink)
+        {
+            m_ShipSlowRate = paramNode.GetChild("SinkingAnim").GetChild("ShipSlowRate").ToFixed().ToFloat();
+            m_ShipSlowAccel = paramNode.GetChild("SinkingAnim").GetChild("ShipSlowAccel").ToFixed().ToFloat();
+        }
         m_DelayTime = paramNode.GetChild("DelayTime").ToFixed().ToFloat();
         m_SinkRate = paramNode.GetChild("SinkRate").ToFixed().ToFloat();
         m_SinkAccel = paramNode.GetChild("SinkAccel").ToFixed().ToFloat();
@@ -141 +154 @@
             const CMessageInterpolate& msgData = static_cast<const CMessageInterpolate&> (msg);
 
             CmpPtr<ICmpPosition> cmpPosition(GetEntityHandle());
+            CmpPtr<ICmpWaterManager> cmpWaterManager(GetSystemEntity());
             if (!cmpPosition || !cmpPosition->IsInWorld())
             {
                 // If there's no position (this usually shouldn't happen), destroy the unit immediately
@@ -180 +194 @@
                     // lacking randomness we'll trick
                     m_SinkingAngleX = (pos.X.ToInt_RoundToNearest() % 30 - 15) / 15.0;
                     m_SinkingAngleZ = (pos.Z.ToInt_RoundToNearest() % 30) / 40.0;
-                    m_TotalSinkDepth += 10.f;
+
+                    m_ShipSinkDepth = pos.Y - cmpTerrain->GetGroundLevel(pos.X, pos.Z);
+                    m_TotalSinkDepth += 10.0f;
                 }
                 // probably 0 in both cases but we'll remember it anyway.
                 m_InitialXRotation = cmpPosition->GetRotation().X;
@@ -193 +209 @@
             {
                 float t = m_CurrentTime - m_DelayTime;
                 float depth = (m_SinkRate * t) + (m_SinkAccel * t * t);
-
                 if (m_ShipSink)
                 {
-                    // exponential sinking with tilting
-                    float tilt_time = t > 5.f ? 5.f : t;
-                    float tiltSink = tilt_time * tilt_time / 5.f;
-                    entity_pos_t RotX = entity_pos_t::FromFloat(((m_InitialXRotation.ToFloat() * (5.f - tiltSink)) + (m_SinkingAngleX * tiltSink)) / 5.f);
-                    entity_pos_t RotZ = entity_pos_t::FromFloat(((m_InitialZRotation.ToFloat() * (3.f - tilt_time)) + (m_SinkingAngleZ * tilt_time)) / 3.f);
-                    cmpPosition->SetXZRotation(RotX,RotZ);
-                    
-                    depth = m_SinkRate * (exp(t - 1.f) - 0.54881163609f) + (m_SinkAccel * exp(t - 4.f) - 0.01831563888f);
+                    CFixedVector3D pos = cmpPosition->GetPosition();
+                    if (pos.Y > cmpWaterManager->GetWaterLevel(pos.X, pos.Z) - m_ShipSinkDepth)
+                    { //If moving towards the water's floor use exponential sinking with tilting
+                        float tilt_time = t > 5.f ? 5.f : t;
+                        float tiltSink = tilt_time * tilt_time / 5.f;
+                        entity_pos_t RotX = entity_pos_t::FromFloat(((m_InitialXRotation.ToFloat() * (5.f - tiltSink)) + (m_SinkingAngleX * tiltSink)) / 5.f);
+                        entity_pos_t RotZ = entity_pos_t::FromFloat(((m_InitialZRotation.ToFloat() * (3.f - tilt_time)) + (m_SinkingAngleZ * tilt_time)) / 3.f);
+                        cmpPosition->SetXZRotation(RotX,RotZ);
+                        depth = m_SinkRate * (exp(t - 1.f) - 0.54881163609f) + (m_SinkAccel * exp(t - 4.f) - 0.01831563888f);
+                    }
+                    else
+                    { //Else use the slower sink
+                        depth = (m_ShipSlowRate * t) + (m_ShipSlowAccel * t * t) + m_ShipSinkDepth.ToFloat();
+                    }
                     if (depth < 0.f)
                         depth = 0.f;
                 }
-                
                 cmpPosition->SetHeightOffset(entity_pos_t::FromFloat(-depth));
 
                 if (depth > m_TotalSinkDepth)