JSFlood

API for creating and setting water surface features.

Created with the Module.getFlood API.

var flood = Module.getFlood();

active(active)

Sets the water surface to active or inactive.

Information

Name	Type	Description
active	boolean	Sets the water surface to active (true: activate, false: deactivate)

• Sample

  • Refer to function init.

  • Sandbox_Flood

Template

setColor(color)

Sets the color of the water surface.

Information

Name	Type	Description
color	JSColor	Water surface color

• Sample

  • Refer to function SetFloodColor.

  • Sandbox_Flood

Template

setHeight(height)

Sets the reference height for the water surface.

Information

Name	Type	Description
height	number	Reference height for the water surface (based on sea level, in meters)

• Sample

  • Refer to function setFloodHeight.

  • Sandbox_Flood

Template

setVisibleAltitude(altitude)

Sets the visible distance for the water surface representation.

The higher the number, the water surface is visible from a farther distance.

Information

Name	Type	Description
altitude	number	Visible distance for the water surface (in meters)

• Sample

  • Refer to function setFloodVisibleAltitude.

  • Sandbox_Flood

Template

setWaterSpeed(speed)

Sets the flow speed of the water surface.

The higher the number, the faster the flow speed.

Information

Name	Type	Description
speed	number	Water surface flow speed

• Sample

  • Refer to function SetWaterSpeed.

  • Sandbox_Flood

Template

visibleWaterPlane(type)

Sets the visibility of the water surface on the screen.

Information

Name	Type	Description
type	boolean	Water surface visualization (true: show, false: hide)

• Sample

  • Refer to function visibleWaterPlane.

  • Sandbox_Flood

Template