Phobos-developers · Metadorius · Nov 11, 2021 · Nov 12, 2021 · Nov 12, 2021 · Nov 15, 2021
diff --git a/CREDITS.md b/CREDITS.md
@@ -39,6 +39,7 @@ This page lists all the individual contributions to the project by their author.
   - Recursive transport killer fix
   - Custom locomotors example implementation and piggybacking test warheads
   - Initial jumpjet facing fix
+  - Techno Attachment logic
   - Migration utility
   - GitHub Actions setup
   - Official docs

diff --git a/Phobos.vcxproj b/Phobos.vcxproj
@@ -18,7 +18,6 @@
     </ProjectConfiguration>
   </ItemGroup>
   <ItemGroup>
-    <ClCompile Include="src\Ext\Cell\Hooks.cpp" />
     <ClCompile Include="src\Ext\Event\Body.cpp" />
     <ClCompile Include="src\Ext\Infantry\Hooks.cpp" />
     <ClCompile Include="src\Ext\Infantry\Hooks.Firing.cpp" />
@@ -35,6 +34,7 @@
     <ClCompile Include="src\Blowfish\blowfish.cpp" />
     <ClCompile Include="src\Blowfish\Hooks.Blowfish.cpp" />
     <ClCompile Include="src\Ext\Cell\Body.cpp" />
+    <ClCompile Include="src\Ext\Cell\Hooks.cpp" />
     <ClCompile Include="src\Ext\House\Hooks.ForceEnemy.cpp" />
     <ClCompile Include="src\Commands\ToggleSWSidebar.cpp" />
     <ClCompile Include="src\Ext\Sidebar\SWSidebar\SWColumnClass.cpp" />
@@ -95,6 +95,7 @@
     <ClCompile Include="src\Ext\Unit\Hooks.Crushing.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Harvester.cpp" />
     <ClCompile Include="src\Locomotion\TestLocomotionClass.cpp" />
+    <ClCompile Include="src\Locomotion\AttachmentLocomotionClass.cpp"/>
     <ClCompile Include="src\Misc\Hooks.Gamespeed.cpp" />
     <ClCompile Include="src\Misc\Hooks.Ares.cpp" />
     <ClCompile Include="src\Misc\Hooks.Crates.cpp" />
@@ -115,7 +116,9 @@
     <ClCompile Include="src\New\Type\LaserTrailTypeClass.cpp" />
     <ClCompile Include="src\New\Type\Affiliated\InterceptorTypeClass.cpp" />
     <ClCompile Include="src\New\Type\Affiliated\PassengerDeletionTypeClass.cpp" />
+    <ClCompile Include="src\New\Type\AttachmentTypeClass.cpp" />
     <ClCompile Include="src\New\Entity\LaserTrailClass.cpp" />
+    <ClCompile Include="src\New\Entity\AttachmentClass.cpp" />
     <ClCompile Include="src\Ext\Aircraft\Body.cpp" />
     <ClCompile Include="src\Ext\Aircraft\Hooks.cpp" />
     <ClCompile Include="src\Ext\AnimType\Body.cpp" />
@@ -154,6 +157,7 @@
     <ClCompile Include="src\Ext\Techno\Body.cpp" />
     <ClCompile Include="src\Ext\Techno\Body.Internal.cpp" />
     <ClCompile Include="src\Ext\Techno\Body.Update.cpp" />
+    <ClCompile Include="src\Ext\Techno\Body.TechnoAttachment.cpp" />
     <ClCompile Include="src\Ext\Techno\WeaponHelpers.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.Cloak.cpp" />
@@ -162,6 +166,7 @@
     <ClCompile Include="src\Ext\Techno\Hooks.ReceiveDamage.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.TargetEvaluation.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.Transport.cpp" />
+    <ClCompile Include="src\Ext\Techno\Hooks.TechnoAttachment.cpp" />
     <ClCompile Include="src\Ext\TerrainType\Body.cpp" />
     <ClCompile Include="src\Ext\TerrainType\Hooks.cpp" />
     <ClCompile Include="src\Ext\TerrainType\Hooks.Passable.cpp" />
