Version: 2018.1 (switch to 2018.2b or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Rigidbody2D.useFullKinematicContacts

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

Switch to Manual
public var useFullKinematicContacts: bool;
public bool useFullKinematicContacts;

Description

Should kinematic/kinematic and kinematic/static collisions be allowed?

By default, colliders attached to a pair of Rigidbody2D that are either both set to be kinematic or kinematic and static will not collide with each other. Only Rigidbody2D where one is kinematic and the other is dynamic will collide by default.

This default behaviour happens when this property is set to false however, when set to true then kinematic Rigidbody2D are allowed to collide with other kinematic or static Rigidbody2D. When this happens, collision callbacks will be produced when kinematic/kinematic or kinematic/static pairs collide although no actual collision response will happen. In other words, callbacks will happen but the Rigidbody2D will allow colliders to overlap similar to the situation when a Collider2D is set to be a trigger.

This can be a useful feature if detecting collisions is required with details of the contact points and collision normal but without the automatic collision response.

This is only used when the bodyType is set to [[RigidbodyType2D.Kinematic]].

See Also: bodyType.

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