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

PhysicsShape.physicsGroup

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

public PhysicsGroup physicsGroup;

Description

The group this shape belongs to, used to treat a set of shapes on one body as a single object when reporting contact and trigger begin and end events. Grouping marks the shape's contact and trigger begin/end events with whether they are the first or last event between the two groups involved. A shape starts with no group and can be assigned a group once only; the group then cannot be changed for the lifetime of the shape. Every shape given the same group must belong to the same body, otherwise the first and last marking of their events is unreliable.

See PhysicsGroup for why grouping exists and its limitations, PhysicsWorld.CreateGroup and PhysicsWorld.eventGroupingAllowed. Attempting to assign an empty group, or assign to a shape that already has a group, produces a warning and leaves the shape unchanged.