@@ -182,6 +187,7 @@
     <ClCompile Include="src\Ext\WeaponType\Hooks.cpp" />
     <ClCompile Include="src\Ext\WeaponType\Hooks.DiskLaserRadius.cpp" />
     <ClCompile Include="src\Misc\BlittersFix.cpp" />
+    <ClCompile Include="src\Misc\Hooks.AI.cpp" />
     <ClCompile Include="src\Misc\Selection.cpp" />
     <ClCompile Include="src\Utilities\Anchor.cpp" />
     <ClCompile Include="src\Utilities\Debug.cpp" />
@@ -260,7 +266,8 @@
     <ClInclude Include="src\Ext\TAction\Body.h" />
     <ClInclude Include="src\Ext\Team\Body.h" />
     <ClInclude Include="src\Ext\TEvent\Body.h" />
-    <ClInclude Include="src\Locomotion\TestLocomotionClass.h" />
+    <ClInclude Include="src\Locomotion\TestLocomotionClass.h"/>
+    <ClInclude Include="src\Locomotion\AttachmentLocomotionClass.h"/>
     <ClInclude Include="src\Misc\BlittersFix.h" />
     <ClInclude Include="src\Ext\CaptureManager\Body.h" />
     <ClInclude Include="src\Misc\FlyingStrings.h" />
@@ -278,8 +285,10 @@
     <ClInclude Include="src\New\Type\LaserTrailTypeClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\InterceptorTypeClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\PassengerDeletionTypeClass.h" />
+    <ClInclude Include="src\New\Type\AttachmentTypeClass.h" />
     <ClInclude Include="src\New\Entity\LaserTrailClass.h" />
     <ClInclude Include="src\New\Entity\ShieldClass.h" />
+    <ClInclude Include="src\New\Entity\AttachmentClass.h" />
     <ClInclude Include="src\Utilities\Anchor.h" />
     <ClInclude Include="src\Utilities\Enumerable.h" />
     <ClInclude Include="src\Ext\Aircraft\Body.h" />

diff --git a/YRpp b/YRpp
diff --git a/docs/Miscellanous.md b/docs/Miscellanous.md
@@ -49,20 +49,22 @@ SaveVariablesOnScenarioEnd=false    ; boolean
 ### Semantic locomotor aliases
 
 - It's now possible to write locomotor aliases instead of their CLSIDs in the `Locomotor` tag value. Use the table below to find the needed alias for a locomotor.
