IsFilteringLayerMask(GameObject)

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

阅读时间1 分钟

最后更新于 1 个月前

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
bool	Returns 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.

Unity Engine

User Manual

Script Reference