Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

PlatformEffector2D.useSideFriction

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 useSideFriction: bool;
public bool useSideFriction;

Description

Should friction be used on the platform sides?

When false, a contact on the side uses no friction. When true, any existing friction is used. This is useful to stop friction slowing a Collider2D when in contact with a vertical surface when a force is being applied to keep the Collider2D in contact with the surface. The "sides" are defined as the edges perpendicular to the "top" surface(s) in local-space.