# How to Use

{% hint style="info" %}
To view an example of the tool in use, see the **Demonstration** map located in WaterfallTool > Maps.
{% endhint %}

Drag and drop the Blueprint **BP\_WaterfallTool** into the viewport (located in WaterfallTool > Blueprints).

<figure><img src="/files/rRVlJIDtifahss5HWgwN" alt=""><figcaption></figcaption></figure>

Use the spline points to adjust the height and angle of the waterfall.

{% hint style="info" %}
The bottom spline point will be automatically locked to the ground if **Ground Check** is ticked on.
{% endhint %}

<figure><img src="/files/w64xwnwIPv5Xih6bcM30" alt=""><figcaption></figcaption></figure>

Change settings in the *Details Panel* as desired:

* Waterfall Settings
  * **Ground Check**: Toggle if the waterfall should automatically stay on the ground
  * **Easy Scale**: Scales the width of the waterfall
  * **Water Color**: Change the colour of the water here
  * **Foam Brightness**: How bright the foam should be in the waterfall
  * **Opacity**: Changes the opacity of the water
  * **Opacity Edge Fade**: Depth Fade on the opacity (when the water is near other objects)
  * **Flow Speed**: How fast the water flows
  * **Start Fade**: The strength of the opacity fade at the start of the waterfall
  * **End Fade**: The strength of the opacity fade at the end of the waterfall
  * **Edge Fade**: The strength of the opacity fade on the edges of the waterfall
  * **Object Detection**: Toggle to enable object detection on material
  * **Object Detection Size**: The distance to the nearest surface to check for object detection
  * **Object Detection Strength**: An overall strength multiplier for the object detection checks
  * **Object Detection Smoothness**: The gradient for the fade when colliding with objects
  * **Actors to Ignore**: The waterfall will ignore any actors defined here for any of its collision checks
* Particles:
  * **Water Particle Color**: Change the colour of all the particle effects here
  * **Enable Top Splash**: Toggles the splash particle at the top of the waterfall on and off
  * **Top Splash Lifetime**: The lifetime of the splash particle at the top of the waterfall
  * **Enable Mist**: Enable and disable the mist particle
  * **Mist Lifetime**: The lifetime of the mist particle
  * **Enable Ground Splash**:  Toggles the splash particle at the bottom of the waterfall on and off
  * **Ground Splash Scale Offset**: Scales the splash particle at the bottom of the waterfall
  * **Ground Splash X Location Offset**: Offsets the location of the splash particle at the bottom of the waterfall

{% hint style="warning" %}
In versions 4.27 and prior, the particles use Cascade rather than Niagara and are only visible when simulating/playing in editor
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shadersource.io/assets-and-plugins/waterfall-tool/how-to-use.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.