Skip to content

Fluid Volume

The Fluid Volume component defines an area filled with a user-defined "fluid". Combined with the Physics Influencer this controls buoyancy for objects, as well as triggering swimming animations on the player avatar.

UI

Fluid-Volume-UI.png

Volume Type

This dropdown allows you to select between the two supported zone shapes:

  • Box

or

  • Sphere

Width/Length

Defines the distance between the faces of the fluid zone along the LOCAL X (X) and Z (Y) axes. At default scale, this is 10 meters by default.

Depth

Defines the "depth" of the fluid zone along the LOCAL Y axis. At default scale, this is 5 meters by default.

Place From Center

Determines whether depth should be managed from the center of the volume, or from the center of the top face.

Stream Type

Stream in this context refers to to a flowing force within the Fluid volume, such as a flowing river or water cannon. The Stream Direction dropdown contains two states: - Directional: The entire volume flows in a single direction defined by the Stream Angle. - Outward: Flows outward omnidirectionally from the origin.

Stream Angle

The angle the stream flows toward in degrees. 0 is local +Z.

Stream Strength

This applies a force in the direction of the stream. Strength is measured in newtons multiplied by the submerged volume of an affected object.

Splash Particle System

The Particle System you wish to activate when an object enters or exits the volume.

Examples

There are currently no examples. If you'd like to add one, please contribute! Community contributions can be submitted to our Documentation Github.