GSC reference › Built-in
SetWaveWaterHeight()
Built-in (engine)
Client
Sets the height of one or all waters in a level
Signature
SetWaveWaterHeight(<water name>, <height>)
Parameters
| Name | Required? | Details |
|---|---|---|
| water name | Required | The name of the water affected, or empty string for all |
| height | Required | The new height value in world coordinates |
Example (from Treyarch's docs)
SetWaveWaterHeight( "huge_lake", 15.0 )
Real uses in BO3's scripts
Called 2 times in the decompiled scripts. A few, zombies first:
- scripts/zm/zm_island_pap_quest.csc, line 101
setwavewaterheight("bunker_pap_room_water", var_c0b3756a); - scripts/zm/zm_island_pap_quest.csc, line 106
setwavewaterheight("bunker_pap_room_water", n_end);
Related built-ins
- GetWaterHeight()Returns the height of the water at this position
- SetWaveWaterEnabled()Makes a water completely appear or disappear
- SetWaveWaterGeneratorAmplitude()Sets the wave water amplitude of the generator.
- IsPlayerUnderwater()Return if a player is underwater
- SetHeliHeightPatchEnabled()Enabled or disables the specified heli height lock path
- IsUnderwater()Returns 1 if the player is underwater.
- SetHeliHeightLock()Locks the heli to the height mesh
- DepthOfPlayerInWater()Returns the depth (in inches) that the player is in water.
- DepthInWater()Returns the depth (in inches) that the entity is in water.
- GetHeliHeightLockHeight()Gets the mesh height at a given point.
- SetWaterDrops()Sets water drops equal to the count
- GetLastOutWaterTime()Returns the last time the player was not completely submerged
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).