Emits events (UnityEvents) based on the sampled water data.
Properties¶
Source |
What transform should the queries be based on. “Viewer” will reuse queries already performed by the Water Renderer |
Transform |
This game object’s transform. |
Viewer |
The viewer’s transform. The viewer is the main camera the system uses. |
Viewer |
The viewer as the source of the queries. Only needs to be set if using multiple viewpoints on the Water Renderer. |
Layer |
Which water collision layer to target. |
Everything |
Include all displacement. |
After Animated Waves |
Only include Animated Waves. |
After Dynamic Waves |
Include Animated Waves and Dynamic Waves. |
Distance From Water Surface¶
Minimum Wavelength |
The minimum wavelength for queries. The higher the value, the more smaller waves will be ignored when sampling the water surface. |
Signed |
Whether to keep the sign of the value (ie positive/negative). A positive value means the query point is above the surface, while a negative means it below the surface. |
Maximum Distance |
The maximum distance. Always use a real distance in real units (ie not normalized). |
Use Curve |
Whether to apply a curve to the distance. Normalizes and inverts the distance to be between zero and one, then applies a curve. |
Curve |
Apply a curve to the distance. Values towards “one” means closer to the water surface. |
Distance From Water Edge¶
Signed |
Whether to keep the sign of the value (ie positive/negative). A positive value means the query point is over water, while a negative means it is over land. |
Maximum Distance |
The maximum distance. Always use a real distance in real units (ie not normalized). |
Use Curve |
Apply a curve to the distance. Normalizes and inverts the distance to be between zero and one, then applies a curve. |
Curve |
Apply a curve to the distance. Values towards “one” means closer to the water’s edge. |
Events¶
On Below Water |
Triggers when game object goes below water surface. Triggers once per state change. |
On Above Water |
Triggers when game object goes above water surface. Triggers once per state change. |
Distance From Surface |
Sends the distance from the water surface. |
Distance From Edge |
Sends the distance from the water’s edge. |