Version: 2021.1
LanguageEnglish
  • C#

ContactFilter2D.IsFilteringLayerMask

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 bool IsFilteringLayerMask(GameObject obj);

Parameters

obj The GameObject used to check the GameObject.layer.

Returns

bool Returns true when obj is excluded by the filter and false if otherwise.

Description

Checks if the GameObject.layer for obj is included in the layerMask to be filtered.

Filtering is defined as including or excluding objects based upon a specific condition. Layer mask filtering checks the GameObject.layer and includes it when it is within the layer mask and excludes it if otherwise. IsFilteringLayerMask returns true when useLayerMask is set to true and the obj layer mask is not included by layerMask. This indicates the obj is filtered which means it should be excluded. IsFilteringLayerMask returns false if otherwise.

See Also: useDepth, ::ref:minDepth & maxDepth.