Field Shoreline

A field shoreline is an object, specifying global water areas where swash zone should be located. Field Shoreline helps to create swashes near the shores and applies the wetness effect on objects near the shoreline.

Notice

A field shoreline object affects water only if the FieldShoreline interaction option is enabled on the States tab of the water_global_base material.

Swash zone created by using FieldShoreline object.

NoticeThe maximum number of FieldShorelines rendered per frame/bit mask is limited to:
			 113 (DirectX)
 14 (OpenGL)

		

See also#

The FieldShoreline class to manage FieldShoreline objects via API
The render_field_shoreline_resolution console command to change the resolution of the texture into which all textures set for the object are rendered

To add a shoreline field in the world via UnigineEditor, do the following:

On the Menu bar, choose Create -> Water -> Field Shoreline.
Place the shoreline field in the world so that it intersects Global Water object.
Notice
Make sure that the FieldShoreline interaction option is enabled for water_global_base material.
Go to the Node tab of the Parameters window, set up necessary parameters and grab the shoreline texture.

NoticeAfter adding a FieldShoreline object to the scene, you can't see any changes of the global water object because FieldShoreline object doesn't have any default texture.

In the Field Shoreline section (Parameters window -> Node tab), the following parameters of the shoreline field can be adjusted:

Setting Bit Masks#

Field Mask	A field mask. A bit mask that specifies an area of the shoreline field to be applied to water. The shoreline field will be applied to water only if they have matching masks.
Viewport Mask	A viewport mask. A bit mask for rendering the shoreline field into the current viewport. For the shoreline field to be rendered into the viewport, its mask should match the camera viewport mask.

Setting Shoreline Parameters#

Size	Size of the shoreline field along the axes in units. A big-sized FiledShoreline object provides less detailed swash zones.
Texture	Shoreline texture. Grab the texture to fill that field.

Grabber Parameters#

Distance	Padding distance (from shore to the beginning of swash).
Blur	Blur coefficient (make shoreline smoother).
Resolution	Grabbing texture resolution.
Grab texture	Grabbing texture button.

In This Article: