WaterBrush

Extends: ShapeTool < Tool < Object

Description

The tool used to edit water. Use World.Level.WaterMesh if you want to directly edit the water.

Accessed by Global.Editor.Tools["WaterBrush"].

Properties

WaterMesh	Mesh
int	Size
Range	BlendDistance
bool	DisableBorder
bool	IsUsingShapes

Methods

void	UpdateBrushRadius ( )
void	UpdateCursor ( )
void	ChangeColor ( Color color, String name )
void	ChangeDeepColor ( Color color )
void	ChangeShallowColor ( Color color )
void	ChangeBlendDistance ( float value )
void	SetDisableBorder ( bool value )

Property Descriptions

• WaterMesh Mesh:
  The water instance itself.

---

• int Size:
  Get or set the size of the brush [0 - 4].

---

• Range BlendDistance:
  Modify the Range to change the blend distance between shallow and deep water color. Call ChangeBlendDistance() instead to set.

---

• bool DisableBorder:
  Toggle the border visibility. Call SetDisableBorder() to set.

---

• bool IsUsingShapes:
  Gets or sets if the brush is using a brush or a shape mode. Setting the parent Mode property will always enable this.

Method Descriptions

• void UpdateBrushRadius ( ):
  Update the cursor to reflect size change.

---

• void UpdateCursor ( ):
  Update the cursor to reflect size and mode changes.

---

• void ChangeColor ( Color color, String name ):
  Changes the water colors. Valid entries for names are: "DeepColor" and "ShallowColor".

---

• void ChangeDeepColor ( Color color ):
  Changes the deep water color.

---

• void ChangeShallowColor ( Color color ):
  Changes the shallow water color.

---

• void ChangeBlendDistance ( float value ):
  Changes the blend distance water.

---

• void SetDisableBorder ( bool value ):
  Toggles the water border.