Implements NumberOfDocks and DockingOffset for BuildingTypes.

Author: CCHyper

src/extensions/building/buildingext.cpp

@@ -29,6 +29,7 @@
 #include "building.h"
 #include "buildingtype.h"
 #include "buildingtypeext.h"
+#include "tibsun_inline.h"
 #include "house.h"
 #include "housetype.h"
 #include "wwcrc.h"
@@ -178,6 +179,7 @@ void BuildingClassExtension::Compute_CRC(WWCRCEngine &crc) const
     crc(ProduceCashTimer());
 }
 
+
 /**
  *  #issue-26
  * 
@@ -291,3 +293,47 @@ void BuildingClassExtension::Produce_Cash_AI()
     }
 
 }
+
+
+/**
+ *  Fetches the coordinate to use for docking.
+ *  
+ *  @author: CCHyper
+ */
+Coordinate BuildingClassExtension::Docking_Coord() const
+{
+    //EXT_DEBUG_TRACE("BuildingClassExtension::Docking_Coord - Name: %s (0x%08X)\n", Name(), (uintptr_t)(This()));
+
+    Coordinate coord = This()->Center_Coord();
+
+    /**
+     *  #issue-786
+     * 
+     *  Implements DockingOffset for BuildingTypes (currently limited to Helipads and Refinerys).
+     *  
+     *  @author: CCHyper
+     */
+    BuildingTypeClassExtension *buildingtypeext = Extension::Fetch<BuildingTypeClassExtension>(This()->Class);
+
+    if (buildingtypeext->NumberOfDocks > 0) {
+
+        if (This()->Class->IsRefinery || This()->Class->IsWeeder) {
+            TPoint3D<int> docking_offset = buildingtypeext->DockingOffsets[0];
+            coord.X += docking_offset.X;
+            coord.Y += docking_offset.Y;
+            coord.Z += docking_offset.Z;
+            return coord;
+        }
+
+        if (This()->Class->IsHelipad) {
+            TPoint3D<int> docking_offset = buildingtypeext->DockingOffsets[0];
+            coord.X += docking_offset.X;
+            coord.Y += docking_offset.Y;
+            coord.Z += docking_offset.Z;
+            return coord;
+        }
+
+    }
+
+    return coord;
+}

src/extensions/building/buildingext.h

@@ -66,6 +66,7 @@ BuildingClassExtension final : public TechnoClassExtension
         virtual RTTIType What_Am_I() const override { return RTTI_BUILDING; }
 
         void Produce_Cash_AI();
+        Coordinate Docking_Coord() const;
 
     public:
         /**

src/extensions/building/buildingext_hooks.cpp

@@ -56,6 +56,32 @@
 #include "hooker_macros.h"
 
 
+/**
+ *  A fake class for implementing new member functions which allow
+ *  access to the "this" pointer of the intended class.
+ * 
+ *  @note: This must not contain a constructor or destructor!
+ *  @note: All functions must be prefixed with "_" to prevent accidental virtualization.
+ */
+class BuildingClassExt final : public BuildingClass
+{
+    public:
+        Coordinate _Docking_Coord() const;
+};
+
+
+/**
+ *  Reimplementation of BuildingClass::Docking_Coord.
+ * 
+ *  @author: CCHyper
+ */
+Coordinate BuildingClassExt::_Docking_Coord() const
+{
+    BuildingClassExtension *buildingext = Extension::Fetch<BuildingClassExtension>(this);
+    return buildingext->Docking_Coord();
+}
+
+
 /**
  *  #issue-26
  * 
@@ -481,4 +507,5 @@ void BuildingClassExtension_Hooks()
     Patch_Jump(0x00429A96, &_BuildingClass_AI_ProduceCash_Patch);
     Patch_Jump(0x0042F67D, &_BuildingClass_Captured_ProduceCash_Patch);
     Patch_Jump(0x0042E179, &_BuildingClass_Grand_Opening_ProduceCash_Patch);
+    Patch_Dword(0x006CC3A0, Get_Func_Address(&BuildingClassExt::_Docking_Coord));
 }

src/extensions/buildingtype/buildingtypeext.cpp

@@ -27,6 +27,7 @@
  ******************************************************************************/
 #include "buildingtypeext.h"
 #include "buildingtype.h"
