Techno attachment logic

CREDITS.md

@@ -36,6 +36,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
   - Jumpjet initial facing fix
+  - Techno Attachment logic
   - Migration utility
   - GitHub Actions setup
   - Official docs

Phobos.vcxproj

@@ -49,7 +49,8 @@
     <ClCompile Include="src\Ext\TEvent\Body.cpp" />
     <ClCompile Include="src\Ext\Trigger\Hooks.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Crushing.cpp" />
-    <ClCompile Include="src\Locomotion\TestLocomotionClass.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\PhobosToolTip.cpp" />
@@ -62,7 +63,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" />
@@ -107,6 +110,7 @@
     <ClCompile Include="src\Ext\Techno\Hooks.Transport.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.Disguise.cpp" />
     <ClCompile Include="src\Ext\Techno\Hooks.DeploysInto.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" />
@@ -124,6 +128,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\Hooks.Blowfish.cpp" />
     <ClCompile Include="src\Misc\Selection.cpp" />
     <ClCompile Include="src\Utilities\Anchor.cpp" />
@@ -177,7 +182,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" />
@@ -190,8 +196,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" />

docs/Contributing.md

@@ -146,7 +146,7 @@ ExtData(TerrainTypeClass* OwnerObject) : Extension<TerrainTypeClass>(OwnerObject
 - Class fields that can be set via INI tags should be named exactly like ini tags with dots replaced with underscores.
 - Pointer type declarations always have pointer sign `*` attached to the type declaration.
 - Non-static class extension methods faked by declaring a static method with `pThis` as a first argument are only to be placed in the extension class for the class instance of which `pThis` is.
-  - If it's crucial to fake `__thiscall` you may use `__fastcall` and use `void*` or `void* _` as a second argument to discard value passed through `EDX` register. Such methods are to be used for call replacement.
+  - If it's crucial to fake `__thiscall` you may use `__fastcall` and use `discard_t` or `discard_t _` as a second argument to discard value passed through `EDX` register. Such methods are to be used for call replacement.
 - Hooks have to be named using a following scheme: `HookedFunction_HookPurpose`, or `ClassName_HookedMethod_HookPurpose`. Defined-again hooks are exempt from this scheme due to impossibility to define different names for the same hook.
 - Return addresses should use anonymous enums to make it clear what address means what, if applicable. The enum has to be placed right at the function start and include all addresses that are used in this hook:
 ```cpp

docs/Miscellanous.md

@@ -46,25 +46,28 @@ SkirmishUnlimitedColors=false	; boolean
 ### Frame Step In
 
 - There's a new hotkey to execute the game frame by frame for development usage.
-	- You can switch to frame by frame mode and then use frame step in command to forward 1, 5, 10, 15, 30 or 60 frames by one hit.
+  - You can switch to frame by frame mode and then use frame step in command to forward 1, 5, 10, 15, 30 or 60 frames by one hit.
 
 ### 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.
+  - The feature is also supported for Phobos locomotors.
+
+| *Alias*  | *CLSID*                                  |
+| -------: | :--------------------------------------: |
+Drive      | `{4A582741-9839-11d1-B709-00A024DDAFD1}` |
+Jumpjet    | `{92612C46-F71F-11d1-AC9F-006008055BB5}` |
+Hover      | `{4A582742-9839-11d1-B709-00A024DDAFD1}` |
+Rocket     | `{B7B49766-E576-11d3-9BD9-00104B972FE8}` |
+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}` |
+Attachment | `{C5D54B98-8C98-4275-8CE4-EF75CB0CBE3E}` |
 
-| *Alias*| *CLSID*                                  |
-| -----: | :--------------------------------------: |
-Drive    | `{4A582741-9839-11d1-B709-00A024DDAFD1}` |
-Jumpjet  | `{92612C46-F71F-11d1-AC9F-006008055BB5}` |
-Hover    | `{4A582742-9839-11d1-B709-00A024DDAFD1}` |
-Rocket   | `{B7B49766-E576-11d3-9BD9-00104B972FE8}` |
-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}` |
 
 ## Game Speed
 

docs/New-or-Enhanced-Logics.md

@@ -4,6 +4,57 @@ This page describes all the engine features that are either new and introduced b
 
 ## New types / ingame entities
 
+### 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).
+
+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
+LowSelectionPriority=true             ; boolean, whether the child is low priority while attached
+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]                          ; TechnoTypeClass
+; 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
+
+[General]
+AttachmentTopLayerMinHeight=500           ; integer,
+AttachmentUndergroundLayerMaxHeight=-256  ; integer
+```
+
 ### Custom Radiation Types
 
 ![image](_static/images/radtype-01.png)

docs/Whats-New.md

