✎ WaterAssets [Dynamic Water Physics 2 Documentation]

Edit the page and hit Save. See syntax for Wiki syntax. Please edit the page only if you can improve it. If you want to test some things, learn to make your first steps on the playground.

====== Supported Water Assets ======

''WaterDataProvider'' scripts are interfaces between the 3rd party water assets and Dynamic Water Physics 2. They tell the WaterObject where the water is.
\\

===== ! Assembly Definitions ! =====

<wrap round important>Due to inclusion of assembly definitions into this asset with v2.4 an additional step is required when setting up 3rd party water assets. The asset either needs to be referenced inside ''NWH.DWP2.asmdef'' or all the .asmdef (assembly definition) files need to be removed from DWP2. If the 3rd party asset does not include an assembly definition file one should be added manually to the root of that asset, or the .asmdef files need to be removed from DWP2.</wrap>

<wrap round important>If removing .asmdef files make sure to tick //Project Settings > Player > Allow 'unsafe' code//. This code will not harm your device, it just allows unmanaged memory access (i.e. pointers) which are used for performance optimization inside DWP2.</wrap>

**Steps to reference a 3rd party asset inside Dynamic Water Physics 2:**
  * Open the folder containing the asset (e.g. Crest) and check if there is an .asmdef file there. Sometimes this file can be inside a //Scripts// or similar folder. If the file is missing create one by //Right Click > Assembly Definition//. Name the file the same as the asset, e.g. ''Crest''.
  * Go to //NWH/Dynamic Water Physics 2// and click on NWH.DWP2.asmdef file. Under //Assembly Definition References// click on + to add a new element to the list. Set the new element to the newly created .asmdef file, e.g. Crest.asmdef.
  * Done. Now DWP2 will know about the 3rd party water asset and will be able to access the code from that assembly.

====== ======

===== Multiple Assets / Water Types =====
Multiple water types can be used in the same scene at the same time. This is achieved through triggers (''Collider''s with ''isTrigger'' set to true) attached to the same ''GameObject'' as the ''WaterDataProvider'' in question.\\
By default these colliders are created automatically on ''Awake'' and are set to cover the whole world. However, it is possible to use a ''WaterDataProvider'' just for a small part of the scene - such as a lake.\\

* Attach a ''Collider'' of any type (e.g. ''SphereCollider'') to the ''GameObject'' containing ''WaterDataProvider''.
  * Tick ''Is Trigger'' on the collider.
  * Adjust the size/radius of the collider to cover the area you want the ''WaterDataProvider'' to have the effect on.

If there are multiple trigger volumes they will act as a queue, meaning the one that the object last entered will be currently active.

Edit summary