Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Terrain.collectDetailPatches

Suggest a change

Success!

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.

Close

Sumbission failed

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

Close

Cancel

public var collectDetailPatches: bool;
public bool collectDetailPatches;

Description

Collect Detail patches from memory.

If enabled the detail patches in the Terrain will be removed from memory when not visible. If the property is set to false, the patches are kept in memory until the Terrain object is destroyed or the collectDetailPatches property is set to true. By setting the property to false all the detail patches for a given density will be initialized and kept in memory. Changing the density will recreate the patches.

Note that Detail Patches can use a large amount of memory, therefore this property when set to false can increase the memory usage of your application significantly. In most cases you don't need to set this property to false (default behavior).

See Also: detailObjectDensity.

function Start () {
	Terrain.activeTerrain.collectDetailPatches = false;
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { Terrain.activeTerrain.collectDetailPatches = false; } }