Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Destroy(int)

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.
Read time 1 minuteLast updated 12 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule
public bool Destroy(int ownerKey = 0)

Parameters

ownerKey

int
Optional owner key returned when using PhysicsBody.SetOwner.

Returns

Type

Description

boolReturns 
true
if the body was successfully destroyed. Otherwise, 
false
.

Remarks

Unity produces an error in the Console window if you try to destroy a body that no longer exists. Check _isValid first.
Additional Resources: PhysicsWorld.DestroyBodyBatch

Examples

// 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();    }}