+#include "tibsun_globals.h"
 #include "tibsun_defines.h"
 #include "ccini.h"
 #include "wwcrc.h"
@@ -50,7 +51,9 @@ BuildingTypeClassExtension::BuildingTypeClassExtension(const BuildingTypeClass *
     ProduceCashBudget(0),
     IsStartupCashOneTime(false),
     IsResetBudgetOnCapture(false),
-    IsEligibleForAllyBuilding(false)
+    IsEligibleForAllyBuilding(false),
+    NumberOfDocks(0),
+    DockingOffsets()
 {
     //if (this_ptr) EXT_DEBUG_TRACE("BuildingTypeClassExtension::BuildingTypeClassExtension - Name: %s (0x%08X)\n", Name(), (uintptr_t)(This()));
 
@@ -174,6 +177,8 @@ void BuildingTypeClassExtension::Compute_CRC(WWCRCEngine &crc) const
     //EXT_DEBUG_TRACE("BuildingTypeClassExtension::Compute_CRC - Name: %s (0x%08X)\n", Name(), (uintptr_t)(This()));
 
     crc(IsEligibleForAllyBuilding);
+    crc(NumberOfDocks);
+    crc(DockingOffsets.Count());
 }
 
 
@@ -190,7 +195,14 @@ bool BuildingTypeClassExtension::Read_INI(CCINIClass &ini)
         return false;
     }
 
+    char buffer[1024];
+
     const char *ini_name = Name();
+    const char *graphic_name = Graphic_Name();
+
+    //if (!ArtINI.Is_Present(graphic_name)) {
+    //    return false;
+    //}
 
     GateUpSound = ini.Get_VocType(ini_name, "GateUpSound", GateUpSound);
     GateDownSound = ini.Get_VocType(ini_name, "GateDownSound", GateDownSound);
@@ -204,6 +216,37 @@ bool BuildingTypeClassExtension::Read_INI(CCINIClass &ini)
 
     IsEligibleForAllyBuilding = ini.Get_Bool(ini_name, "EligibleForAllyBuilding",
                                                     This()->IsConstructionYard ? true : IsEligibleForAllyBuilding);
+
+    /**
+     *  The following structures must have at least one docking location.
+     */
+    if (This()->IsHelipad || This()->IsRefinery || This()->IsWeeder) {
+        NumberOfDocks = 1;
+    }
+
+    NumberOfDocks = ini.Get_Int(ini_name, "NumberOfDocks", NumberOfDocks);
+
+    for (int i = 0; i < NumberOfDocks; ++i) {
+        std::snprintf(buffer, sizeof(buffer), "DockingOffset%d", i);
+
+        TPoint3D<int> default_value(0, 0, 0);
+
+        /**
+         *  Both of these refinerys have artwork specific dock locations. As we have
+         *  reimplemented Docking_Coord, we need to ensure the original positions
+         *  remain unmodified.
+         */
+        if (This()->IsWeeder) {
+            default_value.X += CELL_LEPTON_W * 2;
+            default_value.Y += CELL_LEPTON_H;
+
+        } else if (This()->IsRefinery) {
+            default_value.X += CELL_LEPTON_W / 2;
+        }
+
+        TPoint3D<int> offset = ArtINI.Get_Point(graphic_name, buffer, default_value);
+        DockingOffsets.Add(offset);
+    }
 
     return true;
 }

src/extensions/buildingtype/buildingtypeext.h

@@ -106,4 +106,14 @@ BuildingTypeClassExtension final : public TechnoTypeClassExtension
          *  Is this building eligible for proximity checks by players who are its owner's allies?
          */
         bool IsEligibleForAllyBuilding;
+
+        /**
+         *  The number of available docking positions this building has.
+         */
+        unsigned NumberOfDocks;
+
+        /**
+         *  The offset(s) from the center of the building for each docking position.
+         */
+        DynamicVectorClass<TPoint3D<int>> DockingOffsets;
 };