> For the complete documentation index, see [llms.txt](https://docs.shadersource.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shadersource.io/assets-and-plugins/waterfall-tool-2/how-to-use/waterfall-2-actor.md).

# Waterfall 2 Actor

The Waterfall 2 actor (SHADERSOURCE Waterfall 2) is the main actor used by the Waterfall 2 Editor Mode.

<details>

<summary>Creating a Waterfall 2 Actor</summary>

The Waterfall 2 actor can be created by dragging and dropping from the Place Actors tab, the Place Actors menu, or through the Waterfall 2 Editor Mode.

Place Actors Tab:

<img src="/files/tgKKghlxplDsKKRcCjE0" alt="Place Actors Tab" data-size="original">

Place Actors Menu:

<img src="/files/ApWo38Trc4T93v5HDs1E" alt="Place Actors Menu" data-size="original">

Waterfall Tool 2 Editor Mode (with no waterfall selected)

<img src="/files/lKp7fj2viYCPhrCwOnVI" alt="Waterfall Tool 2 Editor Mode (with no waterfalls selected)" data-size="original">

Waterfall Tool 2 Editor Mode (with a waterfall selected)

<img src="/files/zsOR014awA1AeGLAsjYU" alt="Waterfall Tool 2 Editor Mode (with a waterfall selected)" data-size="original">

</details>

<details>

<summary>Waterfall 2 Actor Components</summary>

(<mark style="color:red;">Red components</mark> are hidden in editor - accessible only through C++ or Blueprints)

* **RootComp (Root Comp)**: The root component of the actor.
  * **FxAttachPoint**: The component to act as the origin/attach all the VFX and SFX components to.&#x20;
    * **VFX\_Top (Top)**: A niagara component for global top VFX (default top splash).
    * **VFX\_Middle (Middle)**: A niagara component for global middle VFX (default mist).
    * **VFX\_Bottom (Bottom)**: A niagara component for global bottom VFX (default bottom splash).
    * **SFX\_Top (SFX Top)**: An audio component for global top SFX.
    * **SFX\_Middle (SFX Mid)**: An audio component for global middle SFX.
    * **SFX\_Bottom (SFX Bottom)**: An audio component for global bottom SFX.
    * **VFXComponent {#}**: A niagara component for FX added through the FX tab.
    * **SFXComponent {#}**: An audio component for SFX added through the FX tab.
  * **BakedMeshComp (Mesh Comp)**: A static mesh component for the final optimised baked static mesh.
  * **TopSpline (Top Spline)**: A spline component that's used to draw the top of the waterfall.
    * **SH\_WaterfallPathComponent\_{#}**: Spline components generated by the Editor Mode to use as guides for creating vertices and material data.
  * **KillPlaneVisualiser (Kill Plane)**: A visualiser for the kill plane which acts as the end-point for the path component generation. (Note: The plane is actually infinite, the visualiser is just a general guide to help with placement.)
  * **MeshComp\_Singular**: A dynamic mesh component for the mesh created that covers the entire waterfall.
  * **MeshComp\_PerPath**: A dynamic mesh component for the mesh created that runs along each individual path.
  * **MeshComp\_Cross**: A dynamic mesh component for the mesh created that runs along each individual path and is a flat plane.
  * **MeshComp\_Splash**: A dynamic mesh component for the meshes generated at the bottom of each path for the splash effect.
* <mark style="color:red;">**WaterfallSettingsComp**</mark><mark style="color:red;">: A custom actor component that stores all of the variables used in the Editor Mode, allowing them all to be saved per-waterfall.</mark>

</details>

<details>

<summary>Waterfall 2 Actor Editable Variables</summary>

* Waterfall Settings
  * **Show Dynamic Meshes in Game**: If this is true, the dynamic meshes will be visible in game, if false the static mesh will be visible in game.

</details>

<details>

<summary>Waterfall 2 Actor C++ Reference</summary>

```
Cpp Class Name: ASH_Waterfall2
Module: Shadersource_Waterfall2Runtime
Header: /Shadersource_WaterfallTool2/Source/Shadersource_Waterfall2Runtime/Public/Actors/SH_Waterfall2.h
Include: #include "Actors/SH_Waterfall2.h"
```

</details>