@@ -261,6 +261,15 @@ You can use the migration utility (can be found on [Phobos supplementaries repo]
 
 ## Changelog
 
+### 0.4
+
+<details>
+  <summary>Click to show</summary>
+
+New:
+- Techno Attachment logic (by Kerbiter)
+</details>
+
 ### Version TBD (develop branch nightly builds)
 
 <details open>

src/Ext/Rules/Body.cpp

@@ -8,6 +8,7 @@
 #include <New/Type/ShieldTypeClass.h>
 #include <New/Type/LaserTrailTypeClass.h>
 #include <New/Type/DigitalDisplayTypeClass.h>
+#include <New/Type/AttachmentTypeClass.h>
 
 std::unique_ptr<RulesExt::ExtData> RulesExt::Data = nullptr;
 
@@ -32,6 +33,7 @@ void RulesExt::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	RadTypeClass::LoadFromINIList(pINI);
 	ShieldTypeClass::LoadFromINIList(pINI);
 	LaserTrailTypeClass::LoadFromINIList(&CCINIClass::INI_Art.get());
+	AttachmentTypeClass::LoadFromINIList(pINI);
 
 	Data->LoadBeforeTypeData(pThis, pINI);
 }
@@ -130,6 +132,9 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 	this->Vehicles_DefaultDigitalDisplayTypes.Read(exINI, GameStrings::AudioVisual, "Vehicles.DefaultDigitalDisplayTypes");
 	this->Aircraft_DefaultDigitalDisplayTypes.Read(exINI, GameStrings::AudioVisual, "Aircraft.DefaultDigitalDisplayTypes");
 
+	this->AttachmentTopLayerMinHeight.Read(exINI, GameStrings::General, "AttachmentTopLayerMinHeight");
+	this->AttachmentUndergroundLayerMaxHeight.Read(exINI, GameStrings::General, "AttachmentUndergroundLayerMaxHeight");
+
 	// Section AITargetTypes
 	int itemsCount = pINI->GetKeyCount(sectionAITargetTypes);
 	for (int i = 0; i < itemsCount; ++i)
@@ -255,6 +260,8 @@ void RulesExt::ExtData::Serialize(T& Stm)
 		.Process(this->Infantry_DefaultDigitalDisplayTypes)
 		.Process(this->Vehicles_DefaultDigitalDisplayTypes)
 		.Process(this->Aircraft_DefaultDigitalDisplayTypes)
+		.Process(this->AttachmentTopLayerMinHeight)
+		.Process(this->AttachmentUndergroundLayerMaxHeight)
 		;
 }
 

src/Ext/Rules/Body.h

@@ -96,6 +96,9 @@
 		ValueableVector<DigitalDisplayTypeClass*> Vehicles_DefaultDigitalDisplayTypes;
 		ValueableVector<DigitalDisplayTypeClass*> Aircraft_DefaultDigitalDisplayTypes;
 
+		Valueable<bool> AttachmentTopLayerMinHeight;
+		Valueable<bool> AttachmentUndergroundLayerMaxHeight;
+
 		ExtData(RulesClass* OwnerObject) : Extension<RulesClass>(OwnerObject)
 			, Storage_TiberiumIndex { -1 }
 			, InfantryGainSelfHealCap {}
@@ -153,7 +156,9 @@
 			, Infantry_DefaultDigitalDisplayTypes {}
 			, Vehicles_DefaultDigitalDisplayTypes {}
 			, Aircraft_DefaultDigitalDisplayTypes {}
+			, AttachmentTopLayerMinHeight { 500 }
+			, AttachmentUndergroundLayerMaxHeight { -256 }
 		{ }
 
 		virtual ~ExtData() = default;
 

src/Ext/Techno/Body.Internal.cpp

@@ -2,6 +2,7 @@
 
 #include <BitFont.h>
 
+#include <Ext/WeaponType/Body.h>
 #include <Misc/FlyingStrings.h>
 #include <Utilities/EnumFunctions.h>
 
@@ -41,23 +42,26 @@ void TechnoExt::ObjectKilledBy(TechnoClass* pVictim, TechnoClass* pKiller)
 	}
 }
 