-
-| *Alias* | *CLSID*                                  |
-|--------:|:----------------------------------------:|
-|Drive    | `{4A582741-9839-11d1-B709-00A024DDAFD1}` |
-|Hover    | `{4A582742-9839-11d1-B709-00A024DDAFD1}` |
-|Tunnel   | `{4A582743-9839-11d1-B709-00A024DDAFD1}` |
-|Walk     | `{4A582744-9839-11d1-B709-00A024DDAFD1}` |
-|DropPod  | `{4A582745-9839-11d1-B709-00A024DDAFD1}` |
-|Fly      | `{4A582746-9839-11d1-B709-00A024DDAFD1}` |
-|Teleport | `{4A582747-9839-11d1-B709-00A024DDAFD1}` |
-|Mech     | `{55D141B8-DB94-11d1-AC98-006008055BB5}` |
-|Ship     | `{2BEA74E1-7CCA-11d3-BE14-00104B62A16C}` |
-|Jumpjet  | `{92612C46-F71F-11d1-AC9F-006008055BB5}` |
-|Rocket   | `{B7B49766-E576-11d3-9BD9-00104B972FE8}` |
+  - The feature is also supported for Phobos locomotors.
+
+| *Alias*   | *CLSID*                                  |
+|----------:|:----------------------------------------:|
+|Drive      | `{4A582741-9839-11d1-B709-00A024DDAFD1}` |
+|Hover      | `{4A582742-9839-11d1-B709-00A024DDAFD1}` |
+|Tunnel     | `{4A582743-9839-11d1-B709-00A024DDAFD1}` |
+|Walk       | `{4A582744-9839-11d1-B709-00A024DDAFD1}` |
+|DropPod    | `{4A582745-9839-11d1-B709-00A024DDAFD1}` |
+|Fly        | `{4A582746-9839-11d1-B709-00A024DDAFD1}` |
+|Teleport   | `{4A582747-9839-11d1-B709-00A024DDAFD1}` |
+|Mech       | `{55D141B8-DB94-11d1-AC98-006008055BB5}` |
+|Ship       | `{2BEA74E1-7CCA-11d3-BE14-00104B62A16C}` |
+|Jumpjet    | `{92612C46-F71F-11d1-AC9F-006008055BB5}` |
+|Rocket     | `{B7B49766-E576-11d3-9BD9-00104B972FE8}` |
+|Attachment | `{C5D54B98-8C98-4275-8CE4-EF75CB0CBE3E}` |
 
 ```{note}
 `Chrono` is not a standard Alias, but since the default behavior of using `Teleport` will be triggered when the value of `Locomotor` is incorrect, the result of the operation will appear as if `Chrono` has taken effect.

diff --git a/docs/New-or-Enhanced-Logics.md b/docs/New-or-Enhanced-Logics.md
@@ -189,6 +189,69 @@ SuppressReflectDamage.Types=                       ; List of AttachEffectTypes
 SuppressReflectDamage.Groups=                      ; comma-separated list of strings (group IDs)
 ```
 
+### Attachments
+
+![Unit Attachment](your image here)
+*Attachments used in [mod name](link)*
+
+```{warning}
+This feature is not final and is under development.
+```
+
+- Technos now can be attached one to another in a tree like way. The attached units won't process any locomotion code and act like a part of a parent unit in a configurable.
+  - Currently the attached techno may only be a vehicle.
+  - When attached, the special `Attachment` (`{C5D54B98-8C98-4275-8CE4-EF75CB0CBE3E}`) locomotor is automatically casted on a unit. You may also specify it in the child unit types manually if the unit is not intended to move without a parent (f. ex. a turret).
+- Attachment slots can now be assigned an `AttachmentX.ID` string. This enables child techno preservation across type conversions (e.g. Ares `UpdateType`) and deploys between building and unit. Each TechnoType owns its own set of attachment slots, and the following happens when a techno is type-converted:
+  1. The current type's slots (and any children inside them) are placed in a per-type dormant storage.
+  2. The new type's slots are set up - restored from dormant storage if the unit previously had this type, or created fresh otherwise.
+  3. For each new slot that has an `AttachmentX.ID`, the old type's dormant slots are searched for a matching ID. If found, the child and its attachment state (e.g. the respawn timer, scaled proportionally to the new slot's `RespawnDelay`) are transferred into the new slot.
+     - If the new slot specifies an `AttachmentX.TechnoType` that differs from the child's current type, the child is automatically converted to the new slot's TechnoType.
+     - If the new slot has no `AttachmentX.TechnoType`, or if the old slot had `AttachmentX.TechnoType` set and the child's type does not match it, the child is transferred as-is regardless of its type.
+     - Slots without an `AttachmentX.ID` are never matched and their children are not transferred.
+  4. Unmatched old dormant slots have their children placed in limbo. New slots that ended up empty are unlimboed (unless the parent is currently in limbo).
+
+In `rulesmd.ini`:
+```ini
+[AttachmentTypes]
+0=MNT                                     ; (example)
+
+[MNT]
+RespawnAtCreation=true                    ; boolean
+RespawnDelay=-1                           ; integer, non-negative values enable the respawn timer
+InheritOwner=true                         ; boolean, whether the child inherits owner of the parent while it's attached
+InheritStateEffects=true                  ; boolean (state effects = chaos, iron curtain etc.)
+InheritCommands=true                      ; boolean
+InheritCommands.StopCommand=true          ; boolean
+InheritCommands.DeployCommand=true        ; boolean
+LowSelectionPriority=true                 ; boolean, whether the child is low priority while attached
+PassSelection=true                        ; boolean, whether the child selection propagates to parent
+TransparentToMouse=false                  ; boolean, can't click on attached techno if set
+YSortPosition=default                     ; Attachment YSort position enumeration - default|underparent|overparent
+InheritDestruction=true                   ; boolean
+InheritHeightStatus=true                  ; boolean, whether the layer and InAir/OnGround/IsSurfaced inherited from parent
+OccupiesCell=true                         ; boolean
+DestructionWeapon.Child=                  ; WeaponType, detonated on child when parent is destroyed
+DestructionWeapon.Parent=                 ; WeaponType, detonated on parent when child is destroyed
+ParentDestructionMission=                 ; MissionType, queued to child when parent is destroyed
+ParentDetachmentMission=                  ; MissionType, queued to child when it's detached from parent
+
+[SOMETECHNO]                              ; TechnoType
+; used when this techno is attached
+AttachmentTopLayerMinHeight=              ; integer
+AttachmentUndergroundLayerMaxHeight=      ; integer
+; used for attaching other technos
+AttachmentX.Type=MNT                      ; AttachmentType (example)
+AttachmentX.TechnoType=                   ; TechnoType that can be attached, currently only units are supported
+AttachmentX.FLH=0,0,0                     ; integer - Forward, Lateral, Height
+AttachmentX.IsOnTurret=false              ; boolean
+AttachmentX.RotationAdjust=0              ; rotation in DirType, from -255 to 255
+AttachmentX.ID=                           ; string, max 32 chars - ID for child transfer on type conversion; must be unique per TechnoType
+
+[General]
+AttachmentTopLayerMinHeight=500           ; integer
+AttachmentUndergroundLayerMaxHeight=-256  ; integer
+```
+
 ### Custom Radiation Types
 
 ![image](_static/images/radtype-01.png)

