Skip to end of metadata
Go to start of metadata

Overview

Allows to spawn ripples on water surfaces. It is especially useful for cutscenes when non-physicalized entities are moving through a body of water.

The WaterRipplesGenerator entity can be found in RollupBar -> Entity -> Environment.

Limitations

  • The WaterRipplesGenerator only works with WaterVolumes, it doesn't work with the ocean surface.
  • All WaterVolumes below and above the WaterRipplesGenerator will be affected.

WaterRipplesGenerator Properties

Property

Description

Enabled

Turns the entity on/off.

Scale

Size of the ripple effect.

Strength

Strength of the ripple effect. Also affects size.
The most noticeable changes happen in the range from 0 to 1.

RandomFreq

Randomly changes the frequency of the ripple effect. The value specified is the maximum frequency that will occurr.

RandomOffsetX

Randomly spawns ripples at an offset position relative to the entity. This value sets the maximum offset on the X axis (local coordinate system).
Only works if AutoSpawn is enabled.

RandomOffsetY

Same as RandomOffsetX, but for the Y axis (local coordinate system). Only works if AutoSpawn is enabled.

RandomScale

Randomly sets the scale of the ripple effect. The value specified is the maximum scale that can be set.

RandomStrength

Same as RandomScale, but for the Strength value.

AutoSpawn

If enabled, water ripples will be spawned regularly even if the entity doesn't move.
The spawn interval is determined by the Frequency and RandomFreq properties.

Frequency

Sets the interval for AutoSpawn in seconds.

SpawnOnMovement

If enabled, ripples will be spawned when the entity moves.

Examples

Spawn On Movement

WaterRipplesGenerator entity linked to a character bone, set to use SpawnOnMovement:

Entity animated in a Track View sequence, set to use SpawnOnMovement:

Randomized AutoSpawn

AutoSpawn set to 'true', RandomOffsetX and RandomOffsetY set to '3'.

In this example the WaterRipplesGenerator is used to enhance the sprinkler particle effects in the room:

For comparison: The same room again with only the particles and without the WaterRipplesGenerator entity:

  • No labels