PhysicsBody.Destroy

Parameters

Returns

bool Returns true if the body was successfully destroyed. Otherwise, false.

Description

Destroy a body, destroying all attached PhysicsShape and PhysicsJoint. If the object is owned with PhysicsBody.SetOwner then you must provide the owner key it returned. Failing to do so will return a warning and the body will not be destroyed.

Unity produces an error in the Console window if you try to destroy a body that no longer exists. Check PhysicsBody.isValid first.

Additional resources: PhysicsWorld.DestroyBodyBatch

 // Create a physics body, then destroy it when it's no longer needed.
 using UnityEngine;
 using Unity.U2D.Physics;

 public class DestroyBodyExample : MonoBehaviour
 {
     void Start()
     {
         PhysicsWorld world = PhysicsWorld.defaultWorld;
         PhysicsBody myBody = world.CreateBody();
         myBody.Destroy();
     }
 }