Implemented joint assembly type setting!!

Author: tommojphillips

ModAPI/Attachable/CallBacks/TriggerCallBack.cs

@@ -25,6 +25,10 @@ public class TriggerCallback : MonoBehaviour
         /// </summary>
         public event Action<Collider, TriggerCallback> onTriggerEnter;
         /// <summary>
+        /// Represents the on trigger enter event.
+        /// </summary>
+        public event Action<float, TriggerCallback> onJointBreak;
+        /// <summary>
         /// Represents the collider that invoked this callback.
         /// </summary>
         public Collider callbackCollider { get; private set; }
@@ -48,7 +52,10 @@ private void OnTriggerEnter(Collider collider)
         {
             onTriggerEnter?.Invoke(collider, this);
         }
-
+        private void OnJointBreak(float breakforce)
+        {
+            onJointBreak?.Invoke(breakforce, this);
+        }
         #endregion
     }
 }

ModAPI/Attachable/Part.cs

@@ -1,4 +1,5 @@
-using System;
+using MSCLoader;
+using System;
 using System.Collections;
 using System.Linq;
 using TommoJProductions.ModApi.Attachable.CallBacks;
@@ -89,6 +90,10 @@ public class PartSettings
             /// </summary>
             public AssembleType assembleType = AssembleType.static_rigidbodyDelete;
             /// <summary>
+            /// Represents '<see cref="AssembleType.joint"/>' settings.
+            /// </summary>
+            public AssemblyTypeJointSettings assemblyTypeJointSettings = new AssemblyTypeJointSettings() { installPointRigidbodies = null };
+            /// <summary>
             /// Represents the layer to send a part that is installed
             /// </summary>
             public LayerMasksEnum installedPartToLayer = LayerMasksEnum.Parts;
@@ -119,6 +124,28 @@ public enum AssembleType
             /// </summary>
             joint
         }
+        /// <summary>
+        /// Represents settings for assembly type, joint
+        /// </summary>
+        public class AssemblyTypeJointSettings 
+        {
+            /// <summary>
+            /// Represents a list of install point rigidbodies for when using assemblyType:Joint
+            /// </summary>
+            public Rigidbody[] installPointRigidbodies;
+            /// <summary>
+            /// Represents the break force to break this joint. NOTE: unbreakable joints are <see cref="float.PositiveInfinity"/>.
+            /// </summary>
+            public float breakForce = float.PositiveInfinity;
+            /// <summary>
+            /// Inits new joint settings class and assigns rbs
+            /// </summary>
+            /// <param name="rigidbodies"></param>
+            public AssemblyTypeJointSettings(params Rigidbody[] rigidbodies) 
+            {
+                installPointRigidbodies = rigidbodies;
+            }
+        }
 
         #endregion
 
@@ -198,6 +225,10 @@ public int installPointIndex
         /// Represents the cached mass of the parts rigidbody.mass property.
         /// </summary>
         private float cachedMass;
+        /// <summary>
+        /// Represents the fixed joint when using <see cref="AssembleType.joint"/>.
+        /// </summary>
+        private FixedJoint joint;
 
         #endregion
 
@@ -219,6 +250,10 @@ void OnEnable()
             if (installed)
                 StartCoroutine(partInstalled());
         }
+        void OnJointBreak(float breakForce)
+        {
+            disassemble();
+        }
 
         #endregion
 
@@ -246,6 +281,7 @@ private IEnumerator partInstalled()
                     mouseOverReset();
                 yield return null;
             }
+            installedRoutine = null;
         }
         /// <summary>
         /// Represents the part in a trigger logic.
@@ -266,6 +302,7 @@ private IEnumerator partInTrigger(Collider other)
                 }
                 yield return null;
             }
+            triggerRoutine = null;
         }
 
         #endregion
@@ -295,17 +332,26 @@ void callback_onTriggerExit(Collider other, TriggerCallback callback_ref)
         {
             if (installPointColliders.Contains(callback_ref.callbackCollider))
             {
+                ModClient.guiAssemble = false;
+                inTrigger = false;
                 if (triggerRoutine != null)
                     StopCoroutine(triggerRoutine);
-                inTrigger = false;
-                ModClient.guiAssemble = false;
             }
         }
+        void callback_onJointBreak(float breakForce, TriggerCallback callback_ref)
+        {
+            disassemble();
+        }
 
         #endregion
 
         #region Methods
 
+        private void vaildiatePart() 
+        {
+            if (partSettings.assembleType == AssembleType.joint && partSettings.assemblyTypeJointSettings.installPointRigidbodies.Length <= 0)
+                ModConsole.Print("NOTE: assembly type is 'joint' but no install point rigidbodies have been assigned!!! error!!!");
+        }
         /// <summary>
         /// Initializes this part.
         /// </summary>
@@ -317,12 +363,14 @@ void callback_onTriggerExit(Collider other, TriggerCallback callback_ref)
             // Written, 08.09.2021
 
             this.partSettings = partSettings;
-
+            vaildiatePart();
             triggers = triggerRefs;
 
             loadedSaveInfo = saveInfo ?? defaultSaveInfo ?? new PartSaveInfo();
             installPointColliders = new Collider[triggerRefs.Length];
 