diff --git a/docs/Whats-New.md b/docs/Whats-New.md
@@ -553,6 +553,7 @@ New:
 - [Implement `CurleyShuffle` for AircraftTypes](Fixed-or-Improved-Logics.md#implement-curleyshuffle-for-aircrafttypes) (ported from Vinifera by Noble_Fish)
 - Customize which parasite can remove by warhead (by NetsuNegi)
 - Add toggle of whether shield use ArmorMultiplier or not (by NetsuNegi)
+- [Techno attachment system](New-or-Enhanced-Logics.md#attachments) (by Kerbiter)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

diff --git a/src/Ext/Building/Body.cpp b/src/Ext/Building/Body.cpp
@@ -371,6 +371,10 @@ void BuildingExt::KickOutStuckUnits(BuildingClass* pThis)
 				if (pThis->Owner != pUnit->Owner || pUnit->Locomotor->Destination() != CoordStruct::Empty)
 					continue;
 
+				// Skip attachments - they shouldn't be treated as stuck units
+				if (TechnoExt::IsAttached(pUnit))
+					continue;
+
 				const auto height = pUnit->GetHeight();
 
 				if (height < 0 || height > Unsorted::CellHeight)

diff --git a/src/Ext/Building/Hooks.cpp b/src/Ext/Building/Hooks.cpp
@@ -19,6 +19,9 @@ DEFINE_HOOK(0x43FE69, BuildingClass_AI, 0xA)
 	const auto pTechnoExt = pBuildingExt->TechnoExtData;
 	pTechnoExt->UpdateLaserTrails(); // Mainly for on turret trails
 
+	for (auto const& attachment : pTechnoExt->ChildAttachments)
+		attachment->AI();
+
 	// Force airstrike targets to redraw every frame to account for tint intensity fluctuations.
 	if (pTechnoExt->AirstrikeTargetingMe)
 		pThis->Mark(MarkType::Change);
@@ -752,6 +755,7 @@ DEFINE_HOOK(0x44EFD8, BuildingClass_FindExitCell_BarracksExitCell, 0x6)
 	return 0;
 }
 
+
 DEFINE_HOOK(0x444B83, BuildingClass_ExitObject_BarracksExitCell, 0x7)
 {
 	enum { SkipGameCode = 0x444C7C };

diff --git a/src/Ext/Cell/Body.cpp b/src/Ext/Cell/Body.cpp
@@ -12,6 +12,8 @@ void CellExt::ExtData::Serialize(T& Stm)
 		.Process(this->RadSites)
 		.Process(this->RadLevels)
 		.Process(this->InfantryCount)
+		.Process(this->IncomingUnit)
+		.Process(this->IncomingUnitAlt)
 		;
 }
 
@@ -28,7 +30,19 @@ void CellExt::ExtData::SaveToStream(PhobosStreamWriter& Stm)
 }
 
 void CellExt::ExtData::InvalidatePointer(void* ptr, bool removed)
