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

PhysicsShape.SetContactFilter

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 int SetContactFilter(ReadOnlySpan<PhysicsShape> shapes, ReadOnlySpan<ContactFilter> filters);

Parameters

Parameter Description
shapes The shapes to set the contact filter on.
filters The contact filters to set, one entry per shape.

Returns

int The number of shapes that were ignored (not set because the shape was invalid). A single warning is logged when any are ignored. If the spans are different lengths, nothing is set and every shape is counted as ignored.

Description

Set the ContactFilter on a batch of shapes. The shapes and filters spans must be the same length; shapes[n] receives filters[n].


Declaration

public static int SetContactFilter(ReadOnlySpan<PhysicsShape> shapes, ContactFilter contactFilter);

Parameters

Parameter Description
shapes The shapes to set the contact filter on.
contactFilter The contact filter to set on every shape.

Returns

int The number of shapes that were ignored (not set because the shape was invalid). A single warning is logged when any are ignored.

Description

Set the same ContactFilter on a batch of shapes.