-// reversed from 6F3D60
-CoordStruct TechnoExt::GetFLHAbsoluteCoords(TechnoClass* pThis, CoordStruct pCoord, bool isOnTurret)
+Matrix3D TechnoExt::GetTransform(TechnoClass* pThis, VoxelIndexKey* pKey, bool isShadow)
 {
-	auto const pType = pThis->GetTechnoType();
-	auto const pFoot = abstract_cast<FootClass*>(pThis);
 	Matrix3D mtx;
 
-	// Step 1: get body transform matrix
-	if (pFoot && pFoot->Locomotor)
-		mtx = pFoot->Locomotor->Draw_Matrix(nullptr);
+	if ((pThis->AbstractFlags & AbstractFlags::Foot) && ((FootClass*)pThis)->Locomotor)
+		mtx = isShadow ? ((FootClass*)pThis)->Locomotor->Shadow_Matrix(pKey) : ((FootClass*)pThis)->Locomotor->Draw_Matrix(pKey);
 	else // no locomotor means no rotation or transform of any kind (f.ex. buildings) - Kerbiter
 		mtx.MakeIdentity();
 
-	// Steps 2-3: turret offset and rotation
+	return mtx;
+}
+
+Matrix3D TechnoExt::TransformFLHForTurret(TechnoClass* pThis, Matrix3D mtx, bool isOnTurret, double factor)
+{
+	auto const pType = pThis->GetTechnoType();
+
+	// turret offset and rotation
 	if (isOnTurret && pThis->HasTurret())
 	{
-		TechnoTypeExt::ApplyTurretOffset(pType, &mtx);
+		TechnoTypeExt::ApplyTurretOffset(pType, &mtx, factor);
 
 		double turretRad = pThis->TurretFacing().GetRadian<32>();
 		double bodyRad = pThis->PrimaryFacing.Current().GetRadian<32>();
@@ -66,17 +70,32 @@ CoordStruct TechnoExt::GetFLHAbsoluteCoords(TechnoClass* pThis, CoordStruct pCoo
 		mtx.RotateZ(angle);
 	}
 
-	// Step 4: apply FLH offset
-	mtx.Translate((float)pCoord.X, (float)pCoord.Y, (float)pCoord.Z);
+	return mtx;
+}
 
-	auto result = mtx * Vector3D<float>::Empty;
+Matrix3D TechnoExt::GetFLHMatrix(TechnoClass* pThis, CoordStruct pCoord, bool isOnTurret, double factor, bool isShadow)
+{
+	Matrix3D transform = TechnoExt::GetTransform(pThis, nullptr, isShadow);
+	Matrix3D mtx = TechnoExt::TransformFLHForTurret(pThis, transform, isOnTurret, factor);
+
+	CoordStruct scaledCoord = pCoord * factor;
+	// apply FLH offset
+	mtx.Translate((float)scaledCoord.X, (float)scaledCoord.Y, (float)scaledCoord.Z);
+
+	return mtx;
+}
+
+// reversed from 6F3D60
+CoordStruct TechnoExt::GetFLHAbsoluteCoords(TechnoClass* pThis, CoordStruct pCoord, bool isOnTurret)
+{
+	auto result = TechnoExt::GetFLHMatrix(pThis, pCoord, isOnTurret) * Vector3D<float>::Empty;
 
 	// Resulting coords are mirrored along X axis, so we mirror it back
 	result.Y *= -1;
 
-	// Step 5: apply as an offset to global object coords
+	// apply as an offset to global object coords
 	CoordStruct location = pThis->GetCoords();
-	location += { (int)result.X, (int)result.Y, (int)result.Z };
+	location += { std::lround(result.X), std::lround(result.Y), std::lround(result.Z) };
 
 	return location;
 }

src/Ext/Techno/Body.Update.cpp

@@ -589,19 +589,29 @@ void TechnoExt::KillSelf(TechnoClass* pThis, AutoDeathBehavior deathOption, Anim
 	}
 
 	default: //must be AutoDeathBehavior::Kill
-		if (IS_ARES_FUN_AVAILABLE(SpawnSurvivors))
+		TechnoExt::Kill(pThis, nullptr, pThis->Owner);
+	}
+}
+
+void TechnoExt::Kill(TechnoClass* pThis, ObjectClass* pAttacker, HouseClass* pAttackingHouse)
+{
+	if (IS_ARES_FUN_AVAILABLE(SpawnSurvivors))
+	{
+		switch (pThis->WhatAmI())
 		{
-			switch (pThis->WhatAmI())
-			{
-			case AbstractType::Unit:
-			case AbstractType::Aircraft:
-				AresFunctions::SpawnSurvivors(static_cast<FootClass*>(pThis), nullptr, false, false);
-			default:break;
-			}
+		case AbstractType::Unit:
+		case AbstractType::Aircraft:
+			AresFunctions::SpawnSurvivors(abstract_cast<FootClass*>(pThis), abstract_cast<TechnoClass*>(pAttacker), false, false);
+		default: break;
 		}
-		pThis->ReceiveDamage(&pThis->Health, 0, RulesClass::Instance->C4Warhead, nullptr, true, false, pThis->Owner);
-		return;
 	}
+
+	pThis->ReceiveDamage(&pThis->Health, 0, RulesClass::Instance->C4Warhead, pAttacker, true, false, pAttackingHouse);
+}
+
+void TechnoExt::Kill(TechnoClass* pThis, TechnoClass* pAttacker)
+{
+	TechnoExt::Kill(pThis, pAttacker, pAttacker ? pAttacker->Owner : nullptr);
 }
 
 void TechnoExt::UpdateSharedAmmo(TechnoClass* pThis)