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.

BuoyancyEffector2D.flowMagnitude

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 flowMagnitude: float;
public float flowMagnitude;

Description

The magnitude of the force used to similate fluid flow.

Fluid flow can be defined to move in any direction with a specific magnitude and a random variation on that magnitude.

This property defines the size of the force to be applied in the direction defined by flowAngle. This magnitude can be randomly varied by using flowVariation.

The flow forces are applied to the center of any submerged region of a Collider2D so it will not produce any torque (rotation) if the Collider2D is fully submerged (fully below the surfaceLevel) but will produce torque if the Collider2D is partially submerged (overlapping the surfaceLevel).

See Also: flowAngle, flowVariation.