Add Attachable property GibWhenRemovedFromParent

CHANGELOG.md

@@ -539,6 +539,8 @@ This can be accessed via the new Lua (R/W) `SettingsMan` property `AIUpdateInter
 
 - New `HDFirearm` Lua property `MSPerRound` which returns the minimum amount of MS in between shots, relative to`RateOfFire`.
 
+- New `Attachable` INI and Lua (R/W) property `GibWhenRemovedFromParent` which gibs the `Attachable` in question when it's removed from its parent. `DeleteWhenRemovedFromParent` will always override this.
+
 </details>
 
 <details><summary><b>Changed</b></summary>

Entities/Attachable.cpp

@@ -17,6 +17,7 @@ namespace RTE {
 		m_DrawAfterParent = true;
 		m_DrawnNormallyByParent = true;
 		m_DeleteWhenRemovedFromParent = false;
+		m_GibWhenRemovedFromParent = false;
 		m_ApplyTransferredForcesAtOffset = true;
 
 		m_GibWithParentChance = 0.0F;
@@ -69,6 +70,7 @@ namespace RTE {
 		m_DrawAfterParent = reference.m_DrawAfterParent;
 		m_DrawnNormallyByParent = reference.m_DrawnNormallyByParent;
 		m_DeleteWhenRemovedFromParent = reference.m_DeleteWhenRemovedFromParent;
+		m_GibWhenRemovedFromParent = reference.m_GibWhenRemovedFromParent;
 		m_ApplyTransferredForcesAtOffset = reference.m_ApplyTransferredForcesAtOffset;
 
 		m_GibWithParentChance = reference.m_GibWithParentChance;
@@ -112,6 +114,8 @@ namespace RTE {
 			reader >> m_DrawAfterParent;
 		} else if (propName == "DeleteWhenRemovedFromParent") {
 			reader >> m_DeleteWhenRemovedFromParent;
+		} else if (propName == "GibWhenRemovedFromParent") {
+			reader >> m_GibWhenRemovedFromParent;
 		} else if (propName == "ApplyTransferredForcesAtOffset") {
 			reader >> m_ApplyTransferredForcesAtOffset;
 		} else if (propName == "GibWithParentChance") {
@@ -163,6 +167,7 @@ namespace RTE {
 		writer.NewPropertyWithValue("ParentOffset", m_ParentOffset);
 		writer.NewPropertyWithValue("DrawAfterParent", m_DrawAfterParent);
 		writer.NewPropertyWithValue("DeleteWhenRemovedFromParent", m_DeleteWhenRemovedFromParent);
+		writer.NewPropertyWithValue("GibWhenRemovedFromParent", m_GibWhenRemovedFromParent);
 		writer.NewPropertyWithValue("ApplyTransferredForcesAtOffset", m_ApplyTransferredForcesAtOffset);
 
 		writer.NewPropertyWithValue("JointStrength", m_JointStrength);

Entities/Attachable.h

@@ -136,17 +136,29 @@ namespace RTE {
 		void SetDrawnNormallyByParent(bool drawnNormallyByParent) { m_DrawnNormallyByParent = drawnNormallyByParent; }
 
 		/// <summary>
-		/// Gets whether this Attachable will be deleted when it's removed from its parent. Has no effect until the Attachable is added to a parent.
+		/// Gets whether this Attachable will be deleted when removed from its parent. Has no effect until the Attachable has been added to a parent.
 		/// </summary>
-		/// <returns>Whether this Attachable is marked to be deleted when it's removed from its parent or not.</returns>
+		/// <returns>Whether this Attachable is marked to be deleted when removed from its parent or not.</returns>
 		bool GetDeleteWhenRemovedFromParent() const { return m_DeleteWhenRemovedFromParent; }
 
 		/// <summary>
-		/// Sets whether this Attachable will be deleted when it's removed from its parent.
+		/// Sets whether this Attachable will be deleted when removed from its parent.
 		/// </summary>
-		/// <param name="deleteWhenRemovedFromParent">Whether this Attachable should be deleted when it's removed from its parent.</param>
+		/// <param name="deleteWhenRemovedFromParent">Whether this Attachable should be deleted when removed from its parent.</param>
 		virtual void SetDeleteWhenRemovedFromParent(bool deleteWhenRemovedFromParent) { m_DeleteWhenRemovedFromParent = deleteWhenRemovedFromParent; }
 
+		/// <summary>
+		/// Gets whether this Attachable will gib when removed from its parent. Has no effect until the Attachable has been added to a parent.
+		/// </summary>
+		/// <returns>Whether this Attachable is marked to gib when removed from its parent or not.</returns>
+		bool GetGibWhenRemovedFromParent() const { return m_GibWhenRemovedFromParent; }
+
+		/// <summary>
+		/// Sets whether this Attachable will gib when removed from its parent.
+		/// </summary>
+		/// <param name="gibWhenRemovedFromParent">Whether this Attachable should gib when removed from its parent.</param>
+		virtual void SetGibWhenRemovedFromParent(bool gibWhenRemovedFromParent) { m_GibWhenRemovedFromParent = gibWhenRemovedFromParent; }
+
 		/// <summary>
 		/// Gets whether forces transferred from this Attachable should be applied at its parent's offset (rotated to match the parent) where they will produce torque, or directly at its parent's position.
 		/// </summary>
@@ -549,7 +561,8 @@ namespace RTE {
 		Vector m_ParentOffset; //!< The offset from the parent's Pos to the joint point this Attachable is attached with.
 		bool m_DrawAfterParent; //!< Whether to draw this Attachable after (in front of) or before (behind) the parent.
 		bool m_DrawnNormallyByParent; //!< Whether this Attachable will be drawn normally when attached, or will require special handling by some non-MOSR parent type.
-		bool m_DeleteWhenRemovedFromParent; //!< Whether this Attachable should be deleted when it's removed from its parent.
+		bool m_DeleteWhenRemovedFromParent; //!< Whether this Attachable should be deleted when removed from its parent.
+		bool m_GibWhenRemovedFromParent; //!< Whether this Attachable should gib when removed from its parent.
 		bool m_ApplyTransferredForcesAtOffset; //!< Whether forces transferred from this Attachable should be applied at the rotated parent offset (which will produce torque), or directly at the parent's position. Mostly useful to make jetpacks and similar emitters viable.
 
 		float m_GibWithParentChance; //!< The percentage chance that this Attachable will gib when its parent does. 0 means never, 1 means always.

Entities/MOSRotating.cpp

@@ -1146,7 +1146,7 @@ void MOSRotating::RemoveAttachablesWhenGibbing(const Vector &impactImpulse, Mova
 	for (Attachable *attachable : nonVolatileAttachablesVectorForLuaSafety) {
         RTEAssert(attachable, "Broken Attachable when Gibbing!");
 
-        if (RandomNum() < attachable->GetGibWithParentChance()) {
+        if (RandomNum() < attachable->GetGibWithParentChance() || attachable->GetGibWhenRemovedFromParent()) {
             attachable->GibThis();
             continue;
         }
@@ -1754,6 +1754,7 @@ Attachable * MOSRotating::RemoveAttachable(Attachable *attachable, bool addToMov
     if (attachable->GetDeleteWhenRemovedFromParent()) { attachable->SetToDelete(); }
     if (addToMovableMan || attachable->IsSetToDelete()) {
         g_MovableMan.AddMO(attachable);
+		if (attachable->GetGibWhenRemovedFromParent()) { attachable->GibThis(); }
         return nullptr;
     }
 

Entities/Scene.cpp

@@ -1545,6 +1545,7 @@ void Scene::SaveSceneObject(Writer &writer, const SceneObject *sceneObjectToSave
 		writer.NewPropertyWithValue("ParentOffset", attachableToSave->GetParentOffset());
 		writer.NewPropertyWithValue("DrawAfterParent", attachableToSave->IsDrawnAfterParent());
 		writer.NewPropertyWithValue("DeleteWhenRemovedFromParent", attachableToSave->GetDeleteWhenRemovedFromParent());
+		writer.NewPropertyWithValue("GibWhenRemovedFromParent", attachableToSave->GetGibWhenRemovedFromParent());
 		writer.NewPropertyWithValue("JointStrength", attachableToSave->GetJointStrength());
 		writer.NewPropertyWithValue("JointStiffness", attachableToSave->GetJointStiffness());
 		writer.NewPropertyWithValue("JointOffset", attachableToSave->GetJointOffset());

Lua/LuaBindingsEntities.cpp

@@ -579,6 +579,7 @@ namespace RTE {
 		.property("JointOffset", &Attachable::GetJointOffset, &Attachable::SetJointOffset)
 		.property("JointPos", &Attachable::GetJointPos)
 		.property("DeleteWhenRemovedFromParent", &Attachable::GetDeleteWhenRemovedFromParent, &Attachable::SetDeleteWhenRemovedFromParent)
+		.property("GibWhenRemovedFromParent", &Attachable::GetGibWhenRemovedFromParent, &Attachable::SetGibWhenRemovedFromParent)
 		.property("ApplyTransferredForcesAtOffset", &Attachable::GetApplyTransferredForcesAtOffset, &Attachable::SetApplyTransferredForcesAtOffset)
 		.property("BreakWound", &Attachable::GetBreakWound, &LuaAdaptersPropertyOwnershipSafetyFaker::AttachableSetBreakWound)
 		.property("ParentBreakWound", &Attachable::GetParentBreakWound, &LuaAdaptersPropertyOwnershipSafetyFaker::AttachableSetParentBreakWound)