Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

PhysicsBody.DestroyBatch

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static void DestroyBatch(ReadOnlySpan<PhysicsBody> bodies);

Parameters

Parameter Description
bodies The bodies to destroy.

Description

Destroy a batch of bodies, destroying all attached PhysicsShape and PhysicsJoint. Any invalid bodies will be ignored. Owned bodies will produce a warning and will not be destroyed (See PhysicsBody.SetOwner).


Declaration

public static void DestroyBatch(ReadOnlySpan<PhysicsBody> bodies, int ownerKey);

Parameters

Parameter Description
bodies The bodies to destroy.
ownerKey Optional owner key returned when using PhysicsBody.SetOwner.

Description

Destroy a batch of bodies, destroying all attached shapes and joints. Any invalid bodies are ignored. A body owned by a different owner key is skipped and left valid; a body with no owner, or one matching the given owner key, is destroyed. One summary warning reports how many bodies were skipped this way, rather than one warning per body.