Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Destroy(int)

Destroy a world, destroying all objects contained within it such as all PhysicsBody and attached PhysicsShape and PhysicsJoint. If the object is owned with PhysicsWorld.SetOwner then you must provide the owner key it returned. Failing to do so will return a warning and the world will not be destroyed. You cannot destroy the _defaultWorld as it is permanently owned by Unity itself.
Read time 1 minuteLast updated 10 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 PhysicsWorld.SetOwner.

Returns

Type

Description

boolIf the world was destroyed or not.