Version: 2019.2
Experimental: this API is experimental and might be changed or removed in the future.

TerrainPaintTool<T0>.OnPaint

Switch to Manual
public bool OnPaint (Terrain terrain, Experimental.TerrainAPI.IOnPaint editContext);

Parameters

terrainActive Terrain object.
editContextInterface used to communicate between Editor and Paint tools.

Returns

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

Description

Custom terrain tool paint callback.

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 OnSceneGUI. When the method returns true, the layers on top of the terrain, such as trees, grass, and other details, are not rendered.

See Also: PaintContext