Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OnPaint(Terrain, IOnPaint)

Custom terrain tool paint callback.
Read time 1 minuteLast updated 13 days ago

Definition

public virtual bool OnPaint(Terrain terrain, IOnPaint editContext)

Parameters

terrain

Active Terrain object.

editContext

Interface used to communicate between Editor and Paint tools.

Returns

Type

Description

boolReturn true to temporarily hide tree, grass, and detail layers on the terrain.

Remarks

Unity calls this method when the mouse button is pressed or dragged, which is typically when a tool applies its modifications. Some tools may instead want to apply their modifications in custom painting logic from within TerrainPaintTool<T>.OnSceneGUI. When the method returns true, the layers on top of the terrain, such as trees, grass, and other details, are not rendered.
Additional Resources: PaintContext