Show / Hide Table of Contents

Class Terrain

Inheritance
Object
Object
Component
Behaviour
Terrain
Inherited Members
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.transform
Component.gameObject
Component.GetComponent(Type)
Component.GetComponent<T>()
Component.GetComponent(String)
Component.GetComponentInChildren(Type, Boolean)
Component.GetComponentInChildren(Type)
Component.GetComponentInChildren<T>(Boolean)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren(Type, Boolean)
Component.GetComponentsInChildren(Type)
Component.GetComponentsInChildren<T>(Boolean)
Component.GetComponentsInChildren<T>(Boolean, List<T>)
Component.GetComponentsInChildren<T>()
Component.GetComponentsInChildren<T>(List<T>)
Component.GetComponentInParent(Type)
Component.GetComponentInParent<T>()
Component.GetComponentsInParent(Type, Boolean)
Component.GetComponentsInParent(Type)
Component.GetComponentsInParent<T>(Boolean)
Component.GetComponentsInParent<T>(Boolean, List<T>)
Component.GetComponentsInParent<T>()
Component.GetComponents(Type)
Component.GetComponents(Type, List<Component>)
Component.GetComponents<T>(List<T>)
Component.tag
Component.GetComponents<T>()
Component.CompareTag(String)
Component.SendMessageUpwards(String, Object, SendMessageOptions)
Component.SendMessageUpwards(String, Object)
Component.SendMessageUpwards(String)
Component.SendMessageUpwards(String, SendMessageOptions)
Component.SendMessage(String, Object)
Component.SendMessage(String)
Component.SendMessage(String, Object, SendMessageOptions)
Component.SendMessage(String, SendMessageOptions)
Component.BroadcastMessage(String, Object, SendMessageOptions)
Component.BroadcastMessage(String, Object)
Component.BroadcastMessage(String)
Component.BroadcastMessage(String, SendMessageOptions)
Object.GetInstanceID()
Object.GetHashCode()
Object.Equals(Object)
Object.name
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate(Object, Transform, Boolean)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Instantiate<T>(T, Transform, Boolean)
Object.Destroy(Object, Single)
Object.Destroy(Object)
Object.DestroyImmediate(Object, Boolean)
Object.DestroyImmediate(Object)
Object.FindObjectsOfType(Type)
Object.DontDestroyOnLoad(Object)
Object.hideFlags
Object.DestroyObject(Object, Single)
Object.DestroyObject(Object)
Object.FindSceneObjectsOfType(Type)
Object.FindObjectsOfTypeIncludingAssets(Type)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.FindObjectsOfTypeAll(Type)
Object.FindObjectOfType(Type)
Object.ToString()
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
public sealed class Terrain : Behaviour

Properties

activeTerrain

Declaration
public static Terrain activeTerrain { get; }
Property Value
Type Description
Terrain

activeTerrains

Declaration
public static Terrain[] activeTerrains { get; }
Property Value
Type Description
Terrain[]

allowAutoConnect

Declaration
public bool allowAutoConnect { get; set; }
Property Value
Type Description
Boolean

bakeLightProbesForTrees

Declaration
public bool bakeLightProbesForTrees { get; set; }
Property Value
Type Description
Boolean

basemapDistance

Declaration
public float basemapDistance { get; set; }
Property Value
Type Description
Single

bottomNeighbor

Declaration
public Terrain bottomNeighbor { get; }
Property Value
Type Description
Terrain

castShadows

Declaration
public bool castShadows { get; set; }
Property Value
Type Description
Boolean

collectDetailPatches

Declaration
public bool collectDetailPatches { get; set; }
Property Value
Type Description
Boolean

deringLightProbesForTrees

Declaration
public bool deringLightProbesForTrees { get; set; }
Property Value
Type Description
Boolean

detailObjectDensity

Declaration
public float detailObjectDensity { get; set; }
Property Value
Type Description
Single

detailObjectDistance

Declaration
public float detailObjectDistance { get; set; }
Property Value
Type Description
Single

drawHeightmap

Declaration
public bool drawHeightmap { get; set; }
Property Value
Type Description
Boolean

drawInstanced

Declaration
public bool drawInstanced { get; set; }
Property Value
Type Description
Boolean

drawTreesAndFoliage

Declaration
public bool drawTreesAndFoliage { get; set; }
Property Value
Type Description
Boolean

editorRenderFlags

Declaration
public TerrainRenderFlags editorRenderFlags { get; set; }
Property Value
Type Description
TerrainRenderFlags

freeUnusedRenderingResources

Declaration
public bool freeUnusedRenderingResources { get; set; }
Property Value
Type Description
Boolean

groupingID

Declaration
public int groupingID { get; set; }
Property Value
Type Description
Int32

heightmapMaximumLOD

Declaration
public int heightmapMaximumLOD { get; set; }
Property Value
Type Description
Int32

heightmapPixelError

Declaration
public float heightmapPixelError { get; set; }
Property Value
Type Description
Single

heightmapRenderTextureFormat

