Version: 2020.1
LanguageEnglish
  • C#

ContactFilter2D.IsFilteringTrigger

Leave feedback
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

public bool IsFilteringTrigger(Collider2D collider);

Parameters

collider The Collider2D used to check for a trigger.

Returns

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

Description

Checks if the collider is a trigger and should be filtered by the useTriggers to be filtered.

Filtering is defined as including or excluding objects based upon a specific condition. Trigger filtering checks the Collider.isTrigger and includes it if triggers are being used and excludes it otherwise. IsFilteringTriggers returns true when useTriggers is set to false and Collider.isTrigger is true. This indicates the collider is filtered which means it should be excluded. IsFilteringTriggers returns false if otherwise.

See Also: useTriggers.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2021-02-24.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information