Staggart Creations

Stylized Water 2 documentation

Stylized Water 2

  1. Stylized Water 2
  2. Compatibility
  3. Getting Started
  4. Overview
    1. Shader
    2. Vertex colors
    3. Planar Reflections
    4. Components & Utilities
    5. Scripting
    6. River mode
    7. Third party integrations
    8. Transparency Mask
  5. Buoyancy
  6. Troubleshooting/FAQ
  7. Performance guidelines
  8. Roadmap
Stylized Water 2
Version: 1.5.1
Review

5.Buoyancy #

Reading wave data through C#

The package comes with scripting functionality that allows the water surface height and orientation to be read. This in turn can be used for buoyancy calculations. Familiarity with scripting is assumed in order to understand how to use this. If you’re set on making a buoyancy system, understand that it’s potentially a complex task.

This API primarily provides the necessary functionality for third party or custom buoyancy systems. This asset does not feature boat controllers or true physics-based buoyancy, which falls outside of its scope.

Buoyancy will only work for flat water bodies. Rivers or spheres are technically not possible without some complex scripting magic, this starts to delve into a custom physics system.

The wave height and normal can be read at any world position using this static function:

StylizedWater2.Buoyancy.SampleWaves(Vector3 position, Material waterMat, float waterLevel, float rollStrength, bool dynamicMaterial, out Vector3 normal);

The function has a summary, you can view a description for each parameter in your IDE, as well as any overload functions.

For buoyancy to work, on the material the “UV Source” under the General tab must be set to “World XZ projected” (that’s default)

The returned information is likely far more accurate than the visual representation of the water mesh. It does not actually return the height/normal of a mesh’s triangles.

If you are using an assembly definition, ensure you add a reference to the sc.stylizedwater2.runtime assembly, otherwise you won’t be able to access the StylizedWater2.Buoyancy class.

Floating Transform

This component makes a GameObject and all of its child objects snap to the water surface. It’s a basic non-physics based buoyancy implementation and uses the same API as outlined above.

Because the script sets the orientation of the Transform, modifying all axis, it cannot be rotated manually or through other scripts. Instead, set the rotation of the child objects directly. The position (X/Z value) can be changed freely.

Hierarchy set up when looking to modify the rotation, on top of the wave orientation

 

 

 

 

 

 

The “BuoyancyExample” scene shows this component in action

Dynamic Water Physics 2

The DWP2 asset is an advanced buoyancy/hydrodynamics system, that includes a ship controller. An integration is included, that allows it to be used with Stylized Water 2.

To install the required Stylized Water Data Provider component, see the Third party integrations section.

Water setup

By going to Help->Stylized Water 2->Hub Window you can quickly set up this component

Manual instructions:

By default, the DWP2 will rely on the Flat Water Data Provider component to identify and read a body of water’s surface.

Remove this, and add the Stylized Water Data Provider component to your lake/ocean. You will have to assign the water material you are using, since this script requires to know what kind of parameters are used for the waves.

When using the Stylized Water Data Provider component, DWP2’s systems can use it to query the wave height/orientation at any given point. Under the hood, this simply uses the Buoyancy API outlined above.

 

For any further details, please refer to the DWP2 manual… (I’m not the author)

Yes No Suggest edit
Last updated on May 1, 2023
4 of 4 users found this section helpful
If you're familiar with this asset, please consider leaving a review!
Your support is instrumental to its future
« Transparency MaskTroubleshooting/FAQ »
Suggest Edit