Version: 2018.3 (switch to 2019.1)
  • C#
Experimental: this API is experimental and might be changed or removed in the future.


Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.



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


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


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


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

Did you find this page useful? Please give it a rating: