Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

IsFilteringLayerMask(GameObject)

Checks if the GameObject.layer for obj is included in the ContactFilter2D.layerMask to be filtered.
Read time 1 minuteLast updated 9 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public bool IsFilteringLayerMask(GameObject obj)

Parameters

obj

GameObject
The GameObject used to check the GameObject.layer.

Returns

Type

Description

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

Remarks

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 ContactFilter2D.useLayerMask is set to true and the 
obj
layer mask is not included by ContactFilter2D.layerMask. This indicates the 
obj
is filtered which means it should be excluded. IsFilteringLayerMask returns false if otherwise.
Additional Resources: ContactFilter2D.useDepth, ::ref:minDepth & ContactFilter2D.maxDepth.