Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IsFilteringLayerMask(GameObject)

Checks if the _layer for obj is included in the _layerMask to be filtered.
Read time 1 minuteLast updated 4 days ago

Definition

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

Parameters

The GameObject used to check the _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 _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.
Additional Resources: _useDepth, _maxDepth