Vixen
c7401864

BuoyancySettings

struct Core/Vixen.Water/Buoyancy.cs:48
csharp
public readonly record struct BuoyancySettings

How a body floats.

Read the guide page for this →

Remarks

Unreal's UBuoyancyComponent, minus the pieces that belong elsewhere: the pontoon list is the caller's span, the FX flags are Vixen.Vfx's, and the boat that steers with these forces is [28 § Vixen.Gameplay.Movement](../../docs/plan/28-gameplay-framework.md)'s.

Fields and properties (6)

  • public float Coefficient

    A multiplier on the displaced weight.

  • public float Damping

    First-order damping on the submerged part's velocity, per second.

  • public float QuadraticDamping

    Second-order damping, per metre of travel.

  • public float MaximumForce

    The most upward force one pontoon may produce, in newtons. Zero for no limit.

  • public float FlowDrag

    How hard a current drags a submerged pontoon along with it, per second.

  • public static BuoyancySettings Default

    A crate: Archimedes exactly, damped enough to settle in a couple of seconds.

Used by (5)

  • BuoyancyVixen.Water
  • BuoyancyBodyVixen.Water.Physics
  • BuoyancySystemTestsVixen.Water.Physics.Tests
  • BuoyancyTestsVixen.Water.Tests
  • TypeRegistrationVixen.Water.Physics