+            makePartPickable(!loadedSaveInfo.installed);
+
             if (triggerRefs.Length > 0)
             {
                 TriggerCallback callback;
@@ -334,6 +382,7 @@ void callback_onTriggerExit(Collider other, TriggerCallback callback_ref)
                         callback = triggers[i].triggerGameObject.AddComponent<TriggerCallback>();
                     callback.onTriggerExit += callback_onTriggerExit;
                     callback.onTriggerEnter += callback_onTriggerEnter;
+                    //callback.onJointBreak += callback_onJointBreak;
                 }
                 if (installed)
                     assemble(installPointColliders[installPointIndex], false);
@@ -356,7 +405,7 @@ public void assemble(Collider installPoint, bool playSound = true)
             inTrigger = false;
             installPoint.enabled = false;
             installPointIndex = Array.IndexOf(installPointColliders, installPoint);
-            makePartPickable(false, partSettings.notInstalledPartToLayer);
+            makePartPickable(false);
             transform.parent = installPoint.transform;
             transform.localPosition = Vector3.zero;
             transform.localEulerAngles = Vector3.zero;
@@ -372,6 +421,12 @@ public void assemble(Collider installPoint, bool playSound = true)
                     case AssembleType.static_rigidibodySetKinematic:
                         cachedRigidBody.isKinematic = true;
                         break;
+                    case AssembleType.joint:
+                        joint = gameObject.AddComponent<FixedJoint>();
+                        joint.connectedBody = partSettings.assemblyTypeJointSettings.installPointRigidbodies.Length > -1 ? partSettings.assemblyTypeJointSettings.installPointRigidbodies[installPointIndex] : installPoint.transform.GetComponentInParent<Rigidbody>();
+                        joint.breakForce = partSettings.assemblyTypeJointSettings.breakForce;
+                        joint.breakTorque = joint.breakForce / 2;
+                        break;
                 }
             }
 
@@ -395,7 +450,7 @@ public void disassemble(bool playSound = true)
             installed = false;
             if (mouseOver)
                 mouseOverReset();
-            makePartPickable(true, partSettings.installedPartToLayer);
+            makePartPickable(true);
             transform.parent = null;            
             setActiveAttachedToTrigger(true);
 
@@ -408,6 +463,9 @@ public void disassemble(bool playSound = true)
                 case AssembleType.static_rigidibodySetKinematic:
                     cachedRigidBody.isKinematic = false;
                     break;
+                case AssembleType.joint:
+                    Destroy(joint);
+                    break;
             }
 
             if (playSound)
@@ -454,15 +512,15 @@ public PartSaveInfo getSaveInfo()
          /// </summary>
          /// <param name="inPickable">Make part pickable?</param>
          /// <param name="inLayer">Make part on different layer</param>
-        public void makePartPickable(bool inPickable, LayerMasksEnum inLayer = LayerMasksEnum.Parts)
+        public void makePartPickable(bool inPickable)
         {
             // Written, 14.08.2018 | Modified, 10.09.2021
 
             if (inPickable)
                 gameObject.tag = "PART";
             else
                 gameObject.tag = "DontPickThis";
-            gameObject.layer = inLayer.layer();
+            gameObject.layer = (inPickable ? partSettings.notInstalledPartToLayer : partSettings.installedPartToLayer).layer();
         }
         /// <summary>
         /// ends (resets) a gui interaction.

ModAPI/ModClient.cs

@@ -417,8 +417,8 @@ public static IEnumerator fixToParent(this Transform transform, Transform parent
         {
             while (transform.parent != parent)
             {
-                transform.parent = parent;
                 yield return new WaitForEndOfFrame();
+                transform.parent = parent;
             }
             onFixedToParent?.Invoke();
             yield break;
@@ -434,9 +434,9 @@ public static IEnumerator fixTransform(this Transform transform, Vector3 pos, Ve
         {
             while (transform.localPosition != pos && transform.localEulerAngles != eulerAngles)
             {
+                yield return new WaitForEndOfFrame();
                 transform.localPosition = pos;
                 transform.localEulerAngles = eulerAngles;
-                yield return new WaitForEndOfFrame();
             }
             onFixedTransform?.Invoke();
             yield break;

ModApiInterface/ModApiInterface.cs

@@ -62,6 +62,7 @@ public class ModApiInterface : Mod
         /// <summary>
         /// second pass on
         /// </summary>
+        /// 
         public override bool SecondPass => true;
 
         #endregion

ModApiInterface/ModApiInterface.csproj

@@ -40,9 +40,6 @@
     <DocumentationFile>bin\x86\Release\ModApiInterface.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="modapi_v0132-alpha">
-      <HintPath>D:\Games\SteamApps\steamapps\common\My Summer Car\Mods\References\modapi_v0132-alpha.dll</HintPath>
-    </Reference>
     <Reference Include="MSCLoader">
       <HintPath>D:\Games\SteamApps\steamapps\common\My Summer Car\mysummercar_Data\Managed\MSCLoader.dll</HintPath>
     </Reference>
@@ -56,6 +53,15 @@
     <Compile Include="ModApiInterface.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <WCFMetadata Include="Connected Services\" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\ModAPI\ModAPI.csproj">
+      <Project>{65dddac8-54ea-4116-a53d-05b126fd5a49}</Project>
+      <Name>ModAPI</Name>
+    </ProjectReference>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>
     <PostBuildEvent>if "$(ConfigurationName)" == "Debug" (