-{ }
+{
+	if (ptr == static_cast<void*>(this->IncomingUnit))
+	{
+		this->OwnerObject()->OccupationFlags &= ~0x20;
+		this->IncomingUnit = nullptr;
+	}
+
+	if (ptr == static_cast<void*>(this->IncomingUnitAlt))
+	{
+		this->OwnerObject()->AltOccupationFlags &= ~0x20;
+		this->IncomingUnitAlt = nullptr;
+	}
+}
 
 bool CellExt::RadLevel::Load(PhobosStreamReader& stm, bool registerForChange)
 {

diff --git a/src/Ext/Cell/Body.h b/src/Ext/Cell/Body.h
@@ -35,13 +35,15 @@ class CellExt
 		std::vector<RadSiteClass*> RadSites {};
 		std::vector<RadLevel> RadLevels { };
 		int InfantryCount{ 0 };
+		UnitClass* IncomingUnit {};
+		UnitClass* IncomingUnitAlt {};
 
 		ExtData(CellClass* OwnerObject) : Extension<CellClass>(OwnerObject)
 		{ }
 
 		virtual ~ExtData() = default;
 
-		virtual void InvalidatePointer(void* ptr, bool removed) override;
+		virtual void InvalidatePointer(void* ptr, bool bRemoved) override;
 
 		virtual void LoadFromStream(PhobosStreamReader& Stm) override;
 		virtual void SaveToStream(PhobosStreamWriter& Stm) override;

diff --git a/src/Ext/Cell/Hooks.cpp b/src/Ext/Cell/Hooks.cpp
@@ -1,6 +1,7 @@
 #include "Body.h"
 
 #include <Ext/Rules/Body.h>
+#include <Ext/Techno/Body.h>
 
 DEFINE_HOOK(0x480EA8, CellClass_DamageWall_AdjacentWallDamage, 0x7)
 {
@@ -9,3 +10,75 @@ DEFINE_HOOK(0x480EA8, CellClass_DamageWall_AdjacentWallDamage, 0x7)
 	pThis->DamageWall(RulesExt::Global()->AdjacentWallDamage);
 	return SkipGameCode;
 }
+
+// because 🦅💣 takes over, we have to do reimpl even more of the func and replicate Ares code
+
+void __fastcall UnitClass_SetOccupyBit_Reimpl(UnitClass* pThis, void*, CoordStruct* pCrd)
+{
+	if (TechnoExt::DoesntOccupyCellAsChild(pThis))
+		return;
+
+	CellClass* pCell = MapClass::Instance.GetCellAt(*pCrd);
+	auto pCellExt = CellExt::ExtMap.Find(pCell);
+	int height = MapClass::Instance.GetCellFloorHeight(*pCrd) + CellClass::BridgeHeight;
+	bool alt = (pCrd->Z >= height && pCell->ContainsBridge());
+
+	// remember which occupation bit we set
+	auto pExt = TechnoExt::ExtMap.Find(pThis);
+	pExt->AltOccupation = alt;
+
+	if (alt)
+	{
+		pCell->AltOccupationFlags |= 0x20;
+		// Phobos addition: set incoming unit tracker
+		pCellExt->IncomingUnitAlt = pThis;
+	}
+	else
+	{
+		pCell->OccupationFlags |= 0x20;
+		// Phobos addition: set incoming unit tracker
+		pCellExt->IncomingUnit = pThis;
+	}
+}
+
+DEFINE_FUNCTION_JUMP(VTABLE, 0x7F5D60, UnitClass_SetOccupyBit_Reimpl);
+
+void __fastcall UnitClass_ClearOccupyBit_Reimpl(UnitClass* pThis, void*, CoordStruct* pCrd)
+{
+	if (TechnoExt::DoesntOccupyCellAsChild(pThis))
+		return;
+
+	enum { obNormal = 1, obAlt = 2 };
+
+	CellClass* pCell = MapClass::Instance.GetCellAt(*pCrd);
+	auto pCellExt = CellExt::ExtMap.Find(pCell);
+	int height = MapClass::Instance.GetCellFloorHeight(*pCrd) + CellClass::BridgeHeight;
+	int alt = (pCrd->Z >= height) ? obAlt : obNormal;
+
+	// also clear the last occupation bit, if set
+	auto pExt = TechnoExt::ExtMap.Find(pThis);
+	if(pExt->AltOccupation.has_value())
+	{
+		int lastAlt = pExt->AltOccupation.value() ? obAlt : obNormal;
+		alt |= lastAlt;
+		pExt->AltOccupation.reset();
+	}
+
+	if (alt & obAlt)
+	{
+		pCell->AltOccupationFlags &= ~0x20;
+		// Phobos addition: clear incoming unit tracker
+		pCellExt->IncomingUnitAlt = nullptr;
+	}
+
+	if (alt & obNormal)
+	{
+		pCell->OccupationFlags &= ~0x20;
+		// Phobos addition: clear incoming unit tracker
+		pCellExt->IncomingUnit = nullptr;
+	}
+}
+
+DEFINE_FUNCTION_JUMP(VTABLE, 0x7F5D64, UnitClass_ClearOccupyBit_Reimpl);
+
+// TODO ^ same for TA for non-UnitClass, not needed so cba for now
diff --git a/src/Ext/Rules/Body.cpp b/src/Ext/Rules/Body.cpp
@@ -9,6 +9,7 @@
 #include <New/Type/BannerTypeClass.h>
 #include <New/Type/InsigniaTypeClass.h>
 #include <New/Type/SelectBoxTypeClass.h>
+#include <New/Type/AttachmentTypeClass.h>
 
 std::unique_ptr<RulesExt::ExtData> RulesExt::Data = nullptr;
 
@@ -37,6 +38,7 @@ void RulesExt::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	AttachEffectTypeClass::LoadFromINIList(pINI);
 	BannerTypeClass::LoadFromINIList(pINI);
 	InsigniaTypeClass::LoadFromINIList(pINI);
+	AttachmentTypeClass::LoadFromINIList(pINI);
 
 	Data->LoadBeforeTypeData(pThis, pINI);
 }
@@ -372,6 +374,9 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 
 	this->UnitsUnsellable.Read(exINI, GameStrings::General, "UnitsUnsellable");
 
+	this->AttachmentTopLayerMinHeight.Read(exINI, GameStrings::General, "AttachmentTopLayerMinHeight");
+	this->AttachmentUndergroundLayerMaxHeight.Read(exINI, GameStrings::General, "AttachmentUndergroundLayerMaxHeight");
+
 	// Section AITargetTypes
 	int itemsCount = pINI->GetKeyCount("AITargetTypes");
 	for (int i = 0; i < itemsCount; ++i)
@@ -677,6 +682,8 @@ void RulesExt::ExtData::Serialize(T& Stm)
 		.Process(this->CylinderRangefinding)
 		.Process(this->PenetratesTransport_Level)
 		.Process(this->UnitsUnsellable)
+		.Process(this->AttachmentTopLayerMinHeight)
+		.Process(this->AttachmentUndergroundLayerMaxHeight)
 		;
 }