Declaration
public static RenderTextureFormat heightmapRenderTextureFormat { get; }
Property Value
Type Description
RenderTextureFormat

heightmapTextureFormat

Declaration
public static TextureFormat heightmapTextureFormat { get; }
Property Value
Type Description
TextureFormat

leftNeighbor

Declaration
public Terrain leftNeighbor { get; }
Property Value
Type Description
Terrain

legacyShininess

Declaration
public float legacyShininess { get; set; }
Property Value
Type Description
Single

legacySpecular

Declaration
public Color legacySpecular { get; set; }
Property Value
Type Description
Color

lightmapIndex

Declaration
public int lightmapIndex { get; set; }
Property Value
Type Description
Int32

lightmapScaleOffset

Declaration
public Vector4 lightmapScaleOffset { get; set; }
Property Value
Type Description
Vector4

materialTemplate

Declaration
public Material materialTemplate { get; set; }
Property Value
Type Description
Material

materialType

Declaration
public Terrain.MaterialType materialType { get; set; }
Property Value
Type Description
Terrain.MaterialType

normalmapTexture

Declaration
public RenderTexture normalmapTexture { get; }
Property Value
Type Description
RenderTexture

patchBoundsMultiplier

Declaration
public Vector3 patchBoundsMultiplier { get; set; }
Property Value
Type Description
Vector3

preserveTreePrototypeLayers

Declaration
public bool preserveTreePrototypeLayers { get; set; }
Property Value
Type Description
Boolean

realtimeLightmapIndex

Declaration
public int realtimeLightmapIndex { get; set; }
Property Value
Type Description
Int32

realtimeLightmapScaleOffset

Declaration
public Vector4 realtimeLightmapScaleOffset { get; set; }
Property Value
Type Description
Vector4

reflectionProbeUsage

Declaration
public ReflectionProbeUsage reflectionProbeUsage { get; set; }
Property Value
Type Description
ReflectionProbeUsage

rightNeighbor

Declaration
public Terrain rightNeighbor { get; }
Property Value
Type Description
Terrain

terrainData

Declaration
public TerrainData terrainData { get; set; }
Property Value
Type Description
TerrainData

topNeighbor

Declaration
public Terrain topNeighbor { get; }
Property Value
Type Description
Terrain

treeBillboardDistance

Declaration
public float treeBillboardDistance { get; set; }
Property Value
Type Description
Single

treeCrossFadeLength

Declaration
public float treeCrossFadeLength { get; set; }
Property Value
Type Description
Single

treeDistance

Declaration
public float treeDistance { get; set; }
Property Value
Type Description
Single

treeLODBiasMultiplier

Declaration
public float treeLODBiasMultiplier { get; set; }
Property Value
Type Description
Single

treeMaximumFullLODCount

Declaration
public int treeMaximumFullLODCount { get; set; }
Property Value
Type Description
Int32

Methods

AddTreeInstance(TreeInstance)

Declaration
public void AddTreeInstance(TreeInstance instance)
Parameters
Type Name Description
TreeInstance instance

ApplyDelayedHeightmapModification()

Declaration
public void ApplyDelayedHeightmapModification()

CreateTerrainGameObject(TerrainData)

Declaration
public static GameObject CreateTerrainGameObject(TerrainData assignTerrain)
Parameters
Type Name Description
TerrainData assignTerrain
Returns
Type Description
GameObject

Flush()

Declaration
public void Flush()

GetClosestReflectionProbes(List<ReflectionProbeBlendInfo>)

Declaration
public void GetClosestReflectionProbes(List<ReflectionProbeBlendInfo> result)
Parameters
Type Name Description
List<ReflectionProbeBlendInfo> result

GetPosition()

Declaration
public Vector3 GetPosition()
Returns
Type Description
Vector3
| Improve this Doc View Source

GetSplatMaterialPropertyBlock(MaterialPropertyBlock)

Declaration
public void GetSplatMaterialPropertyBlock(MaterialPropertyBlock dest)
Parameters
Type Name Description
MaterialPropertyBlock dest

SampleHeight(Vector3)

Declaration
public float SampleHeight(Vector3 worldPosition)
Parameters
Type Name Description
Vector3 worldPosition
Returns
Type Description
Single

SetConnectivityDirty()

Declaration
public static void SetConnectivityDirty()

SetNeighbors(Terrain, Terrain, Terrain, Terrain)

Declaration
public void SetNeighbors(Terrain left, Terrain top, Terrain right, Terrain bottom)
Parameters
Type Name Description
Terrain left
Terrain top
Terrain right
Terrain bottom

SetSplatMaterialPropertyBlock(MaterialPropertyBlock)

Declaration
public void SetSplatMaterialPropertyBlock(MaterialPropertyBlock properties)
Parameters
Type Name Description
MaterialPropertyBlock properties

Extension Methods

TerrainExtensions.UpdateGIMaterials(Terrain)
TerrainExtensions.UpdateGIMaterials(Terrain, Int32, Int32, Int32, Int32)
MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX