feat: No Physics Shapes On The CharacterComponent Causes Unhandled Exception

sources/engine/Stride.Physics/Elements/CharacterComponent.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.ComponentModel;
+using System.Diagnostics;
 using Stride.Core;
 using Stride.Core.Mathematics;
 using Stride.Engine;
@@ -26,7 +27,8 @@ public void Jump(Vector3 jumpDirection)
         {
             if (KinematicCharacter == null)
             {
-                throw new InvalidOperationException("Attempted to call a Physics function that is avaliable only when the Entity has been already added to the Scene.");
+                LogPhysicsFunctionError();
+                return;
             }
             BulletSharp.Math.Vector3 bV3 = jumpDirection;
             KinematicCharacter.Jump(ref bV3);
@@ -39,7 +41,8 @@ public void Jump()
         {
             if (KinematicCharacter == null)
             {
-                throw new InvalidOperationException("Attempted to call a Physics function that is avaliable only when the Entity has been already added to the Scene.");
+                LogPhysicsFunctionError();
+                return;
             }
             KinematicCharacter.Jump();
         }
@@ -209,7 +212,8 @@ public void Teleport(Vector3 targetPosition)
         {
             if (KinematicCharacter == null)
             {
-                throw new InvalidOperationException("Attempted to call a Physics function that is avaliable only when the Entity has been already added to the Scene.");
+                LogPhysicsFunctionError();
+                return;
             }
 
             //we assume that the user wants to teleport in world/entity space
@@ -230,7 +234,8 @@ public void Move(Vector3 movement)
         {
             if (KinematicCharacter == null)
             {
-                throw new InvalidOperationException("Attempted to call a Physics function that is avaliable only when the Entity has been already added to the Scene.");
+                LogPhysicsFunctionError();
+                return;
             }
 
             KinematicCharacter.SetWalkDirection(movement);
@@ -246,7 +251,8 @@ public void SetVelocity(Vector3 velocity)
         {
             if (KinematicCharacter == null)
             {
-                throw new InvalidOperationException("Attempted to call a Physics function that is available only when the Entity has been already added to the Scene.");
+                LogPhysicsFunctionError();
+                return;
             }
 
             KinematicCharacter.SetWalkDirection(velocity * Simulation.FixedTimeStep);
@@ -305,5 +311,16 @@ protected override void OnDetach()
 
             base.OnDetach();
         }
+
+        /// <summary>
+        /// Run specific error when physics functions are called on components that do not have proper setup.
+        /// Captures good tracing info for debugging purposes.
+        /// </summary>
+        private void LogPhysicsFunctionError()
+        {
+            StackFrame frame = new StackTrace(true).GetFrame(2);
+            logger.Error($"Component:[{this}] attempted to call a Physics function that is available only when the Entity has been already added to the Scene. " +
+                $"This may be due to a {this} without any physical shapes.\nLocation: {frame.GetFileName()} at Line Number: {frame.GetFileLineNumber()} from Method: {frame.GetMethod().Name} ");
+        }
     }
 }

sources/engine/Stride.Physics/Engine/PhysicsComponent.cs

@@ -642,6 +642,12 @@ internal void Attach(PhysicsProcessor.AssociatedData data)
         {
             Data = data;
 
+            if (ColliderShapes.Count == 0 && ColliderShape == null)
+            {
+                logger.Error($"Entity {{Entity.Name}} has a PhysicsComponent without any collider shape.");
+                return; //no shape no purpose
+            }
+
             //this is mostly required for the game studio gizmos
             if (Simulation.DisableSimulation)
             {
@@ -651,12 +657,7 @@ internal void Attach(PhysicsProcessor.AssociatedData data)
             //this is not optimal as UpdateWorldMatrix will end up being called twice this frame.. but we need to ensure that we have valid data.
             Entity.Transform.UpdateWorldMatrix();
 
-            if (ColliderShapes.Count == 0 && ColliderShape == null)
-            {
-                logger.Error($"Entity {Entity.Name} has a PhysicsComponent without any collider shape.");
-                return; //no shape no purpose
-            }
-            else if (ColliderShape == null)
+            if (ColliderShape == null)
             {
                 ComposeShape();
                 if (ColliderShape == null)
@@ -700,6 +701,9 @@ internal void Detach()
             }
         }
 
+        /// <summary>
+        /// Called whenever an entity with this component is added to scene.
+        /// </summary>
         protected virtual void OnAttach()
         {
             //set pre-set post deserialization properties